From 358f500822d3e682d0c882608b132f7c5393ca3c Mon Sep 17 00:00:00 2001 From: Anton Dosov Date: Wed, 10 Mar 2021 13:53:20 +0100 Subject: [PATCH] update docs --- api_docs/actions.json | 952 +- api_docs/advanced_settings.json | 54 +- api_docs/alerting.json | 3010 +- api_docs/apm.json | 120 +- api_docs/apm_oss.json | 174 +- api_docs/banners.json | 111 +- api_docs/beats_management.json | 6 +- api_docs/bfetch.json | 602 +- api_docs/canvas.json | 12 +- api_docs/case.json | 6 +- api_docs/charts.json | 1801 +- api_docs/cloud.json | 45 +- api_docs/console.json | 6 +- api_docs/core.json | 80 +- api_docs/core_application.json | 1813 +- api_docs/core_chrome.json | 645 +- api_docs/core_saved_objects.json | 12313 ++++--- api_docs/dashboard.json | 894 +- api_docs/dashboard_enhanced.json | 309 +- api_docs/dashboard_mode.json | 33 +- api_docs/data.json | 27640 ++++++++------- api_docs/data_autocomplete.json | 329 +- api_docs/data_enhanced.json | 306 +- api_docs/data_field_formats.json | 4130 ++- api_docs/data_index_patterns.json | 8216 +++-- api_docs/data_query.json | 1120 +- api_docs/data_search.json | 17095 +++++----- api_docs/data_ui.json | 115 +- api_docs/dev_tools.json | 27 +- api_docs/discover.json | 902 +- api_docs/discover_enhanced.json | 823 +- api_docs/embeddable.json | 6897 ++-- api_docs/embeddable_enhanced.json | 184 +- api_docs/encrypted_saved_objects.json | 144 +- api_docs/enterprise_search.json | 6 +- api_docs/es_ui_shared.json | 1090 +- api_docs/event_log.json | 282 +- api_docs/expressions.json | 33349 +++++++++---------- api_docs/features.json | 2119 +- api_docs/file_upload.json | 1837 +- api_docs/global_search.json | 685 +- api_docs/home.json | 491 +- api_docs/index_lifecycle_management.json | 15 +- api_docs/index_management.json | 1562 +- api_docs/index_pattern_field_editor.json | 211 +- api_docs/index_pattern_management.json | 138 +- api_docs/infra.json | 42 +- api_docs/ingest_pipelines.json | 27 +- api_docs/inspector.json | 474 +- api_docs/kibana_legacy.json | 960 +- api_docs/kibana_react.json | 3398 +- api_docs/kibana_utils.json | 8402 +++-- api_docs/lens.json | 2174 +- api_docs/license_management.json | 9 +- api_docs/licensing.json | 1620 +- api_docs/lists.json | 3416 +- api_docs/lists.mdx | 3 + api_docs/management.json | 513 +- api_docs/maps.json | 57 +- api_docs/maps_legacy.json | 51 +- api_docs/ml.json | 4360 ++- api_docs/monitoring.json | 21 +- api_docs/navigation.json | 87 +- api_docs/newsfeed.json | 51 +- api_docs/observability.json | 2103 +- api_docs/osquery.json | 60 +- api_docs/presentation_util.json | 79 +- api_docs/remote_clusters.json | 12 +- api_docs/reporting.json | 939 +- api_docs/rollup.json | 162 +- api_docs/runtime_fields.json | 204 +- api_docs/saved_objects.json | 2437 +- api_docs/saved_objects_management.json | 1371 +- api_docs/saved_objects_tagging.json | 596 +- api_docs/saved_objects_tagging_oss.json | 1655 +- api_docs/security.json | 847 +- api_docs/security_oss.json | 33 +- api_docs/security_solution.json | 1425 +- api_docs/share.json | 898 +- api_docs/snapshot_restore.json | 98 +- api_docs/spaces.json | 836 +- api_docs/spaces_oss.json | 1102 +- api_docs/stack_alerts.json | 32 +- api_docs/task_manager.json | 465 +- api_docs/telemetry.json | 279 +- api_docs/telemetry_collection_manager.json | 158 +- api_docs/telemetry_collection_xpack.json | 36 +- api_docs/telemetry_management_section.json | 39 +- api_docs/triggers_actions_ui.json | 2677 +- api_docs/ui_actions.json | 967 +- api_docs/ui_actions_enhanced.json | 1651 +- api_docs/uptime.json | 15 +- api_docs/url_forwarding.json | 42 +- api_docs/usage_collection.json | 155 +- api_docs/vis_type_timeseries.json | 6 +- api_docs/visualizations.json | 3890 +-- 96 files changed, 85680 insertions(+), 97953 deletions(-) diff --git a/api_docs/actions.json b/api_docs/actions.json index f4287abb1f470..ec2bd86581f32 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -11,50 +11,6 @@ "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", @@ -90,8 +46,7 @@ "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" + "lineNumber": 22 } } ], @@ -99,70 +54,54 @@ "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" + "lineNumber": 22 }, "initialIsOpen": false - } - ], - "interfaces": [ + }, { - "id": "def-server.ActionsPlugin", - "type": "Interface", - "label": "ActionsPlugin", + "id": "def-server.asSavedObjectExecutionSource", + "type": "Function", + "label": "asSavedObjectExecutionSource", + "signature": [ + "(source: Pick<", + "SavedObjectReference", + ", \"type\" | \"id\">) => ", + "SavedObjectExecutionSource" + ], "description": [], - "tags": [], "children": [ { - "tags": [], - "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" - }, + "label": "source", + "isRequired": true, "signature": [ + "Pick<", { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.PluginSetupContract", - "text": "PluginSetupContract" - } - ] - }, - { - "tags": [], - "id": "def-server.ActionsPlugin.start", - "type": "Object", - "label": "start", + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + ", \"type\" | \"id\">" + ], "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" - } - ] + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 30 + } } ], + "tags": [], + "returnComment": [], "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" + "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", + "lineNumber": 29 }, "initialIsOpen": false - }, + } + ], + "interfaces": [ { "id": "def-server.ActionResult", "type": "Interface", @@ -188,8 +127,7 @@ "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" + "lineNumber": 63 } }, { @@ -200,8 +138,7 @@ "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" + "lineNumber": 64 } }, { @@ -212,8 +149,7 @@ "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" + "lineNumber": 65 } }, { @@ -224,8 +160,7 @@ "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" + "lineNumber": 66 }, "signature": [ "Config | undefined" @@ -239,118 +174,124 @@ "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" + "lineNumber": 67 } } ], "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" + "lineNumber": 62 }, "initialIsOpen": false }, { - "id": "def-server.ActionTypeExecutorOptions", + "id": "def-server.ActionsApiRequestHandlerContext", "type": "Interface", - "label": "ActionTypeExecutorOptions", - "signature": [ - { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.ActionTypeExecutorOptions", - "text": "ActionTypeExecutorOptions" - }, - "" - ], + "label": "ActionsApiRequestHandlerContext", "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-server.ActionTypeExecutorOptions.services", - "type": "Object", - "label": "services", + "id": "def-server.ActionsApiRequestHandlerContext.getActionsClient", + "type": "Function", + "label": "getActionsClient", "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" + "lineNumber": 40 }, "signature": [ + "() => ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", - "section": "def-server.Services", - "text": "Services" + "section": "def-server.ActionsClient", + "text": "ActionsClient" } ] }, { "tags": [], - "id": "def-server.ActionTypeExecutorOptions.config", - "type": "Uncategorized", - "label": "config", + "id": "def-server.ActionsApiRequestHandlerContext.listTypes", + "type": "Function", + "label": "listTypes", "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" + "lineNumber": 41 }, "signature": [ - "Config" + "() => ", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ActionType", + "text": "ActionType" + }, + "[]" ] - }, + } + ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 39 + }, + "initialIsOpen": false + }, + { + "id": "def-server.ActionsPlugin", + "type": "Interface", + "label": "ActionsPlugin", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-server.ActionTypeExecutorOptions.secrets", - "type": "Uncategorized", - "label": "secrets", + "id": "def-server.ActionsPlugin.setup", + "type": "Object", + "label": "setup", "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" + "lineNumber": 49 }, "signature": [ - "Secrets" + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" + } ] }, { "tags": [], - "id": "def-server.ActionTypeExecutorOptions.params", - "type": "Uncategorized", - "label": "params", + "id": "def-server.ActionsPlugin.start", + "type": "Object", + "label": "start", "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" + "lineNumber": 50 }, "signature": [ - "Params" + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + } ] } ], "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" + "lineNumber": 48 }, "initialIsOpen": false }, @@ -379,8 +320,7 @@ "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" + "lineNumber": 101 } }, { @@ -391,8 +331,7 @@ "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" + "lineNumber": 102 } }, { @@ -403,8 +342,7 @@ "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" + "lineNumber": 103 }, "signature": [ "number | undefined" @@ -418,8 +356,7 @@ "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" + "lineNumber": 104 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" @@ -433,8 +370,7 @@ "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" + "lineNumber": 105 }, "signature": [ "{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; } | undefined" @@ -459,8 +395,7 @@ "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" + "lineNumber": 110 } }, { @@ -473,8 +408,7 @@ "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" + "lineNumber": 110 } } ], @@ -482,8 +416,7 @@ "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" + "lineNumber": 110 } }, { @@ -494,8 +427,7 @@ "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" + "lineNumber": 111 }, "signature": [ { @@ -511,145 +443,120 @@ ], "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" + "lineNumber": 95 }, "initialIsOpen": false }, { - "id": "def-server.PreConfiguredAction", + "id": "def-server.ActionTypeExecutorOptions", "type": "Interface", - "label": "PreConfiguredAction", + "label": "ActionTypeExecutorOptions", "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" + "section": "def-server.ActionTypeExecutorOptions", + "text": "ActionTypeExecutorOptions" }, - "" + "" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.PreConfiguredAction.secrets", - "type": "Uncategorized", - "label": "secrets", + "id": "def-server.ActionTypeExecutorOptions.actionId", + "type": "string", + "label": "actionId", "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": [], - "tags": [], - "children": [ + "lineNumber": 55 + } + }, { "tags": [], - "id": "def-server.ActionsApiRequestHandlerContext.getActionsClient", - "type": "Function", - "label": "getActionsClient", + "id": "def-server.ActionTypeExecutorOptions.services", + "type": "Object", + "label": "services", "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" + "lineNumber": 56 }, "signature": [ - "() => ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", - "section": "def-server.ActionsClient", - "text": "ActionsClient" + "section": "def-server.Services", + "text": "Services" } ] }, { "tags": [], - "id": "def-server.ActionsApiRequestHandlerContext.listTypes", - "type": "Function", - "label": "listTypes", + "id": "def-server.ActionTypeExecutorOptions.config", + "type": "Uncategorized", + "label": "config", "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" + "lineNumber": 57 }, "signature": [ - "() => ", - { - "pluginId": "actions", - "scope": "common", - "docId": "kibActionsPluginApi", - "section": "def-common.ActionType", - "text": "ActionType" - }, - "[]" + "Config" + ] + }, + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.secrets", + "type": "Uncategorized", + "label": "secrets", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 58 + }, + "signature": [ + "Secrets" + ] + }, + { + "tags": [], + "id": "def-server.ActionTypeExecutorOptions.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 59 + }, + "signature": [ + "Params" ] } ], "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" + "lineNumber": 54 }, "initialIsOpen": false - } - ], - "enums": [], - "misc": [ + }, { - "id": "def-server.ActionsClient", - "type": "Type", - "label": "ActionsClient", - "tags": [], - "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" - }, + "id": "def-server.PreConfiguredAction", + "type": "Interface", + "label": "PreConfiguredAction", "signature": [ - "{ get: ({ id }: { id: string; }) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", - "section": "def-server.ActionResult", - "text": "ActionResult" + "section": "def-server.PreConfiguredAction", + "text": "PreConfiguredAction" }, - ">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: ({ action: { actionTypeId, name, config, secrets }, }: ", - "CreateOptions", - ") => Promise<", + " extends ", { "pluginId": "actions", "scope": "server", @@ -657,48 +564,77 @@ "section": "def-server.ActionResult", "text": "ActionResult" }, - ">>; update: ({ id, action }: ", - "UpdateOptions", - ") => Promise<", + "" + ], + "description": [], + "tags": [], + "children": [ { - "pluginId": "actions", - "scope": "server", - "docId": "kibActionsPluginApi", - "section": "def-server.ActionResult", - "text": "ActionResult" + "tags": [], + "id": "def-server.PreConfiguredAction.secrets", + "type": "Uncategorized", + "label": "secrets", + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 74 + }, + "signature": [ + "Secrets" + ] } ], + "source": { + "path": "x-pack/plugins/actions/server/types.ts", + "lineNumber": 70 + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", + "lineNumber": 99 + }, + "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.ActionsAuthorization", + "id": "def-server.ActionParamsType", "type": "Type", - "label": "ActionsAuthorization", + "label": "ActionParamsType", "tags": [], "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", + "lineNumber": 34 }, "signature": [ - "{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }" + "{ readonly documents: Record[]; }" ], "initialIsOpen": false }, { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", "tags": [], - "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", + "lineNumber": 50 }, "signature": [ - "\".email\"" + "{ 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 }, @@ -709,28 +645,26 @@ "tags": [], "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", + "lineNumber": 25 }, "signature": [ - "{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }" + "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" ], "initialIsOpen": false }, { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", "tags": [], - "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", + "lineNumber": 46 }, "signature": [ - "\".index\"" + "{ readonly message: string; }" ], "initialIsOpen": false }, @@ -741,28 +675,26 @@ "tags": [], "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", + "lineNumber": 71 }, "signature": [ - "{ readonly documents: Record[]; }" + "{ readonly body?: string | undefined; }" ], "initialIsOpen": false }, { + "id": "def-server.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", "tags": [], - "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", + "lineNumber": 35 }, "signature": [ - "\".pagerduty\"" + "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 }, @@ -773,28 +705,26 @@ "tags": [], "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", + "lineNumber": 36 }, "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; }" + "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.ActionParamsType", + "type": "Type", + "label": "ActionParamsType", "tags": [], - "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", + "lineNumber": 34 }, "signature": [ - "\".server-log\"" + "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 }, @@ -805,44 +735,68 @@ "tags": [], "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", + "lineNumber": 40 }, "signature": [ - "{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" + "{ readonly message: string; }" ], "initialIsOpen": false }, { + "id": "def-server.ActionsAuthorization", + "type": "Type", + "label": "ActionsAuthorization", "tags": [], - "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" + "path": "x-pack/plugins/actions/server/index.ts", + "lineNumber": 16 }, "signature": [ - "\".slack\"" + "{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }" ], "initialIsOpen": false }, { - "id": "def-server.ActionParamsType", + "id": "def-server.ActionsClient", "type": "Type", - "label": "ActionParamsType", + "label": "ActionsClient", "tags": [], "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" + "path": "x-pack/plugins/actions/server/index.ts", + "lineNumber": 15 }, "signature": [ - "{ readonly message: string; }" + "{ 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" + } ], "initialIsOpen": false }, @@ -853,76 +807,71 @@ "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", + "lineNumber": 143 }, "signature": [ - "\".webhook\"" + "\".email\"" ], "initialIsOpen": false }, { - "id": "def-server.ActionParamsType", - "type": "Type", - "label": "ActionParamsType", "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", + "lineNumber": 43 }, "signature": [ - "{ readonly body?: string | undefined; }" + "\".index\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-server.ServiceNowITSMActionTypeId", + "id": "def-server.ActionTypeId", "type": "string", - "label": "ServiceNowITSMActionTypeId", + "label": "ActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", + "lineNumber": 121 }, "signature": [ - "\".servicenow\"" + "\".pagerduty\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-server.ServiceNowSIRActionTypeId", + "id": "def-server.ActionTypeId", "type": "string", - "label": "ServiceNowSIRActionTypeId", + "label": "ActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", + "lineNumber": 42 }, "signature": [ - "\".servicenow-sir\"" + "\".server-log\"" ], "initialIsOpen": false }, { - "id": "def-server.ActionParamsType", - "type": "Type", - "label": "ActionParamsType", "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", + "lineNumber": 54 }, "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[]; }>; }>" + "\".slack\"" ], "initialIsOpen": false }, @@ -933,28 +882,26 @@ "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", + "lineNumber": 76 }, "signature": [ - "\".jira\"" + "\".webhook\"" ], "initialIsOpen": false }, { - "id": "def-server.ActionParamsType", - "type": "Type", - "label": "ActionParamsType", "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", "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" + "lineNumber": 52 }, "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; }>; }>" + "\".jira\"" ], "initialIsOpen": false }, @@ -966,8 +913,7 @@ "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" + "lineNumber": 43 }, "signature": [ "\".resilient\"" @@ -975,50 +921,47 @@ "initialIsOpen": false }, { - "id": "def-server.ActionParamsType", - "type": "Type", - "label": "ActionParamsType", "tags": [], + "id": "def-server.ActionTypeId", + "type": "string", + "label": "ActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", + "lineNumber": 46 }, "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<{} & {}>; }>" + "\".teams\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-server.ActionTypeId", + "id": "def-server.ServiceNowITSMActionTypeId", "type": "string", - "label": "ActionTypeId", + "label": "ServiceNowITSMActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", + "lineNumber": 47 }, "signature": [ - "\".teams\"" + "\".servicenow\"" ], "initialIsOpen": false }, { - "id": "def-server.ActionParamsType", - "type": "Type", - "label": "ActionParamsType", "tags": [], + "id": "def-server.ServiceNowSIRActionTypeId", + "type": "string", + "label": "ServiceNowSIRActionTypeId", "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" + "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", + "lineNumber": 48 }, "signature": [ - "{ readonly message: string; }" + "\".servicenow-sir\"" ], "initialIsOpen": false } @@ -1065,8 +1008,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L86" + "lineNumber": 85 } } ], @@ -1074,15 +1016,13 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L80" + "lineNumber": 79 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 79, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L79" + "lineNumber": 78 }, "lifecycle": "setup", "initialIsOpen": true @@ -1113,8 +1053,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 91, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91" + "lineNumber": 90 } }, { @@ -1132,15 +1071,13 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 91, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91" + "lineNumber": 90 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 91, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91" + "lineNumber": 90 } } ], @@ -1148,8 +1085,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 91, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L91" + "lineNumber": 90 } }, { @@ -1171,8 +1107,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 93, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L93" + "lineNumber": 92 } }, { @@ -1185,8 +1120,7 @@ "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" + "lineNumber": 93 } }, { @@ -1204,15 +1138,13 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L95" + "lineNumber": 94 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L95" + "lineNumber": 94 } } ], @@ -1220,8 +1152,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 92, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L92" + "lineNumber": 91 } }, { @@ -1266,8 +1197,7 @@ "description": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L97" + "lineNumber": 96 } } ], @@ -1275,8 +1205,7 @@ "returnComment": [], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 97, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L97" + "lineNumber": 96 } }, { @@ -1321,8 +1250,7 @@ "description": [], "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" + "lineNumber": 97 } } ], @@ -1330,8 +1258,7 @@ "returnComment": [], "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" + "lineNumber": 97 } }, { @@ -1342,8 +1269,7 @@ "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" + "lineNumber": 98 }, "signature": [ { @@ -1375,8 +1301,7 @@ "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" + "lineNumber": 100 } }, { @@ -1389,8 +1314,7 @@ "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" + "lineNumber": 101 } }, { @@ -1403,8 +1327,7 @@ "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" + "lineNumber": 102 } } ], @@ -1412,15 +1335,13 @@ "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" + "lineNumber": 99 } } ], "source": { "path": "x-pack/plugins/actions/server/plugin.ts", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L90" + "lineNumber": 89 }, "lifecycle": "start", "initialIsOpen": true @@ -1448,8 +1369,7 @@ "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" + "lineNumber": 43 } } ], @@ -1457,178 +1377,164 @@ "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" + "lineNumber": 42 }, "initialIsOpen": false } ], "interfaces": [ { - "id": "def-common.ActionType", + "id": "def-common.ActionResult", "type": "Interface", - "label": "ActionType", + "label": "ActionResult", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ActionType.id", + "id": "def-common.ActionResult.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" + "lineNumber": 20 } }, { "tags": [], - "id": "def-common.ActionType.name", + "id": "def-common.ActionResult.actionTypeId", "type": "string", - "label": "name", + "label": "actionTypeId", "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" + "lineNumber": 21 } }, { "tags": [], - "id": "def-common.ActionType.enabled", - "type": "boolean", - "label": "enabled", + "id": "def-common.ActionResult.name", + "type": "string", + "label": "name", "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" + "lineNumber": 22 } }, { "tags": [], - "id": "def-common.ActionType.enabledInConfig", - "type": "boolean", - "label": "enabledInConfig", + "id": "def-common.ActionResult.config", + "type": "Object", + "label": "config", "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" - } + "lineNumber": 25 + }, + "signature": [ + "Record" + ] }, { "tags": [], - "id": "def-common.ActionType.enabledInLicense", + "id": "def-common.ActionResult.isPreconfigured", "type": "boolean", - "label": "enabledInLicense", + "label": "isPreconfigured", "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" + "lineNumber": 26 } - }, - { - "tags": [], - "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" + "lineNumber": 19 }, "initialIsOpen": false }, { - "id": "def-common.ActionResult", + "id": "def-common.ActionType", "type": "Interface", - "label": "ActionResult", + "label": "ActionType", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ActionResult.id", + "id": "def-common.ActionType.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" + "lineNumber": 11 } }, { "tags": [], - "id": "def-common.ActionResult.actionTypeId", + "id": "def-common.ActionType.name", "type": "string", - "label": "actionTypeId", + "label": "name", "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" + "lineNumber": 12 } }, { "tags": [], - "id": "def-common.ActionResult.name", - "type": "string", - "label": "name", + "id": "def-common.ActionType.enabled", + "type": "boolean", + "label": "enabled", "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" + "lineNumber": 13 } }, { "tags": [], - "id": "def-common.ActionResult.config", - "type": "Object", - "label": "config", + "id": "def-common.ActionType.enabledInConfig", + "type": "boolean", + "label": "enabledInConfig", "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" - ] + "lineNumber": 14 + } }, { "tags": [], - "id": "def-common.ActionResult.isPreconfigured", + "id": "def-common.ActionType.enabledInLicense", "type": "boolean", - "label": "isPreconfigured", + "label": "enabledInLicense", "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" + "lineNumber": 15 } + }, + { + "tags": [], + "id": "def-common.ActionType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", + "description": [], + "source": { + "path": "x-pack/plugins/actions/common/types.ts", + "lineNumber": 16 + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ] } ], "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" + "lineNumber": 10 }, "initialIsOpen": false }, @@ -1657,8 +1563,7 @@ "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" + "lineNumber": 34 } }, { @@ -1669,8 +1574,7 @@ "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" + "lineNumber": 35 }, "signature": [ "\"error\" | \"ok\"" @@ -1684,8 +1588,7 @@ "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" + "lineNumber": 36 }, "signature": [ "string | undefined" @@ -1699,8 +1602,7 @@ "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" + "lineNumber": 37 }, "signature": [ "string | undefined" @@ -1714,8 +1616,7 @@ "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" + "lineNumber": 38 }, "signature": [ "Data | undefined" @@ -1729,8 +1630,7 @@ "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" + "lineNumber": 39 }, "signature": [ "boolean | Date | null | undefined" @@ -1739,8 +1639,7 @@ ], "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" + "lineNumber": 33 }, "initialIsOpen": false } @@ -1755,8 +1654,7 @@ "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" + "lineNumber": 10 }, "signature": [ "\"/api/actions\"" diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json index 452eb623f06c2..18ff69de69c64 100644 --- a/api_docs/advanced_settings.json +++ b/api_docs/advanced_settings.json @@ -17,8 +17,7 @@ "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" + "lineNumber": 28 }, "signature": [ "{ [key: string]: Id; }" @@ -37,8 +36,7 @@ "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" + "lineNumber": 30 }, "signature": [ "() => JSX.Element" @@ -52,8 +50,7 @@ "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" + "lineNumber": 31 }, "signature": [ "() => null" @@ -67,8 +64,7 @@ "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" + "lineNumber": 32 }, "signature": [ "() => null" @@ -79,8 +75,7 @@ "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" + "lineNumber": 29 } }, { @@ -92,8 +87,7 @@ "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" + "lineNumber": 35 } }, { @@ -109,8 +103,7 @@ "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" + "lineNumber": 72 }, "signature": [ "{ [key: string]: Id; }" @@ -124,8 +117,7 @@ "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" + "lineNumber": 73 }, "signature": [ "(id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void" @@ -136,8 +128,7 @@ "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" + "lineNumber": 71 } }, { @@ -153,8 +144,7 @@ "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" + "lineNumber": 77 }, "signature": [ "{ [key: string]: Id; }" @@ -168,8 +158,7 @@ "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" + "lineNumber": 78 }, "signature": [ "(id: Id) => React.ComponentType | undefined>" @@ -180,15 +169,13 @@ "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" + "lineNumber": 76 } } ], "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" + "lineNumber": 27 }, "initialIsOpen": false } @@ -204,8 +191,7 @@ ], "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" + "lineNumber": 20 }, "signature": [ "React.LazyExoticComponent | undefined>, allowOverride?: boolean) => void; }" @@ -244,8 +229,7 @@ ], "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" + "lineNumber": 15 }, "lifecycle": "setup", "initialIsOpen": true @@ -265,8 +249,7 @@ "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" + "lineNumber": 19 }, "signature": [ "{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType | undefined>; }" @@ -275,8 +258,7 @@ ], "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" + "lineNumber": 18 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/alerting.json b/api_docs/alerting.json index f192321505e8e..40f8e9c06ef15 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -22,8 +22,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/public/plugin.ts#L15" + "lineNumber": 15 }, "signature": [ "(consumer: string, alertType: string, handler: ", @@ -45,8 +44,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/public/plugin.ts#L20" + "lineNumber": 20 }, "signature": [ "(consumer: string, handler: ", @@ -63,8 +61,7 @@ ], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/public/plugin.ts#L14" + "lineNumber": 14 }, "lifecycle": "setup", "initialIsOpen": true @@ -84,8 +81,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/public/plugin.ts#L23" + "lineNumber": 23 }, "signature": [ "(alertId: string) => Promise<", @@ -110,8 +106,7 @@ ], "source": { "path": "x-pack/plugins/alerting/public/plugin.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/public/plugin.ts#L22" + "lineNumber": 22 }, "lifecycle": "start", "initialIsOpen": true @@ -139,8 +134,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L14" + "lineNumber": 14 } } ], @@ -148,240 +142,12 @@ "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L14" + "lineNumber": 14 }, "initialIsOpen": false } ], "interfaces": [ - { - "id": "def-server.AlertType", - "type": "Interface", - "label": "AlertType", - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertType", - "text": "AlertType" - }, - "" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.AlertType.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 127, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L127" - } - }, - { - "tags": [], - "id": "def-server.AlertType.name", - "type": "string", - "label": "name", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 128, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L128" - } - }, - { - "tags": [], - "id": "def-server.AlertType.validate", - "type": "Object", - "label": "validate", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 129, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L129" - }, - "signature": [ - "{ params?: ", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertTypeParamsValidator", - "text": "AlertTypeParamsValidator" - }, - " | undefined; } | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AlertType.actionGroups", - "type": "Array", - "label": "actionGroups", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 132, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L132" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - "[]" - ] - }, - { - "tags": [], - "id": "def-server.AlertType.defaultActionGroupId", - "type": "Uncategorized", - "label": "defaultActionGroupId", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 133, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L133" - }, - "signature": [ - "ActionGroupIds" - ] - }, - { - "tags": [], - "id": "def-server.AlertType.recoveryActionGroup", - "type": "Object", - "label": "recoveryActionGroup", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 134, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L134" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AlertType.executor", - "type": "Function", - "label": "executor", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 135, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L135" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.ExecutorType", - "text": "ExecutorType" - }, - ">" - ] - }, - { - "tags": [], - "id": "def-server.AlertType.producer", - "type": "string", - "label": "producer", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 146, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L146" - } - }, - { - "tags": [], - "id": "def-server.AlertType.actionVariables", - "type": "Object", - "label": "actionVariables", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 147, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L147" - }, - "signature": [ - "{ context?: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionVariable", - "text": "ActionVariable" - }, - "[] | undefined; state?: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionVariable", - "text": "ActionVariable" - }, - "[] | undefined; params?: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionVariable", - "text": "ActionVariable" - }, - "[] | undefined; } | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AlertType.minimumLicenseRequired", - "type": "CompoundType", - "label": "minimumLicenseRequired", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 152, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L152" - }, - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ] - } - ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 119, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L119" - }, - "initialIsOpen": false - }, { "id": "def-server.ActionGroup", "type": "Interface", @@ -407,8 +173,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L26" + "lineNumber": 26 }, "signature": [ "ActionGroupIds" @@ -422,72 +187,13 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L27" + "lineNumber": 27 } } ], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L25" - }, - "initialIsOpen": false - }, - { - "id": "def-server.AlertingPlugin", - "type": "Interface", - "label": "AlertingPlugin", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.AlertingPlugin.setup", - "type": "Object", - "label": "setup", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L226" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.PluginSetupContract", - "text": "PluginSetupContract" - } - ] - }, - { - "tags": [], - "id": "def-server.AlertingPlugin.start", - "type": "Object", - "label": "start", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 227, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L227" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.PluginStartContract", - "text": "PluginStartContract" - } - ] - } - ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 225, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L225" + "lineNumber": 25 }, "initialIsOpen": false }, @@ -516,8 +222,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 92, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L92" + "lineNumber": 92 } }, { @@ -528,8 +233,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 93, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L93" + "lineNumber": 93 }, "signature": [ "Date" @@ -543,8 +247,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 94, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L94" + "lineNumber": 94 }, "signature": [ "Date | null" @@ -558,8 +261,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L95" + "lineNumber": 95 }, "signature": [ { @@ -580,8 +282,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 96, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L96" + "lineNumber": 96 }, "signature": [ "Params" @@ -595,8 +296,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 97, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L97" + "lineNumber": 97 }, "signature": [ "State" @@ -610,8 +310,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 98, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L98" + "lineNumber": 98 } }, { @@ -622,8 +321,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 99, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L99" + "lineNumber": 99 }, "signature": [ "string | undefined" @@ -637,8 +335,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 100, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L100" + "lineNumber": 100 } }, { @@ -649,8 +346,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L101" + "lineNumber": 101 }, "signature": [ "string[]" @@ -664,8 +360,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 102, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L102" + "lineNumber": 102 }, "signature": [ "string | null" @@ -679,8 +374,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 103, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L103" + "lineNumber": 103 }, "signature": [ "string | null" @@ -689,57 +383,7 @@ ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 85, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L85" - }, - "initialIsOpen": false - }, - { - "id": "def-server.AlertServices", - "type": "Interface", - "label": "AlertServices", - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertServices", - "text": "AlertServices" - }, - " extends ", - "Services" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.AlertServices.alertInstanceFactory", - "type": "Function", - "label": "alertInstanceFactory", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L80" - }, - "signature": [ - "(id: string) => Pick<", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertInstance", - "text": "AlertInstance" - }, - ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" - ] - } - ], - "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L75" + "lineNumber": 85 }, "initialIsOpen": false }, @@ -760,8 +404,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 48, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L48" + "lineNumber": 48 }, "signature": [ "() => ", @@ -782,8 +425,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 49, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L49" + "lineNumber": 49 }, "signature": [ "() => Set<", @@ -805,8 +447,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 50, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L50" + "lineNumber": 50 }, "signature": [ "() => Promise<", @@ -823,252 +464,386 @@ ], "source": { "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 47, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L47" + "lineNumber": 47 }, "initialIsOpen": false }, { - "id": "def-server.PluginSetupContract", + "id": "def-server.AlertingPlugin", "type": "Interface", - "label": "PluginSetupContract", + "label": "AlertingPlugin", "description": [], "tags": [], "children": [ { - "id": "def-server.PluginSetupContract.registerType", - "type": "Function", - "label": "registerType", + "tags": [], + "id": "def-server.AlertingPlugin.setup", + "type": "Object", + "label": "setup", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 226 + }, "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": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-server.AlertType", - "text": "AlertType" - }, - ") => void" - ], - "description": [], - "children": [ - { - "type": "Object", - "label": "alertType", - "isRequired": true, - "signature": [ - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.AlertType", - "text": "AlertType" - }, - "" - ], - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 112, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L112" - } + "section": "def-server.PluginSetupContract", + "text": "PluginSetupContract" } - ], + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-server.AlertingPlugin.start", + "type": "Object", + "label": "start", + "description": [], "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 104, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L104" - } + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 227 + }, + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.PluginStartContract", + "text": "PluginStartContract" + } + ] } ], "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 103, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L103" + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 225 }, "initialIsOpen": false }, { - "id": "def-server.PluginStartContract", + "id": "def-server.AlertServices", "type": "Interface", - "label": "PluginStartContract", + "label": "AlertServices", + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertServices", + "text": "AlertServices" + }, + " extends ", + "Services" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.PluginStartContract.listTypes", + "id": "def-server.AlertServices.alertInstanceFactory", "type": "Function", - "label": "listTypes", + "label": "alertInstanceFactory", "description": [], "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 124, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L124" + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 80 }, "signature": [ - "() => Set<", - { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "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<", + "(id: string) => Pick<", { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "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/alerting/server/plugin.ts", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L125" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L125" - } - }, - { - "tags": [], - "id": "def-server.PluginStartContract.getFrameworkHealth", - "type": "Function", - "label": "getFrameworkHealth", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 126, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L126" - }, - "signature": [ - "() => Promise<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsHealth", - "text": "AlertsHealth" + "section": "def-server.AlertInstance", + "text": "AlertInstance" }, - ">" + ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" ] } ], "source": { - "path": "x-pack/plugins/alerting/server/plugin.ts", - "lineNumber": 123, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/plugin.ts#L123" + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 75 }, "initialIsOpen": false }, { - "id": "def-server.FindResult", + "id": "def-server.AlertType", "type": "Interface", - "label": "FindResult", + "label": "AlertType", "signature": [ { "pluginId": "alerting", "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-server.FindResult", - "text": "FindResult" + "section": "def-server.AlertType", + "text": "AlertType" }, - "" + "" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.FindResult.page", - "type": "number", - "label": "page", + "id": "def-server.AlertType.id", + "type": "string", + "label": "id", "description": [], "source": { - "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 132, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/alerts_client/alerts_client.ts#L132" + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 127 } }, { "tags": [], - "id": "def-server.FindResult.perPage", - "type": "number", - "label": "perPage", + "id": "def-server.AlertType.name", + "type": "string", + "label": "name", "description": [], "source": { - "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 133, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/alerts_client/alerts_client.ts#L133" + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 128 } }, { "tags": [], - "id": "def-server.FindResult.total", - "type": "number", - "label": "total", + "id": "def-server.AlertType.validate", + "type": "Object", + "label": "validate", "description": [], "source": { - "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 134, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/alerts_client/alerts_client.ts#L134" - } - }, - { - "tags": [], - "id": "def-server.FindResult.data", - "type": "Array", - "label": "data", - "description": [], + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 129 + }, + "signature": [ + "{ params?: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertTypeParamsValidator", + "text": "AlertTypeParamsValidator" + }, + " | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.actionGroups", + "type": "Array", + "label": "actionGroups", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 132 + }, + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.defaultActionGroupId", + "type": "Uncategorized", + "label": "defaultActionGroupId", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 133 + }, + "signature": [ + "ActionGroupIds" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.recoveryActionGroup", + "type": "Object", + "label": "recoveryActionGroup", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 134 + }, + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.executor", + "type": "Function", + "label": "executor", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 135 + }, + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.ExecutorType", + "text": "ExecutorType" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.producer", + "type": "string", + "label": "producer", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 146 + } + }, + { + "tags": [], + "id": "def-server.AlertType.actionVariables", + "type": "Object", + "label": "actionVariables", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 147 + }, + "signature": [ + "{ context?: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionVariable", + "text": "ActionVariable" + }, + "[] | undefined; state?: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionVariable", + "text": "ActionVariable" + }, + "[] | undefined; params?: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionVariable", + "text": "ActionVariable" + }, + "[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-server.AlertType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 152 + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 119 + }, + "initialIsOpen": false + }, + { + "id": "def-server.FindResult", + "type": "Interface", + "label": "FindResult", + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.FindResult", + "text": "FindResult" + }, + "" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.FindResult.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", + "lineNumber": 132 + } + }, + { + "tags": [], + "id": "def-server.FindResult.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", + "lineNumber": 133 + } + }, + { + "tags": [], + "id": "def-server.FindResult.total", + "type": "number", + "label": "total", + "description": [], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 135, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/alerts_client/alerts_client.ts#L135" + "lineNumber": 134 + } + }, + { + "tags": [], + "id": "def-server.FindResult.data", + "type": "Array", + "label": "data", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", + "lineNumber": 135 }, "signature": [ "Pick<", @@ -1085,57 +860,183 @@ ], "source": { "path": "x-pack/plugins/alerting/server/alerts_client/alerts_client.ts", - "lineNumber": 131, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/alerts_client/alerts_client.ts#L131" + "lineNumber": 131 }, "initialIsOpen": false - } - ], - "enums": [], - "misc": [ + }, { - "id": "def-server.AlertsClient", - "type": "Type", - "label": "AlertsClient", - "tags": [], + "id": "def-server.PluginSetupContract", + "type": "Interface", + "label": "PluginSetupContract", "description": [], + "tags": [], + "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": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertType", + "text": "AlertType" + }, + ") => void" + ], + "description": [], + "children": [ + { + "type": "Object", + "label": "alertType", + "isRequired": true, + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertType", + "text": "AlertType" + }, + "" + ], + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 112 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 104 + } + } + ], "source": { - "path": "x-pack/plugins/alerting/server/index.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/index.ts#L15" + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 103 }, - "signature": [ - "{ get: ({ id, }: { id: string; }) => Promise Set<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.RegistryAlertType", + "text": "RegistryAlertType" + }, + ">" + ] }, - ", \"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": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Alert", - "text": "Alert" + "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": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "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/alerting/server/plugin.ts", + "lineNumber": 125 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 125 + } }, - ">; find: ({ options: { fields, ...options }, }?: { options?: ", - "FindOptions", - " | undefined; }) => Promise<", { - "pluginId": "alerting", - "scope": "server", - "docId": "kibAlertingPluginApi", - "section": "def-server.FindResult", - "text": "FindResult" + "tags": [], + "id": "def-server.PluginStartContract.getFrameworkHealth", + "type": "Function", + "label": "getFrameworkHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 126 + }, + "signature": [ + "() => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsHealth", + "text": "AlertsHealth" + }, + ">" + ] } ], + "source": { + "path": "x-pack/plugins/alerting/server/plugin.ts", + "lineNumber": 123 + }, "initialIsOpen": false - }, + } + ], + "enums": [], + "misc": [ { "id": "def-server.ActionGroupIdsOf", "type": "Type", @@ -1144,8 +1045,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L30" + "lineNumber": 30 }, "signature": [ "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" @@ -1160,8 +1060,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 40, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L40" + "lineNumber": 40 }, "signature": [ "SavedObjectAttributes" @@ -1169,15 +1068,14 @@ "initialIsOpen": false }, { - "id": "def-server.AlertTypeState", + "id": "def-server.AlertInstanceContext", "type": "Type", - "label": "AlertTypeState", + "label": "AlertInstanceContext", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L11" + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 28 }, "signature": [ "{ [x: string]: unknown; }" @@ -1185,15 +1083,14 @@ "initialIsOpen": false }, { - "id": "def-server.AlertTypeParams", + "id": "def-server.AlertInstanceState", "type": "Type", - "label": "AlertTypeParams", + "label": "AlertInstanceState", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 12, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L12" + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 25 }, "signature": [ "{ [x: string]: unknown; }" @@ -1201,31 +1098,56 @@ "initialIsOpen": false }, { - "id": "def-server.PartialAlert", + "id": "def-server.AlertsClient", "type": "Type", - "label": "PartialAlert", + "label": "AlertsClient", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/server/types.ts", - "lineNumber": 185, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/types.ts#L185" + "path": "x-pack/plugins/alerting/server/index.ts", + "lineNumber": 15 }, "signature": [ - "Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>" + "{ 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": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.Alert", + "text": "Alert" + }, + ">; find: ({ options: { fields, ...options }, }?: { options?: ", + "FindOptions", + " | undefined; }) => Promise<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.FindResult", + "text": "FindResult" + } ], "initialIsOpen": false }, { - "id": "def-server.AlertInstanceState", + "id": "def-server.AlertTypeParams", "type": "Type", - "label": "AlertInstanceState", + "label": "AlertTypeParams", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L25" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 12 }, "signature": [ "{ [x: string]: unknown; }" @@ -1233,21 +1155,35 @@ "initialIsOpen": false }, { - "id": "def-server.AlertInstanceContext", + "id": "def-server.AlertTypeState", "type": "Type", - "label": "AlertInstanceContext", + "label": "AlertTypeState", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L28" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 11 }, "signature": [ "{ [x: string]: unknown; }" ], "initialIsOpen": false }, + { + "id": "def-server.PartialAlert", + "type": "Type", + "label": "PartialAlert", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerting/server/types.ts", + "lineNumber": 185 + }, + "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.PublicAlertInstance", "type": "Type", @@ -1256,8 +1192,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/server/alert_instance/alert_instance.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/server/alert_instance/alert_instance.ts#L30" + "lineNumber": 30 }, "signature": [ "{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }" @@ -1320,8 +1255,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/builtin_action_groups.ts#L31" + "lineNumber": 31 } } ], @@ -1329,97 +1263,47 @@ "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/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/alerting/common/disabled_action_groups.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/disabled_action_groups.ts#L19" - } - }, - { - "type": "string", - "label": "actionTypeId", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/disabled_action_groups.ts#L20" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/disabled_action_groups.ts#L18" + "lineNumber": 30 }, "initialIsOpen": false }, { - "id": "def-common.validateNotifyWhenType", + "id": "def-common.getDurationNumberInItsUnit", "type": "Function", - "label": "validateNotifyWhenType", + "label": "getDurationNumberInItsUnit", "signature": [ - "(notifyWhen: string) => string | undefined" + "(duration: string) => number" ], "description": [], "children": [ { "type": "string", - "label": "notifyWhen", + "label": "duration", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_notify_when_type.ts#L15" + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 30 } } ], "tags": [], "returnComment": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_notify_when_type.ts#L15" + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 30 }, "initialIsOpen": false }, { - "id": "def-common.parseDuration", + "id": "def-common.getDurationUnitValue", "type": "Function", - "label": "parseDuration", + "label": "getDurationUnitValue", "signature": [ - "(duration: string) => number" + "(duration: string) => string" ], "description": [], "children": [ @@ -1433,8 +1317,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L14" + "lineNumber": 34 } } ], @@ -1442,83 +1325,60 @@ "returnComment": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L14" + "lineNumber": 34 }, "initialIsOpen": false }, { - "id": "def-common.getDurationNumberInItsUnit", + "id": "def-common.isActionGroupDisabledForActionTypeId", "type": "Function", - "label": "getDurationNumberInItsUnit", + "label": "isActionGroupDisabledForActionTypeId", "signature": [ - "(duration: string) => number" + "(actionGroup: string, actionTypeId: string) => boolean" ], "description": [], "children": [ { "type": "string", - "label": "duration", + "label": "actionGroup", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L30" + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", + "lineNumber": 19 } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/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", + "label": "actionTypeId", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L34" + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", + "lineNumber": 20 } } ], "tags": [], "returnComment": [], "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L34" + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-common.validateDurationSchema", + "id": "def-common.parseDuration", "type": "Function", - "label": "validateDurationSchema", + "label": "parseDuration", "signature": [ - "(duration: string) => string | undefined" + "(duration: string) => number" ], "description": [], "children": [ @@ -1532,287 +1392,192 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 39, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L39" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "x-pack/plugins/alerting/common/parse_duration.ts", - "lineNumber": 39, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/parse_duration.ts#L39" - }, - "initialIsOpen": false - } - ], - "interfaces": [ - { - "id": "def-common.AlertingFrameworkHealth", - "type": "Interface", - "label": "AlertingFrameworkHealth", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", - "type": "boolean", - "label": "isSufficientlySecure", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/index.ts#L22" - } - }, - { - "tags": [], - "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", - "type": "boolean", - "label": "hasPermanentEncryptionKey", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/index.ts#L23" + "lineNumber": 14 } - }, - { - "tags": [], - "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath", - "type": "Object", - "label": "alertingFrameworkHeath", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/index.ts#L24" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertsHealth", - "text": "AlertsHealth" - } - ] } ], + "tags": [], + "returnComment": [], "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/index.ts#L21" + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-common.IntervalSchedule", - "type": "Interface", - "label": "IntervalSchedule", + "id": "def-common.validateDurationSchema", + "type": "Function", + "label": "validateDurationSchema", "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IntervalSchedule", - "text": "IntervalSchedule" - }, - " extends ", - "SavedObjectAttributes" + "(duration: string) => string | undefined" ], "description": [], - "tags": [], "children": [ { - "tags": [], - "id": "def-common.IntervalSchedule.interval", "type": "string", - "label": "interval", + "label": "duration", + "isRequired": true, + "signature": [ + "string" + ], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L15" + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 39 } } ], + "tags": [], + "returnComment": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L14" + "path": "x-pack/plugins/alerting/common/parse_duration.ts", + "lineNumber": 39 }, "initialIsOpen": false }, { - "id": "def-common.AlertExecutionStatus", - "type": "Interface", - "label": "AlertExecutionStatus", + "id": "def-common.validateNotifyWhenType", + "type": "Function", + "label": "validateNotifyWhenType", + "signature": [ + "(notifyWhen: string) => string | undefined" + ], "description": [], - "tags": [], "children": [ { - "tags": [], - "id": "def-common.AlertExecutionStatus.status", - "type": "CompoundType", - "label": "status", + "type": "string", + "label": "notifyWhen", + "isRequired": true, + "signature": [ + "string" + ], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L32" - }, - "signature": [ - "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" - ] + "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", + "lineNumber": 15 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", + "lineNumber": 15 + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.ActionGroup", + "type": "Interface", + "label": "ActionGroup", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AlertExecutionStatus.lastExecutionDate", - "type": "Object", - "label": "lastExecutionDate", + "id": "def-common.ActionGroup.id", + "type": "Uncategorized", + "label": "id", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L33" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 26 }, "signature": [ - "Date" + "ActionGroupIds" ] }, { "tags": [], - "id": "def-common.AlertExecutionStatus.error", - "type": "Object", - "label": "error", + "id": "def-common.ActionGroup.name", + "type": "string", + "label": "name", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L34" - }, - "signature": [ - "{ reason: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertExecutionStatusErrorReasons", - "text": "AlertExecutionStatusErrorReasons" - }, - "; message: string; } | undefined" - ] + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 27 + } } ], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L31" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-common.AlertAction", + "id": "def-common.ActionVariable", "type": "Interface", - "label": "AlertAction", + "label": "ActionVariable", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AlertAction.group", - "type": "string", - "label": "group", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L44" - } - }, - { - "tags": [], - "id": "def-common.AlertAction.id", + "id": "def-common.ActionVariable.name", "type": "string", - "label": "id", + "label": "name", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L45" + "lineNumber": 102 } }, { "tags": [], - "id": "def-common.AlertAction.actionTypeId", + "id": "def-common.ActionVariable.description", "type": "string", - "label": "actionTypeId", + "label": "description", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 46, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L46" + "lineNumber": 103 } }, { "tags": [], - "id": "def-common.AlertAction.params", - "type": "Object", - "label": "params", + "id": "def-common.ActionVariable.deprecated", + "type": "CompoundType", + "label": "deprecated", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 47, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L47" + "lineNumber": 104 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" - } + "boolean | undefined" ] - } - ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L43" - }, - "initialIsOpen": false - }, - { - "id": "def-common.AlertAggregations", - "type": "Interface", - "label": "AlertAggregations", - "description": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.AlertAggregations.alertExecutionStatus", - "type": "Object", - "label": "alertExecutionStatus", + "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", + "type": "CompoundType", + "label": "useWithTripleBracesInTemplates", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 51, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L51" + "lineNumber": 105 }, "signature": [ - "{ [status: string]: number; }" + "boolean | undefined" ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 50, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L50" + "lineNumber": 101 }, "initialIsOpen": false }, @@ -1841,8 +1606,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 55, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L55" + "lineNumber": 55 } }, { @@ -1853,8 +1617,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 56, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L56" + "lineNumber": 56 } }, { @@ -1865,8 +1628,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 57, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L57" + "lineNumber": 57 } }, { @@ -1877,8 +1639,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 58, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L58" + "lineNumber": 58 }, "signature": [ "string[]" @@ -1892,8 +1653,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L59" + "lineNumber": 59 } }, { @@ -1904,8 +1664,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 60, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L60" + "lineNumber": 60 } }, { @@ -1916,8 +1675,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 61, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L61" + "lineNumber": 61 }, "signature": [ { @@ -1937,8 +1695,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 62, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L62" + "lineNumber": 62 }, "signature": [ { @@ -1959,8 +1716,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 63, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L63" + "lineNumber": 63 }, "signature": [ "Params" @@ -1974,8 +1730,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L64" + "lineNumber": 64 }, "signature": [ "string | undefined" @@ -1989,8 +1744,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 65, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L65" + "lineNumber": 65 }, "signature": [ "string | null" @@ -2004,8 +1758,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 66, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L66" + "lineNumber": 66 }, "signature": [ "string | null" @@ -2019,8 +1772,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 67, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L67" + "lineNumber": 67 }, "signature": [ "Date" @@ -2034,8 +1786,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 68, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L68" + "lineNumber": 68 }, "signature": [ "Date" @@ -2049,8 +1800,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 69, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L69" + "lineNumber": 69 }, "signature": [ "string | null" @@ -2064,8 +1814,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 70, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L70" + "lineNumber": 70 }, "signature": [ "string | null" @@ -2079,8 +1828,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L71" + "lineNumber": 71 }, "signature": [ "string | null" @@ -2094,8 +1842,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 72, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L72" + "lineNumber": 72 }, "signature": [ "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" @@ -2109,8 +1856,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 73, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L73" + "lineNumber": 73 } }, { @@ -2121,457 +1867,338 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 74, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L74" - }, - "signature": [ - "string[]" - ] - }, - { - "tags": [], - "id": "def-common.Alert.executionStatus", - "type": "Object", - "label": "executionStatus", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L75" - }, - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertExecutionStatus", - "text": "AlertExecutionStatus" - } - ] - } - ], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L54" - }, - "initialIsOpen": false - }, - { - "id": "def-common.AlertsHealth", - "type": "Interface", - "label": "AlertsHealth", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.AlertsHealth.decryptionHealth", - "type": "Object", - "label": "decryptionHealth", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 87, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L87" - }, - "signature": [ - "{ status: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.HealthStatus", - "text": "HealthStatus" - }, - "; timestamp: string; }" - ] - }, - { - "tags": [], - "id": "def-common.AlertsHealth.executionHealth", - "type": "Object", - "label": "executionHealth", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 91, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L91" + "lineNumber": 74 }, "signature": [ - "{ status: ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.HealthStatus", - "text": "HealthStatus" - }, - "; timestamp: string; }" + "string[]" ] }, { "tags": [], - "id": "def-common.AlertsHealth.readHealth", + "id": "def-common.Alert.executionStatus", "type": "Object", - "label": "readHealth", + "label": "executionStatus", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L95" + "lineNumber": 75 }, "signature": [ - "{ status: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.HealthStatus", - "text": "HealthStatus" - }, - "; timestamp: string; }" + "section": "def-common.AlertExecutionStatus", + "text": "AlertExecutionStatus" + } ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L86" + "lineNumber": 54 }, "initialIsOpen": false }, { - "id": "def-common.ActionVariable", + "id": "def-common.AlertAction", "type": "Interface", - "label": "ActionVariable", + "label": "AlertAction", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ActionVariable.name", + "id": "def-common.AlertAction.group", "type": "string", - "label": "name", + "label": "group", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 102, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L102" + "lineNumber": 44 } }, { "tags": [], - "id": "def-common.ActionVariable.description", + "id": "def-common.AlertAction.id", "type": "string", - "label": "description", + "label": "id", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 103, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L103" + "lineNumber": 45 } }, { "tags": [], - "id": "def-common.ActionVariable.deprecated", - "type": "CompoundType", - "label": "deprecated", + "id": "def-common.AlertAction.actionTypeId", + "type": "string", + "label": "actionTypeId", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 104, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L104" - }, - "signature": [ - "boolean | undefined" - ] + "lineNumber": 46 + } }, { "tags": [], - "id": "def-common.ActionVariable.useWithTripleBracesInTemplates", - "type": "CompoundType", - "label": "useWithTripleBracesInTemplates", + "id": "def-common.AlertAction.params", + "type": "Object", + "label": "params", "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 105, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L105" + "lineNumber": 47 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + } ] } ], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L101" + "lineNumber": 43 }, "initialIsOpen": false }, { - "id": "def-common.AlertType", + "id": "def-common.AlertAggregations", "type": "Interface", - "label": "AlertType", - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertType", - "text": "AlertType" - }, - "" - ], + "label": "AlertAggregations", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AlertType.id", - "type": "string", - "label": "id", + "id": "def-common.AlertAggregations.alertExecutionStatus", + "type": "Object", + "label": "alertExecutionStatus", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L15" - } - }, + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 51 + }, + "signature": [ + "{ [status: string]: number; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 50 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertExecutionStatus", + "type": "Interface", + "label": "AlertExecutionStatus", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AlertType.name", - "type": "string", - "label": "name", + "id": "def-common.AlertExecutionStatus.status", + "type": "CompoundType", + "label": "status", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L16" - } + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 32 + }, + "signature": [ + "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" + ] }, { "tags": [], - "id": "def-common.AlertType.actionGroups", - "type": "Array", - "label": "actionGroups", + "id": "def-common.AlertExecutionStatus.lastExecutionDate", + "type": "Object", + "label": "lastExecutionDate", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 17, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L17" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 33 }, "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - "[]" + "Date" ] }, { "tags": [], - "id": "def-common.AlertType.recoveryActionGroup", + "id": "def-common.AlertExecutionStatus.error", "type": "Object", - "label": "recoveryActionGroup", + "label": "error", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L18" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 34 }, "signature": [ + "{ reason: ", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" + "section": "def-common.AlertExecutionStatusErrorReasons", + "text": "AlertExecutionStatusErrorReasons" }, - "" - ] - }, - { - "tags": [], - "id": "def-common.AlertType.actionVariables", - "type": "Array", - "label": "actionVariables", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L19" - }, - "signature": [ - "string[]" + "; message: string; } | undefined" ] - }, + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 31 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertingFrameworkHealth", + "type": "Interface", + "label": "AlertingFrameworkHealth", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AlertType.defaultActionGroupId", - "type": "Uncategorized", - "label": "defaultActionGroupId", + "id": "def-common.AlertingFrameworkHealth.isSufficientlySecure", + "type": "boolean", + "label": "isSufficientlySecure", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L20" - }, - "signature": [ - "ActionGroupIds" - ] + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 22 + } }, { "tags": [], - "id": "def-common.AlertType.producer", - "type": "string", - "label": "producer", + "id": "def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey", + "type": "boolean", + "label": "hasPermanentEncryptionKey", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L21" + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 23 } }, { "tags": [], - "id": "def-common.AlertType.minimumLicenseRequired", - "type": "CompoundType", - "label": "minimumLicenseRequired", + "id": "def-common.AlertingFrameworkHealth.alertingFrameworkHeath", + "type": "Object", + "label": "alertingFrameworkHeath", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L22" + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 24 }, "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertsHealth", + "text": "AlertsHealth" + } ] } ], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L11" + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-common.ActionGroup", + "id": "def-common.AlertInstanceStatus", "type": "Interface", - "label": "ActionGroup", - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.ActionGroup", - "text": "ActionGroup" - }, - "" - ], + "label": "AlertInstanceStatus", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ActionGroup.id", - "type": "Uncategorized", - "label": "id", + "id": "def-common.AlertInstanceStatus.status", + "type": "CompoundType", + "label": "status", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L26" + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 29 }, "signature": [ - "ActionGroupIds" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertInstanceStatusValues", + "text": "AlertInstanceStatusValues" + } ] }, { "tags": [], - "id": "def-common.ActionGroup.name", - "type": "string", - "label": "name", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L27" - } - } - ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L25" - }, - "initialIsOpen": false - }, - { - "id": "def-common.AlertUrlNavigation", - "type": "Interface", - "label": "AlertUrlNavigation", - "description": [], - "tags": [], - "children": [ + "id": "def-common.AlertInstanceStatus.muted", + "type": "boolean", + "label": "muted", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 30 + } + }, { "tags": [], - "id": "def-common.AlertUrlNavigation.path", + "id": "def-common.AlertInstanceStatus.actionGroupId", "type": "string", - "label": "path", + "label": "actionGroupId", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_navigation.ts#L11" - } - } - ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 10, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_navigation.ts#L10" - }, - "initialIsOpen": false - }, - { - "id": "def-common.AlertStateNavigation", - "type": "Interface", - "label": "AlertStateNavigation", - "description": [], - "tags": [], - "children": [ + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 31 + }, + "signature": [ + "string | undefined" + ] + }, { "tags": [], - "id": "def-common.AlertStateNavigation.state", - "type": "Object", - "label": "state", + "id": "def-common.AlertInstanceStatus.actionSubgroup", + "type": "string", + "label": "actionSubgroup", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_navigation.ts#L14" + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 32 }, "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.JsonObject", - "text": "JsonObject" - } + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceStatus.activeStartDate", + "type": "string", + "label": "activeStartDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 33 + }, + "signature": [ + "string | undefined" ] } ], "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_navigation.ts#L13" + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 28 }, "initialIsOpen": false }, @@ -2590,8 +2217,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 12, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L12" + "lineNumber": 12 } }, { @@ -2602,8 +2228,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L13" + "lineNumber": 13 } }, { @@ -2614,8 +2239,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L14" + "lineNumber": 14 }, "signature": [ "string[]" @@ -2629,8 +2253,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L15" + "lineNumber": 15 } }, { @@ -2641,8 +2264,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L16" + "lineNumber": 16 } }, { @@ -2653,233 +2275,446 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 17, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L17" + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.throttle", + "type": "CompoundType", + "label": "throttle", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 18 + }, + "signature": [ + "string | null" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.enabled", + "type": "boolean", + "label": "enabled", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.statusStartDate", + "type": "string", + "label": "statusStartDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 20 + } + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.statusEndDate", + "type": "string", + "label": "statusEndDate", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 21 } }, { "tags": [], - "id": "def-common.AlertInstanceSummary.throttle", - "type": "CompoundType", - "label": "throttle", + "id": "def-common.AlertInstanceSummary.status", + "type": "CompoundType", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 22 + }, + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertStatusValues", + "text": "AlertStatusValues" + } + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.lastRun", + "type": "string", + "label": "lastRun", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 23 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.errorMessages", + "type": "Array", + "label": "errorMessages", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 24 + }, + "signature": [ + "{ date: string; message: string; }[]" + ] + }, + { + "tags": [], + "id": "def-common.AlertInstanceSummary.instances", + "type": "Object", + "label": "instances", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 25 + }, + "signature": [ + "Record" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertsHealth", + "type": "Interface", + "label": "AlertsHealth", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertsHealth.decryptionHealth", + "type": "Object", + "label": "decryptionHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 87 + }, + "signature": [ + "{ status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ] + }, + { + "tags": [], + "id": "def-common.AlertsHealth.executionHealth", + "type": "Object", + "label": "executionHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 91 + }, + "signature": [ + "{ status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ] + }, + { + "tags": [], + "id": "def-common.AlertsHealth.readHealth", + "type": "Object", + "label": "readHealth", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 95 + }, + "signature": [ + "{ status: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.HealthStatus", + "text": "HealthStatus" + }, + "; timestamp: string; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 86 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertStateNavigation", + "type": "Interface", + "label": "AlertStateNavigation", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AlertStateNavigation.state", + "type": "Object", + "label": "state", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L18" + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 14 }, "signature": [ - "string | null" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.JsonObject", + "text": "JsonObject" + } ] - }, + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertType", + "type": "Interface", + "label": "AlertType", + "signature": [ { - "tags": [], - "id": "def-common.AlertInstanceSummary.enabled", - "type": "boolean", - "label": "enabled", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L19" - } + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertType", + "text": "AlertType" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AlertInstanceSummary.statusStartDate", + "id": "def-common.AlertType.id", "type": "string", - "label": "statusStartDate", + "label": "id", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L20" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 15 } }, { "tags": [], - "id": "def-common.AlertInstanceSummary.statusEndDate", + "id": "def-common.AlertType.name", "type": "string", - "label": "statusEndDate", + "label": "name", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L21" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 16 } }, { "tags": [], - "id": "def-common.AlertInstanceSummary.status", - "type": "CompoundType", - "label": "status", + "id": "def-common.AlertType.actionGroups", + "type": "Array", + "label": "actionGroups", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L22" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 17 }, "signature": [ { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.AlertStatusValues", - "text": "AlertStatusValues" - } + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "[]" ] }, { "tags": [], - "id": "def-common.AlertInstanceSummary.lastRun", - "type": "string", - "label": "lastRun", + "id": "def-common.AlertType.recoveryActionGroup", + "type": "Object", + "label": "recoveryActionGroup", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L23" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 18 }, "signature": [ - "string | undefined" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ActionGroup", + "text": "ActionGroup" + }, + "" ] }, { "tags": [], - "id": "def-common.AlertInstanceSummary.errorMessages", + "id": "def-common.AlertType.actionVariables", "type": "Array", - "label": "errorMessages", + "label": "actionVariables", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L24" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 19 }, "signature": [ - "{ date: string; message: string; }[]" + "string[]" ] }, { "tags": [], - "id": "def-common.AlertInstanceSummary.instances", - "type": "Object", - "label": "instances", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L25" - }, - "signature": [ - "Record" - ] - } - ], - "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L11" - }, - "initialIsOpen": false - }, - { - "id": "def-common.AlertInstanceStatus", - "type": "Interface", - "label": "AlertInstanceStatus", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.AlertInstanceStatus.status", - "type": "CompoundType", - "label": "status", + "id": "def-common.AlertType.defaultActionGroupId", + "type": "Uncategorized", + "label": "defaultActionGroupId", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L29" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 20 }, "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertInstanceStatusValues", - "text": "AlertInstanceStatusValues" - } + "ActionGroupIds" ] }, { "tags": [], - "id": "def-common.AlertInstanceStatus.muted", - "type": "boolean", - "label": "muted", + "id": "def-common.AlertType.producer", + "type": "string", + "label": "producer", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L30" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 21 } }, { "tags": [], - "id": "def-common.AlertInstanceStatus.actionGroupId", - "type": "string", - "label": "actionGroupId", + "id": "def-common.AlertType.minimumLicenseRequired", + "type": "CompoundType", + "label": "minimumLicenseRequired", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L31" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 22 }, "signature": [ - "string | undefined" + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ] - }, + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AlertUrlNavigation", + "type": "Interface", + "label": "AlertUrlNavigation", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AlertInstanceStatus.actionSubgroup", + "id": "def-common.AlertUrlNavigation.path", "type": "string", - "label": "actionSubgroup", + "label": "path", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L32" - }, - "signature": [ - "string | undefined" - ] + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 11 + } + } + ], + "source": { + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 10 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IntervalSchedule", + "type": "Interface", + "label": "IntervalSchedule", + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" }, + " extends ", + "SavedObjectAttributes" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AlertInstanceStatus.activeStartDate", + "id": "def-common.IntervalSchedule.interval", "type": "string", - "label": "activeStartDate", + "label": "interval", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L33" - }, - "signature": [ - "string | undefined" - ] + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 15 + } } ], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L28" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 14 }, "initialIsOpen": false } @@ -2893,8 +2728,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L23" + "lineNumber": 23 }, "initialIsOpen": false }, @@ -2906,74 +2740,58 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L80" + "lineNumber": 80 }, "initialIsOpen": false } ], "misc": [ { + "id": "def-common.ActionGroupIdsOf", + "type": "Type", + "label": "ActionGroupIdsOf", "tags": [], - "id": "def-common.BASE_ALERT_API_PATH", - "type": "string", - "label": "BASE_ALERT_API_PATH", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/index.ts#L27" - }, - "signature": [ - "\"/api/alerts\"" - ], - "initialIsOpen": false - }, - { - "tags": [], - "id": "def-common.ALERTS_FEATURE_ID", - "type": "string", - "label": "ALERTS_FEATURE_ID", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/index.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/index.ts#L28" + "path": "x-pack/plugins/alerting/common/alert_type.ts", + "lineNumber": 30 }, "signature": [ - "\"alerts\"" + "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" ], "initialIsOpen": false }, { - "id": "def-common.AlertTypeState", + "id": "def-common.AlertActionParam", "type": "Type", - "label": "AlertTypeState", + "label": "AlertActionParam", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L11" + "lineNumber": 41 }, "signature": [ - "{ [x: string]: unknown; }" + "undefined | null | string | number | false | true | ", + "SavedObjectAttributes", + " | ", + "SavedObjectAttributeSingle", + "[]" ], "initialIsOpen": false }, { - "id": "def-common.AlertTypeParams", + "id": "def-common.AlertActionParams", "type": "Type", - "label": "AlertTypeParams", + "label": "AlertActionParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 12, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L12" + "lineNumber": 40 }, "signature": [ - "{ [x: string]: unknown; }" + "SavedObjectAttributes" ], "initialIsOpen": false }, @@ -2985,8 +2803,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L21" + "lineNumber": 21 }, "signature": [ "\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\"" @@ -2994,228 +2811,211 @@ "initialIsOpen": false }, { - "id": "def-common.AlertActionParams", + "id": "def-common.AlertInstanceContext", "type": "Type", - "label": "AlertActionParams", + "label": "AlertInstanceContext", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 40, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L40" + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 28 }, "signature": [ - "SavedObjectAttributes" + "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { - "id": "def-common.AlertActionParam", + "id": "def-common.AlertInstanceMeta", "type": "Type", - "label": "AlertActionParam", + "label": "AlertInstanceMeta", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 41, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L41" + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 22 }, "signature": [ - "undefined | null | string | number | false | true | ", - "SavedObjectAttributes", - " | ", - "SavedObjectAttributeSingle", - "[]" + "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.SanitizedAlert", + "id": "def-common.AlertInstanceState", "type": "Type", - "label": "SanitizedAlert", + "label": "AlertInstanceState", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 78, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L78" + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 25 }, "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; }" + "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { - "id": "def-common.ActionGroupIdsOf", + "id": "def-common.AlertInstanceStatusValues", "type": "Type", - "label": "ActionGroupIdsOf", + "label": "AlertInstanceStatusValues", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_type.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_type.ts#L30" + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 9 }, "signature": [ - "T extends ActionGroup ? groups : T extends Readonly> ? groups : never" + "\"OK\" | \"Active\"" ], "initialIsOpen": false }, { - "id": "def-common.AlertInstanceMeta", + "id": "def-common.AlertNavigation", "type": "Type", - "label": "AlertInstanceMeta", + "label": "AlertNavigation", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L22" + "path": "x-pack/plugins/alerting/common/alert_navigation.ts", + "lineNumber": 16 }, "signature": [ - "{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }" + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertUrlNavigation", + "text": "AlertUrlNavigation" + }, + " | ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertStateNavigation", + "text": "AlertStateNavigation" + } ], "initialIsOpen": false }, { - "id": "def-common.AlertInstanceState", + "id": "def-common.AlertNotifyWhenType", "type": "Type", - "label": "AlertInstanceState", + "label": "AlertNotifyWhenType", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L25" + "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", + "lineNumber": 13 }, "signature": [ - "{ [x: string]: unknown; }" + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" ], "initialIsOpen": false }, { - "id": "def-common.AlertInstanceContext", - "type": "Type", - "label": "AlertInstanceContext", "tags": [], + "id": "def-common.ALERTS_FEATURE_ID", + "type": "string", + "label": "ALERTS_FEATURE_ID", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L28" + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 28 }, "signature": [ - "{ [x: string]: unknown; }" + "\"alerts\"" ], "initialIsOpen": false }, { - "id": "def-common.RawAlertInstance", + "id": "def-common.AlertStatusValues", "type": "Type", - "label": "RawAlertInstance", + "label": "AlertStatusValues", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L34" + "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", + "lineNumber": 8 }, "signature": [ - "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" + "\"OK\" | \"Active\" | \"Error\"" ], "initialIsOpen": false }, { - "id": "def-common.AlertTaskState", + "id": "def-common.AlertTaskParams", "type": "Type", - "label": "AlertTaskState", + "label": "AlertTaskParams", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_task_instance.ts#L18" + "lineNumber": 28 }, "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; }" + "{ alertId: string; } & { spaceId?: string | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.AlertTaskParams", + "id": "def-common.AlertTaskState", "type": "Type", - "label": "AlertTaskParams", + "label": "AlertTaskState", "tags": [], "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_task_instance.ts#L28" + "lineNumber": 18 }, "signature": [ - "{ alertId: string; } & { spaceId?: string | undefined; }" + "{ 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.AlertNavigation", + "id": "def-common.AlertTypeParams", "type": "Type", - "label": "AlertNavigation", + "label": "AlertTypeParams", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_navigation.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_navigation.ts#L16" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 12 }, "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertUrlNavigation", - "text": "AlertUrlNavigation" - }, - " | ", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.AlertStateNavigation", - "text": "AlertStateNavigation" - } + "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { - "id": "def-common.AlertStatusValues", + "id": "def-common.AlertTypeState", "type": "Type", - "label": "AlertStatusValues", + "label": "AlertTypeState", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 8, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L8" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 11 }, "signature": [ - "\"OK\" | \"Active\" | \"Error\"" + "{ [x: string]: unknown; }" ], "initialIsOpen": false }, { - "id": "def-common.AlertInstanceStatusValues", - "type": "Type", - "label": "AlertInstanceStatusValues", "tags": [], + "id": "def-common.BASE_ALERT_API_PATH", + "type": "string", + "label": "BASE_ALERT_API_PATH", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance_summary.ts", - "lineNumber": 9, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance_summary.ts#L9" + "path": "x-pack/plugins/alerting/common/index.ts", + "lineNumber": 27 }, "signature": [ - "\"OK\" | \"Active\"" + "\"/api/alerts\"" ], "initialIsOpen": false }, @@ -3227,14 +3027,28 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/builtin_action_groups.ts#L11" + "lineNumber": 11 }, "signature": [ "\"default\"" ], "initialIsOpen": false }, + { + "id": "def-common.RawAlertInstance", + "type": "Type", + "label": "RawAlertInstance", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 34 + }, + "signature": [ + "{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }" + ], + "initialIsOpen": false + }, { "id": "def-common.RecoveredActionGroupId", "type": "Type", @@ -3243,8 +3057,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/builtin_action_groups.ts#L13" + "lineNumber": 13 }, "signature": [ "\"recovered\"" @@ -3259,8 +3072,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/builtin_action_groups.ts#L21" + "lineNumber": 21 }, "signature": [ "RecoveryActionGroupId | \"recovered\"" @@ -3268,34 +3080,32 @@ "initialIsOpen": false }, { - "id": "def-common.WithoutReservedActionGroups", + "id": "def-common.SanitizedAlert", "type": "Type", - "label": "WithoutReservedActionGroups", + "label": "SanitizedAlert", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/builtin_action_groups.ts#L25" + "path": "x-pack/plugins/alerting/common/alert.ts", + "lineNumber": 78 }, "signature": [ - "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" + "{ 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.AlertNotifyWhenType", + "id": "def-common.WithoutReservedActionGroups", "type": "Type", - "label": "AlertNotifyWhenType", + "label": "WithoutReservedActionGroups", "tags": [], "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_notify_when_type.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_notify_when_type.ts#L13" + "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", + "lineNumber": 25 }, "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\"" + "ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds" ], "initialIsOpen": false } @@ -3309,8 +3119,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert.ts#L20" + "lineNumber": 20 }, "signature": [ "readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]" @@ -3319,25 +3128,24 @@ }, { "tags": [], - "id": "def-common.rawAlertInstance", + "id": "def-common.alertParamsSchema", "type": "Object", - "label": "rawAlertInstance", + "label": "alertParamsSchema", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_instance.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_instance.ts#L30" + "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", + "lineNumber": 20 }, "signature": [ - "PartialC", - "<{ state: ", - "RecordC", - "<", + "IntersectionC", + "<[", + "TypeC", + "<{ alertId: ", "StringC", - ", ", - "UnknownC", - ">; meta: ", - "PartialC" + "; }>, ", + "PartialC", + "<{ spaceId: ", + "StringC" ], "initialIsOpen": false }, @@ -3349,8 +3157,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", - "lineNumber": 12, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_task_instance.ts#L12" + "lineNumber": 12 }, "signature": [ "PartialC", @@ -3367,25 +3174,39 @@ }, { "tags": [], - "id": "def-common.alertParamsSchema", + "id": "def-common.DisabledActionTypeIdsForActionGroup", "type": "Object", - "label": "alertParamsSchema", + "label": "DisabledActionTypeIdsForActionGroup", "description": [], "source": { - "path": "x-pack/plugins/alerting/common/alert_task_instance.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/alert_task_instance.ts#L20" + "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", + "lineNumber": 14 + }, + "signature": [ + "Map" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.rawAlertInstance", + "type": "Object", + "label": "rawAlertInstance", + "description": [], + "source": { + "path": "x-pack/plugins/alerting/common/alert_instance.ts", + "lineNumber": 30 }, "signature": [ - "IntersectionC", - "<[", - "TypeC", - "<{ alertId: ", - "StringC", - "; }>, ", "PartialC", - "<{ spaceId: ", - "StringC" + "<{ state: ", + "RecordC", + "<", + "StringC", + ", ", + "UnknownC", + ">; meta: ", + "PartialC" ], "initialIsOpen": false }, @@ -3397,8 +3218,7 @@ "description": [], "source": { "path": "x-pack/plugins/alerting/common/builtin_action_groups.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/builtin_action_groups.ts#L14" + "lineNumber": 14 }, "signature": [ "Readonly<", @@ -3412,22 +3232,6 @@ "<\"recovered\">>" ], "initialIsOpen": false - }, - { - "tags": [], - "id": "def-common.DisabledActionTypeIdsForActionGroup", - "type": "Object", - "label": "DisabledActionTypeIdsForActionGroup", - "description": [], - "source": { - "path": "x-pack/plugins/alerting/common/disabled_action_groups.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerting/common/disabled_action_groups.ts#L14" - }, - "signature": [ - "Map" - ], - "initialIsOpen": false } ] } diff --git a/api_docs/apm.json b/api_docs/apm.json index a873a05a8e3ea..ac26de577cf0f 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -19,8 +19,7 @@ "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" + "lineNumber": 15 } }, { @@ -31,8 +30,7 @@ "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" + "lineNumber": 16 } }, { @@ -43,8 +41,7 @@ "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" + "lineNumber": 17 }, "signature": [ "{ enabled: boolean; }" @@ -53,8 +50,7 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false } @@ -70,8 +66,7 @@ "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" + "lineNumber": 45 }, "signature": [ "void" @@ -141,8 +136,7 @@ "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" + "lineNumber": 61 } } ], @@ -150,8 +144,7 @@ "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" + "lineNumber": 61 } }, { @@ -219,8 +212,7 @@ "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" + "lineNumber": 66 } }, { @@ -238,8 +230,7 @@ "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" + "lineNumber": 68 }, "signature": [ { @@ -259,8 +250,7 @@ "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" + "lineNumber": 69 }, "signature": [ { @@ -280,8 +270,7 @@ "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" + "lineNumber": 70 }, "signature": [ { @@ -301,8 +290,7 @@ "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" + "lineNumber": 71 }, "signature": [ { @@ -323,8 +311,7 @@ "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" + "lineNumber": 72 }, "signature": [ "Pick<", @@ -346,8 +333,7 @@ "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" + "lineNumber": 73 }, "signature": [ { @@ -368,8 +354,7 @@ "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" + "lineNumber": 74 }, "signature": [ { @@ -390,8 +375,7 @@ "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" + "lineNumber": 75 }, "signature": [ { @@ -412,8 +396,7 @@ "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" + "lineNumber": 76 }, "signature": [ { @@ -434,8 +417,7 @@ "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" + "lineNumber": 77 }, "signature": [ { @@ -455,8 +437,7 @@ "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" + "lineNumber": 78 }, "signature": [ { @@ -477,8 +458,7 @@ "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" + "lineNumber": 79 }, "signature": [ { @@ -494,8 +474,7 @@ ], "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" + "lineNumber": 67 } } ], @@ -503,8 +482,7 @@ "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" + "lineNumber": 65 } }, { @@ -540,8 +518,7 @@ "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" + "lineNumber": 196 } } ], @@ -549,8 +526,7 @@ "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" + "lineNumber": 196 } }, { @@ -566,15 +542,13 @@ "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" + "lineNumber": 215 } } ], "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" + "lineNumber": 58 }, "initialIsOpen": false } @@ -603,8 +577,7 @@ "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" + "lineNumber": 60 } }, { @@ -625,8 +598,7 @@ "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" + "lineNumber": 61 } } ], @@ -634,8 +606,7 @@ "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" + "lineNumber": 59 }, "initialIsOpen": false } @@ -650,42 +621,39 @@ "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" + "lineNumber": 8 }, "initialIsOpen": false } ], "misc": [ { - "id": "def-server.APMXPackConfig", + "id": "def-server.APMConfig", "type": "Type", - "label": "APMXPackConfig", + "label": "APMConfig", "tags": [], "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" + "lineNumber": 56 }, "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; }" + "{ '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 }, { - "id": "def-server.APMConfig", + "id": "def-server.APMXPackConfig", "type": "Type", - "label": "APMConfig", + "label": "APMXPackConfig", "tags": [], "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" + "lineNumber": 55 }, "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; }" + "{ 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 } @@ -706,8 +674,7 @@ "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" + "lineNumber": 49 }, "signature": [ "Observable", @@ -730,8 +697,7 @@ "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" + "lineNumber": 50 }, "signature": [ "() => Promise<", @@ -753,8 +719,7 @@ "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" + "lineNumber": 51 }, "signature": [ "(params: { debug?: boolean | undefined; request: ", @@ -790,8 +755,7 @@ ], "source": { "path": "x-pack/plugins/apm/server/plugin.ts", - "lineNumber": 48, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L48" + "lineNumber": 48 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json index ee79a93d14dd4..389cf76726613 100644 --- a/api_docs/apm_oss.json +++ b/api_docs/apm_oss.json @@ -14,8 +14,7 @@ "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" + "lineNumber": 9 }, "signature": [ "\"apm_static_index_pattern_id\"" @@ -33,8 +32,7 @@ "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" + "lineNumber": 10 }, "lifecycle": "setup", "initialIsOpen": true @@ -48,8 +46,7 @@ "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" + "lineNumber": 13 }, "lifecycle": "start", "initialIsOpen": true @@ -59,7 +56,7 @@ "classes": [], "functions": [ { - "id": "def-server.createNodeAgentInstructions", + "id": "def-server.createDjangoAgentInstructions", "type": "Function", "children": [ { @@ -72,8 +69,7 @@ "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" + "lineNumber": 88 } }, { @@ -86,8 +82,7 @@ "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" + "lineNumber": 88 } } ], @@ -95,18 +90,17 @@ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createNodeAgentInstructions", + "label": "createDjangoAgentInstructions", "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" + "lineNumber": 88 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createDjangoAgentInstructions", + "id": "def-server.createDotNetAgentInstructions", "type": "Function", "children": [ { @@ -119,8 +113,7 @@ "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" + "lineNumber": 631 } }, { @@ -133,20 +126,18 @@ "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" + "lineNumber": 631 } } ], "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + "(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": "createDjangoAgentInstructions", + "label": "createDotNetAgentInstructions", "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" + "lineNumber": 631 }, "tags": [], "returnComment": [], @@ -166,8 +157,7 @@ "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" + "lineNumber": 173 } }, { @@ -180,8 +170,7 @@ "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" + "lineNumber": 173 } } ], @@ -192,15 +181,14 @@ "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" + "lineNumber": 173 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createRailsAgentInstructions", + "id": "def-server.createGoAgentInstructions", "type": "Function", "children": [ { @@ -213,8 +201,7 @@ "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" + "lineNumber": 492 } }, { @@ -227,8 +214,7 @@ "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" + "lineNumber": 492 } } ], @@ -236,18 +222,17 @@ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createRailsAgentInstructions", + "label": "createGoAgentInstructions", "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" + "lineNumber": 492 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createRackAgentInstructions", + "id": "def-server.createJavaAgentInstructions", "type": "Function", "children": [ { @@ -260,8 +245,7 @@ "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" + "lineNumber": 585 } }, { @@ -274,20 +258,18 @@ "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" + "lineNumber": 585 } } ], "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createRackAgentInstructions", + "label": "createJavaAgentInstructions", "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" + "lineNumber": 585 }, "tags": [], "returnComment": [], @@ -307,8 +289,7 @@ "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" + "lineNumber": 393 } } ], @@ -319,15 +300,14 @@ "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" + "lineNumber": 393 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createGoAgentInstructions", + "id": "def-server.createNodeAgentInstructions", "type": "Function", "children": [ { @@ -340,8 +320,7 @@ "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" + "lineNumber": 11 } }, { @@ -354,8 +333,7 @@ "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" + "lineNumber": 11 } } ], @@ -363,18 +341,17 @@ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createGoAgentInstructions", + "label": "createNodeAgentInstructions", "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" + "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createJavaAgentInstructions", + "id": "def-server.createPhpAgentInstructions", "type": "Function", "children": [ { @@ -387,8 +364,7 @@ "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" + "lineNumber": 705 } }, { @@ -401,8 +377,7 @@ "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" + "lineNumber": 705 } } ], @@ -410,18 +385,17 @@ "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createJavaAgentInstructions", + "label": "createPhpAgentInstructions", "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" + "lineNumber": 705 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createDotNetAgentInstructions", + "id": "def-server.createRackAgentInstructions", "type": "Function", "children": [ { @@ -434,8 +408,7 @@ "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" + "lineNumber": 298 } }, { @@ -448,27 +421,25 @@ "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" + "lineNumber": 298 } } ], "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; })[]" + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createDotNetAgentInstructions", + "label": "createRackAgentInstructions", "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" + "lineNumber": 298 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.createPhpAgentInstructions", + "id": "def-server.createRailsAgentInstructions", "type": "Function", "children": [ { @@ -481,8 +452,7 @@ "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" + "lineNumber": 255 } }, { @@ -495,20 +465,18 @@ "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" + "lineNumber": 255 } } ], "signature": [ - "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" + "(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]" ], "description": [], - "label": "createPhpAgentInstructions", + "label": "createRailsAgentInstructions", "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" + "lineNumber": 255 }, "tags": [], "returnComment": [], @@ -519,34 +487,32 @@ "enums": [], "misc": [ { - "id": "def-server.APMOSSConfig", - "type": "Type", - "label": "APMOSSConfig", "tags": [], + "id": "def-server.APM_STATIC_INDEX_PATTERN_ID", + "type": "string", + "label": "APM_STATIC_INDEX_PATTERN_ID", "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" + "path": "src/plugins/apm_oss/common/index_pattern_constants.ts", + "lineNumber": 9 }, "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; }" + "\"apm_static_index_pattern_id\"" ], "initialIsOpen": false }, { + "id": "def-server.APMOSSConfig", + "type": "Type", + "label": "APMOSSConfig", "tags": [], - "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" + "path": "src/plugins/apm_oss/server/index.ts", + "lineNumber": 32 }, "signature": [ - "\"apm_static_index_pattern_id\"" + "{ 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 } @@ -567,8 +533,7 @@ "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" + "lineNumber": 48 }, "signature": [ "Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>" @@ -582,8 +547,7 @@ "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" + "lineNumber": 49 }, "signature": [ "Observable", @@ -610,15 +574,13 @@ "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" + "lineNumber": 50 } } ], "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" + "lineNumber": 47 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/banners.json b/api_docs/banners.json index 981c17a7de679..46c827ab47767 100644 --- a/api_docs/banners.json +++ b/api_docs/banners.json @@ -20,54 +20,6 @@ "classes": [], "functions": [], "interfaces": [ - { - "id": "def-common.BannerInfoResponse", - "type": "Interface", - "label": "BannerInfoResponse", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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", @@ -83,8 +35,7 @@ "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" + "lineNumber": 16 }, "signature": [ { @@ -104,8 +55,7 @@ "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" + "lineNumber": 17 } }, { @@ -116,8 +66,7 @@ "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" + "lineNumber": 18 } }, { @@ -128,15 +77,58 @@ "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" + "lineNumber": 19 } } ], "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" + "lineNumber": 15 + }, + "initialIsOpen": false + }, + { + "id": "def-common.BannerInfoResponse", + "type": "Interface", + "label": "BannerInfoResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.BannerInfoResponse.allowed", + "type": "boolean", + "label": "allowed", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 9 + } + }, + { + "tags": [], + "id": "def-common.BannerInfoResponse.banner", + "type": "Object", + "label": "banner", + "description": [], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 10 + }, + "signature": [ + { + "pluginId": "banners", + "scope": "common", + "docId": "kibBannersPluginApi", + "section": "def-common.BannerConfiguration", + "text": "BannerConfiguration" + } + ] + } + ], + "source": { + "path": "x-pack/plugins/banners/common/types.ts", + "lineNumber": 8 }, "initialIsOpen": false } @@ -151,8 +143,7 @@ "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" + "lineNumber": 13 }, "signature": [ "\"disabled\" | \"header\"" diff --git a/api_docs/beats_management.json b/api_docs/beats_management.json index f0c995b47d594..5ab0902828ee1 100644 --- a/api_docs/beats_management.json +++ b/api_docs/beats_management.json @@ -30,8 +30,7 @@ "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" + "lineNumber": 23 }, "signature": [ "{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }" @@ -48,8 +47,7 @@ "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" + "lineNumber": 12 }, "signature": [ "ObjectType", diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json index cf0bfbf4dd916..99d37a0c9acbd 100644 --- a/api_docs/bfetch.json +++ b/api_docs/bfetch.json @@ -17,8 +17,7 @@ "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" + "lineNumber": 25 } } ], @@ -35,8 +34,7 @@ "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" + "lineNumber": 25 }, "tags": [], "returnComment": [], @@ -54,8 +52,7 @@ "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" + "lineNumber": 17 }, "signature": [ "(payload: Payload, signal: AbortSignal | undefined) => Promise" @@ -79,8 +76,7 @@ "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" + "lineNumber": 25 }, "signature": [ "(params: ", @@ -104,8 +100,7 @@ "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" + "lineNumber": 26 }, "signature": [ "(params: ", @@ -130,8 +125,7 @@ ], "source": { "path": "src/plugins/bfetch/public/plugin.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L24" + "lineNumber": 24 }, "lifecycle": "start", "initialIsOpen": true @@ -166,8 +160,7 @@ "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" + "lineNumber": 40 }, "signature": [ "(data: BatchItemData) => Promise" @@ -176,8 +169,7 @@ ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 39, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L39" + "lineNumber": 39 }, "initialIsOpen": false } @@ -196,8 +188,7 @@ ], "source": { "path": "src/plugins/bfetch/server/types.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/types.ts#L18" + "lineNumber": 18 }, "signature": [ "(context: ", @@ -243,8 +234,7 @@ "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" + "lineNumber": 45 }, "signature": [ "(path: string, handler: (request: ", @@ -274,8 +264,7 @@ "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" + "lineNumber": 49 }, "signature": [ "(path: string, params: (request: ", @@ -298,9 +287,7 @@ ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-server.BfetchServerSetup.createStreamingRequestHandler", "type": "Function", "label": "createStreamingRequestHandler", @@ -309,8 +296,7 @@ ], "source": { "path": "src/plugins/bfetch/server/plugin.ts", - "lineNumber": 81, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L81" + "lineNumber": 81 }, "signature": [ "" + ], + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 22 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-common.normalizeError", "type": "Function", @@ -688,8 +711,7 @@ "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" + "lineNumber": 11 } } ], @@ -716,8 +738,7 @@ "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" + "lineNumber": 11 }, "tags": [], "returnComment": [], @@ -737,8 +758,7 @@ "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" + "lineNumber": 9 } } ], @@ -749,64 +769,7 @@ "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" - }, - "tags": [], - "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" + "lineNumber": 9 }, "tags": [], "returnComment": [], @@ -815,93 +778,59 @@ ], "interfaces": [ { - "id": "def-common.StreamingResponseHandler", + "id": "def-common.BatchedFunctionParams", "type": "Interface", - "label": "StreamingResponseHandler", + "label": "BatchedFunctionParams", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", - "section": "def-common.StreamingResponseHandler", - "text": "StreamingResponseHandler" + "section": "def-common.BatchedFunctionParams", + "text": "BatchedFunctionParams" }, - "" + "" ], "description": [], "tags": [], "children": [ { - "id": "def-common.StreamingResponseHandler.getResponseStream", + "tags": [], + "id": "def-common.BatchedFunctionParams.onCall", "type": "Function", - "label": "getResponseStream", - "signature": [ - "(payload: Payload) => ", - "Observable", - "" - ], + "label": "onCall", "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": [ + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 15 + }, + "signature": [ + "(...args: Parameters) => [ReturnType, BatchEntry]" + ] + }, { - "pluginId": "bfetch", - "scope": "common", - "docId": "kibBfetchPluginApi", - "section": "def-common.ItemBufferParams", - "text": "ItemBufferParams" + "tags": [], + "id": "def-common.BatchedFunctionParams.onBatch", + "type": "Function", + "label": "onBatch", + "description": [], + "source": { + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 16 + }, + "signature": [ + "(items: BatchEntry[]) => void" + ] }, - "" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.ItemBufferParams.flushOnMaxItems", + "id": "def-common.BatchedFunctionParams.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." - ], + "description": [], "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" + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 17 }, "signature": [ "number | undefined" @@ -909,48 +838,36 @@ }, { "tags": [], - "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." - ], + "id": "def-common.BatchedFunctionParams.maxItemAge", + "type": "number", + "label": "maxItemAge", + "description": [], "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" + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 18 }, "signature": [ - "(items: Item[]) => void" + "number | undefined" ] } ], "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" + "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-common.TimedItemBufferParams", + "id": "def-common.BatchRequestData", "type": "Interface", - "label": "TimedItemBufferParams", + "label": "BatchRequestData", "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" + "section": "def-common.BatchRequestData", + "text": "BatchRequestData" }, "" ], @@ -959,111 +876,85 @@ "children": [ { "tags": [], - "id": "def-common.TimedItemBufferParams.maxItemAge", - "type": "number", - "label": "maxItemAge", - "description": [ - "\nFlushes buffer when oldest item reaches age specified by this parameter,\nin milliseconds." - ], + "id": "def-common.BatchRequestData.batch", + "type": "Array", + "label": "batch", + "description": [], "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" + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 14 }, "signature": [ - "number | undefined" + "Item[]" ] } ], "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" + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-common.BatchedFunctionParams", + "id": "def-common.BatchResponseItem", "type": "Interface", - "label": "BatchedFunctionParams", + "label": "BatchResponseItem", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", - "section": "def-common.BatchedFunctionParams", - "text": "BatchedFunctionParams" + "section": "def-common.BatchResponseItem", + "text": "BatchResponseItem" }, - "" + "" ], "description": [], "tags": [], "children": [ { "tags": [], - "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]" - ] - }, - { - "tags": [], - "id": "def-common.BatchedFunctionParams.onBatch", - "type": "Function", - "label": "onBatch", + "id": "def-common.BatchResponseItem.id", + "type": "number", + "label": "id", "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" - ] + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 18 + } }, { "tags": [], - "id": "def-common.BatchedFunctionParams.flushOnMaxItems", - "type": "number", - "label": "flushOnMaxItems", + "id": "def-common.BatchResponseItem.result", + "type": "Uncategorized", + "label": "result", "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" + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 19 }, "signature": [ - "number | undefined" + "Result | undefined" ] }, { "tags": [], - "id": "def-common.BatchedFunctionParams.maxItemAge", - "type": "number", - "label": "maxItemAge", + "id": "def-common.BatchResponseItem.error", + "type": "Uncategorized", + "label": "error", "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" + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 20 }, "signature": [ - "number | undefined" + "Error | 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" + "path": "src/plugins/bfetch/common/batch.ts", + "lineNumber": 17 }, "initialIsOpen": false }, @@ -1082,29 +973,27 @@ "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" + "lineNumber": 10 } } ], "source": { "path": "src/plugins/bfetch/common/batch.ts", - "lineNumber": 9, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L9" + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-common.BatchRequestData", + "id": "def-common.ItemBufferParams", "type": "Interface", - "label": "BatchRequestData", + "label": "ItemBufferParams", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", - "section": "def-common.BatchRequestData", - "text": "BatchRequestData" + "section": "def-common.ItemBufferParams", + "text": "ItemBufferParams" }, "" ], @@ -1113,91 +1002,144 @@ "children": [ { "tags": [], - "id": "def-common.BatchRequestData.batch", - "type": "Array", - "label": "batch", - "description": [], + "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/batch.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L14" + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 15 }, "signature": [ - "Item[]" + "number | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "(items: Item[]) => void" ] } ], "source": { - "path": "src/plugins/bfetch/common/batch.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L13" + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-common.BatchResponseItem", + "id": "def-common.StreamingResponseHandler", "type": "Interface", - "label": "BatchResponseItem", + "label": "StreamingResponseHandler", "signature": [ { "pluginId": "bfetch", "scope": "common", "docId": "kibBfetchPluginApi", - "section": "def-common.BatchResponseItem", - "text": "BatchResponseItem" + "section": "def-common.StreamingResponseHandler", + "text": "StreamingResponseHandler" }, - "" + "" ], "description": [], "tags": [], "children": [ { - "tags": [], - "id": "def-common.BatchResponseItem.id", - "type": "number", - "label": "id", + "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 + } + } + ], + "tags": [], + "returnComment": [], "source": { - "path": "src/plugins/bfetch/common/batch.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L18" + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 12 } + } + ], + "source": { + "path": "src/plugins/bfetch/common/streaming/types.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.TimedItemBufferParams", + "type": "Interface", + "label": "TimedItemBufferParams", + "signature": [ + { + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.TimedItemBufferParams", + "text": "TimedItemBufferParams" }, + " extends ", { - "tags": [], - "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" - ] + "pluginId": "bfetch", + "scope": "common", + "docId": "kibBfetchPluginApi", + "section": "def-common.ItemBufferParams", + "text": "ItemBufferParams" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.BatchResponseItem.error", - "type": "Uncategorized", - "label": "error", - "description": [], + "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/batch.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L20" + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 16 }, "signature": [ - "Error | undefined" + "number | 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" + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "lineNumber": 11 }, "initialIsOpen": false } diff --git a/api_docs/canvas.json b/api_docs/canvas.json index 650423400045a..70d3fa06bf2eb 100644 --- a/api_docs/canvas.json +++ b/api_docs/canvas.json @@ -19,8 +19,7 @@ "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" + "lineNumber": 16 }, "signature": [ "{ services: ", @@ -53,8 +52,7 @@ ], "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" + "lineNumber": 15 }, "initialIsOpen": false } @@ -74,8 +72,7 @@ ], "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" + "lineNumber": 63 }, "signature": [ "CanvasApi" @@ -91,8 +88,7 @@ "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" + "lineNumber": 64 }, "signature": [ "void" diff --git a/api_docs/case.json b/api_docs/case.json index c6b124325c83d..24f49c97e61ba 100644 --- a/api_docs/case.json +++ b/api_docs/case.json @@ -27,8 +27,7 @@ "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" + "lineNumber": 14 }, "signature": [ "() => ", @@ -44,8 +43,7 @@ ], "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" + "lineNumber": 13 }, "initialIsOpen": false } diff --git a/api_docs/charts.json b/api_docs/charts.json index d1ba272be29f1..181ed29399291 100644 --- a/api_docs/charts.json +++ b/api_docs/charts.json @@ -4,50 +4,34 @@ "classes": [], "functions": [ { - "id": "def-public.getHeatmapColors", + "id": "def-public.ColorPicker", "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", + "type": "Object", + "label": "{ onChange, color: selectedColor, id, label }", "isRequired": true, "signature": [ - "string" + "ColorPickerProps" ], "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" + "path": "src/plugins/charts/public/static/components/color_picker.tsx", + "lineNumber": 83 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "({ onChange, color: selectedColor, id, label }: ColorPickerProps) => JSX.Element" + ], + "description": [], + "label": "ColorPicker", "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" + "path": "src/plugins/charts/public/static/components/color_picker.tsx", + "lineNumber": 83 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -71,8 +55,7 @@ "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" + "lineNumber": 41 } } ], @@ -80,58 +63,8 @@ "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 - }, - { - "tags": [], - "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" + "lineNumber": 41 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { @@ -148,8 +81,7 @@ "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" + "lineNumber": 24 } } ], @@ -162,8 +94,7 @@ "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" + "lineNumber": 24 }, "tags": [], "returnComment": [], @@ -183,8 +114,7 @@ "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" + "lineNumber": 37 } } ], @@ -195,8 +125,7 @@ "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" + "lineNumber": 37 }, "tags": [], "returnComment": [], @@ -216,8 +145,7 @@ "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" + "lineNumber": 121 } }, { @@ -230,8 +158,7 @@ "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" + "lineNumber": 122 } }, { @@ -244,8 +171,7 @@ "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" + "lineNumber": 123 } }, { @@ -258,8 +184,7 @@ "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" + "lineNumber": 124 } } ], @@ -272,99 +197,79 @@ "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" + "lineNumber": 120 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.renderEndzoneTooltip", + "id": "def-public.getBrushFromChartBrushEventFn", "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, + "type": "Object", + "label": "table", + "isRequired": true, "signature": [ - "number | undefined" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } ], "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" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 255 } }, { - "type": "number", - "label": "domainEnd", - "isRequired": false, + "type": "CompoundType", + "label": "xAccessor", + "isRequired": true, "signature": [ - "number | undefined" + "string | number | ", + "AccessorFn" ], "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" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 256 } - }, + } + ], + "signature": [ + "(table: ", { - "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" - } + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" }, + ", xAccessor: string | number | ", + "AccessorFn", + ") => ({ x: selectedRange }: ", + "XYBrushArea", + ") => ", { - "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" - } + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.BrushTriggerEvent", + "text": "BrushTriggerEvent" } ], - "signature": [ - "(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ", - "TooltipValue", - ") => string | JSX.Element" + "description": [ + "\nHelper function to transform `@elastic/charts` brush event into brush action event" ], - "description": [], - "label": "renderEndzoneTooltip", + "label": "getBrushFromChartBrushEventFn", "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" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 254 }, "tags": [], "returnComment": [], @@ -390,8 +295,7 @@ "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" + "lineNumber": 172 } }, { @@ -405,8 +309,7 @@ "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" + "lineNumber": 173 } }, { @@ -421,8 +324,7 @@ "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" + "lineNumber": 174 } }, { @@ -437,8 +339,7 @@ "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" + "lineNumber": 175 } }, { @@ -451,8 +352,7 @@ "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" + "lineNumber": 176 } } ], @@ -480,8 +380,7 @@ "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" + "lineNumber": 171 }, "tags": [], "returnComment": [], @@ -507,8 +406,7 @@ "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" + "lineNumber": 220 } } ], @@ -542,201 +440,276 @@ "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" + "lineNumber": 220 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.getBrushFromChartBrushEventFn", + "id": "def-public.getHeatmapColors", "type": "Function", + "label": "getHeatmapColors", + "signature": [ + "(value: any, colorSchemaName: string) => string" + ], + "description": [], "children": [ { - "type": "Object", - "label": "table", + "type": "Any", + "label": "value", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "any" ], "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" + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47 } }, { - "type": "CompoundType", - "label": "xAccessor", + "type": "string", + "label": "colorSchemaName", "isRequired": true, "signature": [ - "string | number | ", - "AccessorFn" + "string" ], "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" + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/heatmap_color.ts", + "lineNumber": 47 + }, "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": [], "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.PaletteOutput.type", - "type": "string", - "label": "type", + "id": "def-public.LegendToggle", + "type": "Function", + "label": "LegendToggle", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/legend_toggle.tsx", + "lineNumber": 51 + }, + "signature": [ + "React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.renderEndzoneTooltip", + "type": "Function", + "children": [ + { + "type": "number", + "label": "xInterval", + "isRequired": false, + "signature": [ + "number | undefined" + ], "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" - }, + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 160 + } + }, + { + "type": "number", + "label": "domainStart", + "isRequired": false, "signature": [ - "\"palette\"" - ] + "number | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 161 + } + }, + { + "type": "number", + "label": "domainEnd", + "isRequired": false, + "signature": [ + "number | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 162 + } + }, + { + "type": "Function", + "label": "formatter", + "isRequired": false, + "signature": [ + "((v: any) => string) | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 163 + } }, + { + "type": "boolean", + "label": "renderValue", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/endzones.tsx", + "lineNumber": 164 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.BrushTriggerEvent", + "type": "Interface", + "label": "BrushTriggerEvent", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.PaletteOutput.name", + "id": "def-public.BrushTriggerEvent.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" - } + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 27 + }, + "signature": [ + "\"brush\"" + ] }, { "tags": [], - "id": "def-public.PaletteOutput.params", - "type": "Uncategorized", - "label": "params", + "id": "def-public.BrushTriggerEvent.data", + "type": "Object", + "label": "data", "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" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 28 }, "signature": [ - "T | undefined" + "{ 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/common/palette.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 26 }, "initialIsOpen": false }, { - "id": "def-public.CustomPaletteArguments", + "id": "def-public.ChartColorConfiguration", "type": "Interface", - "label": "CustomPaletteArguments", - "description": [], + "label": "ChartColorConfiguration", + "description": [ + "\nInformation about the structure of a chart to determine the color of a series within it." + ], "tags": [], "children": [ { "tags": [], - "id": "def-public.CustomPaletteArguments.color", - "type": "Array", - "label": "color", - "description": [], + "id": "def-public.ChartColorConfiguration.totalSeries", + "type": "number", + "label": "totalSeries", + "description": [ + "\nOverall number of series in the current chart" + ], "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 37 }, "signature": [ - "string[] | undefined" + "number | undefined" ] }, { "tags": [], - "id": "def-public.CustomPaletteArguments.gradient", - "type": "boolean", - "label": "gradient", - "description": [], + "id": "def-public.ChartColorConfiguration.maxDepth", + "type": "number", + "label": "maxDepth", + "description": [ + "\nMax nesting depth of the series tree" + ], "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15" - } + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 41 + }, + "signature": [ + "number | undefined" + ] }, { "tags": [], - "id": "def-public.CustomPaletteArguments.reverse", + "id": "def-public.ChartColorConfiguration.behindText", "type": "CompoundType", - "label": "reverse", - "description": [], + "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/common/palette.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 46 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 }, "signature": [ "boolean | undefined" @@ -744,78 +717,86 @@ } ], "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 33 }, "initialIsOpen": false }, { - "id": "def-public.CustomPaletteState", + "id": "def-public.ClickTriggerEvent", "type": "Interface", - "label": "CustomPaletteState", + "label": "ClickTriggerEvent", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.CustomPaletteState.colors", - "type": "Array", - "label": "colors", + "id": "def-public.ClickTriggerEvent.name", + "type": "string", + "label": "name", "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" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 22 }, "signature": [ - "string[]" + "\"filterBucket\"" ] }, { "tags": [], - "id": "def-public.CustomPaletteState.gradient", - "type": "boolean", - "label": "gradient", + "id": "def-public.ClickTriggerEvent.data", + "type": "Object", + "label": "data", "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" - } + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 23 + }, + "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/common/palette.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19" + "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-public.SystemPaletteArguments", + "id": "def-public.ColorMap", "type": "Interface", - "label": "SystemPaletteArguments", + "label": "ColorMap", "description": [], "tags": [], "children": [ { + "id": "def-public.ColorMap.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" - } + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 32 + }, + "signature": [ + "any" + ] } ], "source": { - "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24" + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 31 }, "initialIsOpen": false }, @@ -834,8 +815,7 @@ "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" + "lineNumber": 21 }, "signature": [ { @@ -855,35 +835,32 @@ "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" + "lineNumber": 22 } } ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-public.RawColorSchema", + "id": "def-public.ColorSchemaParams", "type": "Interface", - "label": "RawColorSchema", + "label": "ColorSchemaParams", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.RawColorSchema.id", + "id": "def-public.ColorSchemaParams.colorSchema", "type": "Enum", - "label": "id", + "label": "colorSchema", "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" + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 13 }, "signature": [ { @@ -897,114 +874,111 @@ }, { "tags": [], - "id": "def-public.RawColorSchema.label", - "type": "string", - "label": "label", + "id": "def-public.ColorSchemaParams.invertColors", + "type": "boolean", + "label": "invertColors", "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" + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 14 } - }, - { - "tags": [], - "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" + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 12 }, "initialIsOpen": false }, { - "id": "def-public.ColorMap", + "id": "def-public.CustomPaletteArguments", "type": "Interface", - "label": "ColorMap", + "label": "CustomPaletteArguments", "description": [], "tags": [], "children": [ { - "id": "def-public.ColorMap.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-public.CustomPaletteArguments.color", + "type": "Array", + "label": "color", "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 14 }, "signature": [ - "any" + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.CustomPaletteArguments.gradient", + "type": "boolean", + "label": "gradient", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "id": "def-public.CustomPaletteArguments.reverse", + "type": "CompoundType", + "label": "reverse", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 16 + }, + "signature": [ + "boolean | undefined" ] } ], "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-public.ColorSchemaParams", + "id": "def-public.CustomPaletteState", "type": "Interface", - "label": "ColorSchemaParams", + "label": "CustomPaletteState", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.ColorSchemaParams.colorSchema", - "type": "Enum", - "label": "colorSchema", + "id": "def-public.CustomPaletteState.colors", + "type": "Array", + "label": "colors", "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 20 }, "signature": [ - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.ColorSchemas", - "text": "ColorSchemas" - } + "string[]" ] }, { "tags": [], - "id": "def-public.ColorSchemaParams.invertColors", + "id": "def-public.CustomPaletteState.gradient", "type": "boolean", - "label": "invertColors", + "label": "gradient", "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 21 } } ], "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 19 }, "initialIsOpen": false }, @@ -1023,8 +997,7 @@ "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" + "lineNumber": 18 }, "signature": [ "string | undefined" @@ -1038,8 +1011,7 @@ "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" + "lineNumber": 19 }, "signature": [ "boolean | undefined" @@ -1053,8 +1025,7 @@ "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" + "lineNumber": 20 }, "signature": [ "boolean | undefined" @@ -1068,8 +1039,7 @@ "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" + "lineNumber": 21 }, "signature": [ "number | undefined" @@ -1083,8 +1053,7 @@ "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" + "lineNumber": 22 }, "signature": [ "boolean | undefined" @@ -1098,8 +1067,7 @@ "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" + "lineNumber": 23 }, "signature": [ "number | null | undefined" @@ -1108,551 +1076,485 @@ ], "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" + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-public.Style", + "id": "def-public.PaletteDefinition", "type": "Interface", - "label": "Style", - "description": [], + "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." + ], "tags": [], "children": [ { "tags": [], - "id": "def-public.Style.bgFill", + "id": "def-public.PaletteDefinition.id", "type": "string", - "label": "bgFill", - "description": [], + "label": "id", + "description": [ + "\nUnique id of the palette (this will be persisted along with the visualization state)" + ], "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" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 67 } }, { "tags": [], - "id": "def-public.Style.bgColor", - "type": "boolean", - "label": "bgColor", - "description": [], + "id": "def-public.PaletteDefinition.title", + "type": "string", + "label": "title", + "description": [ + "\nUser facing title (should be i18n-ized)" + ], "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" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 71 } }, { "tags": [], - "id": "def-public.Style.labelColor", - "type": "boolean", - "label": "labelColor", - "description": [], + "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/static/components/types.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L29" - } + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 75 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-public.Style.subText", - "type": "string", - "label": "subText", - "description": [], + "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/static/components/types.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L30" - } + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 81 + }, + "signature": [ + "(state?: T | undefined) => ", + "Ast" + ] }, { "tags": [], - "id": "def-public.Style.fontSize", - "type": "number", - "label": "fontSize", - "description": [], + "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/static/components/types.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L31" - } + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 88 + }, + "signature": [ + "((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined" + ] + }, + { + "tags": [], + "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 + }, + "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" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "(size: number, state?: T | undefined) => string[]" + ] } ], "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" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 63 }, "initialIsOpen": false }, { - "id": "def-public.ClickTriggerEvent", + "id": "def-public.PaletteOutput", "type": "Interface", - "label": "ClickTriggerEvent", + "label": "PaletteOutput", + "signature": [ + { + "pluginId": "charts", + "scope": "common", + "docId": "kibChartsPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.ClickTriggerEvent.name", + "id": "def-public.PaletteOutput.type", "type": "string", - "label": "name", + "label": "type", "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 29 }, "signature": [ - "\"filterBucket\"" + "\"palette\"" ] }, { "tags": [], - "id": "def-public.ClickTriggerEvent.data", - "type": "Object", - "label": "data", + "id": "def-public.PaletteOutput.name", + "type": "string", + "label": "name", "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 30 + } + }, + { + "tags": [], + "id": "def-public.PaletteOutput.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 31 }, "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; }" + "T | 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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 28 }, "initialIsOpen": false }, { - "id": "def-public.BrushTriggerEvent", + "id": "def-public.PaletteRegistry", "type": "Interface", - "label": "BrushTriggerEvent", + "label": "PaletteRegistry", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.BrushTriggerEvent.name", - "type": "string", - "label": "name", + "id": "def-public.PaletteRegistry.get", + "type": "Function", + "label": "get", "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" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 110 }, "signature": [ - "\"brush\"" + "(name: string) => ", + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.PaletteDefinition", + "text": "PaletteDefinition" + }, + "" ] }, { "tags": [], - "id": "def-public.BrushTriggerEvent.data", - "type": "Object", - "label": "data", + "id": "def-public.PaletteRegistry.getAll", + "type": "Function", + "label": "getAll", "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" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 111 }, "signature": [ - "{ table: ", + "() => ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.PaletteDefinition", + "text": "PaletteDefinition" }, - "; 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" + "path": "src/plugins/charts/public/services/palettes/types.ts", + "lineNumber": 109 }, "initialIsOpen": false }, { - "id": "def-public.SeriesLayer", + "id": "def-public.RawColorSchema", "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." - ], + "label": "RawColorSchema", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.SeriesLayer.name", - "type": "string", - "label": "name", - "description": [ - "\nName of the series (can be used for lookup-based coloring)" - ], + "id": "def-public.RawColorSchema.id", + "type": "Enum", + "label": "id", + "description": [], "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" - } + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 26 + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchemas", + "text": "ColorSchemas" + } + ] }, { "tags": [], - "id": "def-public.SeriesLayer.rankAtDepth", - "type": "number", - "label": "rankAtDepth", - "description": [ - "\nRank of the series compared to siblings with the same ancestor" - ], + "id": "def-public.RawColorSchema.label", + "type": "string", + "label": "label", + "description": [], "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" + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 27 } }, { "tags": [], - "id": "def-public.SeriesLayer.totalSeriesAtDepth", - "type": "number", - "label": "totalSeriesAtDepth", - "description": [ - "\nTotal number of series with the same ancestor" - ], + "id": "def-public.RawColorSchema.value", + "type": "Array", + "label": "value", + "description": [], "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" - } + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 28 + }, + "signature": [ + "[number, number[]][]" + ] } ], "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" + "path": "src/plugins/charts/public/static/color_maps/color_maps.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-public.ChartColorConfiguration", + "id": "def-public.SeriesLayer", "type": "Interface", - "label": "ChartColorConfiguration", + "label": "SeriesLayer", "description": [ - "\nInformation about the structure of a chart to determine the color of a series within it." + "\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." ], "tags": [], "children": [ { "tags": [], - "id": "def-public.ChartColorConfiguration.totalSeries", - "type": "number", - "label": "totalSeries", + "id": "def-public.SeriesLayer.name", + "type": "string", + "label": "name", "description": [ - "\nOverall number of series in the current chart" + "\nName of the series (can be used for lookup-based coloring)" ], "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" - ] + "lineNumber": 19 + } }, { "tags": [], - "id": "def-public.ChartColorConfiguration.maxDepth", + "id": "def-public.SeriesLayer.rankAtDepth", "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" - ] - }, - { - "tags": [], - "id": "def-public.ChartColorConfiguration.behindText", - "type": "CompoundType", - "label": "behindText", + "label": "rankAtDepth", "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." + "\nRank of the series compared to siblings with the same ancestor" ], "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" - ] + "lineNumber": 23 + } }, { "tags": [], - "id": "def-public.ChartColorConfiguration.syncColors", - "type": "CompoundType", - "label": "syncColors", + "id": "def-public.SeriesLayer.totalSeriesAtDepth", + "type": "number", + "label": "totalSeriesAtDepth", "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." + "\nTotal number of series with the same ancestor" ], "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" - ] + "lineNumber": 27 + } } ], "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" + "lineNumber": 15 }, "initialIsOpen": false }, { - "id": "def-public.PaletteDefinition", + "id": "def-public.Style", "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." - ], + "label": "Style", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.PaletteDefinition.id", + "id": "def-public.Style.bgFill", "type": "string", - "label": "id", - "description": [ - "\nUnique id of the palette (this will be persisted along with the visualization state)" - ], + "label": "bgFill", + "description": [], "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" + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 27 } }, { "tags": [], - "id": "def-public.PaletteDefinition.title", - "type": "string", - "label": "title", - "description": [ - "\nUser facing title (should be i18n-ized)" - ], + "id": "def-public.Style.bgColor", + "type": "boolean", + "label": "bgColor", + "description": [], "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" + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 28 } }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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." - ], + "id": "def-public.Style.labelColor", + "type": "boolean", + "label": "labelColor", + "description": [], "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" - ] + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 29 + } }, { "tags": [], - "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.Style.subText", + "type": "string", + "label": "subText", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 30 + } }, { "tags": [], - "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." - ], + "id": "def-public.Style.fontSize", + "type": "number", + "label": "fontSize", + "description": [], "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[]" - ] + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 31 + } } ], "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" + "path": "src/plugins/charts/public/static/components/types.ts", + "lineNumber": 26 }, "initialIsOpen": false }, { - "id": "def-public.PaletteRegistry", + "id": "def-public.SystemPaletteArguments", "type": "Interface", - "label": "PaletteRegistry", + "label": "SystemPaletteArguments", "description": [], "tags": [], "children": [ { "tags": [], - "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" - }, - "" - ] - }, - { - "tags": [], - "id": "def-public.PaletteRegistry.getAll", - "type": "Function", - "label": "getAll", + "id": "def-public.SystemPaletteArguments.name", + "type": "string", + "label": "name", "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" - }, - "[]" - ] + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 25 + } } ], "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" + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 24 }, "initialIsOpen": false } @@ -1666,26 +1568,24 @@ "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" + "lineNumber": 11 }, "initialIsOpen": false } ], "misc": [ { + "id": "def-public.ColorMode", + "type": "Type", + "label": "ColorMode", "tags": [], - "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" + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 17 }, "signature": [ - "string[]" + "\"Background\" | \"Labels\" | \"None\"" ], "initialIsOpen": false }, @@ -1697,8 +1597,7 @@ "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" + "lineNumber": 3160 }, "signature": [ { @@ -1714,24 +1613,43 @@ }, { "tags": [], - "id": "def-public.truncatedColorSchemas", + "id": "def-public.defaultCountLabel", + "type": "string", + "label": "defaultCountLabel", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 26 + }, + "initialIsOpen": false + }, + { + "id": "def-public.LabelRotation", + "type": "Type", + "label": "LabelRotation", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/charts/public/static/components/collections.ts", + "lineNumber": 24 + }, + "signature": [ + "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.paletteIds", "type": "Array", - "label": "truncatedColorSchemas", + "label": "paletteIds", "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" + "path": "src/plugins/charts/common/constants.ts", + "lineNumber": 10 }, "signature": [ - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.ColorSchema", - "text": "ColorSchema" - }, - "[]" + "string[]" ], "initialIsOpen": false }, @@ -1745,8 +1663,7 @@ ], "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" + "lineNumber": 14 }, "signature": [ "string[]" @@ -1754,52 +1671,72 @@ "initialIsOpen": false }, { + "tags": [], + "id": "def-public.truncatedColorSchemas", + "type": "Array", + "label": "truncatedColorSchemas", + "description": [], + "source": { + "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", + "lineNumber": 26 + }, + "signature": [ + { + "pluginId": "charts", + "scope": "public", + "docId": "kibChartsPluginApi", + "section": "def-public.ColorSchema", + "text": "ColorSchema" + }, + "[]" + ], + "initialIsOpen": false + } + ], + "objects": [ + { + "tags": [], "id": "def-public.ColorMode", - "type": "Type", + "type": "Object", "label": "ColorMode", - "tags": [], "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" + "lineNumber": 12 }, "signature": [ - "\"Background\" | \"Labels\" | \"None\"" + "Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>" ], "initialIsOpen": false }, { + "tags": [], "id": "def-public.LabelRotation", - "type": "Type", + "type": "Object", "label": "LabelRotation", - "tags": [], "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" + "lineNumber": 19 }, "signature": [ - "{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number" + "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" ], "initialIsOpen": false }, { + "id": "def-public.truncatedColorMaps", + "type": "Object", "tags": [], - "id": "def-public.defaultCountLabel", - "type": "string", - "label": "defaultCountLabel", + "children": [], "description": [], + "label": "truncatedColorMaps", "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" + "path": "src/plugins/charts/public/static/color_maps/truncated_color_maps.ts", + "lineNumber": 11 }, "initialIsOpen": false - } - ], - "objects": [ + }, { "id": "def-public.vislibColorMaps", "type": "Object", @@ -1818,8 +1755,7 @@ "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" + "lineNumber": 38 }, "signature": [ { @@ -1840,8 +1776,7 @@ "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" + "lineNumber": 39 } }, { @@ -1852,8 +1787,7 @@ "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" + "lineNumber": 42 }, "signature": [ "[number, number[]][]" @@ -1866,8 +1800,7 @@ "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" + "lineNumber": 37 } }, { @@ -1883,8 +1816,7 @@ "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" + "lineNumber": 558 }, "signature": [ { @@ -1905,8 +1837,7 @@ "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" + "lineNumber": 559 } }, { @@ -1917,8 +1848,7 @@ "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" + "lineNumber": 562 }, "signature": [ "[number, number[]][]" @@ -1929,8 +1859,7 @@ "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" + "lineNumber": 557 } }, { @@ -1946,8 +1875,7 @@ "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" + "lineNumber": 1078 }, "signature": [ { @@ -1968,8 +1896,7 @@ "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" + "lineNumber": 1079 } }, { @@ -1980,8 +1907,7 @@ "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" + "lineNumber": 1082 }, "signature": [ "[number, number[]][]" @@ -1992,8 +1918,7 @@ "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" + "lineNumber": 1077 } }, { @@ -2009,8 +1934,7 @@ "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" + "lineNumber": 1598 }, "signature": [ { @@ -2031,8 +1955,7 @@ "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" + "lineNumber": 1599 } }, { @@ -2043,8 +1966,7 @@ "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" + "lineNumber": 1602 }, "signature": [ "[number, number[]][]" @@ -2055,8 +1977,7 @@ "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" + "lineNumber": 1597 } }, { @@ -2072,8 +1993,7 @@ "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" + "lineNumber": 2118 }, "signature": [ { @@ -2094,8 +2014,7 @@ "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" + "lineNumber": 2119 } }, { @@ -2106,8 +2025,7 @@ "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" + "lineNumber": 2122 }, "signature": [ "[number, number[]][]" @@ -2118,8 +2036,7 @@ "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" + "lineNumber": 2117 } }, { @@ -2135,8 +2052,7 @@ "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" + "lineNumber": 2639 }, "signature": [ { @@ -2157,8 +2073,7 @@ "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" + "lineNumber": 2640 } }, { @@ -2169,8 +2084,7 @@ "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" + "lineNumber": 2643 }, "signature": [ "[number, number[]][]" @@ -2181,8 +2095,7 @@ "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" + "lineNumber": 2638 } } ], @@ -2190,55 +2103,8 @@ "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", - "tags": [], - "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 - }, - { - "tags": [], - "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 - }, - { - "tags": [], - "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" + "lineNumber": 35 }, - "signature": [ - "Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>" - ], "initialIsOpen": false } ], @@ -2252,8 +2118,7 @@ "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" + "lineNumber": 31 }, "signature": [ "ChartsPluginSetup" @@ -2325,8 +2190,7 @@ "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" + "lineNumber": 53 }, "initialIsOpen": false }, @@ -2382,8 +2246,7 @@ "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" + "lineNumber": 119 }, "initialIsOpen": false } @@ -2404,8 +2267,7 @@ "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" + "lineNumber": 14 }, "signature": [ "string[] | undefined" @@ -2419,8 +2281,7 @@ "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" + "lineNumber": 15 } }, { @@ -2431,8 +2292,7 @@ "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" + "lineNumber": 16 }, "signature": [ "boolean | undefined" @@ -2441,8 +2301,7 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13" + "lineNumber": 13 }, "initialIsOpen": false }, @@ -2461,8 +2320,7 @@ "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" + "lineNumber": 20 }, "signature": [ "string[]" @@ -2476,42 +2334,13 @@ "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" + "lineNumber": 21 } } ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24" + "lineNumber": 19 }, "initialIsOpen": false }, @@ -2540,8 +2369,7 @@ "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" + "lineNumber": 29 }, "signature": [ "\"palette\"" @@ -2555,8 +2383,7 @@ "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" + "lineNumber": 30 } }, { @@ -2567,8 +2394,7 @@ "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" + "lineNumber": 31 }, "signature": [ "T | undefined" @@ -2577,8 +2403,32 @@ ], "source": { "path": "src/plugins/charts/common/palette.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28" + "lineNumber": 28 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SystemPaletteArguments", + "type": "Interface", + "label": "SystemPaletteArguments", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SystemPaletteArguments.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 25 + } + } + ], + "source": { + "path": "src/plugins/charts/common/palette.ts", + "lineNumber": 24 }, "initialIsOpen": false } @@ -2593,8 +2443,7 @@ "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" + "lineNumber": 9 }, "signature": [ "\"visualization:colorMapping\"" @@ -2609,8 +2458,7 @@ "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" + "lineNumber": 33 }, "signature": [ "string[]" @@ -2625,8 +2473,7 @@ "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" + "lineNumber": 10 }, "signature": [ "string[]" diff --git a/api_docs/cloud.json b/api_docs/cloud.json index d51ccdb93f3d7..28364d79367dd 100644 --- a/api_docs/cloud.json +++ b/api_docs/cloud.json @@ -19,8 +19,7 @@ "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" + "lineNumber": 17 }, "signature": [ "string | undefined" @@ -34,8 +33,7 @@ "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" + "lineNumber": 18 }, "signature": [ "string | undefined" @@ -49,8 +47,7 @@ "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" + "lineNumber": 19 }, "signature": [ "string | undefined" @@ -64,8 +61,7 @@ "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" + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -74,8 +70,7 @@ ], "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" + "lineNumber": 16 }, "initialIsOpen": false } @@ -98,8 +93,7 @@ "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" + "lineNumber": 32 }, "signature": [ "string | undefined" @@ -113,8 +107,7 @@ "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" + "lineNumber": 33 }, "signature": [ "string | undefined" @@ -128,8 +121,7 @@ "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" + "lineNumber": 34 } }, { @@ -140,8 +132,7 @@ "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" + "lineNumber": 35 }, "signature": [ "string | undefined" @@ -155,8 +146,7 @@ "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" + "lineNumber": 36 }, "signature": [ "string | undefined" @@ -165,8 +155,7 @@ ], "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" + "lineNumber": 31 }, "lifecycle": "setup", "initialIsOpen": true @@ -194,8 +183,7 @@ "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" + "lineNumber": 19 }, "signature": [ "string | undefined" @@ -209,8 +197,7 @@ "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" + "lineNumber": 20 } }, { @@ -221,8 +208,7 @@ "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" + "lineNumber": 21 }, "signature": [ "{ url?: string | undefined; secretToken?: string | undefined; }" @@ -231,8 +217,7 @@ ], "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" + "lineNumber": 18 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/console.json b/api_docs/console.json index 9720d7229cb76..433c94d5237f2 100644 --- a/api_docs/console.json +++ b/api_docs/console.json @@ -25,8 +25,7 @@ "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" + "lineNumber": 13 }, "signature": [ "{ addExtensionSpecFilePath: (path: string) => void; }" @@ -44,8 +43,7 @@ "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" + "lineNumber": 18 }, "signature": [ "{ addProcessorDefinition: (processor: any) => void; }" diff --git a/api_docs/core.json b/api_docs/core.json index 9f7b02df0a332..407edee023285 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -6622,14 +6622,6 @@ "label": "asScoped", "signature": [ "(request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", { "pluginId": "core", "scope": "server", @@ -6645,6 +6637,14 @@ "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, " | undefined) => Pick<", { "pluginId": "core", @@ -6664,14 +6664,6 @@ "label": "request", "isRequired": false, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", { "pluginId": "core", "scope": "server", @@ -6687,6 +6679,14 @@ "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, " | undefined" ], "description": [ @@ -16174,14 +16174,6 @@ }, "signature": [ "{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", { "pluginId": "core", "scope": "server", @@ -16197,6 +16189,14 @@ "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, " | undefined) => Pick; }" ], "initialIsOpen": false @@ -16218,14 +16218,6 @@ }, "signature": [ "{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", { "pluginId": "core", "scope": "server", @@ -16241,6 +16233,14 @@ "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, " | undefined) => Pick; }" ], "initialIsOpen": false @@ -16533,14 +16533,6 @@ "lineNumber": 192 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", { "pluginId": "core", "scope": "server", @@ -16555,6 +16547,14 @@ "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" } ], "initialIsOpen": false diff --git a/api_docs/core_application.json b/api_docs/core_application.json index c6aa4cfde1b50..9a61c915614a5 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -45,8 +45,7 @@ "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" + "lineNumber": 59 } }, { @@ -59,8 +58,7 @@ "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" + "lineNumber": 59 } } ], @@ -68,8 +66,7 @@ "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" + "lineNumber": 59 } }, { @@ -86,8 +83,7 @@ "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" + "lineNumber": 78 } } ], @@ -108,8 +104,7 @@ "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" + "lineNumber": 77 }, "tags": [], "returnComment": [] @@ -124,8 +119,7 @@ ], "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" + "lineNumber": 86 } }, { @@ -138,8 +132,7 @@ ], "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" + "lineNumber": 94 }, "signature": [ "Location", @@ -156,8 +149,7 @@ ], "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" + "lineNumber": 102 }, "signature": [ "Action" @@ -179,8 +171,7 @@ "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" + "lineNumber": 114 } }, { @@ -193,8 +184,7 @@ "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" + "lineNumber": 115 } } ], @@ -209,8 +199,7 @@ "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" + "lineNumber": 113 }, "tags": [], "returnComment": [] @@ -231,8 +220,7 @@ "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" + "lineNumber": 132 } }, { @@ -245,8 +233,7 @@ "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" + "lineNumber": 133 } } ], @@ -261,8 +248,7 @@ "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" + "lineNumber": 131 }, "tags": [], "returnComment": [] @@ -281,8 +267,7 @@ "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" + "lineNumber": 150 } } ], @@ -295,8 +280,7 @@ "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" + "lineNumber": 150 }, "tags": [], "returnComment": [] @@ -314,8 +298,7 @@ "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" + "lineNumber": 168 }, "tags": [], "returnComment": [] @@ -333,8 +316,7 @@ "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" + "lineNumber": 177 }, "tags": [], "returnComment": [] @@ -355,8 +337,7 @@ "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" + "lineNumber": 186 } } ], @@ -372,8 +353,7 @@ "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" + "lineNumber": 185 }, "tags": [], "returnComment": [] @@ -396,8 +376,7 @@ "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" + "lineNumber": 206 } } ], @@ -415,8 +394,7 @@ "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" + "lineNumber": 205 }, "tags": [], "returnComment": [ @@ -438,8 +416,7 @@ "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" + "lineNumber": 223 } }, { @@ -457,8 +434,7 @@ "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" + "lineNumber": 224 }, "signature": [ "boolean | undefined" @@ -467,8 +443,7 @@ ], "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" + "lineNumber": 224 } } ], @@ -483,8 +458,7 @@ "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" + "lineNumber": 222 }, "tags": [], "returnComment": [] @@ -492,8 +466,7 @@ ], "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" + "lineNumber": 34 }, "initialIsOpen": false } @@ -501,545 +474,150 @@ "functions": [], "interfaces": [ { - "id": "def-public.ApplicationSetup", + "id": "def-public.App", "type": "Interface", - "label": "ApplicationSetup", + "label": "App", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + "" + ], "description": [], "tags": [ "public" ], "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" - ], + "tags": [], + "id": "def-public.App.id", + "type": "string", + "label": "id", "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" + "\nThe unique identifier of the application" ], - "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" + "lineNumber": 83 } }, { - "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" - ], + "tags": [], + "id": "def-public.App.title", + "type": "string", + "label": "title", "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" + "\nThe title of the application." ], - "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" + "lineNumber": 88 } - } - ], - "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": [], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-public.ApplicationStart.capabilities", + "id": "def-public.App.category", "type": "Object", - "label": "capabilities", + "label": "category", "description": [ - "\nGets the read-only capabilities." + "\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": 695, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L695" + "lineNumber": 95 }, "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; }>; }>" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + }, + " | undefined" ] }, { - "tags": [ - "remarks" - ], - "id": "def-public.ApplicationStart.applications$", - "type": "Object", - "label": "applications$", + "tags": [], + "id": "def-public.App.status", + "type": "CompoundType", + "label": "status", "description": [ - "\nObservable emitting the list of currently registered apps and their associated status.\n" + "\nThe initial status of the application.\nDefaulting to `accessible`" ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 704, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L704" + "lineNumber": 101 }, "signature": [ - "Observable", - ">" + " | undefined" ] }, { - "id": "def-public.ApplicationStart.navigateToApp", - "type": "Function", - "label": "navigateToApp", + "tags": [], + "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 + }, "signature": [ - "(appId: string, options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.NavigateToAppOptions", - "text": "NavigateToAppOptions" + "section": "def-public.AppNavLinkStatus", + "text": "AppNavLinkStatus" }, - " | undefined) => Promise" - ], + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.App.defaultPath", + "type": "string", + "label": "defaultPath", "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" - } - } + "\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." ], - "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" - } + "lineNumber": 115 + }, + "signature": [ + "string | undefined" + ] }, { - "id": "def-public.ApplicationStart.navigateToUrl", - "type": "Function", - "label": "navigateToUrl", - "signature": [ - "(url: string) => Promise" - ], + "tags": [], + "id": "def-public.App.updater$", + "type": "Object", + "label": "updater$", "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" + "\nAn {@link AppUpdater} observable that can be used to update the application {@link AppUpdatableFields} at runtime.\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", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [ - "example" - ], - "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", - "<", + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 149 + }, + "signature": [ + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -1060,8 +638,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 154, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L154" + "lineNumber": 154 }, "signature": [ "number | undefined" @@ -1077,8 +654,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 159, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L159" + "lineNumber": 159 }, "signature": [ "string | undefined" @@ -1094,8 +670,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 165, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L165" + "lineNumber": 165 }, "signature": [ "string | undefined" @@ -1111,8 +686,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 171, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L171" + "lineNumber": 171 }, "signature": [ "string | undefined" @@ -1128,8 +702,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 176, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L176" + "lineNumber": 176 }, "signature": [ "Partial<", @@ -1153,8 +726,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 182, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L182" + "lineNumber": 182 }, "signature": [ "boolean | undefined" @@ -1170,88 +742,611 @@ ], "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" - }, - "" - ] + "lineNumber": 187 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMount", + "text": "AppMount" + }, + "" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMeta", + "text": "AppMeta" + }, + " | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 79 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 566 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveActionType", + "text": "AppLeaveActionType" + }, + ".confirm" + ] + }, + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 567 + } + }, + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 568 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AppLeaveConfirmAction.callback", + "type": "Function", + "label": "callback", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 569 + }, + "signature": [ + "(() => void) | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 565 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.AppLeaveDefaultAction.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 554 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveActionType", + "text": "AppLeaveActionType" + }, + ".default" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 553 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ApplicationSetup", + "type": "Interface", + "label": "ApplicationSetup", + "description": [], + "tags": [ + "public" + ], + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 626 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 655 + } + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 620 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ApplicationStart", + "type": "Interface", + "label": "ApplicationStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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 + }, + "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; }>; }>" + ] + }, + { + "tags": [], + "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 + }, + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 712 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 750 + } + }, + { + "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 + } + }, + { + "id": "def-public.ApplicationStart.getUrlForApp.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.ApplicationStart.getUrlForApp.options.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ApplicationStart.getUrlForApp.options.absolute", + "type": "CompoundType", + "label": "absolute", + "description": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764 + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 764 + } }, { "tags": [], - "id": "def-public.App.appRoute", - "type": "string", - "label": "appRoute", + "id": "def-public.ApplicationStart.currentAppId$", + "type": "Object", + "label": "currentAppId$", "description": [ - "\nOverride the application's routing path from `/app/${id}`.\nMust be unique across registered applications. Should not include the\nbase path from HTTP." + "\nAn observable that emits the current application id and each subsequent id update." ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 194, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L194" + "lineNumber": 769 }, "signature": [ - "string | undefined" + "Observable", + "" ] - }, + } + ], + "source": { + "path": "src/core/public/application/types.ts", + "lineNumber": 691 + }, + "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." + ], + "tags": [ + "public" + ], + "children": [ { - "tags": [ - "example" - ], - "id": "def-public.App.exactRoute", - "type": "CompoundType", - "label": "exactRoute", + "tags": [], + "id": "def-public.AppMeta.keywords", + "type": "Array", + "label": "keywords", "description": [ - "\nIf set to true, the application's route will only be checked against an exact match. Defaults to `false`.\n" + "Keywords to represent this application" ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L212" + "lineNumber": 257 }, "signature": [ - "boolean | undefined" + "string[] | undefined" ] }, { - "tags": [ - "remarks", - "example" - ], - "id": "def-public.App.meta", - "type": "Object", - "label": "meta", + "tags": [], + "id": "def-public.AppMeta.searchDeepLinks", + "type": "Array", + "label": "searchDeepLinks", "description": [ - "\nMeta data for an application that represent additional information for the app.\nSee {@link AppMeta}\n" + "Array of links that represent secondary in-app locations for the app." ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 244, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L244" + "lineNumber": 259 }, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppMeta", - "text": "AppMeta" + "section": "def-public.AppSearchDeepLink", + "text": "AppSearchDeepLink" }, - " | undefined" + "[] | 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" + "lineNumber": 255 }, "initialIsOpen": false }, @@ -1284,300 +1379,104 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 353, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L353" + "lineNumber": 353 }, "signature": [ "HTMLElement" ] }, { - "tags": [ - "example" - ], + "tags": [], "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" - }, - "" - ] - }, - { - "tags": [ - "deprecated", - "example" - ], - "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" - } - }, - { - "tags": [ - "example", - "deprecated" - ], - "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" - ] - }, - { - "tags": [ - "example" - ], - "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" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" + "lineNumber": 399 }, "signature": [ - "(() => void) | undefined" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" ] - } - ], - "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." - ], - "tags": [ - "public" - ], - "children": [ + }, { - "tags": [], - "id": "def-public.AppMeta.keywords", - "type": "Array", - "label": "keywords", + "tags": [ + "deprecated" + ], + "id": "def-public.AppMountParameters.appBasePath", + "type": "string", + "label": "appBasePath", "description": [ - "Keywords to represent this application" + "\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 + } + }, + { + "tags": [ + "deprecated" + ], + "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": 257, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L257" + "lineNumber": 484 }, "signature": [ - "string[] | undefined" + "(handler: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveHandler", + "text": "AppLeaveHandler" + }, + ") => void" ] }, { "tags": [], - "id": "def-public.AppMeta.searchDeepLinks", - "type": "Array", - "label": "searchDeepLinks", + "id": "def-public.AppMountParameters.setHeaderActionMenu", + "type": "Function", + "label": "setHeaderActionMenu", "description": [ - "Array of links that represent secondary in-app locations for the app." + "\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": 259, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L259" + "lineNumber": 515 }, "signature": [ + "(menuMount: ", { "pluginId": "core", "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppSearchDeepLink", - "text": "AppSearchDeepLink" + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, - "[] | undefined" + " | undefined) => void" ] } ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 255, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L255" + "lineNumber": 349 }, "initialIsOpen": false }, @@ -1600,8 +1499,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 679, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L679" + "lineNumber": 679 }, "signature": [ "string | undefined" @@ -1617,8 +1515,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 683, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L683" + "lineNumber": 683 }, "signature": [ "unknown" @@ -1634,8 +1531,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 687, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L687" + "lineNumber": 687 }, "signature": [ "boolean | undefined" @@ -1644,284 +1540,272 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 674, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L674" + "lineNumber": 674 }, "initialIsOpen": false } ], "enums": [ { - "id": "def-public.AppNavLinkStatus", + "id": "def-public.AppLeaveActionType", "type": "Enum", - "label": "AppNavLinkStatus", + "label": "AppLeaveActionType", "tags": [ "public" ], "description": [ - "\nStatus of the application's navLink.\n" + "\nPossible type of actions on application leave.\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" + "lineNumber": 540 }, "initialIsOpen": false }, { - "id": "def-public.AppStatus", + "id": "def-public.AppNavLinkStatus", "type": "Enum", - "label": "AppStatus", + "label": "AppNavLinkStatus", "tags": [ "public" ], "description": [ - "\nAccessibility status of an application.\n" + "\nStatus of the application's navLink.\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" + "lineNumber": 40 }, "initialIsOpen": false }, { - "id": "def-public.AppLeaveActionType", + "id": "def-public.AppStatus", "type": "Enum", - "label": "AppLeaveActionType", + "label": "AppStatus", "tags": [ "public" ], "description": [ - "\nPossible type of actions on application leave.\n" + "\nAccessibility status of an application.\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" + "lineNumber": 24 }, "initialIsOpen": false } ], "misc": [ { - "id": "def-public.AppMount", + "id": "def-public.AppLeaveAction", "type": "Type", - "label": "AppMount", + "label": "AppLeaveAction", "tags": [ - "link", "public" ], "description": [ - "\nA mount function called when the user navigates to this app's route.\n" + "\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": 338, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L338" + "lineNumber": 579 }, "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" + "section": "def-public.AppLeaveDefaultAction", + "text": "AppLeaveDefaultAction" }, - " | Promise<", + " | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppUnmount", - "text": "AppUnmount" - }, - ">" + "section": "def-public.AppLeaveConfirmAction", + "text": "AppLeaveConfirmAction" + } ], "initialIsOpen": false }, { - "id": "def-public.AppUnmount", + "id": "def-public.AppLeaveHandler", "type": "Type", - "label": "AppUnmount", + "label": "AppLeaveHandler", "tags": [ - "public" + "public", + "deprecated" ], "description": [ - "\nA function called when an application should be unmounted from the page. This function should be synchronous." + "\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": 346, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L346" + "lineNumber": 530 }, "signature": [ - "() => void" + "(factory: ", + "AppLeaveActionFactory", + ", nextAppId: string | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppLeaveAction", + "text": "AppLeaveAction" + } ], "initialIsOpen": false }, { - "id": "def-public.AppLeaveHandler", + "id": "def-public.AppMount", "type": "Type", - "label": "AppLeaveHandler", + "label": "AppMount", "tags": [ - "public", - "deprecated" + "public" ], "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" + "\nA mount function called when the user navigates to this app's route.\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" + "lineNumber": 338 }, "signature": [ - "(factory: ", - "AppLeaveActionFactory", - ", nextAppId: string | undefined) => ", + "(params: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppLeaveAction", - "text": "AppLeaveAction" - } + "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.AppLeaveAction", + "id": "def-public.AppSearchDeepLink", "type": "Type", - "label": "AppLeaveAction", + "label": "AppSearchDeepLink", "tags": [ "public" ], "description": [ - "\nPossible actions to return from a {@link AppLeaveHandler}\n\nSee {@link AppLeaveConfirmAction} and {@link AppLeaveDefaultAction}\n" + "\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": 579, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L579" + "lineNumber": 293 }, "signature": [ + "{ id: string; title: string; } & { path: string; searchDeepLinks?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppLeaveDefaultAction", - "text": "AppLeaveDefaultAction" + "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.AppLeaveConfirmAction", - "text": "AppLeaveConfirmAction" - } + "section": "def-public.AppSearchDeepLink", + "text": "AppSearchDeepLink" + }, + "[]; keywords?: string[] | undefined; }" ], "initialIsOpen": false }, { - "id": "def-public.AppUpdatableFields", + "id": "def-public.AppUnmount", "type": "Type", - "label": "AppUpdatableFields", + "label": "AppUnmount", "tags": [ "public" ], "description": [ - "\nDefines the list of fields that can be updated via an {@link AppUpdater}." + "\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": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L64" + "lineNumber": 346 }, "signature": [ - "{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" + "() => void" ], "initialIsOpen": false }, { - "id": "def-public.AppUpdater", + "id": "def-public.AppUpdatableFields", "type": "Type", - "label": "AppUpdater", + "label": "AppUpdatableFields", "tags": [ "public" ], "description": [ - "\nUpdater for applications.\nsee {@link ApplicationSetup}" + "\nDefines the list of fields that can be updated via an {@link AppUpdater}." ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 74, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L74" + "lineNumber": 64 }, "signature": [ - "(app: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.App", - "text": "App" - }, - ") => Partial, \"status\" | \"meta\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\">> | undefined" + "{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }" ], "initialIsOpen": false }, { - "id": "def-public.AppSearchDeepLink", + "id": "def-public.AppUpdater", "type": "Type", - "label": "AppSearchDeepLink", + "label": "AppUpdater", "tags": [ "public" ], "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." + "\nUpdater for applications.\nsee {@link ApplicationSetup}" ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 293, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L293" + "lineNumber": 74 }, "signature": [ - "{ id: string; title: string; } & { path: string; searchDeepLinks?: ", + "(app: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppSearchDeepLink", - "text": "AppSearchDeepLink" + "section": "def-public.App", + "text": "App" }, - "[] | undefined; keywords?: string[] | undefined; } | { id: string; title: string; } & { path?: string | undefined; searchDeepLinks: ", + ") => Partial, \"status\" | \"meta\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\">> | undefined" ], "initialIsOpen": false }, @@ -1937,8 +1821,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 322, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L322" + "lineNumber": 322 }, "signature": [ "Pick, \"status\" | \"id\" | \"title\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }" @@ -1957,8 +1840,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 267, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L267" + "lineNumber": 267 }, "signature": [ "Pick & { keywords: string[]; searchDeepLinks: PublicAppSearchDeepLinkInfo[]; }" @@ -1977,8 +1859,7 @@ ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 277, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L277" + "lineNumber": 277 }, "signature": [ "Pick & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }" diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index 76234a32faca4..cad8f16b4bd54 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -21,8 +21,7 @@ "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" + "lineNumber": 20 } }, { @@ -33,8 +32,7 @@ "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" + "lineNumber": 21 } }, { @@ -45,8 +43,7 @@ "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" + "lineNumber": 22 }, "signature": [ "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" @@ -55,8 +52,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L19" + "lineNumber": 19 }, "initialIsOpen": false }, @@ -77,8 +73,7 @@ "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" + "lineNumber": 27 }, "signature": [ "string | undefined" @@ -92,8 +87,7 @@ "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" + "lineNumber": 28 }, "signature": [ "string | undefined" @@ -102,8 +96,77 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L26" + "lineNumber": 26 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeDocTitle", + "type": "Interface", + "label": "ChromeDocTitle", + "description": [ + "\nAPIs for accessing and updating the document title.\n" + ], + "tags": [ + "public" + ], + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 45 + } + }, + { + "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 + } + } + ], + "source": { + "path": "src/core/public/chrome/doc_title/doc_title_service.ts", + "lineNumber": 32 }, "initialIsOpen": false }, @@ -126,8 +189,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 49, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L49" + "lineNumber": 49 } }, { @@ -140,8 +202,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 53, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L53" + "lineNumber": 53 }, "signature": [ { @@ -164,8 +225,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 57, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L57" + "lineNumber": 57 }, "signature": [ "((element: HTMLDivElement) => () => void) | undefined" @@ -174,8 +234,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L45" + "lineNumber": 45 }, "initialIsOpen": false }, @@ -215,8 +274,7 @@ ], "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" + "lineNumber": 86 }, "signature": [ "\"custom\"" @@ -232,8 +290,7 @@ ], "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" + "lineNumber": 90 } }, { @@ -246,8 +303,7 @@ ], "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" + "lineNumber": 94 }, "signature": [ "React.ReactNode" @@ -256,8 +312,7 @@ ], "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" + "lineNumber": 82 }, "initialIsOpen": false }, @@ -297,8 +352,7 @@ ], "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" + "lineNumber": 60 }, "signature": [ "\"discuss\"" @@ -314,15 +368,13 @@ ], "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" + "lineNumber": 65 } } ], "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" + "lineNumber": 56 }, "initialIsOpen": false }, @@ -362,8 +414,7 @@ ], "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" + "lineNumber": 73 }, "signature": [ "\"documentation\"" @@ -379,15 +430,13 @@ ], "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" + "lineNumber": 78 } } ], "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" + "lineNumber": 69 }, "initialIsOpen": false }, @@ -427,8 +476,7 @@ ], "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" + "lineNumber": 44 }, "signature": [ "\"github\"" @@ -444,8 +492,7 @@ ], "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" + "lineNumber": 48 }, "signature": [ "string[]" @@ -461,8 +508,7 @@ ], "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" + "lineNumber": 52 }, "signature": [ "string | undefined" @@ -471,8 +517,7 @@ ], "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" + "lineNumber": 40 }, "initialIsOpen": false }, @@ -493,8 +538,7 @@ "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" + "lineNumber": 16 }, "signature": [ "number | undefined" @@ -508,8 +552,7 @@ "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" + "lineNumber": 17 }, "signature": [ { @@ -525,8 +568,7 @@ ], "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" + "lineNumber": 15 }, "initialIsOpen": false }, @@ -538,7 +580,6 @@ "\n{@link ChromeNavControls | APIs} for registering new controls to be displayed in the navigation bar.\n" ], "tags": [ - "example", "public" ], "children": [ @@ -577,8 +618,7 @@ "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" + "lineNumber": 38 } } ], @@ -586,8 +626,7 @@ "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" + "lineNumber": 38 } }, { @@ -625,8 +664,7 @@ "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" + "lineNumber": 40 } } ], @@ -634,8 +672,7 @@ "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" + "lineNumber": 40 } }, { @@ -673,8 +710,7 @@ "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" + "lineNumber": 42 } } ], @@ -682,15 +718,13 @@ "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" + "lineNumber": 42 } } ], "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" + "lineNumber": 36 }, "initialIsOpen": false }, @@ -713,8 +747,7 @@ ], "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" + "lineNumber": 19 } }, { @@ -727,8 +760,7 @@ ], "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" + "lineNumber": 24 } }, { @@ -741,8 +773,7 @@ ], "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" + "lineNumber": 29 }, "signature": [ { @@ -765,8 +796,7 @@ ], "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" + "lineNumber": 34 } }, { @@ -779,8 +809,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -796,8 +825,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ "number | undefined" @@ -813,8 +841,7 @@ ], "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" + "lineNumber": 50 }, "signature": [ "string | undefined" @@ -830,8 +857,7 @@ ], "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" + "lineNumber": 56 }, "signature": [ "string | undefined" @@ -847,8 +873,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ "string | undefined" @@ -864,14 +889,11 @@ ], "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" + "lineNumber": 67 } }, { - "tags": [ - "internalRemarks" - ], + "tags": [], "id": "def-public.ChromeNavLink.disabled", "type": "CompoundType", "label": "disabled", @@ -880,8 +902,7 @@ ], "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" + "lineNumber": 76 }, "signature": [ "boolean | undefined" @@ -897,8 +918,7 @@ ], "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" + "lineNumber": 81 }, "signature": [ "boolean | undefined" @@ -907,8 +927,7 @@ ], "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" + "lineNumber": 15 }, "initialIsOpen": false }, @@ -948,8 +967,7 @@ "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" + "lineNumber": 32 } }, { @@ -981,8 +999,7 @@ "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" + "lineNumber": 38 } } ], @@ -990,8 +1007,7 @@ "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" + "lineNumber": 38 } }, { @@ -1017,8 +1033,7 @@ "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" + "lineNumber": 43 } }, { @@ -1042,8 +1057,7 @@ "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" + "lineNumber": 49 } } ], @@ -1051,8 +1065,7 @@ "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" + "lineNumber": 49 } }, { @@ -1076,19 +1089,15 @@ "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" + "lineNumber": 59 } } ], - "tags": [ - "remarks" - ], + "tags": [], "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" + "lineNumber": 59 } }, { @@ -1128,8 +1137,7 @@ "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" + "lineNumber": 71 } }, { @@ -1150,8 +1158,7 @@ "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" + "lineNumber": 71 } } ], @@ -1161,8 +1168,7 @@ "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" + "lineNumber": 71 } }, { @@ -1176,14 +1182,11 @@ "\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" - ], + "tags": [], "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" + "lineNumber": 85 } }, { @@ -1203,93 +1206,13 @@ "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" + "lineNumber": 90 } } ], "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" - ], - "tags": [ - "example", - "example", - "public" - ], - "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" + "lineNumber": 28 }, "initialIsOpen": false }, @@ -1327,8 +1250,7 @@ ], "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" + "lineNumber": 71 } }, { @@ -1343,8 +1265,7 @@ ], "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" + "lineNumber": 71 } }, { @@ -1359,19 +1280,15 @@ ], "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" + "lineNumber": 71 } } ], - "tags": [ - "example" - ], + "tags": [], "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" + "lineNumber": 71 } }, { @@ -1393,14 +1310,11 @@ "\nGets an Array of the current recently accessed history.\n" ], "children": [], - "tags": [ - "example" - ], + "tags": [], "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" + "lineNumber": 81 } }, { @@ -1424,21 +1338,17 @@ "\nGets an Observable of the array of recently accessed history.\n" ], "children": [], - "tags": [ - "example" - ], + "tags": [], "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" + "lineNumber": 91 } } ], "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" + "lineNumber": 58 }, "initialIsOpen": false }, @@ -1459,8 +1369,7 @@ "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" + "lineNumber": 17 } }, { @@ -1471,8 +1380,7 @@ "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" + "lineNumber": 18 } }, { @@ -1483,54 +1391,13 @@ "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" + "lineNumber": 19 } } ], "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": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" + "lineNumber": 16 }, "initialIsOpen": false }, @@ -1542,9 +1409,6 @@ "\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" ], "tags": [ - "remarks", - "example", - "example", "public" ], "children": [ @@ -1558,8 +1422,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 88, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L88" + "lineNumber": 88 }, "signature": [ { @@ -1581,8 +1444,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L90" + "lineNumber": 90 }, "signature": [ { @@ -1604,8 +1466,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 92, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L92" + "lineNumber": 92 }, "signature": [ { @@ -1627,8 +1488,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 94, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L94" + "lineNumber": 94 }, "signature": [ { @@ -1661,19 +1521,15 @@ "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" + "lineNumber": 103 } } ], - "tags": [ - "internalRemarks" - ], + "tags": [], "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" + "lineNumber": 103 } }, { @@ -1701,8 +1557,7 @@ "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" + "lineNumber": 108 } }, { @@ -1740,20 +1595,15 @@ "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" + "lineNumber": 128 } } ], - "tags": [ - "remarks", - "example" - ], + "tags": [], "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" + "lineNumber": 128 } }, { @@ -1773,8 +1623,7 @@ "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" + "lineNumber": 133 } }, { @@ -1798,8 +1647,7 @@ "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" + "lineNumber": 140 } } ], @@ -1807,8 +1655,7 @@ "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" + "lineNumber": 140 } }, { @@ -1828,8 +1675,7 @@ "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" + "lineNumber": 145 } }, { @@ -1853,8 +1699,7 @@ "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" + "lineNumber": 150 } } ], @@ -1862,8 +1707,7 @@ "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" + "lineNumber": 150 } }, { @@ -1887,8 +1731,7 @@ "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" + "lineNumber": 155 } } ], @@ -1896,8 +1739,7 @@ "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" + "lineNumber": 155 } }, { @@ -1925,8 +1767,7 @@ "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" + "lineNumber": 160 } }, { @@ -1965,8 +1806,7 @@ "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" + "lineNumber": 165 } } ], @@ -1974,8 +1814,7 @@ "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" + "lineNumber": 165 } }, { @@ -1997,8 +1836,7 @@ "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" + "lineNumber": 170 } }, { @@ -2025,8 +1863,7 @@ "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" + "lineNumber": 175 } } ], @@ -2034,8 +1871,7 @@ "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" + "lineNumber": 175 } }, { @@ -2063,8 +1899,7 @@ "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" + "lineNumber": 180 } }, { @@ -2103,8 +1938,7 @@ "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" + "lineNumber": 186 } } ], @@ -2112,8 +1946,7 @@ "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" + "lineNumber": 185 } }, { @@ -2141,8 +1974,7 @@ "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" + "lineNumber": 192 } }, { @@ -2182,8 +2014,7 @@ "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" + "lineNumber": 197 } } ], @@ -2191,8 +2022,7 @@ "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" + "lineNumber": 197 } }, { @@ -2220,8 +2050,7 @@ "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" + "lineNumber": 202 } }, { @@ -2260,8 +2089,7 @@ "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" + "lineNumber": 207 } } ], @@ -2269,8 +2097,7 @@ "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" + "lineNumber": 207 } }, { @@ -2296,8 +2123,7 @@ ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 213, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213" + "lineNumber": 213 } } ], @@ -2305,8 +2131,7 @@ "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" + "lineNumber": 213 } }, { @@ -2326,8 +2151,7 @@ "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" + "lineNumber": 218 } }, { @@ -2366,26 +2190,58 @@ "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" + "lineNumber": 225 } } ], - "tags": [ - "remarks" - ], + "tags": [], "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" + "lineNumber": 225 } } ], "source": { "path": "src/core/public/chrome/types.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L86" + "lineNumber": 86 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ChromeUserBanner", + "type": "Interface", + "label": "ChromeUserBanner", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.ChromeUserBanner.content", + "type": "Function", + "label": "content", + "description": [], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 41 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ] + } + ], + "source": { + "path": "src/core/public/chrome/types.ts", + "lineNumber": 40 }, "initialIsOpen": false } @@ -2402,8 +2258,7 @@ "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" + "lineNumber": 32 }, "signature": [ "CommonProps", @@ -2415,6 +2270,23 @@ ], "initialIsOpen": false }, + { + "id": "def-public.ChromeHelpExtensionLinkBase", + "type": "Type", + "label": "ChromeHelpExtensionLinkBase", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", + "lineNumber": 34 + }, + "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.ChromeHelpExtensionMenuLink", "type": "Type", @@ -2425,8 +2297,7 @@ "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" + "lineNumber": 98 }, "signature": [ { @@ -2463,24 +2334,6 @@ ], "initialIsOpen": false }, - { - "id": "def-public.ChromeHelpExtensionLinkBase", - "type": "Type", - "label": "ChromeHelpExtensionLinkBase", - "tags": [ - "public" - ], - "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", @@ -2491,8 +2344,7 @@ "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" + "lineNumber": 85 }, "signature": [ "{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }" @@ -2507,8 +2359,7 @@ "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" + "lineNumber": 10 }, "signature": [ "\"legacy\" | \"modern\"" diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index 01332a30010f1..67115f7ecb97a 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -3,525 +3,142 @@ "client": { "classes": [ { - "id": "def-public.SimpleSavedObject", + "id": "def-public.SavedObjectsClient", "type": "Class", "tags": [ "public" ], - "label": "SimpleSavedObject", + "label": "SavedObjectsClient", "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" - }, - "" + "\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": [ { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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": [ + "id": "def-public.SavedObjectsClient.create", + "type": "Function", + "children": [ { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 221 + } }, - " | undefined" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, + { + "type": "Uncategorized", + "label": "attributes", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 222 + } + }, + { + "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 + } + } + ], "signature": [ + "(type: string, attributes: T, options?: ", { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - " | undefined" - ] - }, - { - "tags": [], - "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": [ + ") => Promise<", { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" + "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 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.SimpleSavedObject.Unnamed", + "id": "def-public.SavedObjectsClient.bulkCreate", "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], "children": [ { - "type": "Object", - "label": "client", + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - ", \"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" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 256 } }, { "type": "Object", - "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }", + "label": "options", "isRequired": true, "signature": [ { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "" + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + } ], "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" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 257 } } ], - "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 - }, - { - "id": "def-public.SavedObjectsClient", - "type": "Class", - "tags": [ - "public" - ], - "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.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" - }, - "tags": [], - "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?: ", + "(objects?: ", { "pluginId": "core", "scope": "public", @@ -553,8 +170,7 @@ "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" + "lineNumber": 255 }, "tags": [ "property" @@ -577,8 +193,7 @@ "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" + "lineNumber": 284 } }, { @@ -591,8 +206,7 @@ "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" + "lineNumber": 285 } }, { @@ -612,8 +226,7 @@ "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" + "lineNumber": 286 } } ], @@ -634,8 +247,7 @@ "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" + "lineNumber": 283 }, "tags": [], "returnComment": [] @@ -662,8 +274,7 @@ "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" + "lineNumber": 314 } } ], @@ -692,16 +303,9 @@ "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" + "lineNumber": 313 }, "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", "property" ], "returnComment": [ @@ -722,8 +326,7 @@ "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" + "lineNumber": 372 } }, { @@ -736,8 +339,7 @@ "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" + "lineNumber": 372 } } ], @@ -758,8 +360,7 @@ "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" + "lineNumber": 372 }, "tags": [], "returnComment": [ @@ -780,8 +381,7 @@ "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" + "lineNumber": 395 } } ], @@ -802,12 +402,9 @@ "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" + "lineNumber": 395 }, - "tags": [ - "example" - ], + "tags": [], "returnComment": [ "The saved objects with the given type and ids requested" ] @@ -849,8 +446,7 @@ "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" + "lineNumber": 427 } }, { @@ -863,8 +459,7 @@ "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" + "lineNumber": 428 } }, { @@ -877,8 +472,7 @@ "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" + "lineNumber": 429 } }, { @@ -897,20 +491,17 @@ "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" + "lineNumber": 430 } } ], "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" + "lineNumber": 426 } }, { @@ -959,8 +550,7 @@ ], "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" + "lineNumber": 458 } } ], @@ -970,233 +560,117 @@ ], "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" + "lineNumber": 458 } } ], "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" + "lineNumber": 165 }, "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": [], + "id": "def-public.SimpleSavedObject", + "type": "Class", "tags": [ "public" ], - "children": [ - { - "tags": [], - "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" - }, - "[]" - ] - } + "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" ], - "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" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } - ], - "description": [], - "tags": [ - "public" + "" ], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-public.SavedObjectsBulkCreateObject.attributes", + "id": "def-public.SimpleSavedObject.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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 24 }, "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": [], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "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)." - ], + "id": "def-public.SimpleSavedObject._version", + "type": "string", + "label": "_version", + "description": [], "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 26 }, "signature": [ - "boolean | undefined" + "string | 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": [], - "tags": [ - "public" - ], - "children": [ { "tags": [], - "id": "def-public.SavedObjectsBulkUpdateObject.type", + "id": "def-public.SimpleSavedObject.id", "type": "string", - "label": "type", + "label": "id", "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 27 } }, { "tags": [], - "id": "def-public.SavedObjectsBulkUpdateObject.id", + "id": "def-public.SimpleSavedObject.type", "type": "string", - "label": "id", + "label": "type", "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 28 } }, { "tags": [], - "id": "def-public.SavedObjectsBulkUpdateObject.attributes", - "type": "Uncategorized", - "label": "attributes", + "id": "def-public.SimpleSavedObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 29 }, "signature": [ - "T" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.SavedObjectsBulkUpdateObject.version", + "id": "def-public.SimpleSavedObject.coreMigrationVersion", "type": "string", - "label": "version", + "label": "coreMigrationVersion", "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 30 }, "signature": [ "string | undefined" @@ -1204,257 +678,408 @@ }, { "tags": [], - "id": "def-public.SavedObjectsBulkUpdateObject.references", - "type": "Array", - "label": "references", + "id": "def-public.SimpleSavedObject.error", + "type": "Object", + "label": "error", "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 31 }, "signature": [ { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" }, - "[] | undefined" + " | 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": [], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", - "type": "string", - "label": "namespace", + "id": "def-public.SimpleSavedObject.references", + "type": "Array", + "label": "references", "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": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 32 }, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" ] }, { - "tags": [], - "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" - }, + "id": "def-public.SimpleSavedObject.Unnamed", + "type": "Function", + "label": "Constructor", "signature": [ - "boolean | undefined" - ] + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 34 + } }, { - "tags": [], - "id": "def-public.SavedObjectsCreateOptions.migrationVersion", - "type": "Object", - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" + "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 + } + } ], + "tags": [], + "returnComment": [], "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" - }, + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 59 + } + }, + { + "id": "def-public.SimpleSavedObject.set", + "type": "Function", + "label": "set", "signature": [ + "(key: string, value: any) => T" + ], + "description": [], + "children": [ { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63 + } }, - " | undefined" - ] + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63 + } }, { + "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 + } + } + ], "tags": [], - "id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion", - "type": "string", - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 67 + } + }, + { + "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/saved_objects_client.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L44" - }, + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 71 + } + }, + { + "id": "def-public.SimpleSavedObject.delete", + "type": "Function", + "label": "delete", "signature": [ - "string | undefined" - ] + "() => Promise<{}>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 86 + } + } + ], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 23 + }, + "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": [], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-public.SavedObjectsCreateOptions.references", + "id": "def-public.SavedObjectsBatchResponse.savedObjects", "type": "Array", - "label": "references", + "label": "savedObjects", "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" + "lineNumber": 89 }, "signature": [ { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, - "[] | 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" + "lineNumber": 88 }, "initialIsOpen": false }, { - "id": "def-public.SavedObjectsFindResponsePublic", + "id": "def-public.SavedObjectsBulkCreateObject", "type": "Interface", - "label": "SavedObjectsFindResponsePublic", + "label": "SavedObjectsBulkCreateObject", "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, " 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" + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } ], + "description": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-public.SavedObjectsFindResponsePublic.total", - "type": "number", - "label": "total", + "id": "def-public.SavedObjectsBulkCreateObject.type", + "type": "string", + "label": "type", "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" + "lineNumber": 55 } }, { "tags": [], - "id": "def-public.SavedObjectsFindResponsePublic.perPage", - "type": "number", - "label": "perPage", + "id": "def-public.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "label": "attributes", "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" - } - }, + "lineNumber": 56 + }, + "signature": [ + "T" + ] + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 54 + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsBulkCreateOptions", + "type": "Interface", + "label": "SavedObjectsBulkCreateOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-public.SavedObjectsFindResponsePublic.page", - "type": "number", - "label": "page", - "description": [], + "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": 109, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L109" - } + "lineNumber": 62 + }, + "signature": [ + "boolean | undefined" + ] } ], "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" + "lineNumber": 60 }, "initialIsOpen": false }, { - "id": "def-public.SavedObjectsUpdateOptions", + "id": "def-public.SavedObjectsBulkUpdateObject", "type": "Interface", - "label": "SavedObjectsUpdateOptions", + "label": "SavedObjectsBulkUpdateObject", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "" + ], "description": [], "tags": [ "public" @@ -1462,53 +1087,63 @@ "children": [ { "tags": [], - "id": "def-public.SavedObjectsUpdateOptions.version", + "id": "def-public.SavedObjectsBulkUpdateObject.type", "type": "string", - "label": "version", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 67 + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 68 + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsBulkUpdateObject.attributes", + "type": "Uncategorized", + "label": "attributes", "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" + "lineNumber": 69 }, "signature": [ - "string | undefined" + "T" ] }, { "tags": [], - "id": "def-public.SavedObjectsUpdateOptions.migrationVersion", - "type": "Object", - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" - ], + "id": "def-public.SavedObjectsBulkUpdateObject.version", + "type": "string", + "label": "version", + "description": [], "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" + "lineNumber": 70 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, - " | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.SavedObjectsUpdateOptions.references", + "id": "def-public.SavedObjectsBulkUpdateObject.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" + "lineNumber": 71 }, "signature": [ { @@ -1524,15 +1159,14 @@ ], "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" + "lineNumber": 66 }, "initialIsOpen": false }, { - "id": "def-public.SavedObjectsStart", + "id": "def-public.SavedObjectsBulkUpdateOptions", "type": "Interface", - "label": "SavedObjectsStart", + "label": "SavedObjectsBulkUpdateOptions", "description": [], "tags": [ "public" @@ -1540,143 +1174,419 @@ "children": [ { "tags": [], - "id": "def-public.SavedObjectsStart.client", - "type": "Object", - "label": "client", - "description": [ - "{@link SavedObjectsClient}" - ], + "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", + "type": "string", + "label": "namespace", + "description": [], "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" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 76 }, "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" + "string | undefined" ] } ], - "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", - "tags": [ - "public" - ], - "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" + "lineNumber": 75 }, - "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", + "id": "def-public.SavedObjectsCreateOptions", + "type": "Interface", + "label": "SavedObjectsCreateOptions", + "description": [], "tags": [ "public" ], - "label": "SavedObjectsClient", - "description": [ - "\n" - ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsClient.errors", - "type": "Object", - "label": "errors", - "description": [], + "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/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" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 38 }, "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - } + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsClient.errors", - "type": "Object", - "label": "errors", - "description": [], + "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/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" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 40 }, "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - } + "boolean | undefined" ] }, { - "id": "def-server.SavedObjectsClient.create", - "type": "Function", - "label": "create", + "tags": [], + "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 + }, "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" + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" }, - ">" - ], + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsCreateOptions.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 45 + }, + "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 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 107 + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.perPage", + "type": "number", + "label": "perPage", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 108 + } + }, + { + "tags": [], + "id": "def-public.SavedObjectsFindResponsePublic.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 109 + } + } + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 106 + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsStart", + "type": "Interface", + "label": "SavedObjectsStart", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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 + }, + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsUpdateOptions", + "type": "Interface", + "label": "SavedObjectsUpdateOptions", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.SavedObjectsUpdateOptions.version", + "type": "string", + "label": "version", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 81 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SavedObjectsUpdateOptions.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 84 + }, + "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 + }, + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "id": "def-public.SavedObjectsClientContract", + "type": "Type", + "label": "SavedObjectsClientContract", + "tags": [ + "public" + ], + "description": [ + "\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 138 + }, + "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", + "tags": [ + "public" + ], + "label": "SavedObjectsClient", + "description": [ + "\n" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsClient.errors", + "type": "Object", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 397 + }, + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + } + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsClient.errors", + "type": "Object", + "label": "errors", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 398 + }, + "signature": [ + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + } + ] + }, + { + "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" ], @@ -1691,8 +1601,7 @@ "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" + "lineNumber": 414 } }, { @@ -1705,8 +1614,7 @@ "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" + "lineNumber": 414 } }, { @@ -1726,8 +1634,7 @@ "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" + "lineNumber": 414 } } ], @@ -1735,8 +1642,7 @@ "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" + "lineNumber": 414 } }, { @@ -1791,8 +1697,7 @@ "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" + "lineNumber": 425 } }, { @@ -1812,8 +1717,7 @@ "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" + "lineNumber": 426 } } ], @@ -1821,8 +1725,7 @@ "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" + "lineNumber": 424 } }, { @@ -1877,8 +1780,7 @@ "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" + "lineNumber": 439 } }, { @@ -1897,8 +1799,7 @@ "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" + "lineNumber": 440 } } ], @@ -1906,8 +1807,7 @@ "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" + "lineNumber": 438 } }, { @@ -1939,8 +1839,7 @@ "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" + "lineNumber": 452 } }, { @@ -1953,8 +1852,7 @@ "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" + "lineNumber": 452 } }, { @@ -1973,8 +1871,7 @@ "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" + "lineNumber": 452 } } ], @@ -1982,8 +1879,7 @@ "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" + "lineNumber": 452 } }, { @@ -2029,8 +1925,7 @@ "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" + "lineNumber": 461 } } ], @@ -2038,8 +1933,7 @@ "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" + "lineNumber": 461 } }, { @@ -2096,8 +1990,7 @@ ], "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" + "lineNumber": 477 } }, { @@ -2116,19 +2009,15 @@ "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" + "lineNumber": 478 } } ], - "tags": [ - "example" - ], + "tags": [], "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" + "lineNumber": 476 } }, { @@ -2170,8 +2059,7 @@ ], "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" + "lineNumber": 491 } }, { @@ -2186,8 +2074,7 @@ ], "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" + "lineNumber": 492 } }, { @@ -2206,8 +2093,7 @@ "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" + "lineNumber": 493 } } ], @@ -2215,8 +2101,7 @@ "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" + "lineNumber": 490 } }, { @@ -2258,8 +2143,7 @@ ], "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" + "lineNumber": 506 } }, { @@ -2274,8 +2158,7 @@ ], "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" + "lineNumber": 507 } }, { @@ -2294,8 +2177,7 @@ "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" + "lineNumber": 508 } } ], @@ -2303,8 +2185,7 @@ "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" + "lineNumber": 505 } }, { @@ -2344,8 +2225,7 @@ "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" + "lineNumber": 521 } }, { @@ -2358,8 +2238,7 @@ "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" + "lineNumber": 522 } }, { @@ -2372,8 +2251,7 @@ "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" + "lineNumber": 523 } }, { @@ -2392,8 +2270,7 @@ "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" + "lineNumber": 524 } } ], @@ -2401,8 +2278,7 @@ "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" + "lineNumber": 520 } }, { @@ -2442,8 +2318,7 @@ "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" + "lineNumber": 538 } }, { @@ -2456,8 +2331,7 @@ "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" + "lineNumber": 539 } }, { @@ -2470,8 +2344,7 @@ "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" + "lineNumber": 540 } }, { @@ -2490,8 +2363,7 @@ "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" + "lineNumber": 541 } } ], @@ -2499,8 +2371,7 @@ "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" + "lineNumber": 537 } }, { @@ -2540,8 +2411,7 @@ "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" + "lineNumber": 555 } }, { @@ -2554,8 +2424,7 @@ "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" + "lineNumber": 556 } }, { @@ -2568,8 +2437,7 @@ "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" + "lineNumber": 557 } }, { @@ -2588,8 +2456,7 @@ "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" + "lineNumber": 558 } } ], @@ -2597,8 +2464,7 @@ "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" + "lineNumber": 554 } }, { @@ -2653,8 +2519,7 @@ "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" + "lineNumber": 569 } }, { @@ -2674,8 +2539,7 @@ "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" + "lineNumber": 570 } } ], @@ -2683,8 +2547,7 @@ "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" + "lineNumber": 568 } }, { @@ -2724,8 +2587,7 @@ "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" + "lineNumber": 579 } }, { @@ -2738,8 +2600,7 @@ "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" + "lineNumber": 580 } }, { @@ -2759,8 +2620,7 @@ "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" + "lineNumber": 581 } } ], @@ -2768,8 +2628,7 @@ "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" + "lineNumber": 578 } }, { @@ -2809,8 +2668,7 @@ "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" + "lineNumber": 592 } }, { @@ -2829,8 +2687,7 @@ "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" + "lineNumber": 593 } } ], @@ -2838,8 +2695,7 @@ "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" + "lineNumber": 591 } }, { @@ -2879,8 +2735,7 @@ "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" + "lineNumber": 603 } }, { @@ -2900,8 +2755,7 @@ "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" + "lineNumber": 603 } } ], @@ -2909,15 +2763,13 @@ "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" + "lineNumber": 603 } } ], "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" + "lineNumber": 396 }, "initialIsOpen": false }, @@ -2957,8 +2809,7 @@ "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" + "lineNumber": 73 } } ], @@ -2966,8 +2817,7 @@ "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" + "lineNumber": 73 } }, { @@ -2997,8 +2847,7 @@ "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" + "lineNumber": 77 } }, { @@ -3011,8 +2860,7 @@ "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" + "lineNumber": 77 } } ], @@ -3020,8 +2868,7 @@ "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" + "lineNumber": 77 } }, { @@ -3051,8 +2898,7 @@ "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" + "lineNumber": 81 } } ], @@ -3060,8 +2906,7 @@ "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" + "lineNumber": 81 } }, { @@ -3091,8 +2936,7 @@ "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" + "lineNumber": 85 } } ], @@ -3100,8 +2944,7 @@ "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" + "lineNumber": 85 } }, { @@ -3138,8 +2981,7 @@ "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" + "lineNumber": 92 } } ], @@ -3147,8 +2989,7 @@ "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" + "lineNumber": 92 } }, { @@ -3178,8 +3019,7 @@ "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" + "lineNumber": 96 } } ], @@ -3187,8 +3027,7 @@ "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" + "lineNumber": 96 } }, { @@ -3225,8 +3064,7 @@ "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" + "lineNumber": 104 } } ], @@ -3234,8 +3072,7 @@ "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" + "lineNumber": 104 } }, { @@ -3265,8 +3102,7 @@ "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" + "lineNumber": 108 } }, { @@ -3279,8 +3115,7 @@ "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" + "lineNumber": 108 } } ], @@ -3288,8 +3123,7 @@ "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" + "lineNumber": 108 } }, { @@ -3326,8 +3160,7 @@ "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" + "lineNumber": 112 } } ], @@ -3335,8 +3168,7 @@ "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" + "lineNumber": 112 } }, { @@ -3366,8 +3198,7 @@ "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" + "lineNumber": 116 } }, { @@ -3380,8 +3211,7 @@ "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" + "lineNumber": 116 } } ], @@ -3389,8 +3219,7 @@ "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" + "lineNumber": 116 } }, { @@ -3427,8 +3256,7 @@ "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" + "lineNumber": 120 } } ], @@ -3436,8 +3264,7 @@ "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" + "lineNumber": 120 } }, { @@ -3467,8 +3294,7 @@ "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" + "lineNumber": 124 } }, { @@ -3481,8 +3307,7 @@ "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" + "lineNumber": 124 } } ], @@ -3490,8 +3315,7 @@ "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" + "lineNumber": 124 } }, { @@ -3528,8 +3352,7 @@ "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" + "lineNumber": 127 } } ], @@ -3537,8 +3360,7 @@ "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" + "lineNumber": 127 } }, { @@ -3568,8 +3390,7 @@ "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" + "lineNumber": 131 } }, { @@ -3582,8 +3403,7 @@ "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" + "lineNumber": 131 } } ], @@ -3591,8 +3411,7 @@ "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" + "lineNumber": 131 } }, { @@ -3622,8 +3441,7 @@ "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" + "lineNumber": 138 } } ], @@ -3631,8 +3449,7 @@ "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" + "lineNumber": 138 } }, { @@ -3662,8 +3479,7 @@ "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" + "lineNumber": 142 } }, { @@ -3676,8 +3492,7 @@ "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" + "lineNumber": 142 } } ], @@ -3685,8 +3500,7 @@ "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" + "lineNumber": 142 } }, { @@ -3723,8 +3537,7 @@ "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" + "lineNumber": 151 } } ], @@ -3732,8 +3545,7 @@ "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" + "lineNumber": 151 } }, { @@ -3763,8 +3575,7 @@ "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" + "lineNumber": 155 } }, { @@ -3777,8 +3588,7 @@ "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" + "lineNumber": 155 } } ], @@ -3786,8 +3596,7 @@ "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" + "lineNumber": 155 } }, { @@ -3817,8 +3626,7 @@ "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" + "lineNumber": 159 } }, { @@ -3831,8 +3639,7 @@ "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" + "lineNumber": 159 } }, { @@ -3845,8 +3652,7 @@ "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" + "lineNumber": 159 } } ], @@ -3854,8 +3660,7 @@ "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" + "lineNumber": 159 } }, { @@ -3892,8 +3697,7 @@ "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" + "lineNumber": 166 } } ], @@ -3901,8 +3705,7 @@ "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" + "lineNumber": 166 } }, { @@ -3932,8 +3735,7 @@ "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" + "lineNumber": 170 } }, { @@ -3946,8 +3748,7 @@ "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" + "lineNumber": 170 } } ], @@ -3955,8 +3756,7 @@ "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" + "lineNumber": 170 } }, { @@ -3977,233 +3777,29 @@ "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", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "Error" + "string" ], "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" + "lineNumber": 174 } }, { "type": "string", - "label": "reason", - "isRequired": false, + "label": "id", + "isRequired": true, "signature": [ - "string | undefined" + "string" ], "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" + "lineNumber": 174 } } ], @@ -4211,14 +3807,13 @@ "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" + "lineNumber": 174 } }, { - "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError", + "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError", "type": "Function", - "label": "isEsUnavailableError", + "label": "isTooManyRequestsError", "signature": [ "typeof ", { @@ -4228,7 +3823,7 @@ "section": "def-server.SavedObjectsErrorHelpers", "text": "SavedObjectsErrorHelpers" }, - ".isEsUnavailableError" + ".isTooManyRequestsError" ], "description": [], "children": [ @@ -4249,8 +3844,7 @@ "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" + "lineNumber": 178 } } ], @@ -4258,14 +3852,13 @@ "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" + "lineNumber": 178 } }, { - "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError", "type": "Function", - "label": "decorateGeneralError", + "label": "decorateEsCannotExecuteScriptError", "signature": [ "typeof ", { @@ -4275,7 +3868,7 @@ "section": "def-server.SavedObjectsErrorHelpers", "text": "SavedObjectsErrorHelpers" }, - ".decorateGeneralError" + ".decorateEsCannotExecuteScriptError" ], "description": [], "children": [ @@ -4289,8 +3882,7 @@ "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" + "lineNumber": 182 } }, { @@ -4303,8 +3895,7 @@ "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" + "lineNumber": 182 } } ], @@ -4312,14 +3903,13 @@ "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" + "lineNumber": 182 } }, { - "id": "def-server.SavedObjectsErrorHelpers.isGeneralError", + "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError", "type": "Function", - "label": "isGeneralError", + "label": "isEsCannotExecuteScriptError", "signature": [ "typeof ", { @@ -4329,7 +3919,7 @@ "section": "def-server.SavedObjectsErrorHelpers", "text": "SavedObjectsErrorHelpers" }, - ".isGeneralError" + ".isEsCannotExecuteScriptError" ], "description": [], "children": [ @@ -4350,8 +3940,7 @@ "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" + "lineNumber": 186 } } ], @@ -4359,1039 +3948,1267 @@ "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", - "tags": [ - "remarks", - "public" - ], - "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.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" + "lineNumber": 186 } }, { - "id": "def-server.SavedObjectsSerializer.rawToSavedObject", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError", "type": "Function", - "label": "rawToSavedObject", + "label": "decorateEsUnavailableError", "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" - }, - ") => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" }, - "" - ], - "description": [ - "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" + ".decorateEsUnavailableError" ], + "description": [], "children": [ { "type": "Object", - "label": "doc", + "label": "error", "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." + "Error" ], + "description": [], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190 } }, { - "type": "Object", - "label": "options", - "isRequired": true, + "type": "string", + "label": "reason", + "isRequired": false, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - } - ], - "description": [ - "- Options for parsing the raw document." + "string | undefined" ], + "description": [], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190 } } ], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 190 } }, { - "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", + "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError", "type": "Function", - "label": "savedObjectToRaw", + "label": "isEsUnavailableError", "signature": [ - "(savedObj: ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" }, - ") => ", - { - "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" + ".isEsUnavailableError" ], + "description": [], "children": [ { "type": "CompoundType", - "label": "savedObj", + "label": "error", "isRequired": true, "signature": [ + "Error | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" - }, - "" - ], - "description": [ - "- The saved object to be converted to raw ES format." + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } ], + "description": [], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 194 } } ], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 194 } }, { - "id": "def-server.SavedObjectsSerializer.generateRawId", + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError", "type": "Function", - "label": "generateRawId", + "label": "decorateGeneralError", "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" - } + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" }, + ".decorateGeneralError" + ], + "description": [], + "children": [ { - "type": "string", - "label": "type", + "type": "Object", + "label": "error", "isRequired": true, "signature": [ - "string" - ], - "description": [ - "- The saved object type" + "Error" ], + "description": [], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198 } }, { "type": "string", - "label": "id", - "isRequired": true, + "label": "reason", + "isRequired": false, "signature": [ - "string" - ], - "description": [ - "- The id of the saved object" + "string | undefined" ], + "description": [], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198 } } ], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 198 } }, { - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", + "id": "def-server.SavedObjectsErrorHelpers.isGeneralError", "type": "Function", - "label": "generateRawLegacyUrlAliasId", + "label": "isGeneralError", "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" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + ".isGeneralError" ], + "description": [], "children": [ { - "type": "string", - "label": "namespace", + "type": "CompoundType", + "label": "error", "isRequired": true, "signature": [ - "string" - ], - "description": [ - "- The namespace of the saved object" + "Error | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.DecoratedError", + "text": "DecoratedError" + } ], + "description": [], "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" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 202 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 202 + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "lineNumber": 72 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExporter", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsExporter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#savedObjectsClient", + "type": "Object", + "label": "#savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 38 + }, + "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\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#exportTransforms", + "type": "Object", + "label": "#exportTransforms", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 39 + }, + "signature": [ + "Record" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#exportSizeLimit", + "type": "number", + "label": "#exportSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 40 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsExporter.#log", + "type": "Object", + "label": "#log", + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 41 + }, + "signature": [ + "Logger" + ] + }, + { + "id": "def-server.SavedObjectsExporter.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ { - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [ - "- The id of the saved object" + "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 }", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "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 + }, + "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\">" + ] + }, + { + "tags": [], + "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 + }, + "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\">" + ] + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "Logger" + ] + } ], "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" + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 48 } } ], "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" + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 43 } - } - ], - "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.SavedObjectTypeRegistry", - "type": "Class", - "tags": [ - "public" - ], - "label": "SavedObjectTypeRegistry", - "description": [ - "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" - ], - "children": [ + }, { - "id": "def-server.SavedObjectTypeRegistry.registerType", + "id": "def-server.SavedObjectsExporter.exportByTypes", "type": "Function", - "label": "registerType", + "label": "exportByTypes", "signature": [ - "(type: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" }, - ") => void" + ") => Promise<", + "Readable", + ">" ], "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." + "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" ], "children": [ { "type": "Object", - "label": "type", + "label": "options", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" } ], "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" + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 75 } } ], - "tags": [], + "tags": [ + "throws" + ], "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" + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 75 } }, { - "id": "def-server.SavedObjectTypeRegistry.getType", + "id": "def-server.SavedObjectsExporter.exportByObjects", "type": "Function", - "label": "getType", + "label": "exportByObjects", "signature": [ - "(type: string) => ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" }, - " | undefined" + ") => Promise<", + "Readable", + ">" ], "description": [ - "\nReturn the {@link SavedObjectsType | type} definition for given type name." + "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" ], "children": [ { - "type": "string", - "label": "type", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + } ], "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" + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 93 } } ], - "tags": [], + "tags": [ + "throws" + ], "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" + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 93 } + } + ], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 37 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsExportError", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsExportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" }, + " extends Error" + ], + "children": [ { - "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", + "id": "def-server.SavedObjectsExportError.Unnamed", "type": "Function", - "label": "getVisibleTypes", + "label": "Constructor", "signature": [ - "() => ", + "any" + ], + "description": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 16 + } }, - "[]" - ], - "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" + "type": "string", + "label": "message", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 17 + } }, - "[]" - ], - "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." + { + "type": "Object", + "label": "attributes", + "isRequired": false, + "signature": [ + "Record | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 18 + } + } ], - "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 15 } }, { - "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded", "type": "Function", - "label": "getImportableAndExportableTypes", + "label": "exportSizeExceeded", "signature": [ - "() => ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" }, - "[]" - ], - "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" + ".exportSizeExceeded" ], + "description": [], "children": [ { - "type": "string", - "label": "type", + "type": "number", + "label": "limit", "isRequired": true, "signature": [ - "string" + "number" ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27 } } ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 27 } }, { - "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", + "id": "def-server.SavedObjectsExportError.objectFetchError", "type": "Function", - "label": "isSingleNamespace", + "label": "objectFetchError", "signature": [ - "(type: string) => boolean" - ], - "description": [ - "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".objectFetchError" ], + "description": [], "children": [ - { - "type": "string", - "label": "type", + { + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 34 } } ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 34 } }, { - "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", + "id": "def-server.SavedObjectsExportError.objectTransformError", "type": "Function", - "label": "isMultiNamespace", + "label": "objectTransformError", "signature": [ - "(type: string) => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".objectTransformError" ], "description": [ - "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" + "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" ], "children": [ { - "type": "string", - "label": "type", + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 43 + } + }, + { + "type": "Object", + "label": "cause", + "isRequired": true, + "signature": [ + "Error" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 43 } } ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 43 } }, { - "id": "def-server.SavedObjectTypeRegistry.isShareable", + "id": "def-server.SavedObjectsExportError.invalidTransformError", "type": "Function", - "label": "isShareable", + "label": "invalidTransformError", "signature": [ - "(type: string) => boolean" + "typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + }, + ".invalidTransformError" ], "description": [ - "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" + "\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": "string", - "label": "type", + "type": "Array", + "label": "objectKeys", "isRequired": true, "signature": [ - "string" + "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 58 } } ], "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" + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 58 } + } + ], + "source": { + "path": "src/core/server/saved_objects/export/errors.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImporter", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsImporter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#savedObjectsClient", + "type": "Object", + "label": "#savedObjectsClient", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 30 + }, + "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.SavedObjectTypeRegistry.isHidden", + "tags": [], + "id": "def-server.SavedObjectsImporter.#typeRegistry", + "type": "Object", + "label": "#typeRegistry", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 31 + }, + "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\">" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#importSizeLimit", + "type": "number", + "label": "#importSizeLimit", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 32 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImporter.#importHooks", + "type": "Object", + "label": "#importHooks", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 33 + }, + "signature": [ + "Record[]>" + ] + }, + { + "id": "def-server.SavedObjectsImporter.Unnamed", "type": "Function", - "label": "isHidden", + "label": "Constructor", "signature": [ - "(type: string) => boolean" - ], - "description": [ - "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + "any" ], + "description": [], "children": [ { - "type": "string", - "label": "type", - "isRequired": true, - "signature": [ - "string" - ], + "id": "def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "type": "Object", + "label": "{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }", + "tags": [], "description": [], + "children": [ + { + "tags": [], + "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 + }, + "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\">" + ] + }, + { + "tags": [], + "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 + }, + "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\">" + ] + }, + { + "tags": [], + "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 + } + } + ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 39 } } ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 35 } }, { - "id": "def-server.SavedObjectTypeRegistry.getIndex", + "id": "def-server.SavedObjectsImporter.import", "type": "Function", - "label": "getIndex", + "label": "import", "signature": [ - "(type: string) => string | undefined" + "({ 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": [ - "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." + "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" ], "children": [ { - "type": "string", - "label": "type", + "type": "Object", + "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" + } ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64 } } ], - "tags": [], + "tags": [ + "throws" + ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 64 } }, { - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "id": "def-server.SavedObjectsImporter.resolveImportErrors", "type": "Function", - "label": "isImportableAndExportable", + "label": "resolveImportErrors", "signature": [ - "(type: string) => boolean" + "({ 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": [ - "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n" ], "children": [ { - "type": "string", - "label": "type", + "type": "Object", + "label": "{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" + } ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88 } } ], - "tags": [], + "tags": [ + "throws" + ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 88 } } ], "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" + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsUtils", + "id": "def-server.SavedObjectsImportError", "type": "Class", "tags": [ "public" ], - "label": "SavedObjectsUtils", + "label": "SavedObjectsImportError", "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + }, + " extends Error" + ], "children": [ { - "id": "def-server.SavedObjectsUtils.namespaceIdToString", + "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": "string", - "label": "namespace", - "isRequired": false, + "type": "number", + "label": "limit", + "isRequired": true, "signature": [ - "string | undefined" + "number" ], "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 27 + } }, { - "id": "def-server.SavedObjectsUtils.namespaceStringToId", + "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": "string", - "label": "namespace", + "type": "Array", + "label": "nonUniqueEntries", "isRequired": true, "signature": [ - "string" + "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 34 + } }, { - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", + "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": "Object", - "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", + "type": "Array", + "label": "nonUniqueRetryObjects", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } + "string[]" ], "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 41 + } }, { - "id": "def-server.SavedObjectsUtils.generateId", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", "type": "Function", - "label": "generateId", + "label": "nonUniqueRetryDestinations", "signature": [ "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUtils", - "text": "SavedObjectsUtils" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - ".generateId" + ".nonUniqueRetryDestinations" ], - "description": [ - "\nGenerates a random ID for a saved objects." + "description": [], + "children": [ + { + "type": "Array", + "label": "nonUniqueRetryDestinations", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48 + } + } ], - "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 48 } }, { - "id": "def-server.SavedObjectsUtils.isRandomId", + "id": "def-server.SavedObjectsImportError.referencesFetchError", "type": "Function", - "label": "isRandomId", + "label": "referencesFetchError", "signature": [ "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUtils", - "text": "SavedObjectsUtils" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, - ".isRandomId" - ], - "description": [ - "\nValidates that a saved object ID has been randomly generated.\n" + ".referencesFetchError" ], + "description": [], "children": [ { - "type": "string", - "label": "id", - "isRequired": false, + "type": "Array", + "label": "objects", + "isRequired": true, "signature": [ - "string | undefined" - ], - "description": [ - "The ID of a saved object." + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "[]" ], + "description": [], "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55 } } ], - "tags": [ - "todo" - ], + "tags": [], "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 55 } } ], "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" + "path": "src/core/server/saved_objects/import/errors.ts", + "lineNumber": 14 }, "initialIsOpen": false }, @@ -5441,8 +5258,7 @@ "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" + "lineNumber": 237 } }, { @@ -5455,8 +5271,7 @@ "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" + "lineNumber": 238 } }, { @@ -5475,16 +5290,11 @@ "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" + "lineNumber": 239 } } ], "tags": [ - "property", - "property", - "property", - "property", "property" ], "returnComment": [ @@ -5492,8 +5302,7 @@ ], "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" + "lineNumber": 236 } }, { @@ -5550,8 +5359,7 @@ ], "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" + "lineNumber": 330 } }, { @@ -5570,13 +5378,11 @@ "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" + "lineNumber": 331 } } ], "tags": [ - "property", "property" ], "returnComment": [ @@ -5584,8 +5390,7 @@ ], "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" + "lineNumber": 329 } }, { @@ -5640,8 +5445,7 @@ "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" + "lineNumber": 517 } }, { @@ -5660,8 +5464,7 @@ "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" + "lineNumber": 518 } } ], @@ -5669,8 +5472,7 @@ "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" + "lineNumber": 516 } }, { @@ -5702,8 +5504,7 @@ "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" + "lineNumber": 602 } }, { @@ -5716,8 +5517,7 @@ "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" + "lineNumber": 602 } }, { @@ -5736,8 +5536,7 @@ "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" + "lineNumber": 602 } } ], @@ -5747,8 +5546,7 @@ "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" + "lineNumber": 602 } }, { @@ -5780,8 +5578,7 @@ "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" + "lineNumber": 664 } }, { @@ -5800,8 +5597,7 @@ "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" + "lineNumber": 665 } } ], @@ -5811,8 +5607,7 @@ ], "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" + "lineNumber": 663 } }, { @@ -5856,25 +5651,11 @@ "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" + "lineNumber": 725 } } ], "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", "property" ], "returnComment": [ @@ -5882,8 +5663,7 @@ ], "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" + "lineNumber": 725 } }, { @@ -5940,8 +5720,7 @@ ], "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" + "lineNumber": 875 } }, { @@ -5960,22 +5739,19 @@ "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" + "lineNumber": 876 } } ], "tags": [ - "property", - "example" + "property" ], "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" + "lineNumber": 874 } }, { @@ -6015,8 +5791,7 @@ "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" + "lineNumber": 960 } }, { @@ -6029,8 +5804,7 @@ "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" + "lineNumber": 961 } }, { @@ -6049,8 +5823,7 @@ "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" + "lineNumber": 962 } } ], @@ -6062,8 +5835,7 @@ ], "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" + "lineNumber": 959 } }, { @@ -6103,8 +5875,7 @@ "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" + "lineNumber": 998 } }, { @@ -6117,8 +5888,7 @@ "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" + "lineNumber": 999 } }, { @@ -6137,8 +5907,7 @@ "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" + "lineNumber": 1000 } } ], @@ -6150,8 +5919,7 @@ ], "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" + "lineNumber": 997 } }, { @@ -6191,8 +5959,7 @@ "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" + "lineNumber": 1117 } }, { @@ -6205,8 +5972,7 @@ "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" + "lineNumber": 1118 } }, { @@ -6219,8 +5985,7 @@ "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" + "lineNumber": 1119 } }, { @@ -6239,21 +6004,17 @@ "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" + "lineNumber": 1120 } } ], "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" + "lineNumber": 1116 } }, { @@ -6293,8 +6054,7 @@ "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" + "lineNumber": 1190 } }, { @@ -6307,8 +6067,7 @@ "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" + "lineNumber": 1191 } }, { @@ -6321,8 +6080,7 @@ "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" + "lineNumber": 1192 } }, { @@ -6341,8 +6099,7 @@ "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" + "lineNumber": 1193 } } ], @@ -6350,8 +6107,7 @@ "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" + "lineNumber": 1189 } }, { @@ -6391,8 +6147,7 @@ "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" + "lineNumber": 1253 } }, { @@ -6405,8 +6160,7 @@ "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" + "lineNumber": 1254 } }, { @@ -6419,8 +6173,7 @@ "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" + "lineNumber": 1255 } }, { @@ -6439,8 +6192,7 @@ "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" + "lineNumber": 1256 } } ], @@ -6448,8 +6200,7 @@ "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" + "lineNumber": 1252 } }, { @@ -6506,8 +6257,7 @@ ], "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" + "lineNumber": 1358 } }, { @@ -6526,13 +6276,11 @@ "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" + "lineNumber": 1359 } } ], "tags": [ - "property", "property" ], "returnComment": [ @@ -6540,8 +6288,7 @@ ], "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" + "lineNumber": 1357 } }, { @@ -6581,8 +6328,7 @@ "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" + "lineNumber": 1573 } }, { @@ -6595,8 +6341,7 @@ "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" + "lineNumber": 1574 } }, { @@ -6615,19 +6360,15 @@ "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" + "lineNumber": 1575 } } ], - "tags": [ - "remarks" - ], + "tags": [], "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" + "lineNumber": 1572 } }, { @@ -6677,8 +6418,7 @@ ], "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" + "lineNumber": 1670 } }, { @@ -6693,8 +6433,7 @@ ], "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" + "lineNumber": 1671 } }, { @@ -6717,8 +6456,7 @@ ], "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" + "lineNumber": 1672 } }, { @@ -6739,22 +6477,17 @@ ], "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" + "lineNumber": 1673 } } ], - "tags": [ - "remarks", - "example" - ], + "tags": [], "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" + "lineNumber": 1669 } }, { @@ -6794,8 +6527,7 @@ "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" + "lineNumber": 1821 } }, { @@ -6814,14 +6546,11 @@ "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" + "lineNumber": 1822 } } ], "tags": [ - "example", - "property", "property" ], "returnComment": [ @@ -6829,8 +6558,7 @@ ], "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" + "lineNumber": 1820 } }, { @@ -6870,8 +6598,7 @@ "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" + "lineNumber": 1890 } }, { @@ -6893,240 +6620,85 @@ ], "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" + "lineNumber": 1891 } } ], - "tags": [ - "remarks", - "example" - ], + "tags": [], "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" + "lineNumber": 1889 } } ], "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" + "lineNumber": 143 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsExporter", + "id": "def-server.SavedObjectsSerializer", "type": "Class", "tags": [ "public" ], - "label": "SavedObjectsExporter", - "description": [], + "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": [ { - "tags": [], - "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" - }, + "id": "def-server.SavedObjectsSerializer.isRawSavedObject", + "type": "Function", + "label": "isRawSavedObject", "signature": [ - "Pick<", + "(doc: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" + ") => boolean" + ], + "description": [ + "\nDetermines whether or not the raw document can be converted to a saved object.\n" ], - "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 }", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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" - } - }, + "label": "doc", + "isRequired": true, + "signature": [ { - "tags": [], - "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" - ] + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" } ], - "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": [ + "description": [ + "- The raw ES document to be tested" + ], + "source": { + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 + } + }, { "type": "Object", "label": "options", @@ -7136,1423 +6708,1008 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" } ], - "description": [], + "description": [ + "- Options for parsing the raw document." + ], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 } } ], - "tags": [ - "throws" - ], + "tags": [], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 41 } }, { - "id": "def-server.SavedObjectsExporter.exportByObjects", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject", "type": "Function", - "label": "exportByObjects", + "label": "rawToSavedObject", "signature": [ - "(options: ", + "(doc: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" }, - ") => Promise<", - "Readable", - ">" + ", 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": [ - "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" + "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" ], "children": [ { "type": "Object", - "label": "options", + "label": "doc", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" } ], - "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", - "tags": [ - "public" - ], - "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": [ + "- The raw ES document to be converted to saved object format." ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 59 } }, { - "type": "string", - "label": "message", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } ], - "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": [ + "- Options for parsing the raw document." ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 60 } } ], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 58 } }, { - "id": "def-server.SavedObjectsExportError.exportSizeExceeded", + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", "type": "Function", - "label": "exportSizeExceeded", + "label": "savedObjectToRaw", "signature": [ - "typeof ", + "(savedObj: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" }, - ".exportSizeExceeded" + ") => ", + { + "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" ], - "description": [], "children": [ { - "type": "number", - "label": "limit", + "type": "CompoundType", + "label": "savedObj", "isRequired": true, "signature": [ - "number" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + "" + ], + "description": [ + "- The saved object to be converted to raw ES format." ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 102 } } ], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 102 } }, { - "id": "def-server.SavedObjectsExportError.objectFetchError", + "id": "def-server.SavedObjectsSerializer.generateRawId", "type": "Function", - "label": "objectFetchError", + "label": "generateRawId", "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - }, - ".objectFetchError" + "(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" ], - "description": [], "children": [ { - "type": "Array", - "label": "objects", + "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 + } + }, + { + "type": "string", + "label": "type", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "[]" + "string" + ], + "description": [ + "- The saved object type" ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 143 + } + }, + { + "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 } } ], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 143 } }, { - "id": "def-server.SavedObjectsExportError.objectTransformError", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", "type": "Function", - "label": "objectTransformError", + "label": "generateRawLegacyUrlAliasId", "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - }, - ".objectTransformError" + "(namespace: string, type: string, id: string) => string" ], "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error" + "\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": "Array", - "label": "objects", + "type": "string", + "label": "namespace", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "[]" + "string" + ], + "description": [ + "- The namespace of the saved object" ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156 } }, { - "type": "Object", - "label": "cause", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "Error" + "string" + ], + "description": [ + "- The saved object type" ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156 } - } - ], - "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", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - "string[]" + "string" + ], + "description": [ + "- The id of the saved object" ], - "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156 } } ], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 156 } } ], "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" + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "lineNumber": 26 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImporter", + "id": "def-server.SavedObjectsUtils", "type": "Class", "tags": [ "public" ], - "label": "SavedObjectsImporter", + "label": "SavedObjectsUtils", "description": [], "children": [ { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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", + "id": "def-server.SavedObjectsUtils.namespaceIdToString", "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 }", - "tags": [], + "type": "string", + "label": "namespace", + "isRequired": false, + "signature": [ + "string | undefined" + ], "description": [], - "children": [ - { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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/service/lib/utils.ts", + "lineNumber": 29 + } + } + ], + "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 + }, + "tags": [], + "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/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" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43 } } ], - "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" - }, - ">" + "(namespace: string) => string | undefined" ], "description": [ - "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + "\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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", + "type": "Function", "children": [ { "type": "Object", - "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", + "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.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" } ], "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" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54 } } ], - "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, }: ", + "({ page, perPage, }: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, - ") => Promise<", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, - ">" + "" ], "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" + "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." ], - "returnComment": [], + "label": "createEmptyFindResponse", "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", - "tags": [ - "public" - ], - "label": "SavedObjectsImportError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54 + }, + "tags": [], + "returnComment": [] }, - " extends Error" - ], - "children": [ { - "id": "def-server.SavedObjectsImportError.importSizeExceeded", + "id": "def-server.SavedObjectsUtils.generateId", "type": "Function", - "label": "importSizeExceeded", + "label": "generateId", "signature": [ "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" }, - ".importSizeExceeded" + ".generateId" ], - "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" - } - } + "description": [ + "\nGenerates a random ID for a saved objects." ], + "children": [], "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" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 67 } }, { - "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", + "id": "def-server.SavedObjectsUtils.isRandomId", "type": "Function", - "label": "nonUniqueImportObjects", + "label": "isRandomId", "signature": [ "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" }, - ".nonUniqueImportObjects" + ".isRandomId" + ], + "description": [ + "\nValidates that a saved object ID has been randomly generated.\n" ], - "description": [], "children": [ { - "type": "Array", - "label": "nonUniqueEntries", - "isRequired": true, + "type": "string", + "label": "id", + "isRequired": false, "signature": [ - "string[]" + "string | undefined" + ], + "description": [ + "The ID of a saved object." ], - "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" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77 } } ], - "tags": [], + "tags": [ + "todo" + ], "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" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77 } - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectTypeRegistry", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectTypeRegistry", + "description": [ + "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" + ], + "children": [ { - "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", + "id": "def-server.SavedObjectTypeRegistry.registerType", "type": "Function", - "label": "nonUniqueRetryObjects", + "label": "registerType", "signature": [ - "typeof ", + "(type: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ".nonUniqueRetryObjects" + ") => 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." ], - "description": [], "children": [ { - "type": "Array", - "label": "nonUniqueRetryObjects", + "type": "Object", + "label": "type", "isRequired": true, "signature": [ - "string[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + } ], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31 } } ], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31 } }, { - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", + "id": "def-server.SavedObjectTypeRegistry.getType", "type": "Function", - "label": "nonUniqueRetryDestinations", + "label": "getType", "signature": [ - "typeof ", + "(type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ".nonUniqueRetryDestinations" + " | undefined" + ], + "description": [ + "\nReturn the {@link SavedObjectsType | type} definition for given type name." ], - "description": [], "children": [ { - "type": "Array", - "label": "nonUniqueRetryDestinations", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "string[]" + "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42 } } ], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42 } }, { - "id": "def-server.SavedObjectsImportError.referencesFetchError", + "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", "type": "Function", - "label": "referencesFetchError", + "label": "getVisibleTypes", "signature": [ - "typeof ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ".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" - } - } + "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/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" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 51 } }, { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, + "id": "def-server.SavedObjectTypeRegistry.getAllTypes", + "type": "Function", + "label": "getAllTypes", "signature": [ + "() => ", { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - " | undefined" - ] - }, - { - "tags": [ - "remarks" - ], - "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" - ] - }, - { - "tags": [], - "id": "def-server.SavedObjectsBulkCreateObject.originId", - "type": "string", - "label": "originId", "description": [ - "Optional ID of the original saved object, if this object's `id` was regenerated" + "\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." ], - "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" - ] - }, - { + "children": [], "tags": [], - "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." - ], + "returnComment": [], "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" - ], - "tags": [ - "public" - ], - "children": [ + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 60 + } + }, { + "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": [], - "id": "def-server.SavedObjectsBulkGetObject.id", - "type": "string", - "label": "id", - "description": [], + "returnComment": [], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 67 } }, { + "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 + } + } + ], "tags": [], - "id": "def-server.SavedObjectsBulkGetObject.type", - "type": "string", - "label": "type", - "description": [], + "returnComment": [], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75 } }, { - "tags": [], - "id": "def-server.SavedObjectsBulkGetObject.fields", - "type": "Array", - "label": "fields", + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", + "type": "Function", + "label": "isSingleNamespace", + "signature": [ + "(type: string) => boolean" + ], "description": [ - "SavedObject fields to include in the response" + "\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 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83 + } }, - " extends Pick<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92 + } }, - ", \"version\" | \"references\">" - ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], - "children": [ { - "tags": [], - "id": "def-server.SavedObjectsBulkUpdateObject.id", - "type": "string", - "label": "id", + "id": "def-server.SavedObjectTypeRegistry.isShareable", + "type": "Function", + "label": "isShareable", + "signature": [ + "(type: string) => boolean" + ], "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + "\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 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101 } }, { - "tags": [], - "id": "def-server.SavedObjectsBulkUpdateObject.type", - "type": "string", - "label": "type", + "id": "def-server.SavedObjectTypeRegistry.isHidden", + "type": "Function", + "label": "isHidden", + "signature": [ + "(type: string) => boolean" + ], "description": [ - " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." + "\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 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109 } }, { - "tags": [], - "id": "def-server.SavedObjectsBulkUpdateObject.attributes", - "type": "Object", - "label": "attributes", + "id": "def-server.SavedObjectTypeRegistry.getIndex", + "type": "Function", + "label": "getIndex", + "signature": [ + "(type: string) => string | undefined" + ], "description": [ - "{@inheritdoc SavedObjectAttributes}" + "\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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117 + } }, { - "tags": [], - "id": "def-server.SavedObjectsBulkUpdateObject.namespace", - "type": "string", - "label": "namespace", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "type": "Function", + "label": "isImportableAndExportable", + "signature": [ + "(type: string) => boolean" + ], "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`." + "\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 + } + } ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125 + } } ], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 24 }, "initialIsOpen": false - }, + } + ], + "functions": [], + "interfaces": [ { - "id": "def-server.SavedObjectsBulkUpdateOptions", + "id": "def-server.SavedObjectExportBaseOptions", "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" - ], + "label": "SavedObjectExportBaseOptions", + "description": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", - "type": "CompoundType", - "label": "refresh", + "id": "def-server.SavedObjectExportBaseOptions.request", + "type": "Object", + "label": "request", "description": [ - "The Elasticsearch Refresh setting for this operation" + "The http request initiating the export." ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 15 }, "signature": [ - "boolean | \"wait_for\" | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" ] - } - ], - "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" - ], - "tags": [ - "public" - ], - "children": [ { "tags": [], - "id": "def-server.SavedObjectsBulkResponse.saved_objects", - "type": "Array", - "label": "saved_objects", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 17 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "[]" + "boolean | undefined" ] - } - ], - "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" + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] }, - "" - ], - "description": [ - "\n" - ], - "tags": [ - "public" - ], - "children": [ { "tags": [], - "id": "def-server.SavedObjectsBulkResponse.saved_objects", - "type": "Array", - "label": "saved_objects", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 21 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "[]" + "string | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsBulkUpdateResponse", + "id": "def-server.SavedObjectMigrationContext", "type": "Interface", - "label": "SavedObjectsBulkUpdateResponse", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - "" - ], + "label": "SavedObjectMigrationContext", "description": [ - "\n" + "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" ], "tags": [ "public" @@ -8560,125 +7717,117 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", - "type": "Array", - "label": "saved_objects", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 59 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - "[]" + "section": "def-server.SavedObjectsMigrationLogger", + "text": "SavedObjectsMigrationLogger" + } ] - } - ], - "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" - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsCheckConflictsObject.id", + "id": "def-server.SavedObjectMigrationContext.migrationVersion", "type": "string", - "label": "id", - "description": [], + "label": "migrationVersion", + "description": [ + "\nThe migration version that this migration function is defined for" + ], "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" + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 63 } }, { "tags": [], - "id": "def-server.SavedObjectsCheckConflictsObject.type", + "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", "type": "string", - "label": "type", - "description": [], + "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/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" - } + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 67 + }, + "signature": [ + "string | undefined" + ] } ], "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" + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 55 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsCheckConflictsResponse", + "id": "def-server.SavedObjectMigrationMap", "type": "Interface", - "label": "SavedObjectsCheckConflictsResponse", + "label": "SavedObjectMigrationMap", "description": [ - "\n" + "\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" ], "tags": [ "public" ], "children": [ { + "id": "def-server.SavedObjectMigrationMap.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 88 }, "signature": [ - "{ id: string; type: string; error: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, - "; }[]" + "any" ] } ], "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" + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 87 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsClientProviderOptions", + "id": "def-server.SavedObjectsAddToNamespacesOptions", "type": "Interface", - "label": "SavedObjectsClientProviderOptions", + "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": [ - "\nOptions to control the creation of the Saved Objects Client." + "\n" ], "tags": [ "public" @@ -8686,48 +7835,49 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", - "type": "Array", - "label": "excludedWrappers", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 219 }, "signature": [ - "string[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", - "type": "Array", - "label": "includedHiddenTypes", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 221 }, "signature": [ - "string[] | undefined" + "boolean | \"wait_for\" | 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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 217 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsClientWrapperOptions", + "id": "def-server.SavedObjectsAddToNamespacesResponse", "type": "Interface", - "label": "SavedObjectsClientWrapperOptions", + "label": "SavedObjectsAddToNamespacesResponse", "description": [ - "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." + "\n" ], "tags": [ "public" @@ -8735,145 +7885,74 @@ "children": [ { "tags": [], - "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\">" - ] - }, - { - "tags": [], - "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\">" - ] - }, - { - "tags": [], - "id": "def-server.SavedObjectsClientWrapperOptions.request", - "type": "Object", - "label": "request", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 230 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "string[]" ] } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 228 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsClosePointInTimeResponse", + "id": "def-server.SavedObjectsBaseOptions", "type": "Interface", - "label": "SavedObjectsClosePointInTimeResponse", - "description": [], + "label": "SavedObjectsBaseOptions", + "description": [ + "\n" + ], "tags": [ "public" ], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", - "type": "number", - "label": "num_freed", + "id": "def-server.SavedObjectsBaseOptions.namespace", + "type": "string", + "label": "namespace", "description": [ - "\nThe number of search contexts that have been successfully closed." + "Specify the namespace for this operation" ], "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" - } + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 141 + }, + "signature": [ + "string | undefined" + ] } ], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 139 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsCreateOptions", + "id": "def-server.SavedObjectsBulkCreateObject", "type": "Interface", - "label": "SavedObjectsCreateOptions", + "label": "SavedObjectsBulkCreateObject", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "" ], "description": [ "\n" @@ -8884,16 +7963,13 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.id", + "id": "def-server.SavedObjectsBulkCreateObject.id", "type": "string", "label": "id", - "description": [ - "(not recommended) Specify an id for the document" - ], + "description": [], "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" + "lineNumber": 66 }, "signature": [ "string | undefined" @@ -8901,41 +7977,67 @@ }, { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.overwrite", - "type": "CompoundType", - "label": "overwrite", - "description": [ - "Overwrite existing documents (defaults to false)" - ], + "id": "def-server.SavedObjectsBulkCreateObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 67 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [], "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" + "lineNumber": 68 }, "signature": [ - "boolean | undefined" + "T" ] }, { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.version", + "id": "def-server.SavedObjectsBulkCreateObject.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." - ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 69 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.references", + "type": "Array", + "label": "references", + "description": [], "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" + "lineNumber": 70 }, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.migrationVersion", + "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", "type": "Object", "label": "migrationVersion", "description": [ @@ -8943,8 +8045,7 @@ ], "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" + "lineNumber": 72 }, "signature": [ { @@ -8958,10 +8059,8 @@ ] }, { - "tags": [ - "remarks" - ], - "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", + "tags": [], + "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", "type": "string", "label": "coreMigrationVersion", "description": [ @@ -8969,8 +8068,7 @@ ], "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" + "lineNumber": 82 }, "signature": [ "string | undefined" @@ -8978,91 +8076,164 @@ }, { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.references", - "type": "Array", - "label": "references", - "description": [], + "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": 47, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L47" + "lineNumber": 84 }, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, - "[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.refresh", - "type": "CompoundType", - "label": "refresh", + "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", + "type": "Array", + "label": "initialNamespaces", "description": [ - "The Elasticsearch Refresh setting for this operation" + "\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": 49, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L49" + "lineNumber": 91 }, "signature": [ - "boolean | \"wait_for\" | undefined" + "string[] | undefined" ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 65 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsBulkGetObject", + "type": "Interface", + "label": "SavedObjectsBulkGetObject", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkGetObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 294 + } }, { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.originId", + "id": "def-server.SavedObjectsBulkGetObject.type", "type": "string", - "label": "originId", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 295 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsBulkGetObject.fields", + "type": "Array", + "label": "fields", "description": [ - "Optional ID of the original saved object, if this object's `id` was regenerated" + "SavedObject fields to include in the response" ], "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" + "lineNumber": 297 }, "signature": [ - "string | undefined" + "string[] | undefined" ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 293 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", + "id": "def-server.SavedObjectsBulkResponse.saved_objects", "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." - ], + "label": "saved_objects", + "description": [], "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" + "lineNumber": 120 }, "signature": [ - "string[] | undefined" + { + "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": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L25" + "lineNumber": 119 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsExportResultDetails", + "id": "def-server.SavedObjectsBulkResponse", "type": "Interface", - "label": "SavedObjectsExportResultDetails", + "label": "SavedObjectsBulkResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + "" + ], "description": [ - "\nStructure of the export result details entry" + "\n" ], "tags": [ "public" @@ -9070,72 +8241,146 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsExportResultDetails.exportedCount", - "type": "number", - "label": "exportedCount", + "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 + }, + "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 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsBulkUpdateObject.id", + "type": "string", + "label": "id", "description": [ - "number of successfully exported objects" + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 101 } }, { "tags": [], - "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", - "type": "number", - "label": "missingRefCount", + "id": "def-server.SavedObjectsBulkUpdateObject.type", + "type": "string", + "label": "type", "description": [ - "number of missing references" + " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 103 } }, { "tags": [], - "id": "def-server.SavedObjectsExportResultDetails.missingReferences", - "type": "Array", - "label": "missingReferences", + "id": "def-server.SavedObjectsBulkUpdateObject.attributes", + "type": "Object", + "label": "attributes", "description": [ - "missing references details" + "{@inheritdoc SavedObjectAttributes}" + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 105 + }, + "signature": [ + "Partial" + ] + }, + { + "tags": [], + "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/export/types.ts", - "lineNumber": 63, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L63" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 112 }, "signature": [ - "{ id: string; type: string; }[]" + "string | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 98 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsFindResult", + "id": "def-server.SavedObjectsBulkUpdateOptions", "type": "Interface", - "label": "SavedObjectsFindResult", + "label": "SavedObjectsBulkUpdateOptions", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResult", - "text": "SavedObjectsFindResult" + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" }, - " extends ", - "SavedObject", - "" + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } ], "description": [ "\n" @@ -9146,62 +8391,43 @@ "children": [ { "tags": [], - "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" - } - }, - { - "tags": [ - "remarks", - "example" - ], - "id": "def-server.SavedObjectsFindResult.sort", - "type": "Array", - "label": "sort", + "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", + "type": "CompoundType", + "label": "refresh", "description": [ - "\nThe Elasticsearch `sort` value of this result.\n" + "The Elasticsearch Refresh setting for this operation" ], "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" + "lineNumber": 275 }, "signature": [ - "unknown[] | undefined" + "boolean | \"wait_for\" | 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" + "lineNumber": 273 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsFindResponse", + "id": "def-server.SavedObjectsBulkUpdateResponse", "type": "Interface", - "label": "SavedObjectsFindResponse", + "label": "SavedObjectsBulkUpdateResponse", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" }, "" ], "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" + "\n" ], "tags": [ "public" @@ -9209,91 +8435,118 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsFindResponse.saved_objects", + "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": 172, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L172" + "lineNumber": 313 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResult", - "text": "SavedObjectsFindResult" + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" }, "[]" ] - }, - { - "tags": [], - "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" - } - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 312 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsCheckConflictsObject", + "type": "Interface", + "label": "SavedObjectsCheckConflictsObject", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsFindResponse.per_page", - "type": "number", - "label": "per_page", + "id": "def-server.SavedObjectsCheckConflictsObject.id", + "type": "string", + "label": "id", "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" + "lineNumber": 184 } }, { "tags": [], - "id": "def-server.SavedObjectsFindResponse.page", - "type": "number", - "label": "page", + "id": "def-server.SavedObjectsCheckConflictsObject.type", + "type": "string", + "label": "type", "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" + "lineNumber": 185 } - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 183 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsCheckConflictsResponse", + "type": "Interface", + "label": "SavedObjectsCheckConflictsResponse", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsFindResponse.pit_id", - "type": "string", - "label": "pit_id", + "id": "def-server.SavedObjectsCheckConflictsResponse.errors", + "type": "Array", + "label": "errors", "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" + "lineNumber": 193 }, "signature": [ - "string | undefined" + "{ 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": 171, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L171" + "lineNumber": 192 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportConflictError", + "id": "def-server.SavedObjectsClientProviderOptions", "type": "Interface", - "label": "SavedObjectsImportConflictError", + "label": "SavedObjectsClientProviderOptions", "description": [ - "\nRepresents a failure to import due to a conflict." + "\nOptions to control the creation of the Saved Objects Client." ], "tags": [ "public" @@ -9301,48 +8554,45 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportConflictError.type", - "type": "string", - "label": "type", + "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", + "type": "Array", + "label": "excludedWrappers", "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 58 }, "signature": [ - "\"conflict\"" + "string[] | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportConflictError.destinationId", - "type": "string", - "label": "destinationId", + "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", + "type": "Array", + "label": "includedHiddenTypes", "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 59 }, "signature": [ - "string | undefined" + "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 57 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportAmbiguousConflictError", + "id": "def-server.SavedObjectsClientWrapperOptions", "type": "Interface", - "label": "SavedObjectsImportAmbiguousConflictError", + "label": "SavedObjectsClientWrapperOptions", "description": [ - "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." + "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." ], "tags": [ "public" @@ -9350,48 +8600,124 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", - "type": "string", - "label": "type", + "id": "def-server.SavedObjectsClientWrapperOptions.client", + "type": "Object", + "label": "client", "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 20 }, "signature": [ - "\"ambiguous_conflict\"" + "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\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", - "type": "Array", - "label": "destinations", - "description": [], + "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 + }, + "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\">" + ] + }, + { + "tags": [], + "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 + }, + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsClosePointInTimeResponse", + "type": "Interface", + "label": "SavedObjectsClosePointInTimeResponse", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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/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; }[]" - ] + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 389 + } } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 380 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportFailure", + "id": "def-server.SavedObjectsComplexFieldMapping", "type": "Interface", - "label": "SavedObjectsImportFailure", + "label": "SavedObjectsComplexFieldMapping", "description": [ - "\nRepresents a failure to import." + "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" ], "tags": [ "public" @@ -9399,144 +8725,95 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportFailure.id", - "type": "string", - "label": "id", - "description": [], + "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/import/types.ts", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L90" - } + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 150 + }, + "signature": [ + "false | \"strict\" | undefined" + ] }, { "tags": [], - "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" - } - }, - { - "tags": [ - "deprecated" - ], - "id": "def-server.SavedObjectsImportFailure.title", - "type": "string", - "label": "title", + "id": "def-server.SavedObjectsComplexFieldMapping.enabled", + "type": "CompoundType", + "label": "enabled", "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 151 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportFailure.meta", - "type": "Object", - "label": "meta", + "id": "def-server.SavedObjectsComplexFieldMapping.doc_values", + "type": "CompoundType", + "label": "doc_values", "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 152 }, "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportFailure.overwrite", - "type": "CompoundType", - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." - ], + "id": "def-server.SavedObjectsComplexFieldMapping.type", + "type": "string", + "label": "type", + "description": [], "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 153 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportFailure.error", - "type": "CompoundType", - "label": "error", + "id": "def-server.SavedObjectsComplexFieldMapping.properties", + "type": "Object", + "label": "properties", "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 154 }, "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" + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" } ] } ], "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 141 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportMissingReferencesError", + "id": "def-server.SavedObjectsCoreFieldMapping", "type": "Interface", - "label": "SavedObjectsImportMissingReferencesError", + "label": "SavedObjectsCoreFieldMapping", "description": [ - "\nRepresents a failure to import due to missing references." + "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" ], "tags": [ "public" @@ -9544,129 +8821,101 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportMissingReferencesError.type", + "id": "def-server.SavedObjectsCoreFieldMapping.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\"" - ] + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 124 + } }, { "tags": [], - "id": "def-server.SavedObjectsImportMissingReferencesError.references", - "type": "Array", - "label": "references", + "id": "def-server.SavedObjectsCoreFieldMapping.null_value", + "type": "CompoundType", + "label": "null_value", "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 125 }, "signature": [ - "{ type: string; id: string; }[]" + "string | number | boolean | undefined" ] - } - ], - "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." - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsImportOptions.readStream", - "type": "Object", - "label": "readStream", - "description": [ - "The stream of {@link SavedObject | saved objects} to import" - ], + "id": "def-server.SavedObjectsCoreFieldMapping.index", + "type": "CompoundType", + "label": "index", + "description": [], "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 126 }, "signature": [ - "Readable" + "boolean | undefined" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-server.SavedObjectsImportOptions.namespace", - "type": "string", - "label": "namespace", - "description": [ - "if specified, will import in given namespace, else will import as global object" - ], + "id": "def-server.SavedObjectsCoreFieldMapping.doc_values", + "type": "CompoundType", + "label": "doc_values", + "description": [], "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 127 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "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`." - ], + "id": "def-server.SavedObjectsCoreFieldMapping.fields", + "type": "Object", + "label": "fields", + "description": [], "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" - } + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 128 + }, + "signature": [ + "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" + ] } ], "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 123 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportResponse", + "id": "def-server.SavedObjectsCreateOptions", "type": "Interface", - "label": "SavedObjectsImportResponse", + "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": [ - "\nThe response describing the result of an import." + "\n" ], "tags": [ "public" @@ -9674,161 +8923,139 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportResponse.success", - "type": "boolean", - "label": "success", - "description": [], + "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/import/types.ts", - "lineNumber": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L142" - } + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 27 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-server.SavedObjectsImportResponse.successCount", - "type": "number", - "label": "successCount", - "description": [], + "id": "def-server.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "label": "overwrite", + "description": [ + "Overwrite existing documents (defaults to false)" + ], "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" - } + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 29 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-server.SavedObjectsImportResponse.successResults", - "type": "Array", - "label": "successResults", - "description": [], + "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/import/types.ts", - "lineNumber": 144, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L144" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 34 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, - "[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportResponse.warnings", - "type": "Array", - "label": "warnings", - "description": [], + "id": "def-server.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 36 }, "signature": [ { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" }, - "[]" + " | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportResponse.errors", + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsCreateOptions.references", "type": "Array", - "label": "errors", + "label": "references", "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 47 }, "signature": [ { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportFailure", - "text": "SavedObjectsImportFailure" + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" }, "[] | 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." - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } }, { "tags": [], - "id": "def-server.SavedObjectsImportRetry.overwrite", - "type": "boolean", - "label": "overwrite", - "description": [], + "id": "def-server.SavedObjectsCreateOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], "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" - } + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 49 + }, + "signature": [ + "boolean | \"wait_for\" | undefined" + ] }, { "tags": [], - "id": "def-server.SavedObjectsImportRetry.destinationId", + "id": "def-server.SavedObjectsCreateOptions.originId", "type": "string", - "label": "destinationId", + "label": "originId", "description": [ - "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + "Optional ID of the original saved object, if this object's `id` was regenerated" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 51 }, "signature": [ "string | undefined" @@ -9836,67 +9063,135 @@ }, { "tags": [], - "id": "def-server.SavedObjectsImportRetry.replaceReferences", + "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", "type": "Array", - "label": "replaceReferences", - "description": [], + "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/import/types.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L24" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 58 }, "signature": [ - "{ type: string; from: string; to: string; }[]" + "string[] | undefined" ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 25 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportRetry.createNewCopy", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", "type": "CompoundType", - "label": "createNewCopy", + "label": "refresh", "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." + "The Elasticsearch supports only boolean flag for this operation" ], "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" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 118 }, "signature": [ "boolean | undefined" ] + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 116 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", + "id": "def-server.SavedObjectsDeleteFromNamespacesOptions.refresh", "type": "CompoundType", - "label": "ignoreMissingReferences", + "label": "refresh", "description": [ - "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + "The Elasticsearch Refresh setting for this operation" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 239 }, "signature": [ - "boolean | undefined" + "boolean | \"wait_for\" | 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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 237 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportSuccess", + "id": "def-server.SavedObjectsDeleteFromNamespacesResponse", "type": "Interface", - "label": "SavedObjectsImportSuccess", + "label": "SavedObjectsDeleteFromNamespacesResponse", "description": [ - "\nRepresents a successful import." + "\n" ], "tags": [ "public" @@ -9904,89 +9199,82 @@ "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-server.SavedObjectsImportSuccess.destinationId", - "type": "string", - "label": "destinationId", + "id": "def-server.SavedObjectsDeleteFromNamespacesResponse.namespaces", + "type": "Array", + "label": "namespaces", "description": [ - "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." + "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/import/types.ts", - "lineNumber": 119, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L119" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 248 }, "signature": [ - "string | undefined" + "string[]" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 246 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsDeleteOptions", + "type": "Interface", + "label": "SavedObjectsDeleteOptions", + "signature": [ { - "tags": [ - "deprecated" - ], - "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" - ] + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportSuccess.meta", - "type": "Object", - "label": "meta", - "description": [], + "id": "def-server.SavedObjectsDeleteOptions.refresh", + "type": "CompoundType", + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 284 }, "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" + "boolean | \"wait_for\" | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsImportSuccess.overwrite", + "id": "def-server.SavedObjectsDeleteOptions.force", "type": "CompoundType", - "label": "overwrite", + "label": "force", "description": [ - "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + "Force deletion of an object that exists in multiple namespaces" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 286 }, "signature": [ "boolean | undefined" @@ -9994,18 +9282,34 @@ } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 282 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportUnknownError", + "id": "def-server.SavedObjectsExportByObjectOptions", "type": "Interface", - "label": "SavedObjectsImportUnknownError", + "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": [ - "\nRepresents a failure to import due to an unknown reason." + "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" ], "tags": [ "public" @@ -10013,57 +9317,50 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportUnknownError.type", - "type": "string", - "label": "type", - "description": [], + "id": "def-server.SavedObjectsExportByObjectOptions.objects", + "type": "Array", + "label": "objects", + "description": [ + "optional array of objects to export." + ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 45 }, "signature": [ - "\"unknown\"" + "{ id: string; type: string; }[]" ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 43 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportUnsupportedTypeError", + "id": "def-server.SavedObjectsExportByTypeOptions", "type": "Interface", - "label": "SavedObjectsImportUnsupportedTypeError", + "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": [ - "\nRepresents a failure to import due to having an unsupported saved object type." + "\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n" ], "tags": [ "public" @@ -10071,33 +9368,72 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", + "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 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsExportByTypeOptions.search", "type": "string", - "label": "type", - "description": [], + "label": "search", + "description": [ + "optional query string to filter exported objects." + ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 35 }, "signature": [ - "\"unsupported_type\"" + "string | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectMigrationContext", + "id": "def-server.SavedObjectsExportResultDetails", "type": "Interface", - "label": "SavedObjectMigrationContext", + "label": "SavedObjectsExportResultDetails", "description": [ - "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" + "\nStructure of the export result details entry" ], "tags": [ "public" @@ -10105,200 +9441,156 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectMigrationContext.log", - "type": "Object", - "label": "log", + "id": "def-server.SavedObjectsExportResultDetails.exportedCount", + "type": "number", + "label": "exportedCount", "description": [ - "\nlogger instance to be used by the migration handler" + "number of successfully exported objects" ], "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" - } - ] + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 59 + } }, { "tags": [], - "id": "def-server.SavedObjectMigrationContext.migrationVersion", - "type": "string", - "label": "migrationVersion", + "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", + "type": "number", + "label": "missingRefCount", "description": [ - "\nThe migration version that this migration function is defined for" + "number of missing references" ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 61 } }, { "tags": [], - "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", - "type": "string", - "label": "convertToMultiNamespaceTypeVersion", + "id": "def-server.SavedObjectsExportResultDetails.missingReferences", + "type": "Array", + "label": "missingReferences", "description": [ - "\nThe version in which this object type is being converted to a multi-namespace type" + "missing references details" ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 63 }, "signature": [ - "string | undefined" + "{ id: string; type: string; }[]" ] } ], "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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 57 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsMigrationLogger", + "id": "def-server.SavedObjectsExportTransformContext", "type": "Interface", - "label": "SavedObjectsMigrationLogger", - "description": [], + "label": "SavedObjectsExportTransformContext", + "description": [ + "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" + ], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsMigrationLogger.debug", - "type": "Function", - "label": "debug", - "description": [], + "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/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" + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 81 }, "signature": [ - "(msg: string) => void" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/export/types.ts", + "lineNumber": 76 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFindOptions", + "type": "Interface", + "label": "SavedObjectsFindOptions", + "description": [ + "\n" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [ - "deprecated" - ], - "id": "def-server.SavedObjectsMigrationLogger.warning", - "type": "Function", - "label": "warning", + "id": "def-server.SavedObjectsFindOptions.type", + "type": "CompoundType", + "label": "type", "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 78 }, "signature": [ - "(msg: string) => void" + "string | string[]" ] }, { "tags": [], - "id": "def-server.SavedObjectsMigrationLogger.warn", - "type": "Function", - "label": "warn", + "id": "def-server.SavedObjectsFindOptions.page", + "type": "number", + "label": "page", "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 79 }, "signature": [ - "(msg: string) => void" + "number | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsMigrationLogger.error", - "type": "Function", - "label": "error", + "id": "def-server.SavedObjectsFindOptions.perPage", + "type": "number", + "label": "perPage", "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 80 }, "signature": [ - "(msg: string, meta: ", - "LogMeta", - ") => void" + "number | undefined" ] - } - ], - "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": [], - "tags": [ - "public" - ], - "children": [ { "tags": [], - "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", + "id": "def-server.SavedObjectsFindOptions.sortField", "type": "string", - "label": "keepAlive", - "description": [ - "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." - ], + "label": "sortField", + "description": [], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 81 }, "signature": [ "string | undefined" @@ -10306,362 +9598,305 @@ }, { "tags": [], - "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "id": "def-server.SavedObjectsFindOptions.sortOrder", "type": "string", - "label": "preference", - "description": [ - "\nAn optional ES preference value to be used for the query." - ], + "label": "sortOrder", + "description": [], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 82 }, "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": [], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", - "type": "string", - "label": "id", + "id": "def-server.SavedObjectsFindOptions.fields", + "type": "Array", + "label": "fields", "description": [ - "\nPIT ID returned from ES." + "\nAn array of fields to include in the results" ], "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" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - } + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 88 + }, + "signature": [ + "string[] | undefined" + ] }, { "tags": [], - "id": "def-server.SavedObjectsRawDoc._source", - "type": "Object", - "label": "_source", - "description": [], + "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/serialization/types.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L18" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 90 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocSource", - "text": "SavedObjectsRawDocSource" - } + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsRawDoc._seq_no", - "type": "number", - "label": "_seq_no", - "description": [], + "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/serialization/types.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L19" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 92 }, "signature": [ - "number | undefined" + "string[] | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsRawDoc._primary_term", - "type": "number", - "label": "_primary_term", - "description": [], + "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/serialization/types.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L20" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 96 }, "signature": [ - "number | undefined" + "unknown[] | 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" - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", - "type": "CompoundType", - "label": "namespaceTreatment", + "id": "def-server.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", + "label": "rootSearchFields", "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`." + "\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/serialization/types.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L86" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 101 }, "signature": [ - "\"strict\" | \"lax\" | undefined" + "string[] | 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" - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", - "type": "Function", - "label": "createScopedRepository", + "id": "def-server.SavedObjectsFindOptions.hasReference", + "type": "CompoundType", + "label": "hasReference", "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" + "\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/saved_objects_service.ts", - "lineNumber": 234, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L234" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 107 }, "signature": [ - "(req: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" }, - ", includedHiddenTypes?: string[] | undefined) => Pick<", + " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRepository", - "text": "SavedObjectsRepository" + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" + "[] | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", - "type": "Function", - "label": "createInternalRepository", + "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", + "label": "hasReferenceOperator", "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" ], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 111 }, "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\">" + "\"AND\" | \"OR\" | undefined" ] - } - ], - "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." - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", - "type": "Object", - "label": "readStream", + "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", + "label": "defaultSearchOperator", "description": [ - "The stream of {@link SavedObject | saved objects} to resolve errors from" + "\nThe search operator to use with the provided filter. Defaults to `OR`" ], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 116 }, "signature": [ - "Readable" + "\"AND\" | \"OR\" | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", + "id": "def-server.SavedObjectsFindOptions.filter", + "type": "Any", + "label": "filter", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 117 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.namespaces", "type": "Array", - "label": "retries", + "label": "namespaces", + "description": [], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 118 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "label": "typeToNamespacesMap", "description": [ - "saved object import references to retry" + "\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/import/types.ts", - "lineNumber": 172, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L172" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 126 + }, + "signature": [ + "Map | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportRetry", - "text": "SavedObjectsImportRetry" + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" }, - "[]" + " | undefined" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 77 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsFindOptionsReference", + "type": "Interface", + "label": "SavedObjectsFindOptionsReference", + "description": [], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", + "id": "def-server.SavedObjectsFindOptionsReference.type", "type": "string", - "label": "namespace", - "description": [ - "if specified, will import in given namespace" - ], + "label": "type", + "description": [], "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" - ] + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 61 + } }, { "tags": [], - "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`." - ], + "id": "def-server.SavedObjectsFindOptionsReference.id", + "type": "string", + "label": "id", + "description": [], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 62 } } ], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 60 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsResolveResponse", + "id": "def-server.SavedObjectsFindResponse", "type": "Interface", - "label": "SavedObjectsResolveResponse", + "label": "SavedObjectsFindResponse", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, "" ], "description": [ - "\n" + "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" ], "tags": [ "public" @@ -10669,55 +9904,67 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsResolveResponse.saved_object", - "type": "Object", - "label": "saved_object", + "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": 331, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L331" + "lineNumber": 172 }, "signature": [ { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" }, - "" + "[]" ] }, { "tags": [], - "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." - ], + "id": "def-server.SavedObjectsFindResponse.total", + "type": "number", + "label": "total", + "description": [], "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\"" - ] + "lineNumber": 173 + } }, { "tags": [], - "id": "def-server.SavedObjectsResolveResponse.aliasTargetId", + "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 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.page", + "type": "number", + "label": "page", + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 175 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsFindResponse.pit_id", "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'`." - ], + "label": "pit_id", + "description": [], "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" + "lineNumber": 176 }, "signature": [ "string | undefined" @@ -10726,31 +9973,25 @@ ], "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" + "lineNumber": 171 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsUpdateOptions", + "id": "def-server.SavedObjectsFindResult", "type": "Interface", - "label": "SavedObjectsUpdateOptions", + "label": "SavedObjectsFindResult", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + " extends ", + "SavedObject", + "" ], "description": [ "\n" @@ -10761,88 +10002,46 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsUpdateOptions.version", - "type": "string", - "label": "version", + "id": "def-server.SavedObjectsFindResult.score", + "type": "number", + "label": "score", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + "\nThe Elasticsearch `_score` of this result." ], "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" - ] + "lineNumber": 131 + } }, { "tags": [], - "id": "def-server.SavedObjectsUpdateOptions.references", + "id": "def-server.SavedObjectsFindResult.sort", "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" - ] - }, - { - "tags": [], - "id": "def-server.SavedObjectsUpdateOptions.refresh", - "type": "CompoundType", - "label": "refresh", + "label": "sort", "description": [ - "The Elasticsearch Refresh setting for this operation" + "\nThe Elasticsearch `sort` value of this result.\n" ], "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" + "lineNumber": 160 }, "signature": [ - "boolean | \"wait_for\" | undefined" + "unknown[] | 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" + "lineNumber": 127 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsUpdateResponse", + "id": "def-server.SavedObjectsImportActionRequiredWarning", "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\">" - ], + "label": "SavedObjectsImportActionRequiredWarning", "description": [ - "\n" + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" ], "tags": [ "public" @@ -10850,125 +10049,73 @@ "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-server.SavedObjectsUpdateResponse.references", - "type": "Array", - "label": "references", + "id": "def-server.SavedObjectsImportActionRequiredWarning.type", + "type": "string", + "label": "type", "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 201 }, "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" - ], - "tags": [ - "public" - ], - "children": [ + "\"action_required\"" + ] + }, { "tags": [], - "id": "def-server.SavedObjectsAddToNamespacesOptions.version", + "id": "def-server.SavedObjectsImportActionRequiredWarning.message", "type": "string", - "label": "version", + "label": "message", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + "The translated message to display to the user." ], "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" - ] + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 203 + } }, { "tags": [], - "id": "def-server.SavedObjectsAddToNamespacesOptions.refresh", - "type": "CompoundType", - "label": "refresh", + "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "label": "actionPath", "description": [ - "The Elasticsearch Refresh setting for this operation" + "The path (without the basePath) that the user should be redirect to to address this warning." ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 205 + } + }, + { + "tags": [], + "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 }, "signature": [ - "boolean | \"wait_for\" | undefined" + "string | 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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 200 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsAddToNamespacesResponse", + "id": "def-server.SavedObjectsImportAmbiguousConflictError", "type": "Interface", - "label": "SavedObjectsAddToNamespacesResponse", + "label": "SavedObjectsImportAmbiguousConflictError", "description": [ - "\n" + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], "tags": [ "public" @@ -10976,52 +10123,45 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsAddToNamespacesResponse.namespaces", + "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 54 + }, + "signature": [ + "\"ambiguous_conflict\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", "type": "Array", - "label": "namespaces", - "description": [ - "The namespaces the object exists in after this operation is complete." - ], + "label": "destinations", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 55 }, "signature": [ - "string[]" + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" ] } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 53 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "id": "def-server.SavedObjectsImportConflictError", "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" - } - ], + "label": "SavedObjectsImportConflictError", "description": [ - "\n" + "\nRepresents a failure to import due to a conflict." ], "tags": [ "public" @@ -11029,35 +10169,45 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsDeleteFromNamespacesOptions.refresh", - "type": "CompoundType", - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], + "id": "def-server.SavedObjectsImportConflictError.type", + "type": "string", + "label": "type", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 45 }, "signature": [ - "boolean | \"wait_for\" | undefined" + "\"conflict\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportConflictError.destinationId", + "type": "string", + "label": "destinationId", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 46 + }, + "signature": [ + "string | 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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 44 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsDeleteFromNamespacesResponse", + "id": "def-server.SavedObjectsImportFailure", "type": "Interface", - "label": "SavedObjectsDeleteFromNamespacesResponse", + "label": "SavedObjectsImportFailure", "description": [ - "\n" + "\nRepresents a failure to import." ], "tags": [ "public" @@ -11065,52 +10215,137 @@ "children": [ { "tags": [], - "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." + "id": "def-server.SavedObjectsImportFailure.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 90 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 91 + } + }, + { + "tags": [ + "deprecated" ], + "id": "def-server.SavedObjectsImportFailure.title", + "type": "string", + "label": "title", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 95 }, "signature": [ - "string[]" + "string | undefined" ] - } - ], - "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" + "tags": [], + "id": "def-server.SavedObjectsImportFailure.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 96 + }, + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ] }, - " extends ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportFailure.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 101 + }, + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportHookResult", + "type": "Interface", + "label": "SavedObjectsImportHookResult", "description": [ - "\n" + "\nResult from a {@link SavedObjectsImportHook | import hook}\n" ], "tags": [ "public" @@ -11118,52 +10353,40 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", - "type": "CompoundType", - "label": "refresh", + "id": "def-server.SavedObjectsImportHookResult.warnings", + "type": "Array", + "label": "warnings", "description": [ - "The Elasticsearch Refresh setting for this operation. Defaults to `true`" + "\nAn optional list of warnings to display in the UI when the import succeeds." ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 231 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[] | 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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 227 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsRemoveReferencesToResponse", + "id": "def-server.SavedObjectsImportMissingReferencesError", "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" - } - ], + "label": "SavedObjectsImportMissingReferencesError", "description": [ - "\n" + "\nRepresents a failure to import due to missing references." ], "tags": [ "public" @@ -11171,32 +10394,45 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", - "type": "number", - "label": "updated", - "description": [ - "The number of objects that have been updated by this operation" - ], + "id": "def-server.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "label": "type", + "description": [], "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" - } + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 81 + }, + "signature": [ + "\"missing_references\"" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "label": "references", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 82 + }, + "signature": [ + "{ type: string; id: string; }[]" + ] } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 80 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsServiceStart", + "id": "def-server.SavedObjectsImportOptions", "type": "Interface", - "label": "SavedObjectsServiceStart", + "label": "SavedObjectsImportOptions", "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" + "\nOptions to control the import operation." ], "tags": [ "public" @@ -11204,333 +10440,291 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsServiceStart.getScopedClient", - "type": "Function", - "label": "getScopedClient", + "id": "def-server.SavedObjectsImportOptions.readStream", + "type": "Object", + "label": "readStream", "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}." + "The stream of {@link SavedObject | saved objects} to import" ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 155 }, "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\">" + "Readable" ] }, { - "tags": [ - "remarks" - ], - "id": "def-server.SavedObjectsServiceStart.createScopedRepository", - "type": "Function", - "label": "createScopedRepository", + "tags": [], + "id": "def-server.SavedObjectsImportOptions.overwrite", + "type": "boolean", + "label": "overwrite", "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" + "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/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\">" - ] + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 157 + } }, { "tags": [], - "id": "def-server.SavedObjectsServiceStart.createInternalRepository", - "type": "Function", - "label": "createInternalRepository", + "id": "def-server.SavedObjectsImportOptions.namespace", + "type": "string", + "label": "namespace", "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" + "if specified, will import in given namespace, else will import as global object" ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 159 }, "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\">" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsServiceStart.createSerializer", - "type": "Function", - "label": "createSerializer", + "id": "def-server.SavedObjectsImportOptions.createNewCopies", + "type": "boolean", + "label": "createNewCopies", "description": [ - "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." ], "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" - } - ] + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 161 + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 153 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportResponse", + "type": "Interface", + "label": "SavedObjectsImportResponse", + "description": [ + "\nThe response describing the result of an import." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 142 + } }, { "tags": [], - "id": "def-server.SavedObjectsServiceStart.createExporter", - "type": "Function", - "label": "createExporter", - "description": [ - "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." - ], + "id": "def-server.SavedObjectsImportResponse.successCount", + "type": "number", + "label": "successCount", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 143 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportResponse.successResults", + "type": "Array", + "label": "successResults", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 144 }, "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" + "section": "def-server.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" }, - ", \"exportByTypes\" | \"exportByObjects\">" + "[] | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsServiceStart.createImporter", - "type": "Function", - "label": "createImporter", - "description": [ - "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." - ], + "id": "def-server.SavedObjectsImportResponse.warnings", + "type": "Array", + "label": "warnings", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 145 }, "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" + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" }, - ", \"import\" | \"resolveImportErrors\">" + "[]" ] }, { "tags": [], - "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", - "type": "Function", - "label": "getTypeRegistry", - "description": [ - "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" - ], + "id": "def-server.SavedObjectsImportResponse.errors", + "type": "Array", + "label": "errors", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 146 }, "signature": [ - "() => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeRegistry", - "text": "SavedObjectTypeRegistry" + "section": "def-server.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" }, - ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" + "[] | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 141 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsServiceSetup", + "id": "def-server.SavedObjectsImportRetry", "type": "Interface", - "label": "SavedObjectsServiceSetup", + "label": "SavedObjectsImportRetry", "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" + "\nDescribes a retry operation for importing a saved object." ], "tags": [ - "remarks", - "example", - "example", "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", - "type": "Function", - "label": "setClientFactoryProvider", + "id": "def-server.SavedObjectsImportRetry.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 18 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "label": "overwrite", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.destinationId", + "type": "string", + "label": "destinationId", "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." + "\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/saved_objects_service.ts", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L90" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 23 }, "signature": [ - "(clientFactoryProvider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientFactoryProvider", - "text": "SavedObjectsClientFactoryProvider" - }, - ") => void" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", - "type": "Function", - "label": "addClientWrapper", + "id": "def-server.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "label": "replaceReferences", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 24 + }, + "signature": [ + "{ type: string; from: string; to: string; }[]" + ] + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "label": "createNewCopy", "description": [ - "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." + "\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/saved_objects_service.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L95" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 33 }, "signature": [ - "(priority: number, id: string, factory: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientWrapperFactory", - "text": "SavedObjectsClientWrapperFactory" - }, - ") => void" + "boolean | undefined" ] }, { - "tags": [ - "example" - ], - "id": "def-server.SavedObjectsServiceSetup.registerType", - "type": "Function", - "label": "registerType", + "tags": [], + "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "label": "ignoreMissingReferences", "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" + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 37 }, "signature": [ - "(type: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - ") => void" + "boolean | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 16 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectStatusMeta", + "id": "def-server.SavedObjectsImportSimpleWarning", "type": "Interface", - "label": "SavedObjectStatusMeta", + "label": "SavedObjectsImportSimpleWarning", "description": [ - "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" + "\nA simple informative warning that will be displayed to the user.\n" ], "tags": [ "public" @@ -11538,50 +10732,44 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectStatusMeta.migratedIndices", - "type": "Object", - "label": "migratedIndices", + "id": "def-server.SavedObjectsImportSimpleWarning.type", + "type": "string", + "label": "type", "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 187 }, "signature": [ - "{ [status: string]: number; skipped: number; migrated: number; }" + "\"simple\"" ] + }, + { + "tags": [], + "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 + } } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 186 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsDeleteOptions", + "id": "def-server.SavedObjectsImportSuccess", "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" - } - ], + "label": "SavedObjectsImportSuccess", "description": [ - "\n" + "\nRepresents a successful import." ], "tags": [ "public" @@ -11589,86 +10777,83 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsDeleteOptions.refresh", - "type": "CompoundType", - "label": "refresh", + "id": "def-server.SavedObjectsImportSuccess.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 114 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 115 + } + }, + { + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.destinationId", + "type": "string", + "label": "destinationId", "description": [ - "The Elasticsearch Refresh setting for this operation" + "\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/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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 119 }, "signature": [ - "boolean | \"wait_for\" | undefined" + "string | undefined" ] }, { - "tags": [], - "id": "def-server.SavedObjectsDeleteOptions.force", - "type": "CompoundType", - "label": "force", - "description": [ - "Force deletion of an object that exists in multiple namespaces" + "tags": [ + "deprecated" ], + "id": "def-server.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "label": "createNewCopy", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 126 }, "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" - ], - "tags": [ - "public" - ], - "children": [ + "tags": [], + "id": "def-server.SavedObjectsImportSuccess.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 127 + }, + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ] + }, { "tags": [], - "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", + "id": "def-server.SavedObjectsImportSuccess.overwrite", "type": "CompoundType", - "label": "refresh", + "label": "overwrite", "description": [ - "The Elasticsearch supports only boolean flag for this operation" + "\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/service/lib/repository.ts", - "lineNumber": 118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L118" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 134 }, "signature": [ "boolean | undefined" @@ -11676,101 +10861,94 @@ } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 113 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsIncrementCounterOptions", + "id": "def-server.SavedObjectsImportUnknownError", "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" - } + "label": "SavedObjectsImportUnknownError", + "description": [ + "\nRepresents a failure to import due to an unknown reason." ], - "description": [], "tags": [ "public" ], "children": [ { "tags": [], - "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." - ], + "id": "def-server.SavedObjectsImportUnknownError.type", + "type": "string", + "label": "type", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 71 }, "signature": [ - "boolean | undefined" + "\"unknown\"" ] }, { "tags": [], - "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", - "type": "Object", - "label": "migrationVersion", - "description": [ - "{@link SavedObjectsMigrationVersion}" - ], + "id": "def-server.SavedObjectsImportUnknownError.message", + "type": "string", + "label": "message", + "description": [], "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" - ] + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 72 + } }, { "tags": [], - "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", - "type": "CompoundType", - "label": "refresh", - "description": [ - "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" - ], + "id": "def-server.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "label": "statusCode", + "description": [], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 73 + } + } + ], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 70 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", + "label": "SavedObjectsImportUnsupportedTypeError", + "description": [ + "\nRepresents a failure to import due to having an unsupported saved object type." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 63 }, "signature": [ - "boolean | \"wait_for\" | undefined" + "\"unsupported_type\"" ] } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 62 }, "initialIsOpen": false }, @@ -11793,8 +10971,7 @@ ], "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" + "lineNumber": 135 } }, { @@ -11807,8 +10984,7 @@ ], "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" + "lineNumber": 137 }, "signature": [ "number | undefined" @@ -11817,49 +10993,47 @@ ], "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" + "lineNumber": 133 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsComplexFieldMapping", + "id": "def-server.SavedObjectsIncrementCounterOptions", "type": "Interface", - "label": "SavedObjectsComplexFieldMapping", - "description": [ - "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" + "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": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsComplexFieldMapping.dynamic", + "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", "type": "CompoundType", - "label": "dynamic", + "label": "initialize", "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`." + "\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/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" - ] - }, - { - "tags": [], - "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" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 102 }, "signature": [ "boolean | undefined" @@ -11867,453 +11041,441 @@ }, { "tags": [], - "id": "def-server.SavedObjectsComplexFieldMapping.doc_values", - "type": "CompoundType", - "label": "doc_values", - "description": [], + "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [ + "{@link SavedObjectsMigrationVersion}" + ], "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" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 104 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsComplexFieldMapping.type", - "type": "string", - "label": "type", - "description": [], + "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/mappings/types.ts", - "lineNumber": 153, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L153" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 109 }, "signature": [ - "string | undefined" + "boolean | \"wait_for\" | undefined" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 97 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsMappingProperties", + "type": "Interface", + "label": "SavedObjectsMappingProperties", + "description": [ + "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" + ], + "tags": [ + "public" + ], + "children": [ { + "id": "def-server.SavedObjectsMappingProperties.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "lineNumber": 88 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMappingProperties", - "text": "SavedObjectsMappingProperties" - } + "any" ] } ], "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" + "lineNumber": 87 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsCoreFieldMapping", + "id": "def-server.SavedObjectsMigrationLogger", "type": "Interface", - "label": "SavedObjectsCoreFieldMapping", - "description": [ - "\nSee {@link SavedObjectsFieldMapping} for documentation.\n" - ], + "label": "SavedObjectsMigrationLogger", + "description": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsCoreFieldMapping.type", - "type": "string", - "label": "type", + "id": "def-server.SavedObjectsMigrationLogger.debug", + "type": "Function", + "label": "debug", "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" - } + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 20 + }, + "signature": [ + "(msg: string) => void" + ] }, { "tags": [], - "id": "def-server.SavedObjectsCoreFieldMapping.null_value", - "type": "CompoundType", - "label": "null_value", + "id": "def-server.SavedObjectsMigrationLogger.info", + "type": "Function", + "label": "info", "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" + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 21 }, "signature": [ - "string | number | boolean | undefined" + "(msg: string) => void" ] }, { - "tags": [], - "id": "def-server.SavedObjectsCoreFieldMapping.index", - "type": "CompoundType", - "label": "index", + "tags": [ + "deprecated" + ], + "id": "def-server.SavedObjectsMigrationLogger.warning", + "type": "Function", + "label": "warning", "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" + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 25 }, "signature": [ - "boolean | undefined" + "(msg: string) => void" ] }, { "tags": [], - "id": "def-server.SavedObjectsCoreFieldMapping.doc_values", - "type": "CompoundType", - "label": "doc_values", + "id": "def-server.SavedObjectsMigrationLogger.warn", + "type": "Function", + "label": "warn", "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" + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 26 }, "signature": [ - "boolean | undefined" + "(msg: string) => void" ] }, { "tags": [], - "id": "def-server.SavedObjectsCoreFieldMapping.fields", - "type": "Object", - "label": "fields", + "id": "def-server.SavedObjectsMigrationLogger.error", + "type": "Function", + "label": "error", "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" + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 27 }, "signature": [ - "{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined" + "(msg: string, meta: ", + "LogMeta", + ") => void" ] } ], "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" + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "lineNumber": 19 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsTypeMappingDefinition", + "id": "def-server.SavedObjectsOpenPointInTimeOptions", "type": "Interface", - "label": "SavedObjectsTypeMappingDefinition", - "description": [ - "\nDescribe a saved object type mapping.\n" + "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": [], "tags": [ - "example", "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", - "type": "CompoundType", - "label": "dynamic", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", + "type": "string", + "label": "keepAlive", "description": [ - "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." + "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 355 }, "signature": [ - "false | \"strict\" | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsTypeMappingDefinition.properties", - "type": "Object", - "label": "properties", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "type": "string", + "label": "preference", "description": [ - "The underlying properties of the type mapping" + "\nAn optional ES preference value to be used for the query." ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 359 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMappingProperties", - "text": "SavedObjectsMappingProperties" - } + "string | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 351 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsMappingProperties", + "id": "def-server.SavedObjectsOpenPointInTimeResponse", "type": "Interface", - "label": "SavedObjectsMappingProperties", - "description": [ - "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" - ], + "label": "SavedObjectsOpenPointInTimeResponse", + "description": [], "tags": [ "public" ], "children": [ { - "id": "def-server.SavedObjectsMappingProperties.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], - "description": [], + "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", + "type": "string", + "label": "id", + "description": [ + "\nPIT ID returned from ES." + ], "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" - ] + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 369 + } } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 365 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsType", + "id": "def-server.SavedObjectsPitParams", "type": "Interface", - "label": "SavedObjectsType", + "label": "SavedObjectsPitParams", "description": [], "tags": [ - "remarks", "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsType.name", + "id": "def-server.SavedObjectsPitParams.id", "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" - } - }, - { - "tags": [], - "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}." - ], + "label": "id", + "description": [], "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" + "lineNumber": 69 } }, { "tags": [], - "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" - } - ] - }, - { - "tags": [], - "id": "def-server.SavedObjectsType.indexPattern", + "id": "def-server.SavedObjectsPitParams.keepAlive", "type": "string", - "label": "indexPattern", - "description": [ - "\nIf defined, the type instances will be stored in the given index instead of the default one." - ], + "label": "keepAlive", + "description": [], "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" + "lineNumber": 70 }, "signature": [ "string | undefined" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 68 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRawDoc", + "type": "Interface", + "label": "SavedObjectsRawDoc", + "description": [ + "\nA raw document as represented directly in the saved object index.\n" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsType.convertToAliasScript", + "id": "def-server.SavedObjectsRawDoc._id", "type": "string", - "label": "convertToAliasScript", - "description": [ - "\nIf defined, will be used to convert the type to an alias." - ], + "label": "_id", + "description": [], "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" - ] + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 17 + } }, { "tags": [], - "id": "def-server.SavedObjectsType.mappings", + "id": "def-server.SavedObjectsRawDoc._source", "type": "Object", - "label": "mappings", - "description": [ - "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." - ], + "label": "_source", + "description": [], "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" + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 18 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsTypeMappingDefinition", - "text": "SavedObjectsTypeMappingDefinition" + "section": "def-server.SavedObjectsRawDocSource", + "text": "SavedObjectsRawDocSource" } ] }, { "tags": [], - "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." - ], + "id": "def-server.SavedObjectsRawDoc._seq_no", + "type": "number", + "label": "_seq_no", + "description": [], "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" + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 19 }, "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" + "number | undefined" ] }, { "tags": [], - "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." - ], + "id": "def-server.SavedObjectsRawDoc._primary_term", + "type": "number", + "label": "_primary_term", + "description": [], "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" + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 20 }, "signature": [ - "string | undefined" + "number | undefined" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 16 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsType.management", - "type": "Object", - "label": "management", + "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", + "type": "CompoundType", + "label": "namespaceTreatment", "description": [ - "\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type." + "\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/types.ts", - "lineNumber": 317, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L317" + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 86 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsTypeManagementDefinition", - "text": "SavedObjectsTypeManagementDefinition" - }, - " | undefined" + "\"strict\" | \"lax\" | 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" + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 78 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsTypeManagementDefinition", + "id": "def-server.SavedObjectsRemoveReferencesToOptions", "type": "Interface", - "label": "SavedObjectsTypeManagementDefinition", + "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": [ - "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" + "\n" ], "tags": [ "public" @@ -12321,342 +11483,412 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", + "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", "type": "CompoundType", - "label": "importableAndExportable", + "label": "refresh", "description": [ - "\nIs the type importable or exportable. Defaults to `false`." + "The Elasticsearch Refresh setting for this operation. Defaults to `true`" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 257 }, "signature": [ "boolean | undefined" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 255 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRemoveReferencesToResponse", + "type": "Interface", + "label": "SavedObjectsRemoveReferencesToResponse", + "signature": [ { - "tags": [], - "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" - ] + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsTypeManagementDefinition.icon", - "type": "string", - "label": "icon", + "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", + "type": "number", + "label": "updated", "description": [ - "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." + "The number of objects that have been updated by this operation" ], "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" - ] - }, + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 266 + } + } + ], + "source": { + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 264 + }, + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", "type": "Function", - "label": "getTitle", + "label": "createScopedRepository", "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." + "\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/types.ts", - "lineNumber": 343, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L343" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 234 }, "signature": [ - "((savedObject: ", + "(req: ", { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "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" }, - ") => string) | undefined" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", + "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", "type": "Function", - "label": "getEditUrl", + "label": "createInternalRepository", "description": [ - "\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed." + "\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/types.ts", - "lineNumber": 348, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L348" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 244 }, "signature": [ - "((savedObject: ", + "(includedHiddenTypes?: string[] | undefined) => Pick<", { "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" }, - ") => string) | undefined" + ", \"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 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsResolveImportErrorsOptions", + "type": "Interface", + "label": "SavedObjectsResolveImportErrorsOptions", + "description": [ + "\nOptions to control the \"resolve import\" operation." + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", - "type": "Function", - "label": "getInAppUrl", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", + "type": "Object", + "label": "readStream", "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" + "The stream of {@link SavedObject | saved objects} to resolve errors from" ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 170 }, "signature": [ - "((savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ") => { path: string; uiCapabilitiesPath: string; }) | undefined" + "Readable" ] }, { - "tags": [ - "remarks" - ], - "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", - "type": "Function", - "label": "onExport", + "tags": [], + "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", + "type": "Array", + "label": "retries", "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" + "saved object import references to retry" ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 172 }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportTransform", - "text": "SavedObjectsExportTransform" + "section": "def-server.SavedObjectsImportRetry", + "text": "SavedObjectsImportRetry" }, - " | undefined" + "[]" ] }, { - "tags": [ - "example", - "remarks", - "remarks" - ], - "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", - "type": "Function", - "label": "onImport", + "tags": [], + "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", + "type": "string", + "label": "namespace", "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" + "if specified, will import in given namespace" ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 174 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportHook", - "text": "SavedObjectsImportHook" - }, - " | undefined" + "string | undefined" ] + }, + { + "tags": [], + "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 + } } ], "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" + "path": "src/core/server/saved_objects/import/types.ts", + "lineNumber": 168 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectMigrationMap", + "id": "def-server.SavedObjectsResolveResponse", "type": "Interface", - "label": "SavedObjectMigrationMap", + "label": "SavedObjectsResolveResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + "" + ], "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" + "\n" ], "tags": [ - "example", "public" ], "children": [ { - "id": "def-server.SavedObjectMigrationMap.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SavedObjectsResolveResponse.saved_object", + "type": "Object", + "label": "saved_object", "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 331 }, "signature": [ - "any" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"conflict\" | \"exactMatch\" | \"aliasMatch\"" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" ] } ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 330 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectExportBaseOptions", + "id": "def-server.SavedObjectsServiceSetup", "type": "Interface", - "label": "SavedObjectExportBaseOptions", - "description": [], + "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" + ], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectExportBaseOptions.request", - "type": "Object", - "label": "request", + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", + "type": "Function", + "label": "setClientFactoryProvider", "description": [ - "The http request initiating the export." + "\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/export/types.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L15" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 90 }, "signature": [ + "(clientFactoryProvider: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" }, - "" - ] - }, - { - "tags": [], - "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" + ") => void" ] }, { "tags": [], - "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", - "type": "CompoundType", - "label": "excludeExportDetails", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", + "type": "Function", + "label": "addClientWrapper", "description": [ - "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." + "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." ], "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" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 95 }, "signature": [ - "boolean | undefined" + "(priority: number, id: string, factory: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" + }, + ") => void" ] }, { "tags": [], - "id": "def-server.SavedObjectExportBaseOptions.namespace", - "type": "string", - "label": "namespace", + "id": "def-server.SavedObjectsServiceSetup.registerType", + "type": "Function", + "label": "registerType", "description": [ - "optional namespace to override the namespace used by the savedObjectsClient." + "\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/export/types.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L21" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 144 }, "signature": [ - "string | undefined" + "(type: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + ") => void" ] } ], "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" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 85 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsExportByObjectOptions", + "id": "def-server.SavedObjectsServiceStart", "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" - } - ], + "label": "SavedObjectsServiceStart", "description": [ - "\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n" + "\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" ], "tags": [ "public" @@ -12664,215 +11896,224 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsExportByObjectOptions.objects", - "type": "Array", - "label": "objects", + "id": "def-server.SavedObjectsServiceStart.getScopedClient", + "type": "Function", + "label": "getScopedClient", "description": [ - "optional array of objects to export." + "\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/export/types.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L45" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 172 }, "signature": [ - "{ id: string; type: string; }[]" + "(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\">" ] - } - ], - "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" - ], - "tags": [ - "public" - ], - "children": [ { "tags": [], - "id": "def-server.SavedObjectsExportByTypeOptions.types", - "type": "Array", - "label": "types", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository", + "type": "Function", + "label": "createScopedRepository", "description": [ - "array of saved object types." + "\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/export/types.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L31" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 188 }, "signature": [ - "string[]" + "(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\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", - "type": "Array", - "label": "hasReference", + "id": "def-server.SavedObjectsServiceStart.createInternalRepository", + "type": "Function", + "label": "createInternalRepository", "description": [ - "optional array of references to search object for." + "\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/export/types.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L33" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 198 }, "signature": [ + "(includedHiddenTypes?: string[] | undefined) => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" }, - "[] | undefined" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">" ] }, { "tags": [], - "id": "def-server.SavedObjectsExportByTypeOptions.search", - "type": "string", - "label": "search", + "id": "def-server.SavedObjectsServiceStart.createSerializer", + "type": "Function", + "label": "createSerializer", "description": [ - "optional query string to filter exported objects." + "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." ], "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" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 202 }, "signature": [ - "string | undefined" + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsSerializer", + "text": "SavedObjectsSerializer" + } ] - } - ], - "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" - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsExportTransformContext.request", - "type": "Object", - "label": "request", + "id": "def-server.SavedObjectsServiceStart.createExporter", + "type": "Function", + "label": "createExporter", "description": [ - "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" + "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." ], "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" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 206 }, "signature": [ + "(client: Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "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\">" ] - } - ], - "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" - ], - "tags": [ - "public" - ], - "children": [ + }, + { + "tags": [], + "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 + }, + "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\">" + ] + }, { "tags": [], - "id": "def-server.SavedObjectsImportHookResult.warnings", - "type": "Array", - "label": "warnings", + "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", + "type": "Function", + "label": "getTypeRegistry", "description": [ - "\nAn optional list of warnings to display in the UI when the import succeeds." + "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" ], "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" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 215 }, "signature": [ + "() => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" }, - "[] | undefined" + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">" ] } ], "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" + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "lineNumber": 162 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportSimpleWarning", + "id": "def-server.SavedObjectStatusMeta", "type": "Interface", - "label": "SavedObjectsImportSimpleWarning", + "label": "SavedObjectStatusMeta", "description": [ - "\nA simple informative warning that will be displayed to the user.\n" + "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" ], "tags": [ "public" @@ -12880,274 +12121,267 @@ "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportSimpleWarning.type", - "type": "string", - "label": "type", + "id": "def-server.SavedObjectStatusMeta.migratedIndices", + "type": "Object", + "label": "migratedIndices", "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 50 }, "signature": [ - "\"simple\"" + "{ [status: string]: number; skipped: number; migrated: number; }" ] - }, - { - "tags": [], - "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 49 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsImportActionRequiredWarning", + "id": "def-server.SavedObjectsType", "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" - ], + "label": "SavedObjectsType", + "description": [], "tags": [ - "remark", "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsImportActionRequiredWarning.type", + "id": "def-server.SavedObjectsType.name", "type": "string", - "label": "type", - "description": [], + "label": "name", + "description": [ + "\nThe name of the type, which is also used as the internal id." + ], "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\"" - ] + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 237 + } }, { "tags": [], - "id": "def-server.SavedObjectsImportActionRequiredWarning.message", - "type": "string", - "label": "message", + "id": "def-server.SavedObjectsType.hidden", + "type": "boolean", + "label": "hidden", "description": [ - "The translated message to display to the user." + "\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/import/types.ts", - "lineNumber": 203, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L203" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 244 } }, { "tags": [], - "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", - "type": "string", - "label": "actionPath", + "id": "def-server.SavedObjectsType.namespaceType", + "type": "CompoundType", + "label": "namespaceType", "description": [ - "The path (without the basePath) that the user should be redirect to to address this warning." + "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." ], "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" - } + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 248 + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsNamespaceType", + "text": "SavedObjectsNamespaceType" + } + ] }, { "tags": [], - "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", + "id": "def-server.SavedObjectsType.indexPattern", "type": "string", - "label": "buttonLabel", + "label": "indexPattern", "description": [ - "An optional label to use for the link button. If unspecified, a default label will be used." + "\nIf defined, the type instances will be stored in the given index instead of the default one." ], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 252 }, "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" - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsBaseOptions.namespace", + "id": "def-server.SavedObjectsType.convertToAliasScript", "type": "string", - "label": "namespace", + "label": "convertToAliasScript", "description": [ - "Specify the namespace for this operation" + "\nIf defined, will be used to convert the type to an alias." ], "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" + "lineNumber": 256 }, "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" - ], - "tags": [ - "public" - ], - "children": [ + }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.type", - "type": "CompoundType", - "label": "type", - "description": [], + "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": 78, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L78" + "lineNumber": 260 }, "signature": [ - "string | string[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeMappingDefinition", + "text": "SavedObjectsTypeMappingDefinition" + } ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.page", - "type": "number", - "label": "page", - "description": [], + "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": 79, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L79" + "lineNumber": 264 }, "signature": [ - "number | undefined" + { + "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" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.perPage", - "type": "number", - "label": "perPage", - "description": [], + "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": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L80" + "lineNumber": 313 }, "signature": [ - "number | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.sortField", - "type": "string", - "label": "sortField", - "description": [], + "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 + }, + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsTypeManagementDefinition", + "type": "Interface", + "label": "SavedObjectsTypeManagementDefinition", + "description": [ + "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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": 81, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L81" + "lineNumber": 329 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.sortOrder", + "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", "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" - ] - }, - { - "tags": [ - "example" - ], - "id": "def-server.SavedObjectsFindOptions.fields", - "type": "Array", - "label": "fields", + "label": "defaultSearchField", "description": [ - "\nAn array of fields to include in the results" + "\nThe default search field to use for this type. Defaults to `id`." ], "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" + "lineNumber": 333 }, "signature": [ - "string[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.search", + "id": "def-server.SavedObjectsTypeManagementDefinition.icon", "type": "string", - "label": "search", + "label": "icon", "description": [ - "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + "\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": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L90" + "lineNumber": 338 }, "signature": [ "string | undefined" @@ -13155,299 +12389,337 @@ }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.searchFields", - "type": "Array", - "label": "searchFields", + "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", + "type": "Function", + "label": "getTitle", "description": [ - "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" + "\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": 92, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L92" + "lineNumber": 343 }, "signature": [ - "string[] | undefined" + "((savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ") => string) | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.searchAfter", - "type": "Array", - "label": "searchAfter", + "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", + "type": "Function", + "label": "getEditUrl", "description": [ - "\nUse the sort values from the previous page to retrieve the next page of results." + "\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": 96, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L96" + "lineNumber": 348 }, "signature": [ - "unknown[] | undefined" + "((savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ") => string) | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.rootSearchFields", - "type": "Array", - "label": "rootSearchFields", + "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", + "type": "Function", + "label": "getInAppUrl", "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." + "\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": 101, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L101" + "lineNumber": 357 }, "signature": [ - "string[] | undefined" + "((savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ") => { path: string; uiCapabilitiesPath: string; }) | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.hasReference", - "type": "CompoundType", - "label": "hasReference", + "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", + "type": "Function", + "label": "onExport", "description": [ - "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + "\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": 107, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L107" + "lineNumber": 368 }, "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" + "section": "def-server.SavedObjectsExportTransform", + "text": "SavedObjectsExportTransform" }, - "[] | undefined" + " | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", - "type": "CompoundType", - "label": "hasReferenceOperator", + "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", + "type": "Function", + "label": "onImport", "description": [ - "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + "\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": 111, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L111" + "lineNumber": 411 }, "signature": [ - "\"AND\" | \"OR\" | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportHook", + "text": "SavedObjectsImportHook" + }, + " | undefined" ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 325 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsTypeMappingDefinition", + "type": "Interface", + "label": "SavedObjectsTypeMappingDefinition", + "description": [ + "\nDescribe a saved object type mapping.\n" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", + "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", "type": "CompoundType", - "label": "defaultSearchOperator", + "label": "dynamic", "description": [ - "\nThe search operator to use with the provided filter. Defaults to `OR`" + "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/types.ts", - "lineNumber": 116, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L116" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 40 }, "signature": [ - "\"AND\" | \"OR\" | undefined" + "false | \"strict\" | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.filter", - "type": "Any", - "label": "filter", - "description": [], + "id": "def-server.SavedObjectsTypeMappingDefinition.properties", + "type": "Object", + "label": "properties", + "description": [ + "The underlying properties of the type mapping" + ], "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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 42 }, "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" + } ] - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 36 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsUpdateOptions", + "type": "Interface", + "label": "SavedObjectsUpdateOptions", + "signature": [ { - "tags": [], - "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" - ] + "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" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", - "type": "Object", - "label": "typeToNamespacesMap", + "id": "def-server.SavedObjectsUpdateOptions.version", + "type": "string", + "label": "version", "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." + "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/types.ts", - "lineNumber": 126, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L126" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 206 }, "signature": [ - "Map | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.preference", - "type": "string", - "label": "preference", + "id": "def-server.SavedObjectsUpdateOptions.references", + "type": "Array", + "label": "references", "description": [ - "An optional ES preference value to be used for the query" + "{@inheritdoc SavedObjectReference}" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 208 }, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | undefined" ] }, { "tags": [], - "id": "def-server.SavedObjectsFindOptions.pit", - "type": "Object", - "label": "pit", + "id": "def-server.SavedObjectsUpdateOptions.refresh", + "type": "CompoundType", + "label": "refresh", "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + "The Elasticsearch Refresh setting for this operation" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 210 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" + "boolean | \"wait_for\" | 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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 204 }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectsFindOptionsReference", + "id": "def-server.SavedObjectsUpdateResponse", "type": "Interface", - "label": "SavedObjectsFindOptionsReference", - "description": [], - "tags": [ - "public" - ], - "children": [ + "label": "SavedObjectsUpdateResponse", + "signature": [ { - "tags": [], - "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" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" }, - { - "tags": [], - "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" - } - } + " extends Pick<", + "SavedObject", + ", \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">" + ], + "description": [ + "\n" ], - "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": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.SavedObjectsPitParams.id", - "type": "string", - "label": "id", + "id": "def-server.SavedObjectsUpdateResponse.attributes", + "type": "Object", + "label": "attributes", "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" - } + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 322 + }, + "signature": [ + "Partial" + ] }, { "tags": [], - "id": "def-server.SavedObjectsPitParams.keepAlive", - "type": "string", - "label": "keepAlive", + "id": "def-server.SavedObjectsUpdateResponse.references", + "type": "Array", + "label": "references", "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 323 }, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[] | 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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 320 }, "initialIsOpen": false } @@ -13455,127 +12727,140 @@ "enums": [], "misc": [ { - "id": "def-server.SavedObjectsClientWrapperFactory", + "id": "def-server.ISavedObjectsExporter", "type": "Type", - "label": "SavedObjectsClientWrapperFactory", + "label": "ISavedObjectsExporter", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "lineNumber": 32 + }, + "signature": [ + "{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<", + "Readable", + ">; exportByObjects: (options: SavedObjectsExportByObjectOptions) => Promise<", + "Readable", + ">; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ISavedObjectsImporter", + "type": "Type", + "label": "ISavedObjectsImporter", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "lineNumber": 24 + }, + "signature": [ + "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }" + ], + "initialIsOpen": false + }, + { + "id": "def-server.ISavedObjectsRepository", + "type": "Type", + "label": "ISavedObjectsRepository", "tags": [ "public" ], "description": [ - "\nDescribes the factory used to create instances of Saved Objects Client Wrappers." + "\nSee {@link SavedObjectsRepository}\n" ], "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" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 128 }, "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\">" + "{ 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.SavedObjectsClientFactory", + "id": "def-server.ISavedObjectTypeRegistry", "type": "Type", - "label": "SavedObjectsClientFactory", + "label": "ISavedObjectTypeRegistry", "tags": [ "public" ], "description": [ - "\nDescribes the factory used to create instances of the Saved Objects Client." + "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" ], "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" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 17 }, "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\">" + "{ 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.SavedObjectsClientFactoryProvider", + "id": "def-server.MutatingOperationRefreshSetting", "type": "Type", - "label": "SavedObjectsClientFactoryProvider", + "label": "MutatingOperationRefreshSetting", "tags": [ "public" ], "description": [ - "\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}." + "\nElasticsearch Refresh setting for mutating operation" ], "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" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 148 }, "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" - } + "false | true | \"wait_for\"" ], "initialIsOpen": false }, { - "id": "def-server.SavedObjectsClosePointInTimeOptions", + "id": "def-server.SavedObjectMigrationFn", "type": "Type", - "label": "SavedObjectsClosePointInTimeOptions", + "label": "SavedObjectMigrationFn", "tags": [ "public" ], - "description": [], + "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/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" + "path": "src/core/server/saved_objects/migrations/types.ts", + "lineNumber": 45 }, "signature": [ - "SavedObjectsBaseOptions" + "(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 }, @@ -13591,8 +12876,7 @@ ], "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" + "lineNumber": 71 }, "signature": [ "SavedObjectDoc & Referencable" @@ -13600,183 +12884,181 @@ "initialIsOpen": false }, { - "id": "def-server.SavedObjectUnsanitizedDoc", - "type": "Type", - "label": "SavedObjectUnsanitizedDoc", - "tags": [ - "public" - ], - "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", - "tags": [ - "public" - ], - "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", + "id": "def-server.SavedObjectsClientContract", "type": "Type", - "label": "SavedObjectsFieldMapping", + "label": "SavedObjectsClientContract", "tags": [ "public" ], "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" + "\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/mappings/types.ts", - "lineNumber": 99, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L99" + "path": "src/core/server/saved_objects/types.ts", + "lineNumber": 212 }, "signature": [ + "{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsComplexFieldMapping", - "text": "SavedObjectsComplexFieldMapping" + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, - " | ", + ") => Promise<{}>; create: (type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCoreFieldMapping", - "text": "SavedObjectsCoreFieldMapping" + "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 }, { - "id": "def-server.ISavedObjectTypeRegistry", + "id": "def-server.SavedObjectsClientFactory", "type": "Type", - "label": "ISavedObjectTypeRegistry", + "label": "SavedObjectsClientFactory", "tags": [ "public" ], "description": [ - "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" + "\nDescribes the factory used to create instances of the Saved Objects Client." ], "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 37 }, "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; }" + "(__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.SavedObjectsNamespaceType", + "id": "def-server.SavedObjectsClientFactoryProvider", "type": "Type", - "label": "SavedObjectsNamespaceType", + "label": "SavedObjectsClientFactoryProvider", "tags": [ "public" ], "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" + "\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}." ], "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 49 }, "signature": [ - "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + "(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.SavedObjectMigrationFn", + "id": "def-server.SavedObjectsClientWrapperFactory", "type": "Type", - "label": "SavedObjectMigrationFn", + "label": "SavedObjectsClientWrapperFactory", "tags": [ - "example", "public" ], "description": [ - "\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n" + "\nDescribes the factory used to create instances of Saved Objects Client Wrappers." ], "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" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "lineNumber": 29 }, "signature": [ - "(doc: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" - }, - ", context: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationContext", - "text": "SavedObjectMigrationContext" + "section": "def-server.SavedObjectsClientWrapperOptions", + "text": "SavedObjectsClientWrapperOptions" }, - ") => ", + ") => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" + "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.ISavedObjectsExporter", + "id": "def-server.SavedObjectsClosePointInTimeOptions", "type": "Type", - "label": "ISavedObjectsExporter", + "label": "SavedObjectsClosePointInTimeOptions", "tags": [ "public" ], "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" + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "lineNumber": 375 }, "signature": [ - "{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<", - "Readable", - ">; exportByObjects: (options: SavedObjectsExportByObjectOptions) => Promise<", - "Readable", - ">; }" + "SavedObjectsBaseOptions" ], "initialIsOpen": false }, @@ -13785,9 +13067,6 @@ "type": "Type", "label": "SavedObjectsExportTransform", "tags": [ - "example", - "example", - "remarks", "public" ], "description": [ @@ -13795,8 +13074,7 @@ ], "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" + "lineNumber": 155 }, "signature": [ "(context: ", @@ -13818,20 +13096,35 @@ "initialIsOpen": false }, { - "id": "def-server.ISavedObjectsImporter", + "id": "def-server.SavedObjectsFieldMapping", "type": "Type", - "label": "ISavedObjectsImporter", + "label": "SavedObjectsFieldMapping", "tags": [ "public" ], - "description": [], + "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/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" + "path": "src/core/server/saved_objects/mappings/types.ts", + "lineNumber": 99 }, "signature": [ - "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }" + { + "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 }, @@ -13840,7 +13133,6 @@ "type": "Type", "label": "SavedObjectsImportHook", "tags": [ - "remark", "public" ], "description": [ @@ -13848,8 +13140,7 @@ ], "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" + "lineNumber": 246 }, "signature": [ "(objects: ", @@ -13886,8 +13177,7 @@ ], "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" + "lineNumber": 218 }, "signature": [ { @@ -13909,81 +13199,40 @@ "initialIsOpen": false }, { - "id": "def-server.MutatingOperationRefreshSetting", + "id": "def-server.SavedObjectsNamespaceType", "type": "Type", - "label": "MutatingOperationRefreshSetting", + "label": "SavedObjectsNamespaceType", "tags": [ "public" ], "description": [ - "\nElasticsearch Refresh setting for mutating operation" + "\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": 148, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L148" + "lineNumber": 226 }, "signature": [ - "false | true | \"wait_for\"" + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" ], "initialIsOpen": false }, { - "id": "def-server.SavedObjectsClientContract", + "id": "def-server.SavedObjectUnsanitizedDoc", "type": "Type", - "label": "SavedObjectsClientContract", + "label": "SavedObjectUnsanitizedDoc", "tags": [ "public" ], "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" + "\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/types.ts", - "lineNumber": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L212" + "path": "src/core/server/saved_objects/serialization/types.ts", + "lineNumber": 63 }, "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" - } + "SavedObjectDoc & Partial" ], "initialIsOpen": false } diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json index 778bd8b6da64a..b14f24625ed6c 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -52,8 +52,7 @@ "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" + "lineNumber": 104 }, "signature": [ "\"dashboard\"" @@ -67,8 +66,7 @@ "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" + "lineNumber": 105 }, "signature": [ "((newViewMode: ", @@ -93,8 +91,7 @@ "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" + "lineNumber": 107 }, "tags": [], "returnComment": [] @@ -124,8 +121,7 @@ "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" + "lineNumber": 112 } }, { @@ -144,8 +140,7 @@ "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" + "lineNumber": 113 } }, { @@ -181,8 +176,7 @@ "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" + "lineNumber": 114 } } ], @@ -190,8 +184,7 @@ "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" + "lineNumber": 111 } }, { @@ -267,8 +260,7 @@ "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" + "lineNumber": 131 } }, { @@ -281,8 +273,7 @@ "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" + "lineNumber": 132 } } ], @@ -290,8 +281,7 @@ "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" + "lineNumber": 127 } }, { @@ -345,8 +335,7 @@ "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" + "lineNumber": 139 } }, { @@ -366,8 +355,7 @@ "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" + "lineNumber": 140 } }, { @@ -380,8 +368,7 @@ "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" + "lineNumber": 141 } } ], @@ -389,8 +376,7 @@ "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" + "lineNumber": 138 } }, { @@ -451,8 +437,7 @@ "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" + "lineNumber": 180 } }, { @@ -473,8 +458,7 @@ "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" + "lineNumber": 181 } }, { @@ -487,8 +471,7 @@ "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" + "lineNumber": 182 } } ], @@ -496,8 +479,7 @@ "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" + "lineNumber": 179 } }, { @@ -558,8 +540,7 @@ "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" + "lineNumber": 230 } }, { @@ -572,8 +553,7 @@ "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" + "lineNumber": 230 } }, { @@ -586,8 +566,7 @@ "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" + "lineNumber": 230 } } ], @@ -595,8 +574,7 @@ "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" + "lineNumber": 226 } }, { @@ -618,8 +596,7 @@ "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" + "lineNumber": 244 } } ], @@ -627,8 +604,7 @@ "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" + "lineNumber": 244 } }, { @@ -657,8 +633,7 @@ "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" + "lineNumber": 255 } } ], @@ -666,15 +641,13 @@ "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" + "lineNumber": 255 } } ], "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" + "lineNumber": 103 }, "initialIsOpen": false }, @@ -734,8 +707,7 @@ "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" + "lineNumber": 32 }, "signature": [ "true" @@ -749,8 +721,7 @@ "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" + "lineNumber": 33 }, "signature": [ "\"dashboard\"" @@ -783,8 +754,7 @@ "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" + "lineNumber": 35 } } ], @@ -792,8 +762,7 @@ "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" + "lineNumber": 35 } }, { @@ -807,8 +776,7 @@ "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" + "lineNumber": 37 }, "tags": [], "returnComment": [] @@ -824,8 +792,7 @@ "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" + "lineNumber": 42 }, "tags": [], "returnComment": [] @@ -851,8 +818,7 @@ "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" + "lineNumber": 48 } }, { @@ -875,8 +841,7 @@ "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" + "lineNumber": 59 } }, { @@ -912,8 +877,7 @@ "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" + "lineNumber": 60 } } ], @@ -963,8 +927,7 @@ "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" + "lineNumber": 58 }, "tags": [], "returnComment": [] @@ -972,8 +935,7 @@ ], "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" + "lineNumber": 29 }, "initialIsOpen": false } @@ -998,8 +960,7 @@ "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" + "lineNumber": 22 } }, { @@ -1012,8 +973,7 @@ "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" + "lineNumber": 22 } } ], @@ -1021,8 +981,7 @@ "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" + "lineNumber": 22 }, "initialIsOpen": false }, @@ -1048,8 +1007,7 @@ "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" + "lineNumber": 92 } } ], @@ -1076,8 +1034,7 @@ "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" + "lineNumber": 91 }, "tags": [], "returnComment": [], @@ -1118,8 +1075,7 @@ "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" + "lineNumber": 43 }, "signature": [ { @@ -1140,8 +1096,7 @@ "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" + "lineNumber": 44 }, "signature": [ { @@ -1162,8 +1117,7 @@ "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" + "lineNumber": 45 }, "signature": [ "boolean | undefined" @@ -1177,8 +1131,7 @@ "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" + "lineNumber": 46 } }, { @@ -1189,8 +1142,7 @@ "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" + "lineNumber": 47 }, "signature": [ "string | undefined" @@ -1204,8 +1156,7 @@ "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" + "lineNumber": 48 }, "signature": [ { @@ -1225,8 +1176,7 @@ "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" + "lineNumber": 49 }, "signature": [ "string | undefined" @@ -1240,8 +1190,7 @@ "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" + "lineNumber": 50 } }, { @@ -1252,8 +1201,7 @@ "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" + "lineNumber": 51 }, "signature": [ "boolean | undefined" @@ -1267,8 +1215,7 @@ "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" + "lineNumber": 52 }, "signature": [ { @@ -1288,8 +1235,7 @@ "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" + "lineNumber": 53 }, "signature": [ { @@ -1310,8 +1256,7 @@ "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" + "lineNumber": 54 } }, { @@ -1322,8 +1267,7 @@ "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" + "lineNumber": 55 }, "signature": [ { @@ -1343,8 +1287,7 @@ "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" + "lineNumber": 56 }, "signature": [ "{ [panelId: string]: ", @@ -1369,8 +1312,7 @@ ], "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" + "lineNumber": 42 }, "initialIsOpen": false }, @@ -1389,259 +1331,13 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L90" + "lineNumber": 90 } } ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 89, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L89" - }, - "initialIsOpen": false - }, - { - "id": "def-public.DashboardUrlGeneratorState", - "type": "Interface", - "label": "DashboardUrlGeneratorState", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" + "lineNumber": 89 }, "initialIsOpen": false }, @@ -1677,8 +1373,7 @@ "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" + "lineNumber": 19 }, "signature": [ "string | undefined" @@ -1692,8 +1387,7 @@ "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" + "lineNumber": 20 } }, { @@ -1704,8 +1398,7 @@ "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" + "lineNumber": 21 }, "signature": [ "string | undefined" @@ -1719,8 +1412,7 @@ "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" + "lineNumber": 22 }, "signature": [ "string | undefined" @@ -1734,8 +1426,7 @@ "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" + "lineNumber": 23 }, "signature": [ "string | undefined" @@ -1749,8 +1440,7 @@ "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" + "lineNumber": 24 } }, { @@ -1761,8 +1451,7 @@ "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" + "lineNumber": 25 }, "signature": [ "string | undefined" @@ -1776,8 +1465,7 @@ "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" + "lineNumber": 27 }, "signature": [ "string | undefined" @@ -1791,8 +1479,7 @@ "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" + "lineNumber": 28 } }, { @@ -1803,8 +1490,7 @@ "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" + "lineNumber": 29 }, "signature": [ { @@ -1825,8 +1511,7 @@ "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" + "lineNumber": 30 }, "signature": [ "Pick<", @@ -1860,8 +1545,7 @@ "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" + "lineNumber": 31 } }, { @@ -1885,8 +1569,7 @@ "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" + "lineNumber": 32 } }, { @@ -1897,8 +1580,7 @@ "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" + "lineNumber": 33 }, "signature": [ "(editMode?: boolean | undefined) => string" @@ -1907,8 +1589,239 @@ ], "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" + "lineNumber": 18 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DashboardUrlGeneratorState", + "type": "Interface", + "label": "DashboardUrlGeneratorState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.ViewMode", + "text": "ViewMode" + }, + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "dashboard", + "scope": "common", + "docId": "kibDashboardPluginApi", + "section": "def-common.SavedDashboardPanel730ToLatest", + "text": "SavedDashboardPanel730ToLatest" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DashboardUrlGeneratorState.savedQuery", + "type": "string", + "label": "savedQuery", + "description": [ + "\nSaved query ID" + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 88 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 29 }, "initialIsOpen": false } @@ -1917,49 +1830,46 @@ "misc": [ { "tags": [], - "id": "def-public.DASHBOARD_CONTAINER_TYPE", + "id": "def-public.DASHBOARD_APP_URL_GENERATOR", "type": "string", - "label": "DASHBOARD_CONTAINER_TYPE", + "label": "DASHBOARD_APP_URL_GENERATOR", "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" + "path": "src/plugins/dashboard/public/url_generator.ts", + "lineNumber": 27 }, "signature": [ - "\"dashboard\"" + "\"DASHBOARD_APP_URL_GENERATOR\"" ], "initialIsOpen": false }, { - "id": "def-public.DashboardUrlGenerator", - "type": "Type", - "label": "DashboardUrlGenerator", "tags": [], + "id": "def-public.DASHBOARD_CONTAINER_TYPE", + "type": "string", + "label": "DASHBOARD_CONTAINER_TYPE", "description": [], "source": { - "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 87, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L87" + "path": "src/plugins/dashboard/public/application/embeddable/dashboard_constants.ts", + "lineNumber": 13 }, "signature": [ - "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" + "\"dashboard\"" ], "initialIsOpen": false }, { + "id": "def-public.DashboardUrlGenerator", + "type": "Type", + "label": "DashboardUrlGenerator", "tags": [], - "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" + "path": "src/plugins/dashboard/public/plugin.tsx", + "lineNumber": 87 }, "signature": [ - "\"DASHBOARD_APP_URL_GENERATOR\"" + "UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">" ], "initialIsOpen": false }, @@ -1973,8 +1883,7 @@ ], "source": { "path": "src/plugins/dashboard/common/types.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L33" + "lineNumber": 33 }, "signature": [ "Pick & { readonly id?: string | undefined; readonly type: string; }" @@ -1996,8 +1905,7 @@ "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" + "lineNumber": 12 } }, { @@ -2008,8 +1916,7 @@ "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" + "lineNumber": 13 } }, { @@ -2020,8 +1927,7 @@ "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" + "lineNumber": 14 } }, { @@ -2032,8 +1938,7 @@ "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" + "lineNumber": 15 } }, { @@ -2044,8 +1949,7 @@ "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" + "lineNumber": 16 } }, { @@ -2056,8 +1960,7 @@ "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" + "lineNumber": 17 } }, { @@ -2068,8 +1971,7 @@ "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" + "lineNumber": 18 } }, { @@ -2080,8 +1982,7 @@ "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" + "lineNumber": 19 } } ], @@ -2089,8 +1990,7 @@ "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" + "lineNumber": 11 }, "initialIsOpen": false } @@ -2103,8 +2003,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 120, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L120" + "lineNumber": 120 }, "signature": [ "void" @@ -2127,8 +2026,7 @@ "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" + "lineNumber": 123 }, "signature": [ "() => ", @@ -2149,8 +2047,7 @@ "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" + "lineNumber": 124 }, "signature": [ { @@ -2171,8 +2068,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L125" + "lineNumber": 125 }, "signature": [ { @@ -2192,8 +2088,7 @@ "description": [], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 126, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L126" + "lineNumber": 126 }, "signature": [ "React.FC" @@ -2202,8 +2097,7 @@ ], "source": { "path": "src/plugins/dashboard/public/plugin.tsx", - "lineNumber": 122, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L122" + "lineNumber": 122 }, "lifecycle": "start", "initialIsOpen": true @@ -2293,8 +2187,7 @@ "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" + "lineNumber": 262 } }, { @@ -2307,8 +2200,7 @@ "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" + "lineNumber": 274 } }, { @@ -2321,8 +2213,7 @@ "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" + "lineNumber": 275 } }, { @@ -2340,8 +2231,7 @@ "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" + "lineNumber": 276 }, "signature": [ "any" @@ -2350,8 +2240,7 @@ ], "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" + "lineNumber": 276 } } ], @@ -2359,8 +2248,7 @@ "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" + "lineNumber": 261 }, "initialIsOpen": false } @@ -2381,8 +2269,7 @@ "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" + "lineNumber": 10 } }, { @@ -2393,8 +2280,7 @@ "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" + "lineNumber": 11 } }, { @@ -2405,8 +2291,7 @@ "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" + "lineNumber": 12 } }, { @@ -2417,8 +2302,7 @@ "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" + "lineNumber": 13 } }, { @@ -2429,15 +2313,13 @@ "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" + "lineNumber": 14 } } ], "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" + "lineNumber": 9 }, "initialIsOpen": false } @@ -2445,18 +2327,17 @@ "enums": [], "misc": [ { - "id": "def-common.RawSavedDashboardPanel730ToLatest", + "id": "def-common.DashboardDoc700To720", "type": "Type", - "label": "RawSavedDashboardPanel730ToLatest", + "label": "DashboardDoc700To720", "tags": [], "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" + "lineNumber": 55 }, "signature": [ - "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }" + "Doc" ], "initialIsOpen": false }, @@ -2468,30 +2349,13 @@ "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" + "lineNumber": 53 }, "signature": [ "Doc" ], "initialIsOpen": false }, - { - "id": "def-common.DashboardDoc700To720", - "type": "Type", - "label": "DashboardDoc700To720", - "tags": [], - "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", @@ -2500,8 +2364,7 @@ "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" + "lineNumber": 57 }, "signature": [ "DocPre700" @@ -2509,18 +2372,17 @@ "initialIsOpen": false }, { - "id": "def-common.SavedDashboardPanelTo60", + "id": "def-common.RawSavedDashboardPanel730ToLatest", "type": "Type", - "label": "SavedDashboardPanelTo60", + "label": "RawSavedDashboardPanel730ToLatest", "tags": [], "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" + "path": "src/plugins/dashboard/common/bwc/types.ts", + "lineNumber": 70 }, "signature": [ - "Pick & { readonly id: string; readonly type: string; }" + "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }" ], "initialIsOpen": false }, @@ -2532,8 +2394,7 @@ "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" + "lineNumber": 59 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" @@ -2548,8 +2409,7 @@ "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" + "lineNumber": 51 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" @@ -2564,8 +2424,7 @@ "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" + "lineNumber": 43 }, "signature": [ "Pick & { readonly id: string; readonly type: string; }" @@ -2580,8 +2439,7 @@ "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" + "lineNumber": 35 }, "signature": [ "Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" @@ -2596,13 +2454,27 @@ "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" + "lineNumber": 76 }, "signature": [ "Pick & { readonly id?: string | undefined; readonly type: string; }" ], "initialIsOpen": false + }, + { + "id": "def-common.SavedDashboardPanelTo60", + "type": "Type", + "label": "SavedDashboardPanelTo60", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/dashboard/common/types.ts", + "lineNumber": 67 + }, + "signature": [ + "Pick & { readonly id: string; readonly type: string; }" + ], + "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json index ee634d0c69048..31c54684e50a4 100644 --- a/api_docs/dashboard_enhanced.json +++ b/api_docs/dashboard_enhanced.json @@ -68,8 +68,7 @@ "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" + "lineNumber": 36 } } ], @@ -77,8 +76,7 @@ "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" + "lineNumber": 36 } }, { @@ -89,8 +87,7 @@ "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" + "lineNumber": 38 } }, { @@ -101,8 +98,7 @@ "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" + "lineNumber": 40 }, "signature": [ "() => string[]" @@ -149,8 +145,7 @@ "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" + "lineNumber": 42 } }, { @@ -163,8 +158,7 @@ "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" + "lineNumber": 42 } } ], @@ -172,8 +166,7 @@ "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" + "lineNumber": 42 } }, { @@ -184,8 +177,7 @@ "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" + "lineNumber": 44 }, "signature": [ "100" @@ -202,8 +194,7 @@ "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" + "lineNumber": 46 }, "tags": [], "returnComment": [] @@ -216,8 +207,7 @@ "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" + "lineNumber": 48 }, "signature": [ "\"dashboardApp\"" @@ -231,8 +221,7 @@ "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" + "lineNumber": 54 }, "signature": [ { @@ -280,8 +269,7 @@ "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" + "lineNumber": 56 }, "tags": [], "returnComment": [] @@ -306,8 +294,7 @@ "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" + "lineNumber": 62 } } ], @@ -333,8 +320,7 @@ "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" + "lineNumber": 62 }, "tags": [], "returnComment": [] @@ -359,8 +345,7 @@ "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" + "lineNumber": 67 } }, { @@ -373,8 +358,7 @@ "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" + "lineNumber": 67 } } ], @@ -393,8 +377,7 @@ "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" + "lineNumber": 67 }, "tags": [], "returnComment": [] @@ -419,8 +402,7 @@ "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" + "lineNumber": 72 } }, { @@ -433,8 +415,7 @@ "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" + "lineNumber": 72 } } ], @@ -453,8 +434,7 @@ "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" + "lineNumber": 72 }, "tags": [], "returnComment": [] @@ -467,8 +447,7 @@ "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" + "lineNumber": 77 }, "signature": [ { @@ -483,14 +462,79 @@ ], "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" + "lineNumber": 34 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ + { + "id": "def-public.Params", + "type": "Interface", + "label": "Params", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "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 + }, + "initialIsOpen": false + }, { "id": "def-public.SetupDependencies", "type": "Interface", @@ -506,8 +550,7 @@ "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" + "lineNumber": 17 }, "signature": [ { @@ -527,8 +570,7 @@ "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" + "lineNumber": 18 }, "signature": [ { @@ -548,8 +590,7 @@ "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" + "lineNumber": 19 }, "signature": [ { @@ -564,8 +605,7 @@ ], "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" + "lineNumber": 16 }, "initialIsOpen": false }, @@ -584,8 +624,7 @@ "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" + "lineNumber": 23 }, "signature": [ { @@ -605,8 +644,7 @@ "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" + "lineNumber": 24 }, "signature": [ { @@ -626,8 +664,7 @@ "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" + "lineNumber": 25 }, "signature": [ { @@ -647,8 +684,7 @@ "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" + "lineNumber": 26 }, "signature": [ { @@ -668,8 +704,7 @@ "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" + "lineNumber": 27 }, "signature": [ { @@ -684,76 +719,7 @@ ], "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" + "lineNumber": 22 }, "initialIsOpen": false } @@ -768,8 +734,7 @@ "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" + "lineNumber": 11 }, "signature": [ "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" @@ -787,8 +752,7 @@ "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" + "lineNumber": 31 }, "lifecycle": "setup", "initialIsOpen": true @@ -802,8 +766,7 @@ "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" + "lineNumber": 34 }, "lifecycle": "start", "initialIsOpen": true @@ -828,8 +791,7 @@ "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" + "lineNumber": 13 }, "signature": [ { @@ -844,8 +806,7 @@ ], "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" + "lineNumber": 12 }, "initialIsOpen": false }, @@ -864,8 +825,7 @@ "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" + "lineNumber": 17 }, "signature": [ "void" @@ -874,8 +834,7 @@ ], "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" + "lineNumber": 16 }, "initialIsOpen": false } @@ -892,8 +851,7 @@ "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" + "lineNumber": 21 }, "lifecycle": "setup", "initialIsOpen": true @@ -907,8 +865,7 @@ "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" + "lineNumber": 24 }, "lifecycle": "start", "initialIsOpen": true @@ -936,15 +893,13 @@ "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" + "lineNumber": 49 } } ], "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" + "lineNumber": 48 } } ], @@ -973,8 +928,7 @@ "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" + "lineNumber": 46 }, "tags": [], "returnComment": [], @@ -999,15 +953,13 @@ "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" + "lineNumber": 34 } } ], "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" + "lineNumber": 33 } } ], @@ -1035,8 +987,7 @@ "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" + "lineNumber": 31 }, "tags": [], "returnComment": [], @@ -1047,36 +998,34 @@ "enums": [], "misc": [ { + "id": "def-common.DrilldownConfig", + "type": "Type", + "label": "DrilldownConfig", "tags": [], - "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" - ], + "description": [], "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" + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts", + "lineNumber": 9 }, "signature": [ - "\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"" + "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" ], "initialIsOpen": false }, { - "id": "def-common.DrilldownConfig", - "type": "Type", - "label": "DrilldownConfig", "tags": [], - "description": [], + "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/types.ts", - "lineNumber": 9, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts#L9" + "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts", + "lineNumber": 15 }, "signature": [ - "{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }" + "\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\"" ], "initialIsOpen": false } diff --git a/api_docs/dashboard_mode.json b/api_docs/dashboard_mode.json index d021b31e9596b..dab407a79d7c8 100644 --- a/api_docs/dashboard_mode.json +++ b/api_docs/dashboard_mode.json @@ -61,8 +61,7 @@ "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" + "lineNumber": 30 } } ], @@ -70,8 +69,7 @@ "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" + "lineNumber": 30 } }, { @@ -108,8 +106,7 @@ "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" + "lineNumber": 34 } }, { @@ -122,8 +119,7 @@ "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" + "lineNumber": 34 } } ], @@ -131,8 +127,7 @@ "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" + "lineNumber": 34 } }, { @@ -168,8 +163,7 @@ "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" + "lineNumber": 60 } } ], @@ -177,8 +171,7 @@ "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" + "lineNumber": 60 } }, { @@ -194,15 +187,13 @@ "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" + "lineNumber": 62 } } ], "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" + "lineNumber": 26 }, "initialIsOpen": false } @@ -233,8 +224,7 @@ "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" + "lineNumber": 9 } } ], @@ -242,8 +232,7 @@ "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" + "lineNumber": 8 }, "initialIsOpen": false } diff --git a/api_docs/data.json b/api_docs/data.json index 017235c4269fc..612b911915f9d 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -3,150 +3,160 @@ "client": { "classes": [ { - "id": "def-public.FieldFormat", + "id": "def-public.AggConfig", "type": "Class", "tags": [], - "label": "FieldFormat", + "label": "AggConfig", "description": [], "children": [ { - "tags": [ - "property", - "static", - "public" + "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 + } + } ], - "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" - } - }, - { "tags": [ - "property", - "static", - "public" + "return" + ], + "returnComment": [ + "- the list that was passed in" ], - "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 63 } }, { + "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 + } + } + ], "tags": [ - "property", - "private" + "return" + ], + "returnComment": [ + "list - a list of objects with id properties" ], - "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[]" - ] + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 83 + } }, { - "tags": [ - "property", - "private" - ], - "id": "def-public.FieldFormat.convertObject", + "tags": [], + "id": "def-public.AggConfig.aggConfigs", "type": "Object", - "label": "convertObject", + "label": "aggConfigs", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 92 }, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvert", - "text": "FieldFormatConvert" - }, - " | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + } ] }, { - "tags": [ - "property", - "protected" - ], - "id": "def-public.FieldFormat.htmlConvert", - "type": "Function", - "label": "htmlConvert", + "tags": [], + "id": "def-public.AggConfig.id", + "type": "string", + "label": "id", "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" - ] + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 93 + } }, { - "tags": [ - "property", - "protected" - ], - "id": "def-public.FieldFormat.textConvert", - "type": "Function", - "label": "textConvert", + "tags": [], + "id": "def-public.AggConfig.enabled", + "type": "boolean", + "label": "enabled", "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" - ] + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 94 + } }, { - "tags": [ - "property", - "private" - ], - "id": "def-public.FieldFormat.type", + "tags": [], + "id": "def-public.AggConfig.params", "type": "Any", - "label": "type", + "label": "params", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 95 }, "signature": [ "any" @@ -154,58 +164,55 @@ }, { "tags": [], - "id": "def-public.FieldFormat.allowsNumericalAggregations", - "type": "CompoundType", - "label": "allowsNumericalAggregations", + "id": "def-public.AggConfig.parent", + "type": "Object", + "label": "parent", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 96 }, "signature": [ - "boolean | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.FieldFormat._params", - "type": "Any", - "label": "_params", + "id": "def-public.AggConfig.brandNew", + "type": "CompoundType", + "label": "brandNew", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 97 }, "signature": [ - "any" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.FieldFormat.getConfig", - "type": "Function", - "label": "getConfig", + "id": "def-public.AggConfig.schema", + "type": "string", + "label": "schema", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 98 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - }, - " | undefined" + "string | undefined" ] }, { - "id": "def-public.FieldFormat.Unnamed", + "id": "def-public.AggConfig.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -215,948 +222,947 @@ "children": [ { "type": "Object", - "label": "_params", + "label": "aggConfigs", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.IFieldFormatMetaParams", - "text": "IFieldFormatMetaParams" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104 } }, { - "type": "Function", - "label": "getConfig", - "isRequired": false, + "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/field_formats/field_format.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 104 } }, { - "id": "def-public.FieldFormat.convert", + "id": "def-public.AggConfig.setParams", "type": "Function", - "label": "convert", + "label": "setParams", "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" + "(from: any) => void" ], "description": [ - "\nConvert a raw value to a formatted string" + "\nWrite the current values to this.params, filling in the defaults as we go\n" ], "children": [ { "type": "Any", - "label": "value", + "label": "from", "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" + "- optional object to read values from,\n used when initializing" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134 } - }, + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 134 + } + }, + { + "id": "def-public.AggConfig.getParam", + "type": "Function", + "label": "getParam", + "signature": [ + "(key: string) => any" + ], + "description": [], + "children": [ { - "type": "CompoundType", - "label": "options", - "isRequired": false, + "type": "string", + "label": "key", + "isRequired": true, "signature": [ - "Record | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" - }, - " | undefined" + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171 } } ], - "tags": [ - "return", - "public" - ], - "returnComment": [ - "- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute" - ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 171 } }, { - "id": "def-public.FieldFormat.getConverterFor", + "id": "def-public.AggConfig.write", "type": "Function", - "label": "getConverterFor", + "label": "write", "signature": [ - "(contentType?: ", + "(aggs?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" - } - ], - "description": [ - "\nGet a convert function that is bound to a specific contentType" + " | undefined) => Record" ], + "description": [], "children": [ { - "type": "CompoundType", - "label": "contentType", - "isRequired": true, + "type": "Object", + "label": "aggs", + "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175 } } ], - "tags": [ - "return", - "public" - ], - "returnComment": [ - "- a bound converter function" - ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 175 } }, { - "id": "def-public.FieldFormat.getParamDefaults", + "id": "def-public.AggConfig.isFilterable", "type": "Function", - "label": "getParamDefaults", + "label": "isFilterable", "signature": [ - "() => Record" - ], - "description": [ - "\nGet parameter defaults" + "() => boolean" ], + "description": [], "children": [], - "tags": [ - "return", - "public" - ], - "returnComment": [ - "- parameter defaults" - ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 179 } }, { - "id": "def-public.FieldFormat.param", + "id": "def-public.AggConfig.createFilter", "type": "Function", - "label": "param", + "label": "createFilter", "signature": [ - "(name: string) => any" - ], - "description": [ - "\nGet the value of a param. This value may be a default value.\n" + "(key: string, params?: {}) => any" ], + "description": [], "children": [ { "type": "string", - "label": "name", + "label": "key", "isRequired": true, "signature": [ "string" ], - "description": [ - "- the param name to fetch" + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183 + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "{}" ], + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183 } } ], - "tags": [ - "return", - "public" - ], + "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 183 } }, { - "id": "def-public.FieldFormat.params", + "id": "def-public.AggConfig.onSearchRequestStart", "type": "Function", - "label": "params", + "label": "onSearchRequestStart", "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; }" + "(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": [ - "\nSerialize this format to a simple POJO, with only the params\nthat are not default\n" + "\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 + } + }, + { + "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 + } + } ], - "children": [], "tags": [ - "return", - "public" + "return" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 209 } }, { - "id": "def-public.FieldFormat.from", + "id": "def-public.AggConfig.toDsl", "type": "Function", - "label": "from", + "label": "toDsl", "signature": [ - "typeof ", + "(aggConfigs?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" }, - ".from" + " | undefined) => any" + ], + "description": [ + "\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n" ], - "description": [], "children": [ { - "type": "Function", - "label": "convertFn", - "isRequired": true, + "type": "Object", + "label": "aggConfigs", + "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" - } + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" + }, + " | undefined" + ], + "description": [ + "- the config object to convert" ], - "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 230 } } ], - "tags": [], - "returnComment": [], + "tags": [ + "return" + ], + "returnComment": [ + "- if the config has a dsl representation, it is\n returned, else undefined is returned" + ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 230 } }, { - "id": "def-public.FieldFormat.setupContentType", + "id": "def-public.AggConfig.serialize", "type": "Function", - "label": "setupContentType", + "label": "serialize", "signature": [ - "() => ", + "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvert", - "text": "FieldFormatConvert" - } + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; schema?: string | undefined; }" ], "description": [], "children": [], "tags": [], - "returnComment": [], + "returnComment": [ + "Returns a serialized representation of an AggConfig." + ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 263 } }, { - "id": "def-public.FieldFormat.isInstanceOfFieldFormat", + "id": "def-public.AggConfig.toJSON", "type": "Function", - "label": "isInstanceOfFieldFormat", + "label": "toJSON", "signature": [ - "typeof ", + "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - ".isInstanceOfFieldFormat" + " | undefined; schema?: string | undefined; }" ], "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" - } - } + "children": [], + "tags": [ + "deprecated" ], - "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 294 } - } - ], - "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", - "tags": [], - "label": "IndexPatternsService", - "description": [], - "children": [ - { - "tags": [], - "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", + "id": "def-public.AggConfig.toSerializedFieldFormat", "type": "Function", - "label": "Constructor", + "label": "toSerializedFieldFormat", "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" - } - } + "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" ], - "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 305 } }, { - "id": "def-public.IndexPatternsService.getIds", + "id": "def-public.AggConfig.toExpressionAst", "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" - } - } - ], + "label": "toExpressionAst", "signature": [ - "(refresh?: boolean) => Promise" + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined" ], - "description": [ - "\nGet list of index pattern ids" + "description": [], + "children": [], + "tags": [], + "returnComment": [ + "Returns an ExpressionAst representing the this agg type." ], - "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 314 + } }, { - "id": "def-public.IndexPatternsService.getTitles", + "id": "def-public.AggConfig.getAggParams", "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" - } - } - ], + "label": "getAggParams", "signature": [ - "(refresh?: boolean) => Promise" - ], - "description": [ - "\nGet list of index pattern titles" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ">[]" ], - "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" - }, + "description": [], + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 369 + } }, { - "id": "def-public.IndexPatternsService.find", + "id": "def-public.AggConfig.getRequestAggs", "type": "Function", - "children": [ + "label": "getRequestAggs", + "signature": [ + "() => ", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - { - "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" - } - } + "[]" ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 373 + } + }, + { + "id": "def-public.AggConfig.getResponseAggs", + "type": "Function", + "label": "getResponseAggs", "signature": [ - "(search: string, size?: number) => Promise<", + "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - "[]>" - ], - "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" - }, + "description": [], + "children": [], "tags": [], - "returnComment": [ - "IndexPattern[]" - ] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 377 + } }, { - "id": "def-public.IndexPatternsService.getIdsWithTitle", + "id": "def-public.AggConfig.getValue", "type": "Function", + "label": "getValue", + "signature": [ + "(bucket: any) => any" + ], + "description": [], "children": [ { - "type": "boolean", - "label": "refresh", + "type": "Any", + "label": "bucket", "isRequired": true, "signature": [ - "boolean" + "any" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 381 + } }, { - "id": "def-public.IndexPatternsService.clearCache", + "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": 385 + } + }, { "type": "string", - "label": "id", + "label": "key", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 385 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 385 + } }, { - "id": "def-public.IndexPatternsService.getCache", + "id": "def-public.AggConfig.getFieldDisplayName", "type": "Function", - "children": [], + "label": "getFieldDisplayName", "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>" + "() => any" ], "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" - }, + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 393 + } }, { - "id": "def-public.IndexPatternsService.getDefault", + "id": "def-public.AggConfig.getField", "type": "Function", - "children": [], + "label": "getField", "signature": [ - "() => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | null>" + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 399 + } + }, + { + "id": "def-public.AggConfig.getValueBucketPath", + "type": "Function", + "label": "getValueBucketPath", + "signature": [ + "() => string" ], "description": [ - "\nGet default index pattern" + "\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)" ], - "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" - }, + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 408 + } }, { - "id": "def-public.IndexPatternsService.setDefault", + "id": "def-public.AggConfig.makeLabel", "type": "Function", + "label": "makeLabel", + "signature": [ + "(percentageMode?: boolean) => any" + ], + "description": [], "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", + "label": "percentageMode", "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 412 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 412 + } }, { - "id": "def-public.IndexPatternsService.getFieldsForWildcard", + "id": "def-public.AggConfig.getIndexPattern", "type": "Function", - "children": [ + "label": "getIndexPattern", + "signature": [ + "() => ", { - "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" - } + "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": 426 + } + }, + { + "id": "def-public.AggConfig.getTimeRange", + "type": "Function", + "label": "getTimeRange", "signature": [ - "(options: ", + "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" }, - ") => Promise" + " | undefined" ], - "description": [ - "\nGet field list by providing { pattern }" + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 430 + } + }, + { + "id": "def-public.AggConfig.fieldName", + "type": "Function", + "label": "fieldName", + "signature": [ + "() => any" ], - "label": "getFieldsForWildcard", + "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 434 + } + }, + { + "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": 439 + } + }, + { + "id": "def-public.AggConfig.type", + "type": "Object", + "label": "type", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 446 }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } + ] + }, + { + "id": "def-public.AggConfig.type", + "type": "Object", + "label": "type", "tags": [], - "returnComment": [ - "FieldSpec[]" + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 450 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } ] }, { - "id": "def-public.IndexPatternsService.getFieldsForIndexPattern", + "id": "def-public.AggConfig.setType", "type": "Function", - "children": [ + "label": "setType", + "signature": [ + "(type: ", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" }, + ") => void" + ], + "description": [], + "children": [ { "type": "Object", - "label": "options", - "isRequired": false, + "label": "type", + "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IAggType", + "text": "IAggType" + } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 480 } } ], - "signature": [ - "(indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | ", + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 480 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 55 + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggConfigs", + "type": "Class", + "tags": [], + "label": "AggConfigs", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.AggConfigs.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 58 + }, + "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", options?: ", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ] + }, + { + "tags": [], + "id": "def-public.AggConfigs.timeRange", + "type": "Object", + "label": "timeRange", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 59 + }, + "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" }, - " | undefined) => Promise" - ], - "description": [ - "\nGet field list by providing an index patttern (or spec)" - ], - "label": "getFieldsForIndexPattern", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.AggConfigs.aggs", + "type": "Array", + "label": "aggs", + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 62 }, - "tags": [], - "returnComment": [ - "FieldSpec[]" + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" ] }, { - "id": "def-public.IndexPatternsService.refreshFields", + "id": "def-public.AggConfigs.Unnamed", "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { "type": "Object", @@ -1173,5267 +1179,4871 @@ ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 65 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.IndexPatternsService.fieldArrayToMap", - "type": "Function", - "children": [ { "type": "Array", - "label": "fields", + "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/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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 66 } }, { "type": "Object", - "label": "fieldAttrs", - "isRequired": false, + "label": "opts", + "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigsOptions", + "text": "AggConfigsOptions" + } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 67 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 64 + } + }, + { + "id": "def-public.AggConfigs.setTimeRange", + "type": "Function", + "label": "setTimeRange", "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" + ") => void" ], - "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" - }, - "tags": [], - "returnComment": [ - "Record" - ] - }, - { - "id": "def-public.IndexPatternsService.savedObjectToSpec", - "type": "Function", + "description": [], "children": [ { "type": "Object", - "label": "savedObject", + "label": "timeRange", "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" - }, - ">" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 79 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 79 + } + }, + { + "id": "def-public.AggConfigs.clone", + "type": "Function", + "label": "clone", "signature": [ - "(savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", + "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" - }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfigs", + "text": "AggConfigs" } ], - "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" - }, - "tags": [], - "returnComment": [ - "IndexPatternSpec" - ] - }, - { - "id": "def-public.IndexPatternsService.get", - "type": "Function", + "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "{ enabledOnly = true }", "isRequired": true, "signature": [ - "string" + "{ enabledOnly?: boolean | undefined; }" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 97 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 97 + } }, { - "id": "def-public.IndexPatternsService.create", + "id": "def-public.AggConfigs.createAggConfig", "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", + "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/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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 111 } }, { - "type": "boolean", - "label": "skipFetchFields", + "type": "Object", + "label": "{ addToAggConfigs = true }", "isRequired": true, "signature": [ - "boolean" + "{ addToAggConfigs?: boolean | undefined; }" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 112 } } ], - "tags": [], - "returnComment": [ - "IndexPattern" + "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/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" - } + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 110 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.IndexPatternsService.createAndSave", + "id": "def-public.AggConfigs.jsonDataEquals", "type": "Function", - "label": "createAndSave", + "label": "jsonDataEquals", "signature": [ - "(spec: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", + "(aggConfigs: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - ">" + "[]) => boolean" ], "description": [ - "\nCreate a new index pattern and save it right away" + "\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes" ], "children": [ { - "type": "Object", - "label": "spec", + "type": "Array", + "label": "aggConfigs", "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" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" ], "description": [ - "Overwrite if existing index pattern exists." + "an AggConfigs instance" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 153 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 153 + } + }, + { + "id": "def-public.AggConfigs.toDsl", + "type": "Function", + "label": "toDsl", + "signature": [ + "(hierarchical?: boolean) => Record" + ], + "description": [], + "children": [ { "type": "boolean", - "label": "skipFetchFields", + "label": "hierarchical", "isRequired": true, "signature": [ "boolean" ], - "description": [ - "Whether to skip field refresh step." - ], + "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 165 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 165 } }, { - "id": "def-public.IndexPatternsService.createSavedObject", + "id": "def-public.AggConfigs.getAll", "type": "Function", - "label": "createSavedObject", + "label": "getAll", "signature": [ - "(indexPattern: ", + "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - ", override?: boolean) => Promise<", + "[]" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 227 + } + }, + { + "id": "def-public.AggConfigs.byIndex", + "type": "Function", + "label": "byIndex", + "signature": [ + "(index: number) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ">" - ], - "description": [ - "\nSave a new index pattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + } ], + "description": [], "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "number", + "label": "index", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "number" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 231 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 231 + } + }, + { + "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": "boolean", - "label": "override", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - "boolean" - ], - "description": [ - "Overwrite if existing index pattern exists" + "string" ], + "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 235 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 235 } }, { - "id": "def-public.IndexPatternsService.updateSavedObject", + "id": "def-public.AggConfigs.byName", "type": "Function", - "label": "updateSavedObject", + "label": "byName", "signature": [ - "(indexPattern: ", + "(name: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" - ], - "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + "[]" ], + "description": [], "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "string", + "label": "name", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 239 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 239 + } + }, + { + "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": "number", - "label": "saveAttempts", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "number" + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 243 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 243 + } + }, + { + "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": "boolean", - "label": "ignoreErrors", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 247 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 247 } }, { - "id": "def-public.IndexPatternsService.delete", + "id": "def-public.AggConfigs.bySchemaName", "type": "Function", - "label": "delete", + "label": "bySchemaName", "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "description": [ - "\nDeletes an index pattern from .kibana index" + "(schema: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" ], + "description": [], "children": [ { "type": "string", - "label": "indexPatternId", + "label": "schema", "isRequired": true, "signature": [ "string" ], - "description": [ - ": Id of kibana Index Pattern to delete" - ], + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 251 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 251 } - } - ], - "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", - "tags": [], - "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": [ { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, + "id": "def-public.AggConfigs.getRequestAggs", + "type": "Function", + "label": "getRequestAggs", "signature": [ + "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => Record; }" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [ - "deprecated" - ], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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; }" - ] - }, - { + "children": [], "tags": [], - "id": "def-public.IndexPattern.formatField", - "type": "Function", - "label": "formatField", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 255 + } }, { - "tags": [], - "id": "def-public.IndexPattern.flattenHit", + "id": "def-public.AggConfigs.getRequestAggById", "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" - ] - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, + "label": "getRequestAggById", "signature": [ + "(id: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - "[] | undefined" - ] - }, - { - "tags": [], - "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" + " | undefined" ], "description": [], "children": [ { - "type": "Object", - "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - "IndexPatternDeps" + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 269 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 269 } }, { - "id": "def-public.IndexPattern.getOriginalSavedObjectBody", + "id": "def-public.AggConfigs.getResponseAggs", "type": "Function", - "children": [], + "label": "getResponseAggs", "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; }" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + "[]" ], "description": [ - "\nGet last saved saved object fields" + "\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" ], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.IndexPattern.getComputedFields", - "type": "Function", - "label": "getComputedFields", - "signature": [ - "() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }" + "tags": [ + "return" ], - "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 284 } }, { - "id": "def-public.IndexPattern.toSpec", + "id": "def-public.AggConfigs.getResponseAggById", "type": "Function", - "label": "toSpec", + "label": "getResponseAggById", "signature": [ - "() => ", + "(id: string) => ", { "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" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + " | undefined" ], "description": [ - "\nAdd scripted field to field list\n" + "\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": "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", + "label": "id", "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" + "- the id of the agg to find" ], - "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 298 } } ], - "tags": [], + "tags": [ + "return" + ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 298 } }, { - "id": "def-public.IndexPattern.removeScriptedField", + "id": "def-public.AggConfigs.onSearchRequestStart", "type": "Function", - "label": "removeScriptedField", + "label": "onSearchRequestStart", "signature": [ - "(fieldName: string) => void" - ], - "description": [ - "\nRemove scripted field from field list" + "(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": "string", - "label": "fieldName", + "type": "Object", + "label": "searchSource", "isRequired": true, "signature": [ - "string" + "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/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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 307 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 307 } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 57 + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggParamType", + "type": "Class", + "tags": [], + "label": "AggParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" }, + " extends ", { - "id": "def-public.IndexPattern.getNonScriptedFields", + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.AggParamType.makeAgg", "type": "Function", - "label": "getNonScriptedFields", - "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - "[]" - ], + "label": "makeAgg", "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", + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, "signature": [ - "() => ", + "(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - "[]" - ], - "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" - } + " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" + ] }, { - "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" - ], + "id": "def-public.AggParamType.allowedAggs", + "type": "Array", + "label": "allowedAggs", "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", + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 16 + }, "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" - } + "string[]" + ] }, { - "id": "def-public.IndexPattern.getFieldByName", + "id": "def-public.AggParamType.Unnamed", "type": "Function", - "label": "getFieldByName", + "label": "Constructor", "signature": [ - "(name: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - " | undefined" + "any" ], "description": [], "children": [ { - "type": "string", - "label": "name", + "type": "Object", + "label": "config", "isRequired": true, "signature": [ - "string" + "Record" ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DataPublicPlugin", + "type": "Class", + "tags": [], + "label": "DataPublicPlugin", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPlugin", + "text": "DataPublicPlugin" }, + " implements ", { - "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" - } + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" }, + "<", { - "id": "def-public.IndexPattern.getAsSavedObjectBody", + "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": "getAsSavedObjectBody", + "label": "Constructor", "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; }" + "any" ], - "description": [ - "\nReturns index pattern as saved object body for saving" + "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 + } + } ], - "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 71 } }, { - "id": "def-public.IndexPattern.getFormatterForField", + "id": "def-public.DataPublicPlugin.setup", "type": "Function", - "label": "getFormatterForField", + "label": "setup", "signature": [ - "(field: ", + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" }, - " | ", + ", ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" }, - " | ", + ">, { bfetch, expressions, uiActions, usageCollection, inspector }: ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataSetupDependencies", + "text": "DataSetupDependencies" }, ") => ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - } - ], - "description": [ - "\nProvide a field, get its formatter" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginSetup", + "text": "DataPublicPluginSetup" + } ], + "description": [], "children": [ { - "type": "CompoundType", - "label": "field", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" }, - " | ", + ", ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" }, - " | ", + ">" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 81 + } + }, + { + "type": "Object", + "label": "{ bfetch, expressions, uiActions, usageCollection, inspector }", + "isRequired": true, + "signature": [ { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataSetupDependencies", + "text": "DataSetupDependencies" } ], "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 82 } } ], "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 80 } }, { - "id": "def-public.IndexPattern.addRuntimeField", + "id": "def-public.DataPublicPlugin.start", "type": "Function", - "label": "addRuntimeField", + "label": "start", "signature": [ - "(name: string, runtimeField: ", + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", { uiActions }: ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" }, - ") => void" - ], - "description": [ - "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" + ") => ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + } ], + "description": [], "children": [ { - "type": "string", - "label": "name", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ - "string" - ], - "description": [ - "Field name" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } ], + "description": [], "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 131 } }, { "type": "Object", - "label": "runtimeField", + "label": "{ uiActions }", "isRequired": true, "signature": [ { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataStartDependencies", + "text": "DataStartDependencies" } ], - "description": [ - "Runtime field definition" - ], + "description": [], "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 131 } } ], "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 131 } }, { - "id": "def-public.IndexPattern.removeRuntimeField", + "id": "def-public.DataPublicPlugin.stop", "type": "Function", - "label": "removeRuntimeField", + "label": "stop", "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" - } - } + "() => void" ], + "description": [], + "children": [], "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" + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 213 } + } + ], + "source": { + "path": "src/plugins/data/public/plugin.ts", + "lineNumber": 55 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DuplicateIndexPatternError", + "type": "Class", + "tags": [], + "label": "DuplicateIndexPatternError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.DuplicateIndexPatternError", + "text": "DuplicateIndexPatternError" }, + " extends Error" + ], + "children": [ { - "id": "def-public.IndexPattern.getFormatterForFieldNoDefault", + "id": "def-public.DuplicateIndexPatternError.Unnamed", "type": "Function", - "label": "getFormatterForFieldNoDefault", + "label": "Constructor", "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" + "any" ], + "description": [], "children": [ { "type": "string", - "label": "fieldname", + "label": "message", "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" + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10 } } ], "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" + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10 } - }, + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormat", + "type": "Class", + "tags": [], + "label": "FieldFormat", + "description": [], + "children": [ { - "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" + "tags": [ + "property", + "static", + "public" ], + "id": "def-public.FieldFormat.id", + "type": "string", + "label": "id", "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" - } - } + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 32 + } + }, + { + "tags": [ + "property", + "static", + "public" ], - "tags": [], - "returnComment": [], + "id": "def-public.FieldFormat.title", + "type": "string", + "label": "title", + "description": [], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 38 } }, { - "id": "def-public.IndexPattern.setFieldCustomLabel", - "type": "Function", - "label": "setFieldCustomLabel", + "tags": [ + "property", + "private" + ], + "id": "def-public.FieldFormat.fieldType", + "type": "CompoundType", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 44 + }, "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" + "string | string[]" + ] + }, + { + "tags": [ + "property", + "private" ], + "id": "def-public.FieldFormat.convertObject", + "type": "Object", + "label": "convertObject", "description": [], - "children": [ + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 52 + }, + "signature": [ { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvert", + "text": "FieldFormatConvert" }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-public.FieldFormat.htmlConvert", + "type": "Function", + "label": "htmlConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 60 + }, + "signature": [ { - "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" - } - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeConvert", + "text": "HtmlContextTypeConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-public.FieldFormat.textConvert", + "type": "Function", + "label": "textConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 68 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.TextContextTypeConvert", + "text": "TextContextTypeConvert" + }, + " | undefined" + ] + }, + { + "tags": [ + "property", + "private" ], + "id": "def-public.FieldFormat.type", + "type": "Any", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 74 + }, + "signature": [ + "any" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.FieldFormat.allowsNumericalAggregations", + "type": "CompoundType", + "label": "allowsNumericalAggregations", + "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" - } + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 75 + }, + "signature": [ + "boolean | undefined" + ] }, { - "id": "def-public.IndexPattern.setFieldCount", + "tags": [], + "id": "def-public.FieldFormat._params", + "type": "Any", + "label": "_params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 77 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-public.FieldFormat.getConfig", "type": "Function", - "label": "setFieldCount", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 78 + }, "signature": [ - "(fieldName: string, count: number | null | undefined) => void" + { + "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": "string", - "label": "fieldName", + "type": "Object", + "label": "_params", "isRequired": true, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.IFieldFormatMetaParams", + "text": "IFieldFormatMetaParams" + } ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 } }, { - "type": "CompoundType", - "label": "count", + "type": "Function", + "label": "getConfig", "isRequired": false, "signature": [ - "number | null | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + " | 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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 } } ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 } }, { - "id": "def-public.IndexPattern.setFieldFormat", + "id": "def-public.FieldFormat.convert", "type": "Function", - "children": [ + "label": "convert", + "signature": [ + "(value: any, contentType?: ", { - "type": "string", - "label": "fieldName", + "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": [ - "string" + "any" ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 99 } }, { - "type": "Object", - "label": "format", + "type": "CompoundType", + "label": "contentType", "isRequired": true, "signature": [ { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - ">" + "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" ], - "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 100 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.IndexPattern.deleteFieldFormat", - "type": "Function", - "children": [ { - "type": "string", - "label": "fieldName", - "isRequired": true, + "type": "CompoundType", + "label": "options", + "isRequired": false, "signature": [ - "string" + "Record | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 101 } } ], - "signature": [ - "(fieldName: string) => void" + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute" ], - "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" - }, - "tags": [], - "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", - "tags": [], - "label": "IndexPatternField", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 98 + } }, - " implements ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "children": [ { - "tags": [], - "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" - }, + "id": "def-public.FieldFormat.getConverterFor", + "type": "Function", + "label": "getConverterFor", "signature": [ + "(contentType?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" } - ] - }, - { - "id": "def-public.IndexPatternField.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" ], - "description": [], + "description": [ + "\nGet a convert function that is bound to a specific contentType" + ], "children": [ { - "type": "Object", - "label": "spec", + "type": "CompoundType", + "label": "contentType", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" } ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 119 } } ], - "tags": [], - "returnComment": [], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- a bound converter function" + ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 118 } }, { - "id": "def-public.IndexPatternField.count", - "type": "number", - "label": "count", - "tags": [], + "id": "def-public.FieldFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => Record" + ], "description": [ - "\nCount is used for field popularity" + "\nGet parameter defaults" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- parameter defaults" ], "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", - "tags": [], - "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 133 } }, { - "id": "def-public.IndexPatternField.runtimeField", - "type": "Object", - "label": "runtimeField", - "tags": [], - "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" - }, + "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": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " | undefined" - ] + "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 + } + } + ], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144 + } }, { - "id": "def-public.IndexPatternField.runtimeField", - "type": "Object", - "label": "runtimeField", - "tags": [], - "description": [], + "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/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" - }, + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 161 + } + }, + { + "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 + } + }, + { + "id": "def-public.FieldFormat.from", + "type": "Function", + "label": "from", "signature": [ + "typeof ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, - " | undefined" - ] - }, - { - "id": "def-public.IndexPatternField.script", - "type": "string", - "label": "script", - "tags": [], - "description": [ - "\nScript field code" + ".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 + } + } ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193 + } }, { - "id": "def-public.IndexPatternField.script", - "type": "string", - "label": "script", - "tags": [], + "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/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" - ] + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 197 + } }, { - "id": "def-public.IndexPatternField.lang", - "type": "string", - "label": "lang", - "tags": [], - "description": [ - "\nScript field language" + "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 + } + } ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204 + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 26 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPattern", + "type": "Class", + "tags": [], + "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.IndexPatternField.lang", - "type": "string", - "label": "lang", "tags": [], + "id": "def-public.IndexPattern.id", + "type": "string", + "label": "id", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 45 }, "signature": [ "string | undefined" ] }, { - "id": "def-public.IndexPatternField.customLabel", - "type": "string", - "label": "customLabel", "tags": [], + "id": "def-public.IndexPattern.title", + "type": "string", + "label": "title", "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" - ] + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 46 + } }, { - "id": "def-public.IndexPatternField.customLabel", - "type": "string", - "label": "customLabel", "tags": [], + "id": "def-public.IndexPattern.fieldFormatMap", + "type": "Object", + "label": "fieldFormatMap", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 47 }, "signature": [ - "string | undefined" + "Record" ] }, { - "id": "def-public.IndexPatternField.conflictDescriptions", - "type": "Object", - "label": "conflictDescriptions", "tags": [], + "id": "def-public.IndexPattern.typeMeta", + "type": "Object", + "label": "typeMeta", "description": [ - "\nDescription of field type conflicts across different indices in the same index pattern" + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 51 }, "signature": [ - "Record | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" ] }, { - "id": "def-public.IndexPatternField.conflictDescriptions", - "type": "Object", - "label": "conflictDescriptions", "tags": [], + "id": "def-public.IndexPattern.fields", + "type": "CompoundType", + "label": "fields", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 52 }, "signature": [ - "Record | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" + }, + " & { toSpec: () => Record; }" ] }, { - "id": "def-public.IndexPatternField.name", - "type": "string", - "label": "name", "tags": [], + "id": "def-public.IndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 53 + }, + "signature": [ + "string | undefined" + ] }, { - "id": "def-public.IndexPatternField.displayName", + "tags": [ + "deprecated" + ], + "id": "def-public.IndexPattern.intervalName", "type": "string", - "label": "displayName", - "tags": [], + "label": "intervalName", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 58 + }, + "signature": [ + "string | undefined" + ] }, { - "id": "def-public.IndexPatternField.type", + "tags": [], + "id": "def-public.IndexPattern.type", "type": "string", "label": "type", - "tags": [], - "description": [], + "description": [ + "\nType is used to identify rollup index patterns" + ], "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 62 + }, + "signature": [ + "string | undefined" + ] }, { - "id": "def-public.IndexPatternField.esTypes", - "type": "Array", - "label": "esTypes", "tags": [], + "id": "def-public.IndexPattern.formatHit", + "type": "Function", + "label": "formatHit", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 63 }, "signature": [ - "string[] | undefined" + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" ] }, { - "id": "def-public.IndexPatternField.scripted", - "type": "boolean", - "label": "scripted", "tags": [], + "id": "def-public.IndexPattern.formatField", + "type": "Function", + "label": "formatField", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 67 + }, + "signature": [ + "FormatFieldFn" + ] }, { - "id": "def-public.IndexPatternField.searchable", - "type": "boolean", - "label": "searchable", "tags": [], + "id": "def-public.IndexPattern.flattenHit", + "type": "Function", + "label": "flattenHit", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 68 + }, + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ] }, { - "id": "def-public.IndexPatternField.aggregatable", - "type": "boolean", - "label": "aggregatable", "tags": [], + "id": "def-public.IndexPattern.metaFields", + "type": "Array", + "label": "metaFields", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 69 + }, + "signature": [ + "string[]" + ] }, { - "id": "def-public.IndexPatternField.readFromDocValues", - "type": "boolean", - "label": "readFromDocValues", "tags": [], - "description": [], + "id": "def-public.IndexPattern.version", + "type": "string", + "label": "version", + "description": [ + "\nSavedObject version" + ], "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 73 + }, + "signature": [ + "string | undefined" + ] }, { - "id": "def-public.IndexPatternField.subType", - "type": "Object", - "label": "subType", "tags": [], + "id": "def-public.IndexPattern.sourceFilters", + "type": "Array", + "label": "sourceFilters", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 74 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" + "section": "def-common.SourceFilter", + "text": "SourceFilter" }, - " | undefined" + "[] | undefined" ] }, { - "id": "def-public.IndexPatternField.isMapped", - "type": "CompoundType", - "label": "isMapped", "tags": [], + "id": "def-public.IndexPattern.allowNoIndex", + "type": "boolean", + "label": "allowNoIndex", "description": [ - "\nIs the field part of the index mapping?" + "\nprevents errors when index pattern exists before indices" ], "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", - "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 84 } }, { - "id": "def-public.IndexPatternField.filterable", - "type": "boolean", - "label": "filterable", - "tags": [], + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86 } }, { - "id": "def-public.IndexPatternField.visualizable", - "type": "boolean", - "label": "visualizable", - "tags": [], - "description": [], + "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/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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 128 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.IndexPatternField.deleteCount", + "id": "def-public.IndexPattern.resetOriginalSavedObjectBody", "type": "Function", - "label": "deleteCount", + "children": [], "signature": [ "() => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], + "description": [ + "\nReset last saved saved object fields. used after saving" + ], + "label": "resetOriginalSavedObjectBody", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 133 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.IndexPatternField.toJSON", + "id": "def-public.IndexPattern.getFieldAttrs", "type": "Function", - "label": "toJSON", + "children": [], "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: ", + "() => { [x: string]: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - " | undefined; customLabel: string | undefined; }" + "; }" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "getFieldAttrs", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 137 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.IndexPatternField.toSpec", + "id": "def-public.IndexPattern.getComputedFields", "type": "Function", - "label": "toSpec", + "label": "getComputedFields", "signature": [ - "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", + "() => { 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 + } + }, + { + "id": "def-public.IndexPattern.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - " | ", + "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 + } + }, + { + "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 + } + }, + { + "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": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "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 + } }, - ") => ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "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 + } }, - ") | 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 }", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "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" - ] - } + "type": "string", + "label": "fieldType", + "isRequired": true, + "signature": [ + "string" ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 } - } - ], - "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", - "tags": [], - "label": "DuplicateIndexPatternError", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.DuplicateIndexPatternError", - "text": "DuplicateIndexPatternError" }, - " extends Error" - ], - "children": [ { - "id": "def-public.DuplicateIndexPatternError.Unnamed", + "id": "def-public.IndexPattern.removeScriptedField", "type": "Function", - "label": "Constructor", + "label": "removeScriptedField", "signature": [ - "any" + "(fieldName: string) => void" + ], + "description": [ + "\nRemove scripted field from field list" ], - "description": [], "children": [ { "type": "string", - "label": "message", + "label": "fieldName", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 } - } - ], - "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", - "tags": [], - "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": [ - { - "tags": [], - "id": "def-public.AggParamType.makeAgg", + "id": "def-public.IndexPattern.getNonScriptedFields", "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" - }, + "label": "getNonScriptedFields", "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" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" - ] - }, - { - "tags": [], - "id": "def-public.AggParamType.allowedAggs", - "type": "Array", - "label": "allowedAggs", + "[]" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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[]" - ] + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 277 + } }, { - "id": "def-public.AggParamType.Unnamed", + "id": "def-public.IndexPattern.getScriptedFields", "type": "Function", - "label": "Constructor", + "label": "getScriptedFields", "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" - } - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" ], + "description": [], + "children": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 281 } - } - ], - "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", - "tags": [], - "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" + "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 + } }, - ">" - ], - "children": [ { - "tags": [], - "id": "def-public.OptionedParamType.options", - "type": "Array", - "label": "options", + "id": "def-public.IndexPattern.isTimeNanosBased", + "type": "Function", + "label": "isTimeNanosBased", + "signature": [ + "() => boolean" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - }, + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 289 + } + }, + { + "id": "def-public.IndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", "signature": [ + "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.OptionedValueProp", - "text": "OptionedValueProp" + "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 + } }, { - "id": "def-public.OptionedParamType.Unnamed", + "id": "def-public.IndexPattern.getFieldByName", "type": "Function", - "label": "Constructor", + "label": "getFieldByName", "signature": [ - "any" + "(name: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | undefined" ], "description": [], "children": [ { - "type": "Object", - "label": "config", + "type": "string", + "label": "name", "isRequired": true, "signature": [ - "Record" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 } - } - ], - "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", - "tags": [], - "label": "AggConfigs", - "description": [], - "children": [ + }, { - "tags": [], - "id": "def-public.AggConfigs.indexPattern", - "type": "Object", - "label": "indexPattern", + "id": "def-public.IndexPattern.getAggregationRestrictions", + "type": "Function", + "label": "getAggregationRestrictions", + "signature": [ + "() => Record> | undefined" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - }, + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 304 + } + }, + { + "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 + } + }, + { + "id": "def-public.IndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", "signature": [ + "(field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } - ] - }, - { - "tags": [], - "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": [ + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - " | undefined" - ] - }, - { - "tags": [], - "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" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, - "[]" - ] - }, - { - "id": "def-public.AggConfigs.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "description": [ + "\nProvide a field, get its formatter" ], - "description": [], "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "CompoundType", + "label": "field", "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" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - "; }, \"type\"> & Pick<{ type: string | ", + " | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - }, - "; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 340 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339 + } + }, + { + "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 } }, { "type": "Object", - "label": "opts", + "label": "runtimeField", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigsOptions", - "text": "AggConfigsOptions" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" } ], - "description": [], + "description": [ + "Runtime field definition" + ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 } }, { - "id": "def-public.AggConfigs.setTimeRange", + "id": "def-public.IndexPattern.removeRuntimeField", "type": "Function", - "label": "setTimeRange", + "label": "removeRuntimeField", "signature": [ - "(timeRange: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - ") => void" + "(name: string) => void" + ], + "description": [ + "\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate" ], - "description": [], "children": [ { - "type": "Object", - "label": "timeRange", + "type": "string", + "label": "name", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "string" + ], + "description": [ + "Field name" ], - "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384 } }, { - "id": "def-public.AggConfigs.clone", + "id": "def-public.IndexPattern.getFormatterForFieldNoDefault", "type": "Function", - "label": "clone", + "label": "getFormatterForFieldNoDefault", "signature": [ - "({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ", + "(fieldname: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - } + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + " | undefined" + ], + "description": [ + "\nGet formatter for a given field name. Return undefined if none exists" ], - "description": [], "children": [ { - "type": "Object", - "label": "{ enabledOnly = true }", + "type": "string", + "label": "fieldname", "isRequired": true, "signature": [ - "{ enabledOnly?: boolean | undefined; }" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 } }, { - "id": "def-public.AggConfigs.createAggConfig", + "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": "Object", - "label": "params", + "type": "string", + "label": "fieldName", "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\">" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 412 } }, { - "type": "Object", - "label": "{ addToAggConfigs = true }", + "type": "Uncategorized", + "label": "attrName", "isRequired": true, "signature": [ - "{ addToAggConfigs?: boolean | undefined; }" + "K" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 413 } - } - ], - "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" - }, - "tags": [], - "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", + "type": "Uncategorized", + "label": "value", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - "[]" - ], - "description": [ - "an AggConfigs instance" + "[K]" ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 414 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411 } }, { - "id": "def-public.AggConfigs.toDsl", + "id": "def-public.IndexPattern.setFieldCustomLabel", "type": "Function", - "label": "toDsl", + "label": "setFieldCustomLabel", "signature": [ - "(hierarchical?: boolean) => Record" + "(fieldName: string, customLabel: string | null | undefined) => void" ], "description": [], "children": [ { - "type": "boolean", - "label": "hierarchical", + "type": "string", + "label": "fieldName", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 } - } - ], - "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, + "type": "CompoundType", + "label": "customLabel", + "isRequired": false, "signature": [ - "number" + "string | null | undefined" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 } }, { - "id": "def-public.AggConfigs.byId", + "id": "def-public.IndexPattern.setFieldCount", "type": "Function", - "label": "byId", + "label": "setFieldCount", "signature": [ - "(id: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - " | undefined" + "(fieldName: string, count: number | null | undefined) => void" ], "description": [], "children": [ { "type": "string", - "label": "id", + "label": "fieldName", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 } }, { - "id": "def-public.AggConfigs.byName", + "id": "def-public.IndexPattern.setFieldFormat", "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", + "label": "fieldName", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 } - } - ], - "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", + "type": "Object", + "label": "format", "isRequired": true, "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 } } ], - "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) => ", + "(fieldName: string, format: ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.IndexPattern.deleteFieldFormat", + "type": "Function", "children": [ { "type": "string", - "label": "type", + "label": "fieldName", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(fieldName: string) => void" + ], + "description": [], + "label": "deleteFieldFormat", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternField", + "type": "Class", + "tags": [], + "label": "IndexPatternField", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, + " implements ", { - "id": "def-public.AggConfigs.bySchemaName", - "type": "Function", - "label": "bySchemaName", + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "children": [ + { + "tags": [], + "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 + }, "signature": [ - "(schema: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[]" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ] + }, + { + "id": "def-public.IndexPatternField.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], "description": [], "children": [ { - "type": "string", - "label": "schema", + "type": "Object", + "label": "spec", "isRequired": true, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21 } } ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21 } }, { - "id": "def-public.AggConfigs.getRequestAggs", - "type": "Function", - "label": "getRequestAggs", - "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - "[]" + "id": "def-public.IndexPatternField.count", + "type": "number", + "label": "count", + "tags": [], + "description": [ + "\nCount is used for field popularity" ], - "description": [], - "children": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 31 + } + }, + { + "id": "def-public.IndexPatternField.count", + "type": "number", + "label": "count", "tags": [], - "returnComment": [], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 35 } }, { - "id": "def-public.AggConfigs.getRequestAggById", - "type": "Function", - "label": "getRequestAggById", + "id": "def-public.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 39 + }, "signature": [ - "(id: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, " | 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", + "id": "def-public.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 43 + }, "signature": [ - "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - "[]" - ], + " | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.script", + "type": "string", + "label": "script", + "tags": [], "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" + "\nScript field code" ], - "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", + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 50 + }, "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" - } + "string | undefined" + ] }, { - "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" - } - } - ], + "id": "def-public.IndexPatternField.script", + "type": "string", + "label": "script", "tags": [], - "returnComment": [], + "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" - } - } - ], - "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", - "tags": [], - "label": "AggConfig", - "description": [], - "children": [ - { - "id": "def-public.AggConfig.ensureIds", - "type": "Function", - "label": "ensureIds", + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 54 + }, "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" - } + "string | undefined" + ] }, { - "id": "def-public.AggConfig.nextId", - "type": "Function", - "label": "nextId", - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ".nextId" - ], + "id": "def-public.IndexPatternField.lang", + "type": "string", + "label": "lang", + "tags": [], "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" + "\nScript field language" ], "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" - } + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 61 + }, + "signature": [ + "string | undefined" + ] }, { + "id": "def-public.IndexPatternField.lang", + "type": "string", + "label": "lang", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 65 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - } + "string | undefined" ] }, { - "tags": [], - "id": "def-public.AggConfig.id", + "id": "def-public.IndexPatternField.customLabel", "type": "string", - "label": "id", + "label": "customLabel", + "tags": [], "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" - } + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 69 + }, + "signature": [ + "string | undefined" + ] }, { + "id": "def-public.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", "tags": [], - "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" - } + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 73 + }, + "signature": [ + "string | undefined" + ] }, { + "id": "def-public.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", "tags": [], - "id": "def-public.AggConfig.params", - "type": "Any", - "label": "params", - "description": [], + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern" + ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 80 }, "signature": [ - "any" + "Record | undefined" ] }, { - "tags": [], - "id": "def-public.AggConfig.parent", + "id": "def-public.IndexPatternField.conflictDescriptions", "type": "Object", - "label": "parent", + "label": "conflictDescriptions", + "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 84 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - " | undefined" + "Record | undefined" ] }, { + "id": "def-public.IndexPatternField.name", + "type": "string", + "label": "name", "tags": [], - "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 89 + } }, { + "id": "def-public.IndexPatternField.displayName", + "type": "string", + "label": "displayName", "tags": [], - "id": "def-public.AggConfig.schema", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 93 + } + }, + { + "id": "def-public.IndexPatternField.type", "type": "string", - "label": "schema", + "label": "type", + "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 101 + } + }, + { + "id": "def-public.IndexPatternField.esTypes", + "type": "Array", + "label": "esTypes", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 107 }, "signature": [ - "string | undefined" + "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" - } - } - ], + "id": "def-public.IndexPatternField.scripted", + "type": "boolean", + "label": "scripted", "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 111 } }, { - "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": [], + "id": "def-public.IndexPatternField.searchable", + "type": "boolean", + "label": "searchable", + "tags": [], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 115 } }, { - "id": "def-public.AggConfig.getParam", - "type": "Function", - "label": "getParam", - "signature": [ - "(key: string) => any" - ], + "id": "def-public.IndexPatternField.aggregatable", + "type": "boolean", + "label": "aggregatable", + "tags": [], "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" - } - } - ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 119 + } + }, + { + "id": "def-public.IndexPatternField.readFromDocValues", + "type": "boolean", + "label": "readFromDocValues", "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 123 } }, { - "id": "def-public.AggConfig.write", - "type": "Function", - "label": "write", + "id": "def-public.IndexPatternField.subType", + "type": "Object", + "label": "subType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 127 + }, "signature": [ - "(aggs?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" }, - " | undefined) => Record" + " | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.isMapped", + "type": "CompoundType", + "label": "isMapped", + "tags": [], + "description": [ + "\nIs the field part of the index mapping?" ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 134 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "id": "def-public.IndexPatternField.sortable", + "type": "boolean", + "label": "sortable", + "tags": [], "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" - } - } - ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 139 + } + }, + { + "id": "def-public.IndexPatternField.filterable", + "type": "boolean", + "label": "filterable", "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 146 } }, { - "id": "def-public.AggConfig.isFilterable", + "id": "def-public.IndexPatternField.visualizable", + "type": "boolean", + "label": "visualizable", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 154 + } + }, + { + "id": "def-public.IndexPatternField.deleteCount", "type": "Function", - "label": "isFilterable", + "label": "deleteCount", "signature": [ - "() => boolean" + "() => void" ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 159 } }, { - "id": "def-public.AggConfig.createFilter", + "id": "def-public.IndexPatternField.toJSON", "type": "Function", - "label": "createFilter", + "label": "toJSON", "signature": [ - "(key: string, params?: {}) => any" - ], - "description": [], - "children": [ + "() => { 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: ", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" }, - { - "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" - } - } + " | undefined; customLabel: string | undefined; }" ], + "description": [], + "children": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 163 } }, { - "id": "def-public.AggConfig.onSearchRequestStart", + "id": "def-public.IndexPatternField.toSpec", "type": "Function", - "label": "onSearchRequestStart", + "label": "toSpec", "signature": [ - "(searchSource: Pick<", + "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - ", \"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" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - " | undefined) => Promise | Promise" - ], - "description": [ - "\n Hook for pre-flight logic, see AggType#onSearchRequestStart" + " | ", + { + "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": "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\">" - ], + "label": "{\n getFormatterForField,\n }", + "tags": [], "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": [ + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined" + "tags": [], + "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 + }, + "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" + ] + } ], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 183 } } ], - "tags": [ - "return" - ], + "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 181 } - }, - { - "id": "def-public.AggConfig.toDsl", - "type": "Function", - "label": "toDsl", - "signature": [ - "(aggConfigs?: ", + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ { "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" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] + }, + { + "id": "def-public.IndexPatternsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], + "description": [], "children": [ { "type": "Object", - "label": "aggConfigs", - "isRequired": false, + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - " | undefined" - ], - "description": [ - "- the config object to convert" + "IndexPatternsServiceDeps" ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 } } ], - "tags": [ - "return" - ], - "returnComment": [ - "- if the config has a dsl representation, it is\n returned, else undefined is returned" - ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 } }, { - "id": "def-public.AggConfig.serialize", + "id": "def-public.IndexPatternsService.getIds", "type": "Function", - "label": "serialize", - "signature": [ - "() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", + "children": [ { - "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." + "type": "boolean", + "label": "refresh", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + } + } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 263, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L263" - } - }, - { - "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; }" + "(refresh?: boolean) => Promise" ], - "description": [], - "children": [], - "tags": [ - "deprecated" + "description": [ + "\nGet list of index pattern ids" ], - "returnComment": [], + "label": "getIds", "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 294, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L294" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.toSerializedFieldFormat", + "id": "def-public.IndexPatternsService.getTitles", "type": "Function", - "label": "toSerializedFieldFormat", + "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 + } + } + ], "signature": [ - "() => {}" + "(refresh?: boolean) => Promise" ], "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" + "\nGet list of index pattern titles" ], - "returnComment": [], + "label": "getTitles", "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 305, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L305" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.toExpressionAst", + "id": "def-public.IndexPatternsService.find", "type": "Function", - "label": "toExpressionAst", - "signature": [ - "() => ", + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "type": "string", + "label": "search", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + } }, - " | undefined" - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [ - "Returns an ExpressionAst representing the this agg type." + { + "type": "number", + "label": "size", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + } + } ], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 314, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L314" - } - }, - { - "id": "def-public.AggConfig.getAggParams", - "type": "Function", - "label": "getAggParams", "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamType", - "text": "AggParamType" - }, - "<", + "(search: string, size?: number) => Promise<", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ">[]" + "[]>" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], + "description": [ + "\nFind and load index patterns by title" + ], + "label": "find", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + }, + "tags": [], + "returnComment": [ + "IndexPattern[]" + ] }, { - "id": "def-public.AggConfig.getRequestAggs", + "id": "def-public.IndexPatternsService.getIdsWithTitle", "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": 373, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L373" - } - }, - { - "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": 377, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377" - } - }, - { - "id": "def-public.AggConfig.getValue", - "type": "Function", - "label": "getValue", - "signature": [ - "(bucket: any) => any" - ], - "description": [], "children": [ { - "type": "Any", - "label": "bucket", + "type": "boolean", + "label": "refresh", "isRequired": true, "signature": [ - "any" + "boolean" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 157 } } ], - "tags": [], - "returnComment": [], + "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/search/aggs/agg_config.ts", - "lineNumber": 381, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 156 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.getKey", + "id": "def-public.IndexPatternsService.clearCache", "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": 385, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L385" - } - }, { "type": "string", - "label": "key", + "label": "id", "isRequired": false, "signature": [ "string | undefined" ], "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 385, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L385" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 } } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 385, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L385" - } - }, - { - "id": "def-public.AggConfig.getFieldDisplayName", - "type": "Function", - "label": "getFieldDisplayName", "signature": [ - "() => any" + "(id?: string | undefined) => void" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], + "description": [ + "\nClear index pattern list cache" + ], + "label": "clearCache", "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 393, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L393" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.getField", + "id": "def-public.IndexPatternsService.getCache", "type": "Function", - "label": "getField", + "children": [], "signature": [ - "() => any" + "() => 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": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "getCache", "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 399, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L399" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.getValueBucketPath", + "id": "def-public.IndexPatternsService.getDefault", "type": "Function", - "label": "getValueBucketPath", + "children": [], "signature": [ - "() => string" + "() => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | null>" ], "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)" + "\nGet default index pattern" ], - "children": [], - "tags": [], - "returnComment": [], + "label": "getDefault", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.makeLabel", + "id": "def-public.IndexPatternsService.setDefault", "type": "Function", - "label": "makeLabel", - "signature": [ - "(percentageMode?: boolean) => any" - ], - "description": [], "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 + } + }, { "type": "boolean", - "label": "percentageMode", + "label": "force", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 412, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L412" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(id: string, force?: boolean) => Promise" + ], + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "label": "setDefault", "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 412, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L412" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.AggConfig.getIndexPattern", + "id": "def-public.IndexPatternsService.getFieldsForWildcard", "type": "Function", - "label": "getIndexPattern", + "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 + } + } + ], "signature": [ - "() => ", + "(options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" + }, + ") => Promise" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], + "description": [ + "\nGet field list by providing { pattern }" + ], + "label": "getFieldsForWildcard", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] }, { - "id": "def-public.AggConfig.getTimeRange", + "id": "def-public.IndexPatternsService.getFieldsForIndexPattern", "type": "Function", - "label": "getTimeRange", - "signature": [ - "() => ", + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "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 + } }, - " | undefined" - ], - "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.fieldName", - "type": "Function", - "label": "fieldName", - "signature": [ - "() => any" - ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 434, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L434" - } - }, - { - "id": "def-public.AggConfig.fieldIsTimeField", - "type": "Function", - "label": "fieldIsTimeField", - "signature": [ - "() => boolean | \"\" | undefined" + { + "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 + } + } ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 439, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L439" - } - }, - { - "id": "def-public.AggConfig.type", - "type": "Object", - "label": "type", - "tags": [], - "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": [ + "(indexPattern: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } - ] - }, - { - "id": "def-public.AggConfig.type", - "type": "Object", - "label": "type", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 450, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L450" - }, - "signature": [ + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" - } - ] - }, - { - "id": "def-public.AggConfig.setType", - "type": "Function", - "label": "setType", - "signature": [ - "(type: ", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + }, + ", options?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - ") => void" + " | undefined) => Promise" ], - "description": [], + "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 + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-public.IndexPatternsService.refreshFields", + "type": "Function", "children": [ { "type": "Object", - "label": "type", + "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IAggType", - "text": "IAggType" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" } ], "description": [], "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 480, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L480" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250 } } ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 480, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L480" - } - } - ], - "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", - "tags": [ - "public" - ], - "label": "SearchSource", - "description": [], - "children": [ - { - "tags": [], - "id": "def-public.SearchSource.history", - "type": "Array", - "label": "history", - "description": [], + "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/search/search_source/search_source.ts", - "lineNumber": 111, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L111" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250 }, - "signature": [ - "Record[]" - ] + "tags": [], + "returnComment": [] }, { - "id": "def-public.SearchSource.Unnamed", + "id": "def-public.IndexPatternsService.fieldArrayToMap", "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], "children": [ { - "type": "Object", + "type": "Array", "label": "fields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" ], "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L115" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327 } }, { "type": "Object", - "label": "dependencies", - "isRequired": true, + "label": "fieldAttrs", + "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceDependencies", - "text": "SearchSourceDependencies" - } + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" ], "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L115" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327 } } ], - "tags": [], - "returnComment": [], + "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/search/search_source/search_source.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L115" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327 + }, + "tags": [], + "returnComment": [ + "Record" + ] }, { - "id": "def-public.SearchSource.setPreferredSearchStrategyId", + "id": "def-public.IndexPatternsService.savedObjectToSpec", "type": "Function", - "label": "setPreferredSearchStrategyId", + "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 + } + } + ], "signature": [ - "(searchStrategyId: string) => void" + "(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": [ - "**\nPUBLIC API\n\ninternal, dont use" + "\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 + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] + }, + { + "id": "def-public.IndexPatternsService.get", + "type": "Function", "children": [ { "type": "string", - "label": "searchStrategyId", + "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L133" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464 } } ], - "tags": [], - "returnComment": [], + "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/search/search_source/search_source.ts", - "lineNumber": 133, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L133" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.SearchSource.setField", + "id": "def-public.IndexPatternsService.create", "type": "Function", - "label": "setField", + "label": "create", "signature": [ - "(field: K, value: ", + "(spec: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" }, - "[K]) => this" + ", skipFetchFields?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" ], "description": [ - "\nsets value to a single search source field" + "\nCreate a new index pattern instance" ], "children": [ { - "type": "Uncategorized", - "label": "field", + "type": "Object", + "label": "spec", "isRequired": true, "signature": [ - "K" - ], - "description": [ - ": field name" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], + "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L142" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 } }, { - "type": "Uncategorized", - "label": "value", + "type": "boolean", + "label": "skipFetchFields", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - "[K]" - ], - "description": [ - ": value for the field" + "boolean" ], + "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L142" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 } } ], "tags": [], - "returnComment": [], + "returnComment": [ + "IndexPattern" + ], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L142" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 } }, { - "id": "def-public.SearchSource.removeField", + "id": "def-public.IndexPatternsService.createAndSave", "type": "Function", - "label": "removeField", + "label": "createAndSave", "signature": [ - "(field: K) => this" + "(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": [ - "\nremove field" + "\nCreate a new index pattern and save it right away" ], "children": [ { - "type": "Uncategorized", - "label": "field", + "type": "Object", + "label": "spec", "isRequired": true, "signature": [ - "K" - ], - "description": [ - ": field name" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], + "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L154" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 + } + }, + { + "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 + } + }, + { + "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 } } ], "tags": [], "returnComment": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L154" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 } }, { - "id": "def-public.SearchSource.setFields", + "id": "def-public.IndexPatternsService.createSavedObject", "type": "Function", - "label": "setFields", + "label": "createSavedObject", "signature": [ - "(newFields: ", + "(indexPattern: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ") => this" + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" ], "description": [ - "\nInternal, do not use. Overrides all search source fields with the new field array.\n" + "\nSave a new index pattern" ], "children": [ { "type": "Object", - "label": "newFields", + "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" } ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 + } + }, + { + "type": "boolean", + "label": "override", + "isRequired": true, + "signature": [ + "boolean" + ], "description": [ - "New field array." + "Overwrite if existing index pattern exists" ], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L165" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 } } ], - "tags": [ - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L165" - } - }, - { - "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": 173, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L173" - } - }, - { - "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": 180, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L180" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 } }, { - "id": "def-public.SearchSource.getField", + "id": "def-public.IndexPatternsService.updateSavedObject", "type": "Function", - "label": "getField", + "label": "updateSavedObject", "signature": [ - "(field: K, recurse?: boolean) => ", + "(indexPattern: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - "[K]" + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], "description": [ - "\nGets a single field from the fields" + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" ], "children": [ { - "type": "Uncategorized", - "label": "field", + "type": "Object", + "label": "indexPattern", "isRequired": true, "signature": [ - "K" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } ], "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L187" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 547 + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548 } }, { "type": "boolean", - "label": "recurse", + "label": "ignoreErrors", "isRequired": true, "signature": [ "boolean" ], "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L187" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549 } } ], "tags": [], "returnComment": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L187" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546 } }, { - "id": "def-public.SearchSource.getOwnField", + "id": "def-public.IndexPatternsService.delete", "type": "Function", - "label": "getOwnField", + "label": "delete", "signature": [ - "(field: K) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - "[K]" + "(indexPatternId: string) => Promise<{}>" ], "description": [ - "\nGet the field from our own fields, don't traverse up the chain" + "\nDeletes an index pattern from .kibana index" ], "children": [ { - "type": "Uncategorized", - "label": "field", + "type": "string", + "label": "indexPatternId", "isRequired": true, "signature": [ - "K" + "string" + ], + "description": [ + ": Id of kibana Index Pattern to delete" ], - "description": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L198" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632 } } ], "tags": [], "returnComment": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L198" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632 } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "initialIsOpen": false + }, + { + "id": "def-public.OptionedParamType", + "type": "Class", + "tags": [], + "label": "OptionedParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedParamType", + "text": "OptionedParamType" }, + " extends ", { - "id": "def-public.SearchSource.create", - "type": "Function", - "label": "create", + "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": [ + { + "tags": [], + "id": "def-public.OptionedParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20 + }, "signature": [ - "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - } + "section": "def-common.OptionedValueProp", + "text": "OptionedValueProp" + }, + "[]" + ] + }, + { + "id": "def-public.OptionedParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], "description": [], - "children": [], - "tags": [ - "deprecated" + "children": [ + { + "type": "Object", + "label": "config", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 + } + } ], + "tags": [], "returnComment": [], "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 205, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L205" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19 + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchSource", + "type": "Class", + "tags": [ + "public" + ], + "label": "SearchSource", + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.SearchSource.history", + "type": "Array", + "label": "history", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 111 + }, + "signature": [ + "Record[]" + ] }, { - "id": "def-public.SearchSource.createCopy", + "id": "def-public.SearchSource.Unnamed", "type": "Function", - "label": "createCopy", + "label": "Constructor", "signature": [ - "() => ", + "any" + ], + "description": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "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": 115 + } + }, + { + "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": 115 + } } ], - "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": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L212" + "lineNumber": 115 } }, { - "id": "def-public.SearchSource.createChild", + "id": "def-public.SearchSource.setPreferredSearchStrategyId", "type": "Function", - "label": "createChild", + "label": "setPreferredSearchStrategyId", "signature": [ - "(options?: {}) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - } + "(searchStrategyId: string) => void" ], "description": [ - "\ncreates a new child search source" + "**\nPUBLIC API\n\ninternal, dont use" ], "children": [ { - "type": "Object", - "label": "options", + "type": "string", + "label": "searchStrategyId", "isRequired": true, "signature": [ - "{}" + "string" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L226" + "lineNumber": 133 } } ], @@ -6441,367 +6051,372 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L226" + "lineNumber": 133 } }, { - "id": "def-public.SearchSource.setParent", + "id": "def-public.SearchSource.setField", "type": "Function", - "label": "setParent", + "label": "setField", "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?: ", + "(field: K, value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceOptions", - "text": "SearchSourceOptions" + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, - ") => this" + "[K]) => this" ], "description": [ - "\nSet a searchSource that this source should inherit from" + "\nsets value to a single search source field" ], "children": [ { - "type": "Object", - "label": "parent", - "isRequired": false, + "type": "Uncategorized", + "label": "field", + "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\"> | undefined" + "K" ], "description": [ - "- the parent searchSource" + ": field name" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L238" + "lineNumber": 142 } }, { - "type": "Object", - "label": "options", + "type": "Uncategorized", + "label": "value", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceOptions", - "text": "SearchSourceOptions" - } + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" ], "description": [ - "- the inherit options" + ": value for the field" ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L238" + "lineNumber": 142 } } ], - "tags": [ - "return" - ], - "returnComment": [ - "- chainable" - ], + "tags": [], + "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L238" + "lineNumber": 142 } }, { - "id": "def-public.SearchSource.getParent", + "id": "def-public.SearchSource.removeField", "type": "Function", - "label": "getParent", + "label": "removeField", "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - " | undefined" + "(field: K) => this" ], "description": [ - "\nGet the parent of this SearchSource" + "\nremove field" ], - "children": [], - "tags": [ - "return" + "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": 154 + } + } ], + "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 248, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L248" + "lineNumber": 154 } }, { - "id": "def-public.SearchSource.fetch$", + "id": "def-public.SearchSource.setFields", "type": "Function", - "label": "fetch$", + "label": "setFields", "signature": [ - "(options?: ", + "(newFields: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, - ") => ", - "Observable", - "<", - "SearchResponse", - ">" + ") => this" ], "description": [ - "\nFetch this source from Elasticsearch, returning an observable over the response(s)" + "\nInternal, do not use. Overrides all search source fields with the new field array.\n" ], "children": [ { "type": "Object", - "label": "options", + "label": "newFields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" } ], - "description": [], - "source": { + "description": [ + "New field array." + ], + "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L256" + "lineNumber": 165 } } ], + "tags": [ + "private" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 165 + } + }, + { + "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": 256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L256" + "lineNumber": 173 } }, { - "id": "def-public.SearchSource.fetch", + "id": "def-public.SearchSource.getFields", "type": "Function", - "label": "fetch", + "label": "getFields", "signature": [ - "(options?: ", + "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "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": 180 + } + }, + { + "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" }, - ") => Promise<", - "SearchResponse", - ">" + "[K]" ], "description": [ - "\nFetch this source and reject the returned Promise on error" + "\nGets a single field from the fields" ], "children": [ { - "type": "Object", - "label": "options", + "type": "Uncategorized", + "label": "field", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } + "K" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 187 + } + }, + { + "type": "boolean", + "label": "recurse", + "isRequired": true, + "signature": [ + "boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L283" + "lineNumber": 187 } } ], - "tags": [ - "deprecated" - ], + "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L283" + "lineNumber": 187 } }, { - "id": "def-public.SearchSource.onRequestStart", + "id": "def-public.SearchSource.getOwnField", "type": "Function", - "label": "onRequestStart", + "label": "getOwnField", "signature": [ - "(handler: (searchSource: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - }, - ", options?: ", + "(field: K) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, - " | undefined) => Promise) => void" + "[K]" ], "description": [ - "\n Add a handler that will be notified whenever requests start" + "\nGet the field from our own fields, don't traverse up the chain" ], "children": [ { - "type": "Function", - "label": "handler", + "type": "Uncategorized", + "label": "field", "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" + "K" ], "description": [], "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" + "lineNumber": 198 } } ], - "tags": [ - "return" - ], + "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 292, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L292" + "lineNumber": 198 } }, { - "id": "def-public.SearchSource.getSearchRequestBody", + "id": "def-public.SearchSource.create", "type": "Function", - "label": "getSearchRequestBody", + "label": "create", "signature": [ - "() => Promise" - ], - "description": [ - "\nReturns body contents of the search request, often referred as query DSL." + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } ], + "description": [], "children": [], - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 301, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L301" + "lineNumber": 205 } }, { - "id": "def-public.SearchSource.destroy", + "id": "def-public.SearchSource.createCopy", "type": "Function", - "label": "destroy", + "label": "createCopy", "signature": [ - "() => void" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } ], "description": [ - "\nCompletely destroy the SearchSource." + "\ncreates a copy of this search source (without its children)" ], "children": [], - "tags": [ - "return" - ], + "tags": [], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 310, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L310" + "lineNumber": 212 } }, { - "id": "def-public.SearchSource.getSerializedFields", + "id": "def-public.SearchSource.createChild", "type": "Function", - "label": "getSerializedFields", + "label": "createChild", "signature": [ - "(recurse?: boolean) => ", + "(options?: {}) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "section": "def-common.SearchSource", + "text": "SearchSource" } ], "description": [ - "\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})" + "\ncreates a new child search source" ], "children": [ { - "type": "boolean", - "label": "recurse", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "boolean" + "{}" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L688" + "lineNumber": 226 } } ], @@ -6809,416 +6424,439 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L688" + "lineNumber": 226 } }, { - "id": "def-public.SearchSource.serialize", + "id": "def-public.SearchSource.setParent", "type": "Function", - "label": "serialize", + "label": "setParent", "signature": [ - "() => { searchSourceJSON: string; references: ", + "(parent?: Pick<", { - "pluginId": "core", + "pluginId": "data", "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" + "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": [ - "\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" + "\nSet a searchSource that this source should inherit from" ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 717, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L717" - } - } - ], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 103, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L103" - }, - "initialIsOpen": false - }, - { - "id": "def-public.DataPublicPlugin", - "type": "Class", - "tags": [], - "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, + "label": "parent", + "isRequired": false, "signature": [ + "Pick<", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, - "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>" + ", \"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" ], - "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 238 + } + }, + { + "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": 238 } } ], - "tags": [], - "returnComment": [], + "tags": [ + "return" + ], + "returnComment": [ + "- chainable" + ], "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L71" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 238 } }, { - "id": "def-public.DataPublicPlugin.setup", + "id": "def-public.SearchSource.getParent", "type": "Function", - "label": "setup", + "label": "getParent", "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" + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, - ">, { bfetch, expressions, uiActions, usageCollection, inspector }: ", + " | 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": 248 + } + }, + { + "id": "def-public.SearchSource.fetch$", + "type": "Function", + "label": "fetch$", + "signature": [ + "(options?: ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataSetupDependencies", - "text": "DataSetupDependencies" + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" }, ") => ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataPublicPluginSetup", - "text": "DataPublicPluginSetup" - } + "Observable", + "<", + "SearchResponse", + ">" + ], + "description": [ + "\nFetch this source from Elasticsearch, returning an observable over the response(s)" ], - "description": [], "children": [ { "type": "Object", - "label": "core", + "label": "options", "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" - }, - ">" + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 256 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 256 + } + }, + { + "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": "{ bfetch, expressions, uiActions, usageCollection, inspector }", + "label": "options", "isRequired": true, "signature": [ { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataSetupDependencies", - "text": "DataSetupDependencies" + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 283 } } ], - "tags": [], + "tags": [ + "deprecated" + ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 283 } }, { - "id": "def-public.DataPublicPlugin.start", + "id": "def-public.SearchSource.onRequestStart", "type": "Function", - "label": "start", + "label": "onRequestStart", "signature": [ - "(core: ", + "(handler: (searchSource: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, - ", { uiActions }: ", + ", options?: ", { "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataStartDependencies", - "text": "DataStartDependencies" + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" }, - ") => ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataPublicPluginStart", - "text": "DataPublicPluginStart" - } + " | undefined) => Promise) => void" + ], + "description": [ + "\n Add a handler that will be notified whenever requests start" ], - "description": [], "children": [ { - "type": "Object", - "label": "core", + "type": "Function", + "label": "handler", "isRequired": true, "signature": [ + "(searchSource: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - } + "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/public/plugin.ts", - "lineNumber": 131, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 293 } - }, + } + ], + "tags": [ + "return" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 292 + } + }, + { + "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": 301 + } + }, + { + "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": 310 + } + }, + { + "id": "def-public.SearchSource.getSerializedFields", + "type": "Function", + "label": "getSerializedFields", + "signature": [ + "(recurse?: boolean) => ", { - "type": "Object", - "label": "{ uiActions }", + "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": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataStartDependencies", - "text": "DataStartDependencies" - } + "boolean" ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 688 } } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 688 } }, { - "id": "def-public.DataPublicPlugin.stop", + "id": "def-public.SearchSource.serialize", "type": "Function", - "label": "stop", + "label": "serialize", "signature": [ - "() => void" + "() => { 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." ], - "description": [], "children": [], - "tags": [], + "tags": [ + "public" + ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 717 } } ], "source": { - "path": "src/plugins/data/public/plugin.ts", - "lineNumber": 55, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L55" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 103 }, "initialIsOpen": false } ], "functions": [ { - "id": "def-public.fieldList", + "id": "def-public.castEsToKbnFieldTypeName", "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", + "type": "string", + "label": "esType", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 } } ], "signature": [ - "(specs?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[], shortDotsEnable?: boolean) => ", + "(esType: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" } ], - "description": [], - "label": "fieldList", + "description": [ + "\n Get the KbnFieldType name for an esType string\n" + ], + "label": "castEsToKbnFieldTypeName", "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 }, - "tags": [], + "tags": [ + "return" + ], "returnComment": [], "initialIsOpen": false }, @@ -7242,8 +6880,7 @@ "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" + "lineNumber": 14 } } ], @@ -7272,60 +6909,145 @@ "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" + "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.getSearchParamsFromRequest", + "id": "def-public.fieldList", "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", + "type": "Array", + "label": "specs", "isRequired": true, "signature": [ - "Record" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" ], "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" + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 35 } }, { - "id": "def-public.getSearchParamsFromRequest.dependencies", - "type": "Object", - "label": "dependencies", - "tags": [], - "description": [], - "children": [ - { + "type": "boolean", + "label": "shortDotsEnable", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 36 + } + } + ], + "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 + }, + "tags": [], + "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 + }, + "tags": [ + "return" + ], + "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 + } + }, + { + "id": "def-public.getSearchParamsFromRequest.dependencies", + "type": "Object", + "label": "dependencies", + "tags": [], + "description": [], + "children": [ + { "tags": [], "id": "def-public.getSearchParamsFromRequest.dependencies.getConfig", "type": "Function", @@ -7333,8 +7055,7 @@ "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" + "lineNumber": 35 }, "signature": [ { @@ -7349,8 +7070,7 @@ ], "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" + "lineNumber": 35 } } ], @@ -7360,8 +7080,129 @@ "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" + "lineNumber": 33 + }, + "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 + } + }, + { + "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 + } + }, + { + "id": "def-public.getTime.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "id": "def-public.getTime.options.forceNow", + "type": "Object", + "label": "forceNow", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40 + }, + "signature": [ + "Date | undefined" + ] + }, + { + "tags": [], + "id": "def-public.getTime.options.fieldName", + "type": "string", + "label": "fieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 40 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 37 }, "initialIsOpen": false }, @@ -7386,8 +7227,7 @@ "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" + "lineNumber": 13 } }, { @@ -7407,8 +7247,7 @@ "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" + "lineNumber": 14 } } ], @@ -7436,51 +7275,58 @@ "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" + "lineNumber": 12 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.parseSearchSourceJSON", + "id": "def-public.isCompleteResponse", "type": "Function", "children": [ { - "type": "string", - "label": "searchSourceJSON", - "isRequired": true, + "type": "Object", + "label": "response", + "isRequired": false, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21 } } ], "signature": [ - "(searchSourceJSON: string) => ", + "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined) => boolean" ], "description": [], - "label": "parseSearchSourceJSON", + "label": "isCompleteResponse", "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21 }, "tags": [], - "returnComment": [], + "returnComment": [ + "true if response is completed successfully" + ], "initialIsOpen": false }, { @@ -7504,8 +7350,7 @@ "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" + "lineNumber": 14 } } ], @@ -7524,8 +7369,7 @@ "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" + "lineNumber": 14 }, "tags": [], "returnComment": [ @@ -7534,53 +7378,80 @@ "initialIsOpen": false }, { - "id": "def-public.isCompleteResponse", + "id": "def-public.isFilter", "type": "Function", "children": [ { - "type": "Object", - "label": "response", - "isRequired": false, + "type": "Unknown", + "label": "x", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined" + "unknown" ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103 } } ], "signature": [ - "(response?: ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean" + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "description": [], - "label": "isCompleteResponse", + "label": "isFilter", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103 }, "tags": [], - "returnComment": [ - "true if response is completed successfully" + "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 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -7604,8 +7475,7 @@ "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" + "lineNumber": 28 } } ], @@ -7624,8 +7494,7 @@ "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" + "lineNumber": 28 }, "tags": [], "returnComment": [ @@ -7634,196 +7503,40 @@ "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", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", + "id": "def-public.isQuery", "type": "Function", "children": [ { - "type": "string", - "label": "esType", + "type": "Unknown", + "label": "x", "isRequired": true, "signature": [ - "string" + "unknown" ], "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" + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11 } } ], "signature": [ - "(esType: string) => ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" } ], - "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" - }, - "tags": [ - "return" - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.getKbnTypeNames", - "type": "Function", - "children": [], - "signature": [ - "() => string[]" - ], - "description": [ - "\n Get the esTypes known by all kbnFieldTypes\n" - ], - "label": "getKbnTypeNames", + "description": [], + "label": "isQuery", "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" + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11 }, - "tags": [ - "return" - ], + "tags": [], "returnComment": [], "initialIsOpen": false }, @@ -7841,8 +7554,7 @@ "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" + "lineNumber": 11 } } ], @@ -7860,129 +7572,45 @@ "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" + "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.isQuery", + "id": "def-public.parseSearchSourceJSON", "type": "Function", "children": [ { - "type": "Unknown", - "label": "x", + "type": "string", + "label": "searchSourceJSON", "isRequired": true, "signature": [ - "unknown" + "string" ], "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" + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12 } } ], "signature": [ - "(x: unknown) => x is ", + "(searchSourceJSON: string) => ", { "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - } + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" } ], - "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" - ], "description": [], - "label": "isFilters", + "label": "parseSearchSourceJSON", "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" + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12 }, "tags": [], "returnComment": [], @@ -7991,807 +7619,586 @@ ], "interfaces": [ { - "id": "def-public.RangeFilterParams", + "id": "def-public.AggFunctionsMapping", "type": "Interface", - "label": "RangeFilterParams", - "description": [], + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." + ], "tags": [], "children": [ { "tags": [], - "id": "def-public.RangeFilterParams.from", - "type": "CompoundType", - "label": "from", + "id": "def-public.AggFunctionsMapping.aggFilter", + "type": "Object", + "label": "aggFilter", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 204 }, "signature": [ - "string | number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.RangeFilterParams.to", - "type": "CompoundType", - "label": "to", + "id": "def-public.AggFunctionsMapping.aggFilters", + "type": "Object", + "label": "aggFilters", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 205 }, "signature": [ - "string | number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.RangeFilterParams.gt", - "type": "CompoundType", - "label": "gt", + "id": "def-public.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", + "label": "aggSignificantTerms", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 206 }, "signature": [ - "string | number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.RangeFilterParams.lt", - "type": "CompoundType", - "label": "lt", + "id": "def-public.AggFunctionsMapping.aggIpRange", + "type": "Object", + "label": "aggIpRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 207 }, "signature": [ - "string | number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.RangeFilterParams.gte", - "type": "CompoundType", - "label": "gte", + "id": "def-public.AggFunctionsMapping.aggDateRange", + "type": "Object", + "label": "aggDateRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208 }, "signature": [ - "string | number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.RangeFilterParams.lte", - "type": "CompoundType", - "label": "lte", + "id": "def-public.AggFunctionsMapping.aggRange", + "type": "Object", + "label": "aggRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 209 }, "signature": [ - "string | number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.RangeFilterParams.format", - "type": "string", - "label": "format", + "id": "def-public.AggFunctionsMapping.aggGeoTile", + "type": "Object", + "label": "aggGeoTile", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 210 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.EsQueryConfig.allowLeadingWildcards", - "type": "boolean", - "label": "allowLeadingWildcards", + "id": "def-public.AggFunctionsMapping.aggGeoHash", + "type": "Object", + "label": "aggGeoHash", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 211 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-public.EsQueryConfig.queryStringOptions", + "id": "def-public.AggFunctionsMapping.aggHistogram", "type": "Object", - "label": "queryStringOptions", + "label": "aggHistogram", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 212 }, "signature": [ - "Record" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.EsQueryConfig.ignoreFilterIfFieldNotInIndex", - "type": "boolean", - "label": "ignoreFilterIfFieldNotInIndex", + "id": "def-public.AggFunctionsMapping.aggDateHistogram", + "type": "Object", + "label": "aggDateHistogram", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-public.EsQueryConfig.dateFormatTZ", - "type": "string", - "label": "dateFormatTZ", + "id": "def-public.AggFunctionsMapping.aggTerms", + "type": "Object", + "label": "aggTerms", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 214 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.KueryNode.type", - "type": "CompoundType", - "label": "type", + "id": "def-public.AggFunctionsMapping.aggAvg", + "type": "Object", + "label": "aggAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 215 }, "signature": [ - "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + "FunctionDefinition" ] }, { - "id": "def-public.KueryNode.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-public.AggFunctionsMapping.aggBucketAvg", + "type": "Object", + "label": "aggBucketAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 216 }, "signature": [ - "any" + "FunctionDefinition" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.FieldFormatConfig.id", - "type": "string", - "label": "id", + "id": "def-public.AggFunctionsMapping.aggBucketMax", + "type": "Object", + "label": "aggBucketMax", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 217 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-public.FieldFormatConfig.params", + "id": "def-public.AggFunctionsMapping.aggBucketMin", "type": "Object", - "label": "params", + "label": "aggBucketMin", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 218 }, "signature": [ - "Record" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-public.FieldFormatConfig.es", - "type": "CompoundType", - "label": "es", + "id": "def-public.AggFunctionsMapping.aggBucketSum", + "type": "Object", + "label": "aggBucketSum", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 65, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L65" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 219 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] - } - ], - "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" - }, - "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" + "tags": [], + "id": "def-public.AggFunctionsMapping.aggCardinality", + "type": "Object", + "label": "aggCardinality", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 220 + }, + "signature": [ + "FunctionDefinition" + ] }, - "[]" - ], - "description": [], - "tags": [], - "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": [], + "id": "def-public.AggFunctionsMapping.aggCount", + "type": "Object", + "label": "aggCount", + "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221 + }, + "signature": [ + "FunctionDefinition" + ] }, { - "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": [], + "id": "def-public.AggFunctionsMapping.aggCumulativeSum", + "type": "Object", + "label": "aggCumulativeSum", + "description": [], "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 222 + }, + "signature": [ + "FunctionDefinition" + ] }, { - "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": [], + "id": "def-public.AggFunctionsMapping.aggDerivative", + "type": "Object", + "label": "aggDerivative", + "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 223 + }, + "signature": [ + "FunctionDefinition" + ] }, { - "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": [], + "id": "def-public.AggFunctionsMapping.aggGeoBounds", + "type": "Object", + "label": "aggGeoBounds", + "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 224 + }, + "signature": [ + "FunctionDefinition" + ] }, { - "id": "def-public.IIndexPatternFieldList.remove", - "type": "Function", - "label": "remove", - "signature": [ - "(field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ") => void" - ], + "tags": [], + "id": "def-public.AggFunctionsMapping.aggGeoCentroid", + "type": "Object", + "label": "aggGeoCentroid", "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" - } - } - ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 225 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.AggFunctionsMapping.aggMax", + "type": "Object", + "label": "aggMax", + "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 226 + }, + "signature": [ + "FunctionDefinition" + ] }, { - "id": "def-public.IIndexPatternFieldList.removeAll", - "type": "Function", - "label": "removeAll", + "tags": [], + "id": "def-public.AggFunctionsMapping.aggMedian", + "type": "Object", + "label": "aggMedian", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 227 + }, "signature": [ - "() => void" - ], + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggMin", + "type": "Object", + "label": "aggMin", "description": [], - "children": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 228 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.AggFunctionsMapping.aggMovingAvg", + "type": "Object", + "label": "aggMovingAvg", + "description": [], "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 229 + }, + "signature": [ + "FunctionDefinition" + ] }, { - "id": "def-public.IIndexPatternFieldList.replaceAll", - "type": "Function", - "label": "replaceAll", + "tags": [], + "id": "def-public.AggFunctionsMapping.aggPercentileRanks", + "type": "Object", + "label": "aggPercentileRanks", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 230 + }, "signature": [ - "(specs: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]) => void" - ], + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggPercentiles", + "type": "Object", + "label": "aggPercentiles", "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" - } - } - ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 231 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.AggFunctionsMapping.aggSerialDiff", + "type": "Object", + "label": "aggSerialDiff", + "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 232 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggStdDeviation", + "type": "Object", + "label": "aggStdDeviation", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 233 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggSum", + "type": "Object", + "label": "aggSum", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 234 + }, + "signature": [ + "FunctionDefinition" + ] + }, + { + "tags": [], + "id": "def-public.AggFunctionsMapping.aggTopHit", + "type": "Object", + "label": "aggTopHit", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 235 + }, + "signature": [ + "FunctionDefinition" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 203 + }, + "initialIsOpen": false + }, + { + "id": "def-public.AggParamOption", + "type": "Interface", + "label": "AggParamOption", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.AggParamOption.val", + "type": "string", + "label": "val", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 31 } }, { - "id": "def-public.IIndexPatternFieldList.update", + "tags": [], + "id": "def-public.AggParamOption.display", + "type": "string", + "label": "display", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 32 + } + }, + { + "id": "def-public.AggParamOption.enabled", "type": "Function", - "label": "update", + "label": "enabled", "signature": [ - "(field: ", + "((agg: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - ") => void" + ") => boolean) | undefined" ], "description": [], "children": [ { "type": "Object", - "label": "field", + "label": "agg", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30 }, "initialIsOpen": false }, { - "id": "def-public.IIndexPattern", + "id": "def-public.ApplyGlobalFilterActionContext", "type": "Interface", - "label": "IIndexPattern", - "description": [ - "\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided" - ], + "label": "ApplyGlobalFilterActionContext", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.IIndexPattern.fields", + "id": "def-public.ApplyGlobalFilterActionContext.filters", "type": "Array", - "label": "fields", + "label": "filters", "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" + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 19 }, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" }, "[]" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-public.IIndexPattern.id", + "id": "def-public.ApplyGlobalFilterActionContext.timeFieldName", "type": "string", - "label": "id", + "label": "timeFieldName", "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" + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -8799,463 +8206,505 @@ }, { "tags": [], - "id": "def-public.IIndexPattern.type", - "type": "string", - "label": "type", - "description": [ - "\nType is used for identifying rollup indices, otherwise left undefined" - ], + "id": "def-public.ApplyGlobalFilterActionContext.embeddable", + "type": "Unknown", + "label": "embeddable", + "description": [], "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" + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 23 }, "signature": [ - "string | undefined" + "unknown" ] - }, + } + ], + "source": { + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DataPublicPluginStartActions", + "type": "Interface", + "label": "DataPublicPluginStartActions", + "description": [ + "\nutilities to generate filters from action context" + ], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.IIndexPattern.timeFieldName", - "type": "string", - "label": "timeFieldName", + "id": "def-public.DataPublicPluginStartActions.createFiltersFromValueClickAction", + "type": "Function", + "label": "createFiltersFromValueClickAction", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 68 }, "signature": [ - "string | undefined" - ] - }, - { - "id": "def-public.IIndexPattern.getTimeField", - "type": "Function", - "label": "getTimeField", - "signature": [ - "(() => ", + "({ data, negate, }: ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.ValueClickDataContext", + "text": "ValueClickDataContext" }, - " | 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" - } - }, - { - "tags": [], - "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 Promise<", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" }, - " | undefined> | undefined" + "[]>" ] }, { "tags": [], - "id": "def-public.IIndexPattern.getFormatterForField", + "id": "def-public.DataPublicPluginStartActions.createFiltersFromRangeSelectAction", "type": "Function", - "label": "getFormatterForField", - "description": [ - "\nLook up a formatter for a given field" - ], + "label": "createFiltersFromRangeSelectAction", + "description": [], "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 69 }, "signature": [ - "((field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", + "typeof ", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - " | ", + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.createFiltersFromRangeSelectAction", + "text": "createFiltersFromRangeSelectAction" + } + ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 67 + }, + "initialIsOpen": false + }, + { + "id": "def-public.DataPublicPluginStartUi", + "type": "Interface", + "label": "DataPublicPluginStartUi", + "description": [ + "\nData plugin prewired UI components" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.DataPublicPluginStartUi.IndexPatternSelect", + "type": "CompoundType", + "label": "IndexPatternSelect", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 60 + }, + "signature": [ + "React.ComponentType<", { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.IndexPatternSelectProps", + "text": "IndexPatternSelectProps" }, - ") => ", + ">" + ] + }, + { + "tags": [], + "id": "def-public.DataPublicPluginStartUi.SearchBar", + "type": "CompoundType", + "label": "SearchBar", + "description": [], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 61 + }, + "signature": [ + "React.ComponentType<", { "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "scope": "public", + "docId": "kibDataUiPluginApi", + "section": "def-public.StatefulSearchBarProps", + "text": "StatefulSearchBarProps" }, - ") | 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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 59 }, "initialIsOpen": false }, { - "id": "def-public.IFieldType", + "id": "def-public.EsQueryConfig", "type": "Interface", - "label": "IFieldType", + "label": "EsQueryConfig", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.IFieldType.name", - "type": "string", - "label": "name", + "id": "def-public.EsQueryConfig.allowLeadingWildcards", + "type": "boolean", + "label": "allowLeadingWildcards", "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" + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 18 } }, { "tags": [], - "id": "def-public.IFieldType.type", - "type": "string", - "label": "type", + "id": "def-public.EsQueryConfig.queryStringOptions", + "type": "Object", + "label": "queryStringOptions", "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" - } + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 19 + }, + "signature": [ + "Record" + ] }, { "tags": [], - "id": "def-public.IFieldType.script", - "type": "string", - "label": "script", + "id": "def-public.EsQueryConfig.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", "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" - ] + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 20 + } }, { "tags": [], - "id": "def-public.IFieldType.lang", + "id": "def-public.EsQueryConfig.dateFormatTZ", "type": "string", - "label": "lang", + "label": "dateFormatTZ", "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" + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 21 }, "signature": [ "string | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatConfig", + "type": "Interface", + "label": "FieldFormatConfig", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.IFieldType.count", - "type": "number", - "label": "count", + "id": "def-public.FieldFormatConfig.id", + "type": "string", + "label": "id", "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" - ] + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 63 + } }, { "tags": [], - "id": "def-public.IFieldType.esTypes", - "type": "Array", - "label": "esTypes", + "id": "def-public.FieldFormatConfig.params", + "type": "Object", + "label": "params", "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 64 }, "signature": [ - "string[] | undefined" + "Record" ] }, { "tags": [], - "id": "def-public.IFieldType.aggregatable", + "id": "def-public.FieldFormatConfig.es", "type": "CompoundType", - "label": "aggregatable", + "label": "es", "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 65 }, "signature": [ "boolean | undefined" ] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.IFieldType.filterable", - "type": "CompoundType", - "label": "filterable", + "id": "def-public.IDataPluginServices.appName", + "type": "string", + "label": "appName", "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" - ] + "path": "src/plugins/data/public/types.ts", + "lineNumber": 116 + } }, { "tags": [], - "id": "def-public.IFieldType.searchable", - "type": "CompoundType", - "label": "searchable", + "id": "def-public.IDataPluginServices.uiSettings", + "type": "Object", + "label": "uiSettings", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 117 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } ] }, { "tags": [], - "id": "def-public.IFieldType.sortable", - "type": "CompoundType", - "label": "sortable", + "id": "def-public.IDataPluginServices.savedObjects", + "type": "Object", + "label": "savedObjects", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 118 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsStart", + "text": "SavedObjectsStart" + } ] }, { "tags": [], - "id": "def-public.IFieldType.visualizable", - "type": "CompoundType", - "label": "visualizable", + "id": "def-public.IDataPluginServices.notifications", + "type": "Object", + "label": "notifications", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 119 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + } ] }, { "tags": [], - "id": "def-public.IFieldType.readFromDocValues", - "type": "CompoundType", - "label": "readFromDocValues", + "id": "def-public.IDataPluginServices.http", + "type": "Object", + "label": "http", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 120 }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } ] }, { "tags": [], - "id": "def-public.IFieldType.scripted", - "type": "CompoundType", - "label": "scripted", + "id": "def-public.IDataPluginServices.storage", + "type": "Object", + "label": "storage", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 121 }, "signature": [ - "boolean | undefined" + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IStorageWrapper", + "text": "IStorageWrapper" + }, + "" ] }, { "tags": [], - "id": "def-public.IFieldType.subType", + "id": "def-public.IDataPluginServices.data", "type": "Object", - "label": "subType", + "label": "data", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 122 }, "signature": [ { "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" - }, - " | undefined" + "scope": "public", + "docId": "kibDataPluginApi", + "section": "def-public.DataPublicPluginStart", + "text": "DataPublicPluginStart" + } ] }, { "tags": [], - "id": "def-public.IFieldType.displayName", - "type": "string", - "label": "displayName", + "id": "def-public.IDataPluginServices.usageCollection", + "type": "Object", + "label": "usageCollection", "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" + "path": "src/plugins/data/public/types.ts", + "lineNumber": 123 }, "signature": [ - "string | undefined" + { + "pluginId": "usageCollection", + "scope": "public", + "docId": "kibUsageCollectionPluginApi", + "section": "def-public.UsageCollectionStart", + "text": "UsageCollectionStart" + }, + " | undefined" ] + } + ], + "source": { + "path": "src/plugins/data/public/types.ts", + "lineNumber": 115 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IEsSearchRequest", + "type": "Interface", + "label": "IEsSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" }, + " extends ", { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" }, + "<", { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchRequestParams", + "text": "ISearchRequestParams" }, + ">>" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.IFieldType.toSpec", - "type": "Function", - "label": "toSpec", + "id": "def-public.IEsSearchRequest.indexType", + "type": "string", + "label": "indexType", "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 20 }, "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" - } + "string | undefined" ] } ], "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 19 }, "initialIsOpen": false }, @@ -9274,8 +8723,7 @@ "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" + "lineNumber": 154 }, "signature": [ "{ parent: string; } | undefined" @@ -9289,8 +8737,7 @@ "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" + "lineNumber": 155 }, "signature": [ "{ path: string; } | undefined" @@ -9299,78 +8746,62 @@ ], "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" + "lineNumber": 153 }, "initialIsOpen": false }, { - "id": "def-public.IndexPatternAttributes", + "id": "def-public.IFieldType", "type": "Interface", - "label": "IndexPatternAttributes", - "description": [ - "\nInterface for an index pattern saved object" - ], + "label": "IFieldType", + "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-public.IndexPatternAttributes.fields", + "id": "def-public.IFieldType.name", "type": "string", - "label": "fields", + "label": "name", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 12 } }, { "tags": [], - "id": "def-public.IndexPatternAttributes.title", + "id": "def-public.IFieldType.type", "type": "string", - "label": "title", + "label": "type", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 13 } }, { "tags": [], - "id": "def-public.IndexPatternAttributes.typeMeta", + "id": "def-public.IFieldType.script", "type": "string", - "label": "typeMeta", + "label": "script", "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" - } + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 14 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-public.IndexPatternAttributes.timeFieldName", + "id": "def-public.IFieldType.lang", "type": "string", - "label": "timeFieldName", + "label": "lang", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 15 }, "signature": [ "string | undefined" @@ -9378,219 +8809,174 @@ }, { "tags": [], - "id": "def-public.IndexPatternAttributes.intervalName", - "type": "string", - "label": "intervalName", + "id": "def-public.IFieldType.count", + "type": "number", + "label": "count", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 16 }, "signature": [ - "string | undefined" + "number | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternAttributes.sourceFilters", - "type": "string", - "label": "sourceFilters", + "id": "def-public.IFieldType.esTypes", + "type": "Array", + "label": "esTypes", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 19 }, "signature": [ - "string | undefined" + "string[] | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternAttributes.fieldFormatMap", - "type": "string", - "label": "fieldFormatMap", + "id": "def-public.IFieldType.aggregatable", + "type": "CompoundType", + "label": "aggregatable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 20 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternAttributes.fieldAttrs", - "type": "string", - "label": "fieldAttrs", + "id": "def-public.IFieldType.filterable", + "type": "CompoundType", + "label": "filterable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 21 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternAttributes.runtimeFieldMap", - "type": "string", - "label": "runtimeFieldMap", + "id": "def-public.IFieldType.searchable", + "type": "CompoundType", + "label": "searchable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 22 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternAttributes.allowNoIndex", + "id": "def-public.IFieldType.sortable", "type": "CompoundType", - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" - ], + "label": "sortable", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 23 }, "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.TypeMeta.aggs", - "type": "Object", - "label": "aggs", + "id": "def-public.IFieldType.visualizable", + "type": "CompoundType", + "label": "visualizable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 24 }, "signature": [ - "Record> | undefined" + "boolean | undefined" ] }, { - "id": "def-public.TypeMeta.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-public.IFieldType.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 25 }, "signature": [ - "any" + "boolean | undefined" ] - } - ], - "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" - ], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.IndexPatternSpec.id", - "type": "string", - "label": "id", - "description": [ - "\nsaved object id" - ], + "id": "def-public.IFieldType.scripted", + "type": "CompoundType", + "label": "scripted", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 26 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternSpec.version", - "type": "string", - "label": "version", - "description": [ - "\nsaved object version string" - ], + "id": "def-public.IFieldType.subType", + "type": "Object", + "label": "subType", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternSpec.title", + "id": "def-public.IFieldType.displayName", "type": "string", - "label": "title", + "label": "displayName", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 28 }, "signature": [ "string | undefined" ] }, { - "tags": [ - "deprecated" - ], - "id": "def-public.IndexPatternSpec.intervalName", + "tags": [], + "id": "def-public.IFieldType.customLabel", "type": "string", - "label": "intervalName", + "label": "customLabel", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 29 }, "signature": [ "string | undefined" @@ -9598,54 +8984,46 @@ }, { "tags": [], - "id": "def-public.IndexPatternSpec.timeFieldName", - "type": "string", - "label": "timeFieldName", + "id": "def-public.IFieldType.format", + "type": "Any", + "label": "format", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 30 }, "signature": [ - "string | undefined" + "any" ] }, { "tags": [], - "id": "def-public.IndexPatternSpec.sourceFilters", - "type": "Array", - "label": "sourceFilters", + "id": "def-public.IFieldType.toSpec", + "type": "Function", + "label": "toSpec", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31 }, "signature": [ + "((options?: { getFormatterForField?: ((field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.SourceFilter", - "text": "SourceFilter" + "section": "def-common.IFieldType", + "text": "IFieldType" }, - "[] | undefined" - ] - }, - { - "tags": [], - "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" + ") => ", + { + "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 + }, + "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" + ], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.IndexPatternSpec.typeMeta", - "type": "Object", - "label": "typeMeta", + "id": "def-public.IIndexPattern.fields", + "type": "Array", + "label": "fields", "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" + "lineNumber": 32 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "section": "def-common.IFieldType", + "text": "IFieldType" }, - " | undefined" + "[]" ] }, { "tags": [], - "id": "def-public.IndexPatternSpec.type", + "id": "def-public.IIndexPattern.title", "type": "string", - "label": "type", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 33 + } + }, + { + "tags": [], + "id": "def-public.IIndexPattern.id", + "type": "string", + "label": "id", "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" + "lineNumber": 34 }, "signature": [ "string | undefined" @@ -9695,839 +9113,989 @@ }, { "tags": [], - "id": "def-public.IndexPatternSpec.fieldFormats", - "type": "Object", - "label": "fieldFormats", - "description": [], + "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": 244, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L244" + "lineNumber": 38 }, "signature": [ - "Record>> | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternSpec.runtimeFieldMap", - "type": "Object", - "label": "runtimeFieldMap", + "id": "def-public.IIndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", "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" + "lineNumber": 39 }, "signature": [ - "Record ", + { + "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "section": "def-common.IFieldType", + "text": "IFieldType" }, - "> | undefined" - ] + " | undefined) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 40 + } }, { "tags": [], - "id": "def-public.IndexPatternSpec.fieldAttrs", + "id": "def-public.IIndexPattern.fieldFormatMap", "type": "Object", - "label": "fieldAttrs", + "label": "fieldFormatMap", "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" + "lineNumber": 41 }, "signature": [ + "Record | undefined> | undefined" ] }, { "tags": [], - "id": "def-public.IndexPatternSpec.allowNoIndex", - "type": "CompoundType", - "label": "allowNoIndex", - "description": [], + "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": 247, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L247" + "lineNumber": 45 }, "signature": [ - "boolean | undefined" + "((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": 224, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L224" + "lineNumber": 31 }, "initialIsOpen": false }, { - "id": "def-public.AggFunctionsMapping", + "id": "def-public.IIndexPatternFieldList", "type": "Interface", - "label": "AggFunctionsMapping", - "description": [ - "\nA global list of the expression function definitions for each agg type function." + "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": [], "tags": [], "children": [ { - "tags": [], - "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" - }, + "id": "def-public.IIndexPatternFieldList.add", + "type": "Function", + "label": "add", "signature": [ - "FunctionDefinition" - ] - }, - { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggFilters", - "type": "Object", - "label": "aggFilters", + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => void" + ], "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" - ] - }, - { + "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 + } + } + ], "tags": [], - "id": "def-public.AggFunctionsMapping.aggSignificantTerms", - "type": "Object", - "label": "aggSignificantTerms", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18 + } }, { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggIpRange", - "type": "Object", - "label": "aggIpRange", + "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/search/aggs/types.ts", - "lineNumber": 207, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207" - }, - "signature": [ - "FunctionDefinition" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 19 + } }, { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggDateRange", - "type": "Object", - "label": "aggDateRange", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20 + } }, { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, + "id": "def-public.IIndexPatternFieldList.getByType", + "type": "Function", + "label": "getByType", "signature": [ - "FunctionDefinition" - ] - }, - { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggGeoHash", - "type": "Object", - "label": "aggGeoHash", + "(type: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" + ], "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" - ] - }, - { + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21 + } + } + ], "tags": [], - "id": "def-public.AggFunctionsMapping.aggHistogram", - "type": "Object", - "label": "aggHistogram", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21 + } }, { - "tags": [], - "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" - }, + "id": "def-public.IIndexPatternFieldList.remove", + "type": "Function", + "label": "remove", "signature": [ - "FunctionDefinition" - ] - }, - { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggTerms", - "type": "Object", - "label": "aggTerms", + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ") => void" + ], "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" - ] - }, - { + "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 + } + } + ], "tags": [], - "id": "def-public.AggFunctionsMapping.aggAvg", - "type": "Object", - "label": "aggAvg", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22 + } }, { - "tags": [], - "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" - }, + "id": "def-public.IIndexPatternFieldList.removeAll", + "type": "Function", + "label": "removeAll", "signature": [ - "FunctionDefinition" - ] - }, - { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggBucketMax", - "type": "Object", - "label": "aggBucketMax", + "() => void" + ], "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" - ] - }, - { + "children": [], "tags": [], - "id": "def-public.AggFunctionsMapping.aggBucketMin", - "type": "Object", - "label": "aggBucketMin", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 23 + } }, { - "tags": [], - "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" - }, + "id": "def-public.IIndexPatternFieldList.replaceAll", + "type": "Function", + "label": "replaceAll", "signature": [ - "FunctionDefinition" - ] - }, - { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggCardinality", - "type": "Object", - "label": "aggCardinality", + "(specs: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]) => void" + ], "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" - ] - }, - { + "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 + } + } + ], "tags": [], - "id": "def-public.AggFunctionsMapping.aggCount", - "type": "Object", - "label": "aggCount", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24 + } }, { - "tags": [], - "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" - }, + "id": "def-public.IIndexPatternFieldList.update", + "type": "Function", + "label": "update", "signature": [ - "FunctionDefinition" - ] + "(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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25 + } }, { - "tags": [], - "id": "def-public.AggFunctionsMapping.aggDerivative", - "type": "Object", - "label": "aggDerivative", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26 + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IKibanaSearchRequest", + "type": "Interface", + "label": "IKibanaSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.AggFunctionsMapping.aggGeoBounds", - "type": "Object", - "label": "aggGeoBounds", - "description": [], + "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/aggs/types.ts", - "lineNumber": 224, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 78 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggGeoCentroid", - "type": "Object", - "label": "aggGeoCentroid", + "id": "def-public.IKibanaSearchRequest.params", + "type": "Uncategorized", + "label": "params", "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 80 }, "signature": [ - "FunctionDefinition" + "Params | undefined" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 74 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IKibanaSearchResponse", + "type": "Interface", + "label": "IKibanaSearchResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.AggFunctionsMapping.aggMax", - "type": "Object", - "label": "aggMax", - "description": [], + "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/aggs/types.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 44 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggMedian", - "type": "Object", - "label": "aggMedian", - "description": [], + "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/aggs/types.ts", - "lineNumber": 227, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 50 }, "signature": [ - "FunctionDefinition" + "number | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggMin", - "type": "Object", - "label": "aggMin", - "description": [], + "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/aggs/types.ts", - "lineNumber": 228, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 56 }, "signature": [ - "FunctionDefinition" + "number | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggMovingAvg", - "type": "Object", - "label": "aggMovingAvg", - "description": [], + "id": "def-public.IKibanaSearchResponse.isRunning", + "type": "CompoundType", + "label": "isRunning", + "description": [ + "\nIndicates whether search is still in flight" + ], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 61 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggPercentileRanks", - "type": "Object", - "label": "aggPercentileRanks", - "description": [], + "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/aggs/types.ts", - "lineNumber": 230, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 66 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggPercentiles", - "type": "Object", - "label": "aggPercentiles", - "description": [], + "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/aggs/types.ts", - "lineNumber": 231, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 71 }, "signature": [ - "FunctionDefinition" + "RawResponse" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 40 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexPatternAttributes", + "type": "Interface", + "label": "IndexPatternAttributes", + "description": [ + "\nInterface for an index pattern saved object" + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexPatternAttributes.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 54 + } }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggSerialDiff", - "type": "Object", - "label": "aggSerialDiff", + "id": "def-public.IndexPatternAttributes.fields", + "type": "string", + "label": "fields", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 55 + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 56 + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.typeMeta", + "type": "string", + "label": "typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 57 + } + }, + { + "tags": [], + "id": "def-public.IndexPatternAttributes.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 58 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggStdDeviation", - "type": "Object", - "label": "aggStdDeviation", + "id": "def-public.IndexPatternAttributes.intervalName", + "type": "string", + "label": "intervalName", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 59 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggSum", - "type": "Object", - "label": "aggSum", + "id": "def-public.IndexPatternAttributes.sourceFilters", + "type": "string", + "label": "sourceFilters", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 60 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-public.AggFunctionsMapping.aggTopHit", - "type": "Object", - "label": "aggTopHit", + "id": "def-public.IndexPatternAttributes.fieldFormatMap", + "type": "string", + "label": "fieldFormatMap", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 61 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.AggParamOption.val", + "id": "def-public.IndexPatternAttributes.fieldAttrs", "type": "string", - "label": "val", + "label": "fieldAttrs", "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 62 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-public.AggParamOption.display", + "id": "def-public.IndexPatternAttributes.runtimeFieldMap", "type": "string", - "label": "display", + "label": "runtimeFieldMap", "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 63 + }, + "signature": [ + "string | undefined" + ] }, { - "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": [], + "id": "def-public.IndexPatternAttributes.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [ + "\nprevents errors when index pattern exists before indices" + ], "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 67 + }, + "signature": [ + "boolean | undefined" + ] } ], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53 }, "initialIsOpen": false }, { - "id": "def-public.OptionedValueProp", + "id": "def-public.IndexPatternSpec", "type": "Interface", - "label": "OptionedValueProp", - "description": [], + "label": "IndexPatternSpec", + "description": [ + "\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state" + ], "tags": [], "children": [ { "tags": [], - "id": "def-public.OptionedValueProp.value", + "id": "def-public.IndexPatternSpec.id", "type": "string", - "label": "value", - "description": [], + "label": "id", + "description": [ + "\nsaved object id" + ], "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 228 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-public.OptionedValueProp.text", + "id": "def-public.IndexPatternSpec.version", "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" - } - }, - { - "tags": [], - "id": "def-public.OptionedValueProp.disabled", - "type": "CompoundType", - "label": "disabled", - "description": [], + "label": "version", + "description": [ + "\nsaved object version string" + ], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 232 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.OptionedValueProp.isCompatible", - "type": "Function", - "label": "isCompatible", + "id": "def-public.IndexPatternSpec.title", + "type": "string", + "label": "title", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 233 }, "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" + "string | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ { - "tags": [], - "id": "def-public.IEsSearchRequest.indexType", + "tags": [ + "deprecated" + ], + "id": "def-public.IndexPatternSpec.intervalName", "type": "string", - "label": "indexType", + "label": "intervalName", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 238 }, "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": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-public.IKibanaSearchRequest.id", + "id": "def-public.IndexPatternSpec.timeFieldName", "type": "string", - "label": "id", - "description": [ - "\nAn id can be used to uniquely identify this request." - ], + "label": "timeFieldName", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 239 }, "signature": [ "string | undefined" @@ -10535,151 +10103,298 @@ }, { "tags": [], - "id": "def-public.IKibanaSearchRequest.params", - "type": "Uncategorized", - "label": "params", + "id": "def-public.IndexPatternSpec.sourceFilters", + "type": "Array", + "label": "sourceFilters", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 240 }, "signature": [ - "Params | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | 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": [], - "tags": [], - "children": [ { "tags": [], - "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." - ], + "id": "def-public.IndexPatternSpec.fields", + "type": "Object", + "label": "fields", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 241 }, "signature": [ - "string | undefined" + "Record | undefined" ] }, { "tags": [], - "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." - ], + "id": "def-public.IndexPatternSpec.typeMeta", + "type": "Object", + "label": "typeMeta", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 242 }, "signature": [ - "number | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" + }, + " | undefined" ] }, { "tags": [], - "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." - ], + "id": "def-public.IndexPatternSpec.type", + "type": "string", + "label": "type", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 243 }, "signature": [ - "number | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.IKibanaSearchResponse.isRunning", - "type": "CompoundType", - "label": "isRunning", - "description": [ - "\nIndicates whether search is still in flight" - ], + "id": "def-public.IndexPatternSpec.fieldFormats", + "type": "Object", + "label": "fieldFormats", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 244 }, "signature": [ - "boolean | undefined" + "Record>> | undefined" ] }, { "tags": [], - "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" - }, + "id": "def-public.IndexPatternSpec.runtimeFieldMap", + "type": "Object", + "label": "runtimeFieldMap", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 245 + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.fieldAttrs", + "type": "Object", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 246 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IndexPatternSpec.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 247 + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 224 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ISearchOptions", + "type": "Interface", + "label": "ISearchOptions", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "AbortSignal | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, "signature": [ "boolean | undefined" ] }, { "tags": [], - "id": "def-public.IKibanaSearchResponse.rawResponse", - "type": "Uncategorized", - "label": "rawResponse", + "id": "def-public.ISearchOptions.sessionId", + "type": "string", + "label": "sessionId", "description": [ - "\nThe raw response returned by the internal search method (usually the raw ES response)" + "\nA session ID, grouping multiple search requests into a single session." ], "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" + "lineNumber": 103 }, "signature": [ - "RawResponse" + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" ] } ], "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" + "lineNumber": 83 }, "initialIsOpen": false }, @@ -10704,8 +10419,7 @@ ], "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" + "lineNumber": 30 }, "signature": [ "(fields?: ", @@ -10737,8 +10451,7 @@ ], "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" + "lineNumber": 34 }, "signature": [ "() => Pick<", @@ -10755,456 +10468,299 @@ ], "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" + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-public.SearchSourceFields", + "id": "def-public.KueryNode", "type": "Interface", - "label": "SearchSourceFields", - "description": [ - "\nsearch source fields" - ], + "label": "KueryNode", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.SearchSourceFields.type", - "type": "string", + "id": "def-public.KueryNode.type", + "type": "CompoundType", "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 12 }, "signature": [ - "string | undefined" + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" ] }, { + "id": "def-public.KueryNode.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "id": "def-public.SearchSourceFields.query", - "type": "Object", - "label": "query", - "description": [ - "\n{@link Query}" - ], + "description": [], "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 13 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - " | undefined" + "any" ] + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-public.OptionedValueProp", + "type": "Interface", + "label": "OptionedValueProp", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.OptionedValueProp.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 13 + } }, { "tags": [], - "id": "def-public.SearchSourceFields.filter", + "id": "def-public.OptionedValueProp.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 14 + } + }, + { + "tags": [], + "id": "def-public.OptionedValueProp.disabled", "type": "CompoundType", - "label": "filter", - "description": [ - "\n{@link Filter}" - ], + "label": "disabled", + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 15 }, "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" + "boolean | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.sort", - "type": "CompoundType", - "label": "sort", - "description": [ - "\n{@link EsQuerySortValue}" - ], + "id": "def-public.OptionedValueProp.isCompatible", + "type": "Function", + "label": "isCompatible", + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 }, "signature": [ - "Record | Record[] | undefined" + ") => boolean" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-public.RangeFilterParams", + "type": "Interface", + "label": "RangeFilterParams", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.SearchSourceFields.highlight", - "type": "Any", - "label": "highlight", + "id": "def-public.RangeFilterParams.from", + "type": "CompoundType", + "label": "from", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 36 }, "signature": [ - "any" + "string | number | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.highlightAll", + "id": "def-public.RangeFilterParams.to", "type": "CompoundType", - "label": "highlightAll", + "label": "to", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 37 }, "signature": [ - "boolean | undefined" + "string | number | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.trackTotalHits", + "id": "def-public.RangeFilterParams.gt", "type": "CompoundType", - "label": "trackTotalHits", + "label": "gt", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 38 }, "signature": [ - "number | boolean | undefined" + "string | number | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.aggs", - "type": "Any", - "label": "aggs", - "description": [ - "\n{@link AggConfigs}" - ], + "id": "def-public.RangeFilterParams.lt", + "type": "CompoundType", + "label": "lt", + "description": [], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 39 }, "signature": [ - "any" + "string | number | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.from", - "type": "number", - "label": "from", + "id": "def-public.RangeFilterParams.gte", + "type": "CompoundType", + "label": "gte", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 40 }, "signature": [ - "number | undefined" + "string | number | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.size", - "type": "number", - "label": "size", + "id": "def-public.RangeFilterParams.lte", + "type": "CompoundType", + "label": "lte", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 41 }, "signature": [ - "number | undefined" + "string | number | undefined" ] }, { "tags": [], - "id": "def-public.SearchSourceFields.source", - "type": "CompoundType", - "label": "source", + "id": "def-public.RangeFilterParams.format", + "type": "string", + "label": "format", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 42 }, "signature": [ - "string | boolean | string[] | undefined" + "string | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 35 + }, + "initialIsOpen": false + }, + { + "id": "def-public.RefreshInterval", + "type": "Interface", + "label": "RefreshInterval", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.SearchSourceFields.version", - "type": "CompoundType", - "label": "version", + "id": "def-public.RefreshInterval.pause", + "type": "boolean", + "label": "pause", "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" - ] + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 12 + } }, { "tags": [], - "id": "def-public.SearchSourceFields.fields", - "type": "Array", - "label": "fields", - "description": [ - "\nRetrieve fields via the search Fields API" - ], + "id": "def-public.RefreshInterval.value", + "type": "number", + "label": "value", + "description": [], "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" - ] - }, + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 13 + } + } + ], + "source": { + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-public.SearchError", + "type": "Interface", + "label": "SearchError", + "description": [], + "tags": [], + "children": [ { - "tags": [ - "deprecated" - ], - "id": "def-public.SearchSourceFields.fieldsFromSource", - "type": "CompoundType", - "label": "fieldsFromSource", - "description": [ - "\nRetreive fields directly from _source (legacy behavior)\n" - ], + "tags": [], + "id": "def-public.SearchError.name", + "type": "string", + "label": "name", + "description": [], "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" - ] + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 37 + } }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-public.SearchError.status", - "type": "string", - "label": "status", - "description": [], + "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" + "lineNumber": 38 } }, { @@ -11215,8 +10771,7 @@ "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" + "lineNumber": 39 } }, { @@ -11227,8 +10782,7 @@ "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" + "lineNumber": 40 } }, { @@ -11239,8 +10793,7 @@ "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" + "lineNumber": 41 } }, { @@ -11251,122 +10804,180 @@ "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" + "lineNumber": 42 } } ], "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" + "lineNumber": 36 }, "initialIsOpen": false }, { - "id": "def-public.ISearchOptions", + "id": "def-public.SearchSourceFields", "type": "Interface", - "label": "ISearchOptions", - "description": [], + "label": "SearchSourceFields", + "description": [ + "\nsearch source fields" + ], "tags": [], "children": [ { "tags": [], - "id": "def-public.ISearchOptions.abortSignal", - "type": "Object", - "label": "abortSignal", - "description": [ - "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." - ], + "id": "def-public.SearchSourceFields.type", + "type": "string", + "label": "type", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 62 }, "signature": [ - "AbortSignal | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.ISearchOptions.strategy", - "type": "string", - "label": "strategy", + "id": "def-public.SearchSourceFields.query", + "type": "Object", + "label": "query", "description": [ - "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + "\n{@link Query}" ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 66 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.ISearchOptions.legacyHitsTotal", + "id": "def-public.SearchSourceFields.filter", "type": "CompoundType", - "label": "legacyHitsTotal", + "label": "filter", "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`." + "\n{@link Filter}" ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 70 }, "signature": [ - "boolean | undefined" + { + "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" ] }, { "tags": [], - "id": "def-public.ISearchOptions.sessionId", - "type": "string", - "label": "sessionId", + "id": "def-public.SearchSourceFields.sort", + "type": "CompoundType", + "label": "sort", "description": [ - "\nA session ID, grouping multiple search requests into a single session." + "\n{@link EsQuerySortValue}" ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 74 }, "signature": [ - "string | undefined" + "Record | Record[] | undefined" ] }, { "tags": [], - "id": "def-public.ISearchOptions.isStored", - "type": "CompoundType", - "label": "isStored", - "description": [ - "\nWhether the session is already saved (i.e. sent to background)" - ], + "id": "def-public.SearchSourceFields.highlight", + "type": "Any", + "label": "highlight", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 75 }, "signature": [ - "boolean | undefined" + "any" ] }, { "tags": [], - "id": "def-public.ISearchOptions.isRestore", + "id": "def-public.SearchSourceFields.highlightAll", "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)" - ], + "label": "highlightAll", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 76 }, "signature": [ "boolean | undefined" @@ -11374,471 +10985,287 @@ }, { "tags": [], - "id": "def-public.ISearchOptions.indexPattern", - "type": "Object", - "label": "indexPattern", - "description": [ - "\nIndex pattern reference is used for better error messages" - ], + "id": "def-public.SearchSourceFields.trackTotalHits", + "type": "CompoundType", + "label": "trackTotalHits", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 77 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined" + "number | boolean | 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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.RefreshInterval.pause", - "type": "boolean", - "label": "pause", - "description": [], + "id": "def-public.SearchSourceFields.aggs", + "type": "Any", + "label": "aggs", + "description": [ + "\n{@link AggConfigs}" + ], "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" - } + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 81 + }, + "signature": [ + "any" + ] }, { "tags": [], - "id": "def-public.RefreshInterval.value", + "id": "def-public.SearchSourceFields.from", "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.ApplyGlobalFilterActionContext.filters", - "type": "Array", - "label": "filters", + "label": "from", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 82 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" + "number | undefined" ] }, { "tags": [], - "id": "def-public.ApplyGlobalFilterActionContext.timeFieldName", - "type": "string", - "label": "timeFieldName", + "id": "def-public.SearchSourceFields.size", + "type": "number", + "label": "size", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 83 }, "signature": [ - "string | undefined" + "number | undefined" ] }, { "tags": [], - "id": "def-public.ApplyGlobalFilterActionContext.embeddable", - "type": "Unknown", - "label": "embeddable", + "id": "def-public.SearchSourceFields.source", + "type": "CompoundType", + "label": "source", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 84 }, "signature": [ - "unknown" + "string | boolean | string[] | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-public.IDataPluginServices.appName", - "type": "string", - "label": "appName", + "id": "def-public.SearchSourceFields.version", + "type": "CompoundType", + "label": "version", "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" - } + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 85 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-public.IDataPluginServices.uiSettings", - "type": "Object", - "label": "uiSettings", - "description": [], + "id": "def-public.SearchSourceFields.fields", + "type": "Array", + "label": "fields", + "description": [ + "\nRetrieve fields via the search Fields API" + ], "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L117" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 89 }, "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.IUiSettingsClient", - "text": "IUiSettingsClient" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchFieldValue", + "text": "SearchFieldValue" + }, + "[] | undefined" ] }, { - "tags": [], - "id": "def-public.IDataPluginServices.savedObjects", - "type": "Object", - "label": "savedObjects", - "description": [], + "tags": [ + "deprecated" + ], + "id": "def-public.SearchSourceFields.fieldsFromSource", + "type": "CompoundType", + "label": "fieldsFromSource", + "description": [ + "\nRetreive fields directly from _source (legacy behavior)\n" + ], "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L118" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 95 }, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsStart", - "text": "SavedObjectsStart" - } + "string | boolean | string[] | undefined" ] }, { "tags": [], - "id": "def-public.IDataPluginServices.notifications", + "id": "def-public.SearchSourceFields.index", "type": "Object", - "label": "notifications", - "description": [], + "label": "index", + "description": [ + "\n{@link IndexPatternService}" + ], "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 119, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L119" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 99 }, "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.NotificationsStart", - "text": "NotificationsStart" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.IDataPluginServices.http", + "id": "def-public.SearchSourceFields.searchAfter", "type": "Object", - "label": "http", + "label": "searchAfter", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 100 }, "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.EsQuerySearchAfter", + "text": "EsQuerySearchAfter" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.IDataPluginServices.storage", - "type": "Object", - "label": "storage", + "id": "def-public.SearchSourceFields.timeout", + "type": "string", + "label": "timeout", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 101 }, "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IStorageWrapper", - "text": "IStorageWrapper" - }, - "" + "string | undefined" ] }, { "tags": [], - "id": "def-public.IDataPluginServices.data", - "type": "Object", - "label": "data", + "id": "def-public.SearchSourceFields.terminate_after", + "type": "number", + "label": "terminate_after", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 102 }, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataPublicPluginStart", - "text": "DataPublicPluginStart" - } + "number | undefined" ] }, { "tags": [], - "id": "def-public.IDataPluginServices.usageCollection", + "id": "def-public.SearchSourceFields.parent", "type": "Object", - "label": "usageCollection", + "label": "parent", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 104 }, "signature": [ { - "pluginId": "usageCollection", - "scope": "public", - "docId": "kibUsageCollectionPluginApi", - "section": "def-public.UsageCollectionStart", - "text": "UsageCollectionStart" + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" }, " | 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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 61 }, "initialIsOpen": false }, { - "id": "def-public.DataPublicPluginStartUi", + "id": "def-public.TypeMeta", "type": "Interface", - "label": "DataPublicPluginStartUi", - "description": [ - "\nData plugin prewired UI components" - ], + "label": "TypeMeta", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.DataPublicPluginStartUi.IndexPatternSelect", - "type": "CompoundType", - "label": "IndexPatternSelect", + "id": "def-public.TypeMeta.aggs", + "type": "Object", + "label": "aggs", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 159 }, "signature": [ - "React.ComponentType<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.IndexPatternSelectProps", - "text": "IndexPatternSelectProps" - }, - ">" + "Record> | undefined" ] }, { + "id": "def-public.TypeMeta.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 160 }, "signature": [ - "React.ComponentType<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataUiPluginApi", - "section": "def-public.StatefulSearchBarProps", - "text": "StatefulSearchBarProps" - }, - ">" + "any" ] } ], "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L59" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 158 }, "initialIsOpen": false - }, + } + ], + "enums": [ { - "id": "def-public.DataPublicPluginStartActions", - "type": "Interface", - "label": "DataPublicPluginStartActions", - "description": [ - "\nutilities to generate filters from action context" - ], + "id": "def-public.BUCKET_TYPES", + "type": "Enum", + "label": "BUCKET_TYPES", "tags": [], - "children": [ - { - "tags": [], - "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" - }, - "[]>" - ] - }, - { - "tags": [], - "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" - } - ] - } - ], + "description": [], "source": { - "path": "src/plugins/data/public/types.ts", - "lineNumber": 67, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L67" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "lineNumber": 9 }, "initialIsOpen": false - } - ], - "enums": [ + }, { "id": "def-public.ES_FIELD_TYPES", "type": "Enum", @@ -11849,8 +11276,7 @@ "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" + "lineNumber": 18 }, "initialIsOpen": false }, @@ -11864,21 +11290,7 @@ "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L64" - }, - "initialIsOpen": false - }, - { - "id": "def-public.BUCKET_TYPES", - "type": "Enum", - "label": "BUCKET_TYPES", - "tags": [], - "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" + "lineNumber": 64 }, "initialIsOpen": false }, @@ -11890,8 +11302,7 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false }, @@ -11903,375 +11314,385 @@ "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" + "lineNumber": 39 }, "initialIsOpen": false } ], "misc": [ { - "id": "def-public.RangeFilter", - "type": "Type", - "label": "RangeFilter", "tags": [], + "id": "def-public.ACTION_GLOBAL_APPLY_FILTER", + "type": "string", + "label": "ACTION_GLOBAL_APPLY_FILTER", "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" + "path": "src/plugins/data/public/actions/apply_filter_action.ts", + "lineNumber": 16 }, "signature": [ - "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + "\"ACTION_GLOBAL_APPLY_FILTER\"" ], "initialIsOpen": false }, { - "id": "def-public.RangeFilterMeta", + "id": "def-public.AggConfigOptions", "type": "Type", - "label": "RangeFilterMeta", + "label": "AggConfigOptions", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 43 }, "signature": [ - "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "initialIsOpen": false }, { - "id": "def-public.ExistsFilter", + "id": "def-public.AggGroupName", "type": "Type", - "label": "ExistsFilter", + "label": "AggGroupName", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 18 }, "signature": [ - "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + "\"buckets\" | \"metrics\" | \"none\"" ], "initialIsOpen": false }, { - "id": "def-public.PhrasesFilter", + "id": "def-public.AggParam", "type": "Type", - "label": "PhrasesFilter", + "label": "AggParam", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 28 }, "signature": [ - "Filter & { meta: PhrasesFilterMeta; }" + "BaseParamType" ], "initialIsOpen": false }, { - "id": "def-public.PhraseFilter", + "id": "def-public.AggregationRestrictions", "type": "Type", - "label": "PhraseFilter", + "label": "AggregationRestrictions", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 141 }, "signature": [ - "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + "{ [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.CustomFilter", + "id": "def-public.AggsStart", "type": "Type", - "label": "CustomFilter", - "tags": [], - "description": [], + "label": "AggsStart", + "tags": [ + "public" + ], + "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/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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 139 }, "signature": [ - "Filter & { query: any; }" + "{ 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.MatchAllFilter", - "type": "Type", - "label": "MatchAllFilter", "tags": [], + "id": "def-public.APPLY_FILTER_TRIGGER", + "type": "string", + "label": "APPLY_FILTER_TRIGGER", "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" + "path": "src/plugins/data/public/triggers/apply_filter_trigger.ts", + "lineNumber": 12 }, "signature": [ - "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + "\"FILTER_TRIGGER\"" ], "initialIsOpen": false }, { - "id": "def-public.IFieldFormat", + "id": "def-public.CustomFilter", "type": "Type", - "label": "IFieldFormat", + "label": "CustomFilter", "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 70, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L70" + "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", + "lineNumber": 11 }, "signature": [ - "FieldFormat" + "Filter & { query: any; }" ], "initialIsOpen": false }, { - "id": "def-public.IFieldFormatsRegistry", - "type": "Type", - "label": "IFieldFormatsRegistry", "tags": [], + "id": "def-public.ES_SEARCH_STRATEGY", + "type": "string", + "label": "ES_SEARCH_STRATEGY", "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 13 }, "signature": [ - "{ init: (getConfig: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "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" - } + "\"es\"" ], "initialIsOpen": false }, { - "id": "def-public.FieldFormatsContentType", + "id": "def-public.EsaggsExpressionFunctionDefinition", "type": "Type", - "label": "FieldFormatsContentType", - "tags": [ - "public" - ], + "label": "EsaggsExpressionFunctionDefinition", + "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35 }, "signature": [ - "\"html\" | \"text\"" + "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" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-public.FieldFormatsGetConfigFn", + "id": "def-public.EsQuerySortValue", "type": "Type", - "label": "FieldFormatsGetConfigFn", + "label": "EsQuerySortValue", "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 68, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L68" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 49 }, "signature": [ - "(key: string, defaultOverride: T | undefined) => T" + "{ [x: string]: SortDirection | SortDirectionNumeric; }" ], "initialIsOpen": false }, { - "id": "def-public.FieldFormatId", + "id": "def-public.ExecutionContextSearch", "type": "Type", - "label": "FieldFormatId", - "tags": [ - "string" - ], + "label": "ExecutionContextSearch", + "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L75" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 14 }, "signature": [ - "string" + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], "initialIsOpen": false }, { - "id": "def-public.IndexPatternsContract", + "id": "def-public.ExistsFilter", "type": "Type", - "label": "IndexPatternsContract", + "label": "ExistsFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 18 }, "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; }" + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" ], "initialIsOpen": false }, { - "id": "def-public.AggregationRestrictions", + "id": "def-public.ExpressionFunctionKibana", "type": "Type", - "label": "AggregationRestrictions", + "label": "ExpressionFunctionKibana", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17 }, "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + "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.IndexPatternLoadExpressionFunctionDefinition", + "id": "def-public.ExpressionFunctionKibanaContext", "type": "Type", - "label": "IndexPatternLoadExpressionFunctionDefinition", + "label": "ExpressionFunctionKibanaContext", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 23 }, "signature": [ - "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", + "ExpressionFunctionDefinition<\"kibana_context\", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - "<", + "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", { - "pluginId": "inspector", + "pluginId": "expressions", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - ", ", - "SerializableState", - ">>" + "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" ], "initialIsOpen": false }, { - "id": "def-public.AggGroupName", + "id": "def-public.ExpressionValueSearchContext", "type": "Type", - "label": "AggGroupName", + "label": "ExpressionValueSearchContext", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 20 }, "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { - "id": "def-public.AggParam", + "id": "def-public.FieldFormatId", "type": "Type", - "label": "AggParam", - "tags": [], + "label": "FieldFormatId", + "tags": [ + "string" + ], "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 75 }, "signature": [ - "BaseParamType" + "string" ], "initialIsOpen": false }, { - "id": "def-public.AggConfigOptions", + "id": "def-public.FieldFormatsContentType", "type": "Type", - "label": "AggConfigOptions", + "label": "FieldFormatsContentType", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 14 + }, + "signature": [ + "\"html\" | \"text\"" + ], + "initialIsOpen": false + }, + { + "id": "def-public.FieldFormatsGetConfigFn", + "type": "Type", + "label": "FieldFormatsGetConfigFn", "tags": [], "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 68 }, "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + "(key: string, defaultOverride: T | undefined) => T" ], "initialIsOpen": false }, { - "id": "def-public.EsaggsExpressionFunctionDefinition", + "id": "def-public.Filter", "type": "Type", - "label": "EsaggsExpressionFunctionDefinition", + "label": "Filter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 41 }, "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" - }, - ", ", - "SerializableState", - ">>" + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" ], "initialIsOpen": false }, @@ -12286,8 +11707,7 @@ "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" + "lineNumber": 53 }, "signature": [ "AggConfig" @@ -12302,8 +11722,7 @@ "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" + "lineNumber": 58 }, "signature": [ "AggType>" @@ -12311,210 +11730,146 @@ "initialIsOpen": false }, { - "id": "def-public.IFieldParamType", - "type": "Type", - "label": "IFieldParamType", - "tags": [], - "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", + "id": "def-public.IEsSearchResponse", "type": "Type", - "label": "IMetricAggType", + "label": "IEsSearchResponse", "tags": [], "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 23 }, "signature": [ - "MetricAggType" + "IKibanaSearchResponse>" ], "initialIsOpen": false }, { - "id": "def-public.ParsedInterval", + "id": "def-public.IFieldFormat", "type": "Type", - "label": "ParsedInterval", + "label": "IFieldFormat", "tags": [], "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 70 }, "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + "FieldFormat" ], "initialIsOpen": false }, { - "id": "def-public.ExecutionContextSearch", + "id": "def-public.IFieldFormatsRegistry", "type": "Type", - "label": "ExecutionContextSearch", + "label": "IFieldFormatsRegistry", "tags": [], "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" + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11 }, "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" - ], - "initialIsOpen": false - }, - { - "id": "def-public.ExpressionFunctionKibana", - "type": "Type", - "label": "ExpressionFunctionKibana", - "tags": [], - "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", - "tags": [], - "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\", ", + "{ init: (getConfig: ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, - "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "FieldFormatInstanceType", + "[]) => void; register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; deserialize: ", + "FormatFactory", + "; getDefaultConfig: (fieldType: ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } ], "initialIsOpen": false }, { - "id": "def-public.ExpressionValueSearchContext", + "id": "def-public.IFieldParamType", "type": "Type", - "label": "ExpressionValueSearchContext", + "label": "IFieldParamType", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 21 }, "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "FieldParamType" ], "initialIsOpen": false }, { - "id": "def-public.KibanaContext", + "id": "def-public.IMetricAggType", "type": "Type", - "label": "KibanaContext", - "tags": [], - "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 - }, - { + "label": "IMetricAggType", "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 35 }, "signature": [ - "\"es\"" + "MetricAggType" ], "initialIsOpen": false }, { - "id": "def-public.EsQuerySortValue", + "id": "def-public.IndexPatternLoadExpressionFunctionDefinition", "type": "Type", - "label": "EsQuerySortValue", + "label": "IndexPatternLoadExpressionFunctionDefinition", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 34 }, "signature": [ - "{ [x: string]: SortDirection | SortDirectionNumeric; }" + "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" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-public.IEsSearchResponse", + "id": "def-public.IndexPatternsContract", "type": "Type", - "label": "IEsSearchResponse", + "label": "IndexPatternsContract", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 638 }, "signature": [ - "IKibanaSearchResponse>" + "{ 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 }, @@ -12526,8 +11881,7 @@ "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" + "lineNumber": 13 }, "signature": [ "(request: SearchStrategyRequest, options: ", @@ -12556,8 +11910,7 @@ ], "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" + "lineNumber": 19 }, "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?: ", @@ -12586,140 +11939,218 @@ "initialIsOpen": false }, { - "id": "def-public.Filter", + "id": "def-public.KibanaContext", "type": "Type", - "label": "Filter", + "label": "KibanaContext", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 27 }, "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { - "id": "def-public.Query", + "id": "def-public.MatchAllFilter", "type": "Type", - "label": "Query", + "label": "MatchAllFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 16 }, "signature": [ - "{ query: string | { [key: string]: any; }; language: string; }" + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" ], "initialIsOpen": false }, { - "id": "def-public.TimeRange", + "id": "def-public.ParsedInterval", "type": "Type", - "label": "TimeRange", + "label": "ParsedInterval", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 18 }, "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" ], "initialIsOpen": false }, { - "id": "def-public.AggsStart", + "id": "def-public.PhraseFilter", "type": "Type", - "label": "AggsStart", - "tags": [ - "public" + "label": "PhraseFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 21 + }, + "signature": [ + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" ], - "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" + "initialIsOpen": false + }, + { + "id": "def-public.PhrasesFilter", + "type": "Type", + "label": "PhrasesFilter", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 19 + }, + "signature": [ + "Filter & { meta: PhrasesFilterMeta; }" + ], + "initialIsOpen": false + }, + { + "id": "def-public.Query", + "type": "Type", + "label": "Query", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/query/types.ts", + "lineNumber": 12 + }, + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" ], + "initialIsOpen": false + }, + { + "id": "def-public.RangeFilter", + "type": "Type", + "label": "RangeFilter", + "tags": [], + "description": [], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 60 }, "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; }" + "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", "tags": [], - "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 50 }, "signature": [ - "\"ACTION_GLOBAL_APPLY_FILTER\"" + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" ], "initialIsOpen": false }, { + "id": "def-public.TimeRange", + "type": "Type", + "label": "TimeRange", "tags": [], - "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" + "path": "src/plugins/data/common/query/timefilter/types.ts", + "lineNumber": 17 }, "signature": [ - "\"FILTER_TRIGGER\"" + "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" ], "initialIsOpen": false } ], "objects": [ { - "id": "def-public.esFilters", + "id": "def-public.AggGroupLabels", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-public.esFilters.FilterLabel", - "type": "Function", - "label": "FilterLabel", + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + } + ], + "description": [], + "label": "AggGroupLabels", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.AggGroupNames", + "type": "Object", + "label": "AggGroupNames", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 12 + }, + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.esFilters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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" + "lineNumber": 56 }, "signature": [ "(props: ", @@ -12741,8 +12172,7 @@ "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" + "lineNumber": 58 }, "signature": [ "typeof ", @@ -12763,8 +12193,7 @@ "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" + "lineNumber": 59 }, "signature": [ "typeof ", @@ -12785,8 +12214,7 @@ "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" + "lineNumber": 61 }, "signature": [ "(isPinned: boolean, index?: string | undefined) => ", @@ -12807,8 +12235,7 @@ "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" + "lineNumber": 62 }, "signature": [ "(field: ", @@ -12845,8 +12272,7 @@ "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" + "lineNumber": 63 }, "signature": [ "(field: ", @@ -12883,8 +12309,7 @@ "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" + "lineNumber": 64 }, "signature": [ "(field: ", @@ -12921,8 +12346,7 @@ "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" + "lineNumber": 65 }, "signature": [ "(query: any, index: string, alias: string) => ", @@ -12943,8 +12367,7 @@ "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" + "lineNumber": 66 }, "signature": [ "(field: ", @@ -12989,8 +12412,7 @@ "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" + "lineNumber": 68 }, "signature": [ "(filter: any) => filter is ", @@ -13011,8 +12433,7 @@ "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" + "lineNumber": 69 }, "signature": [ "(filter: any) => filter is ", @@ -13033,8 +12454,7 @@ "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" + "lineNumber": 70 }, "signature": [ "(filter: any) => filter is ", @@ -13055,8 +12475,7 @@ "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" + "lineNumber": 71 }, "signature": [ "(filter: any) => filter is ", @@ -13077,8 +12496,7 @@ "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" + "lineNumber": 72 }, "signature": [ "(filter: any) => filter is ", @@ -13099,8 +12517,7 @@ "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" + "lineNumber": 73 }, "signature": [ "(filter: any) => filter is ", @@ -13121,8 +12538,7 @@ "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" + "lineNumber": 74 }, "signature": [ "(filter: any) => filter is ", @@ -13143,8 +12559,7 @@ "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" + "lineNumber": 75 }, "signature": [ "(filter: ", @@ -13166,8 +12581,7 @@ "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" + "lineNumber": 77 }, "signature": [ "(filter: ", @@ -13197,8 +12611,7 @@ "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" + "lineNumber": 78 }, "signature": [ "(filter: ", @@ -13227,8 +12640,7 @@ "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" + "lineNumber": 79 }, "signature": [ "(filter: ", @@ -13250,8 +12662,7 @@ "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" + "lineNumber": 80 }, "signature": [ "(filter: ", @@ -13273,8 +12684,7 @@ "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" + "lineNumber": 81 }, "signature": [ "typeof ", @@ -13295,8 +12705,7 @@ "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" + "lineNumber": 83 }, "signature": [ "(first: ", @@ -13349,8 +12758,7 @@ "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" + "lineNumber": 84 }, "signature": [ { @@ -13370,8 +12778,7 @@ "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" + "lineNumber": 85 }, "signature": [ "typeof ", @@ -13392,8 +12799,7 @@ "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" + "lineNumber": 86 }, "signature": [ "(newFilters?: ", @@ -13423,8 +12829,7 @@ "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" + "lineNumber": 88 }, "signature": [ "typeof ", @@ -13445,8 +12850,7 @@ "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" + "lineNumber": 89 }, "signature": [ "typeof ", @@ -13467,8 +12871,7 @@ "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" + "lineNumber": 90 }, "signature": [ "(filters: ", @@ -13498,8 +12901,7 @@ "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" + "lineNumber": 91 }, "signature": [ "typeof ", @@ -13520,8 +12922,7 @@ "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" + "lineNumber": 92 }, "signature": [ "typeof ", @@ -13539,8 +12940,7 @@ "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" + "lineNumber": 55 }, "initialIsOpen": false }, @@ -13557,8 +12957,7 @@ "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" + "lineNumber": 122 }, "signature": [ { @@ -13578,8 +12977,7 @@ "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" + "lineNumber": 123 }, "signature": [ "(expression: any, parseOptions?: Partial<", @@ -13608,8 +13006,7 @@ "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" + "lineNumber": 124 }, "signature": [ "(node: ", @@ -13643,8 +13040,7 @@ "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" + "lineNumber": 121 }, "initialIsOpen": false }, @@ -13661,8 +13057,7 @@ "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" + "lineNumber": 128 }, "signature": [ "typeof ", @@ -13683,8 +13078,7 @@ "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" + "lineNumber": 129 }, "signature": [ "typeof ", @@ -13705,8 +13099,7 @@ "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" + "lineNumber": 130 }, "signature": [ "(filters: ", @@ -13752,8 +13145,7 @@ "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" + "lineNumber": 131 }, "signature": [ "typeof ", @@ -13774,8 +13166,7 @@ "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" + "lineNumber": 132 }, "signature": [ "typeof ", @@ -13793,8 +13184,53 @@ "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" + "lineNumber": 127 + }, + "initialIsOpen": false + }, + { + "id": "def-public.exporters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.exporters.datatableToCSV", + "type": "Function", + "label": "datatableToCSV", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 212 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.datatableToCSV", + "text": "datatableToCSV" + } + ] + }, + { + "tags": [], + "id": "def-public.exporters.CSV_MIME_TYPE", + "type": "string", + "label": "CSV_MIME_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 213 + } + } + ], + "description": [], + "label": "exporters", + "source": { + "path": "src/plugins/data/public/index.ts", + "lineNumber": 211 }, "initialIsOpen": false }, @@ -13811,8 +13247,7 @@ "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" + "lineNumber": 169 }, "signature": [ "typeof ", @@ -13833,8 +13268,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 170, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L170" + "lineNumber": 170 }, "signature": [ "typeof ", @@ -13855,8 +13289,7 @@ "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" + "lineNumber": 172 }, "signature": [ "{ range: string; regex: string; text: string; background: string; }" @@ -13870,8 +13303,7 @@ "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" + "lineNumber": 173 }, "signature": [ { @@ -13891,8 +13323,7 @@ "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" + "lineNumber": 174 }, "signature": [ { @@ -13912,8 +13343,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 175, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L175" + "lineNumber": 175 }, "signature": [ "typeof ", @@ -13934,8 +13364,7 @@ "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" + "lineNumber": 177 }, "signature": [ "typeof ", @@ -13956,8 +13385,7 @@ "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" + "lineNumber": 178 }, "signature": [ "typeof ", @@ -13978,8 +13406,7 @@ "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" + "lineNumber": 179 }, "signature": [ "typeof ", @@ -14000,8 +13427,7 @@ "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" + "lineNumber": 180 }, "signature": [ "typeof ", @@ -14022,8 +13448,7 @@ "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" + "lineNumber": 181 }, "signature": [ "typeof ", @@ -14044,8 +13469,7 @@ "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" + "lineNumber": 182 }, "signature": [ "typeof ", @@ -14066,8 +13490,7 @@ "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" + "lineNumber": 183 }, "signature": [ "typeof ", @@ -14088,8 +13511,7 @@ "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" + "lineNumber": 184 }, "signature": [ "typeof ", @@ -14110,8 +13532,7 @@ "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" + "lineNumber": 185 }, "signature": [ "typeof ", @@ -14132,8 +13553,7 @@ "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" + "lineNumber": 186 }, "signature": [ "typeof ", @@ -14154,8 +13574,7 @@ "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" + "lineNumber": 187 }, "signature": [ "typeof ", @@ -14176,8 +13595,7 @@ "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" + "lineNumber": 188 }, "signature": [ "typeof ", @@ -14198,8 +13616,7 @@ "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" + "lineNumber": 189 }, "signature": [ "typeof ", @@ -14220,8 +13637,7 @@ "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" + "lineNumber": 190 }, "signature": [ "typeof ", @@ -14242,8 +13658,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 191, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L191" + "lineNumber": 191 }, "signature": [ "typeof ", @@ -14264,8 +13679,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 192, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L192" + "lineNumber": 192 }, "signature": [ "typeof ", @@ -14283,57 +13697,7 @@ "label": "fieldFormats", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 168, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L168" - }, - "initialIsOpen": false - }, - { - "id": "def-public.exporters", - "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.exporters.datatableToCSV", - "type": "Function", - "label": "datatableToCSV", - "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L212" - }, - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.datatableToCSV", - "text": "datatableToCSV" - } - ] - }, - { - "tags": [], - "id": "def-public.exporters.CSV_MIME_TYPE", - "type": "string", - "label": "CSV_MIME_TYPE", - "description": [], - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 213, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L213" - } - } - ], - "description": [], - "label": "exporters", - "source": { - "path": "src/plugins/data/public/index.ts", - "lineNumber": 211, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L211" + "lineNumber": 168 }, "initialIsOpen": false }, @@ -14350,8 +13714,7 @@ "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" + "lineNumber": 237 } }, { @@ -14362,8 +13725,7 @@ "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" + "lineNumber": 238 } }, { @@ -14374,8 +13736,7 @@ "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" + "lineNumber": 239 }, "signature": [ "string[]" @@ -14389,8 +13750,7 @@ "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" + "lineNumber": 240 }, "signature": [ "string[]" @@ -14404,8 +13764,7 @@ "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" + "lineNumber": 241 }, "signature": [ "(indexPattern: ", @@ -14427,8 +13786,7 @@ "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" + "lineNumber": 242 }, "signature": [ "typeof ", @@ -14449,8 +13807,7 @@ "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" + "lineNumber": 243 }, "signature": [ "typeof ", @@ -14471,8 +13828,7 @@ "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" + "lineNumber": 244 }, "signature": [ "typeof ", @@ -14493,8 +13849,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 245, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L245" + "lineNumber": 245 }, "signature": [ "typeof ", @@ -14515,8 +13870,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 246, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L246" + "lineNumber": 246 }, "signature": [ "typeof ", @@ -14534,92 +13888,8 @@ "label": "indexPatterns", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 236, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L236" - }, - "initialIsOpen": false - }, - { - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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 - }, - { - "tags": [], - "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" + "lineNumber": 236 }, - "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" - ], "initialIsOpen": false }, { @@ -14640,8 +13910,7 @@ "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" + "lineNumber": 403 }, "signature": [ "typeof ", @@ -14662,8 +13931,7 @@ "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" + "lineNumber": 404 }, "signature": [ "typeof ", @@ -14684,8 +13952,7 @@ "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" + "lineNumber": 405 }, "signature": [ "({ display: string; val: string; enabled(agg: ", @@ -14707,8 +13974,7 @@ "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" + "lineNumber": 406 }, "signature": [ "typeof ", @@ -14729,8 +13995,7 @@ "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" + "lineNumber": 407 }, "signature": [ "typeof ", @@ -14751,8 +14016,7 @@ "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" + "lineNumber": 408 }, "signature": [ "typeof ", @@ -14773,8 +14037,7 @@ "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" + "lineNumber": 409 }, "signature": [ "typeof ", @@ -14795,8 +14058,7 @@ "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" + "lineNumber": 410 }, "signature": [ "(agg: ", @@ -14818,8 +14080,7 @@ "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" + "lineNumber": 411 }, "signature": [ "(agg: ", @@ -14841,8 +14102,7 @@ "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" + "lineNumber": 412 }, "signature": [ "(...types: string[]) => (agg: ", @@ -14864,8 +14124,7 @@ "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" + "lineNumber": 413 }, "signature": [ "typeof ", @@ -14886,8 +14145,7 @@ "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" + "lineNumber": 414 }, "signature": [ "typeof ", @@ -14908,8 +14166,7 @@ "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" + "lineNumber": 415 } }, { @@ -14920,8 +14177,7 @@ "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" + "lineNumber": 416 }, "signature": [ "typeof ", @@ -14942,8 +14198,7 @@ "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" + "lineNumber": 417 }, "signature": [ "typeof ", @@ -14964,8 +14219,7 @@ "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" + "lineNumber": 418 }, "signature": [ "typeof ", @@ -14986,8 +14240,7 @@ "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" + "lineNumber": 419 } }, { @@ -14998,8 +14251,7 @@ "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" + "lineNumber": 420 }, "signature": [ "string[]" @@ -15013,8 +14265,7 @@ "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" + "lineNumber": 421 }, "signature": [ "typeof ", @@ -15035,8 +14286,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 422, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L422" + "lineNumber": 422 }, "signature": [ "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" @@ -15050,8 +14300,7 @@ "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" + "lineNumber": 423 }, "signature": [ "(column: ", @@ -15070,8 +14319,7 @@ "label": "aggs", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 402, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L402" + "lineNumber": 402 } }, { @@ -15082,8 +14330,7 @@ "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" + "lineNumber": 425 }, "signature": [ "typeof ", @@ -15104,8 +14351,7 @@ "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" + "lineNumber": 426 }, "signature": [ "typeof ", @@ -15126,8 +14372,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 427, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L427" + "lineNumber": 427 }, "signature": [ "typeof ", @@ -15148,8 +14393,7 @@ "description": [], "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 428, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L428" + "lineNumber": 428 }, "signature": [ "typeof ", @@ -15167,9 +14411,23 @@ "label": "search", "source": { "path": "src/plugins/data/public/index.ts", - "lineNumber": 401, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L401" + "lineNumber": 401 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.UI_SETTINGS", + "type": "Object", + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 11 }, + "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 } ], @@ -15190,8 +14448,7 @@ "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" + "lineNumber": 46 }, "signature": [ "{ addQuerySuggestionProvider: (language: string, provider: ", @@ -15221,8 +14478,7 @@ "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" + "lineNumber": 47 }, "signature": [ { @@ -15242,8 +14498,7 @@ "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" + "lineNumber": 48 }, "signature": [ "Pick<", @@ -15265,8 +14520,7 @@ "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" + "lineNumber": 49 }, "signature": [ "{ filterManager: ", @@ -15308,8 +14562,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L45" + "lineNumber": 45 }, "lifecycle": "setup", "initialIsOpen": true @@ -15333,8 +14586,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L80" + "lineNumber": 80 }, "signature": [ { @@ -15356,8 +14608,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 85, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L85" + "lineNumber": 85 }, "signature": [ "{ getQuerySuggestions: ", @@ -15389,8 +14640,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L90" + "lineNumber": 90 }, "signature": [ "Pick<", @@ -15414,8 +14664,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L95" + "lineNumber": 95 }, "signature": [ { @@ -15437,8 +14686,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 100, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L100" + "lineNumber": 100 }, "signature": [ { @@ -15460,8 +14708,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 105, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L105" + "lineNumber": 105 }, "signature": [ "{ addToQueryLog: (appName: string, { language, query }: ", @@ -15510,8 +14757,7 @@ ], "source": { "path": "src/plugins/data/public/types.ts", - "lineNumber": 110, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L110" + "lineNumber": 110 }, "signature": [ { @@ -15531,8 +14777,7 @@ "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" + "lineNumber": 112 }, "signature": [ "Pick extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-server.AggParamType.makeAgg", + "type": "Function", + "label": "makeAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "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" + ] + }, + { + "tags": [], + "id": "def-server.AggParamType.allowedAggs", + "type": "Array", + "label": "allowedAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 16 + }, + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-server.DataServerPlugin", + "type": "Class", + "tags": [], + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 69 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 77 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 104 + } + }, + { + "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 + } + } + ], + "source": { + "path": "src/plugins/data/server/plugin.ts", + "lineNumber": 52 + }, + "initialIsOpen": false }, - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [ { "id": "def-server.IndexPattern", "type": "Class", @@ -15590,8 +15220,7 @@ "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" + "lineNumber": 45 }, "signature": [ "string | undefined" @@ -15605,8 +15234,7 @@ "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" + "lineNumber": 46 } }, { @@ -15617,8 +15245,7 @@ "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" + "lineNumber": 47 }, "signature": [ "Record" @@ -15634,8 +15261,7 @@ ], "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" + "lineNumber": 51 }, "signature": [ { @@ -15656,8 +15282,7 @@ "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" + "lineNumber": 52 }, "signature": [ { @@ -15686,8 +15311,7 @@ "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" + "lineNumber": 53 }, "signature": [ "string | undefined" @@ -15703,8 +15327,7 @@ "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" + "lineNumber": 58 }, "signature": [ "string | undefined" @@ -15720,8 +15343,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ "string | undefined" @@ -15735,8 +15357,7 @@ "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" + "lineNumber": 63 }, "signature": [ "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" @@ -15750,8 +15371,7 @@ "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" + "lineNumber": 67 }, "signature": [ "FormatFieldFn" @@ -15765,8 +15385,7 @@ "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" + "lineNumber": 68 }, "signature": [ "(hit: Record, deep?: boolean | undefined) => Record" @@ -15780,8 +15399,7 @@ "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" + "lineNumber": 69 }, "signature": [ "string[]" @@ -15797,8 +15415,7 @@ ], "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" + "lineNumber": 73 }, "signature": [ "string | undefined" @@ -15812,8 +15429,7 @@ "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" + "lineNumber": 74 }, "signature": [ { @@ -15836,8 +15452,7 @@ ], "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" + "lineNumber": 84 } }, { @@ -15859,8 +15474,7 @@ "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" + "lineNumber": 86 } } ], @@ -15868,8 +15482,7 @@ "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" + "lineNumber": 86 } }, { @@ -15885,8 +15498,7 @@ "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" + "lineNumber": 128 }, "tags": [], "returnComment": [] @@ -15904,8 +15516,7 @@ "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" + "lineNumber": 133 }, "tags": [], "returnComment": [] @@ -15929,8 +15540,7 @@ "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" + "lineNumber": 137 }, "tags": [], "returnComment": [] @@ -15956,8 +15566,7 @@ "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" + "lineNumber": 162 } }, { @@ -15982,8 +15591,7 @@ "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" + "lineNumber": 208 } }, { @@ -16001,8 +15609,7 @@ "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" + "lineNumber": 230 } }, { @@ -16028,8 +15635,7 @@ ], "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" + "lineNumber": 244 } }, { @@ -16044,8 +15650,7 @@ ], "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" + "lineNumber": 244 } }, { @@ -16058,8 +15663,7 @@ "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" + "lineNumber": 244 } } ], @@ -16067,8 +15671,7 @@ "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" + "lineNumber": 244 } }, { @@ -16092,8 +15695,7 @@ "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" + "lineNumber": 270 } } ], @@ -16101,8 +15703,7 @@ "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" + "lineNumber": 270 } }, { @@ -16126,8 +15727,7 @@ "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" + "lineNumber": 277 } }, { @@ -16151,8 +15751,7 @@ "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" + "lineNumber": 281 } }, { @@ -16168,8 +15767,7 @@ "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" + "lineNumber": 285 } }, { @@ -16185,8 +15783,7 @@ "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" + "lineNumber": 289 } }, { @@ -16210,8 +15807,7 @@ "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" + "lineNumber": 294 } }, { @@ -16241,8 +15837,7 @@ "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" + "lineNumber": 299 } } ], @@ -16250,8 +15845,7 @@ "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" + "lineNumber": 299 } }, { @@ -16267,8 +15861,7 @@ "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" + "lineNumber": 304 } }, { @@ -16286,8 +15879,7 @@ "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" + "lineNumber": 311 } }, { @@ -16364,8 +15956,7 @@ "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" + "lineNumber": 340 } } ], @@ -16373,8 +15964,7 @@ "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" + "lineNumber": 339 } }, { @@ -16408,8 +15998,7 @@ ], "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" + "lineNumber": 360 } }, { @@ -16430,8 +16019,7 @@ ], "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" + "lineNumber": 360 } } ], @@ -16439,8 +16027,7 @@ "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" + "lineNumber": 360 } }, { @@ -16466,8 +16053,7 @@ ], "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" + "lineNumber": 384 } } ], @@ -16475,8 +16061,7 @@ "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" + "lineNumber": 384 } }, { @@ -16508,8 +16093,7 @@ "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" + "lineNumber": 404 } } ], @@ -16517,8 +16101,7 @@ "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" + "lineNumber": 404 } }, { @@ -16548,8 +16131,7 @@ "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" + "lineNumber": 412 } }, { @@ -16562,8 +16144,7 @@ "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" + "lineNumber": 413 } }, { @@ -16583,8 +16164,7 @@ "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" + "lineNumber": 414 } } ], @@ -16592,8 +16172,7 @@ "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" + "lineNumber": 411 } }, { @@ -16615,8 +16194,7 @@ "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" + "lineNumber": 422 } }, { @@ -16629,501 +16207,219 @@ "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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", - "tags": [], - "label": "IndexPatternsService", - "description": [], - "children": [ - { - "tags": [], - "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" - }, - "tags": [], - "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" + "lineNumber": 422 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 + } }, { - "id": "def-server.IndexPatternsService.find", + "id": "def-server.IndexPattern.setFieldCount", "type": "Function", + "label": "setFieldCount", + "signature": [ + "(fieldName: string, count: number | null | undefined) => void" + ], + "description": [], "children": [ { "type": "string", - "label": "search", + "label": "fieldName", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 } }, { - "type": "number", - "label": "size", - "isRequired": true, + "type": "CompoundType", + "label": "count", + "isRequired": false, "signature": [ - "number" + "number | null | undefined" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 } } ], - "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" - }, "tags": [], - "returnComment": [ - "IndexPattern[]" - ] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 + } }, { - "id": "def-server.IndexPatternsService.getIdsWithTitle", + "id": "def-server.IndexPattern.setFieldFormat", "type": "Function", "children": [ { - "type": "boolean", - "label": "refresh", + "type": "string", + "label": "fieldName", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 + } + }, + { + "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 } } ], "signature": [ - "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" - ], - "description": [ - "\nGet list of index pattern ids with titles" + "(fieldName: string, format: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">) => void" ], - "label": "getIdsWithTitle", + "description": [], + "label": "setFieldFormat", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 }, "tags": [], "returnComment": [] }, { - "id": "def-server.IndexPatternsService.clearCache", + "id": "def-server.IndexPattern.deleteFieldFormat", "type": "Function", "children": [ { "type": "string", - "label": "id", - "isRequired": false, + "label": "fieldName", + "isRequired": true, "signature": [ - "string | undefined" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 } } ], "signature": [ - "(id?: string | undefined) => void" - ], - "description": [ - "\nClear index pattern list cache" + "(fieldName: string) => void" ], - "label": "clearCache", + "description": [], + "label": "deleteFieldFormat", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 }, "tags": [], "returnComment": [] - }, + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44 + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ { - "id": "def-server.IndexPatternsService.getCache", + "tags": [], + "id": "def-server.IndexPatternsService.ensureDefaultIndexPattern", "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>" - ], + "label": "ensureDefaultIndexPattern", "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" + "lineNumber": 67 }, - "tags": [], - "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" - }, - "tags": [], - "returnComment": [] + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] }, { - "id": "def-server.IndexPatternsService.setDefault", + "id": "def-server.IndexPatternsService.Unnamed", "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, "signature": [ - "string" + "IndexPatternsServiceDeps" ], "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" + "lineNumber": 69 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 + } + }, + { + "id": "def-server.IndexPatternsService.getIds", + "type": "Function", + "children": [ { "type": "boolean", - "label": "force", + "label": "refresh", "isRequired": true, "signature": [ "boolean" @@ -17131,132 +16427,89 @@ "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" + "lineNumber": 108 } } ], "signature": [ - "(id: string, force?: boolean) => Promise" + "(refresh?: boolean) => Promise" ], "description": [ - "\nOptionally set default index pattern, unless force = true" + "\nGet list of index pattern ids" ], - "label": "setDefault", + "label": "getIds", "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" + "lineNumber": 108 }, "tags": [], "returnComment": [] }, { - "id": "def-server.IndexPatternsService.getFieldsForWildcard", + "id": "def-server.IndexPatternsService.getTitles", "type": "Function", "children": [ { - "type": "Object", - "label": "options", + "type": "boolean", + "label": "refresh", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } + "boolean" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122 + } + } + ], + "signature": [ + "(refresh?: boolean) => Promise" ], "description": [ - "\nGet field list by providing { pattern }" + "\nGet list of index pattern titles" ], - "label": "getFieldsForWildcard", + "label": "getTitles", "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" + "lineNumber": 122 }, "tags": [], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "id": "def-server.IndexPatternsService.find", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "indexPattern", + "type": "string", + "label": "search", "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" - } + "string" ], "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" + "lineNumber": 138 } }, { - "type": "Object", - "label": "options", - "isRequired": false, + "type": "number", + "label": "size", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - " | undefined" + "number" ], "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" + "lineNumber": 138 } } ], "signature": [ - "(indexPattern: ", + "(search: string, size?: number) => Promise<", { "pluginId": "data", "scope": "common", @@ -17264,322 +16517,253 @@ "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)" + "\nFind and load index patterns by title" ], - "label": "getFieldsForIndexPattern", + "label": "find", "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" + "lineNumber": 138 }, "tags": [], "returnComment": [ - "FieldSpec[]" + "IndexPattern[]" ] }, { - "id": "def-server.IndexPatternsService.refreshFields", + "id": "def-server.IndexPatternsService.getIdsWithTitle", "type": "Function", "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "boolean", + "label": "refresh", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "boolean" ], "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" + "lineNumber": 157 } } ], "signature": [ - "(indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ") => Promise" + "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" ], "description": [ - "\nRefresh field list for a given index pattern" + "\nGet list of index pattern ids with titles" ], - "label": "refreshFields", + "label": "getIdsWithTitle", "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" + "lineNumber": 156 }, "tags": [], "returnComment": [] }, { - "id": "def-server.IndexPatternsService.fieldArrayToMap", + "id": "def-server.IndexPatternsService.clearCache", "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", + "type": "string", + "label": "id", "isRequired": false, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "string | 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" + "lineNumber": 175 } } ], "signature": [ - "(fields: ", + "(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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getCache", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", { - "pluginId": "data", + "pluginId": "core", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" }, - "[], fieldAttrs?: ", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IndexPatternSavedObjectAttrs", + "text": "IndexPatternSavedObjectAttrs" }, - " | undefined) => Record[] | null | undefined>" + ], + "description": [], + "label": "getCache", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getDefault", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ">" + " | null>" ], "description": [ - "\nConverts field array to map" + "\nGet default index pattern" ], - "label": "fieldArrayToMap", + "label": "getDefault", "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" + "lineNumber": 194 }, "tags": [], - "returnComment": [ - "Record" - ] + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.savedObjectToSpec", + "id": "def-server.IndexPatternsService.setDefault", "type": "Function", "children": [ { - "type": "Object", - "label": "savedObject", + "type": "string", + "label": "id", "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" - }, - ">" + "string" ], "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" + "lineNumber": 208 } - } - ], - "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" + "type": "boolean", + "label": "force", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + } } ], + "signature": [ + "(id: string, force?: boolean) => Promise" + ], "description": [ - "\nConverts index pattern saved object to index pattern spec" + "\nOptionally set default index pattern, unless force = true" ], - "label": "savedObjectToSpec", + "label": "setDefault", "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" + "lineNumber": 208 }, "tags": [], - "returnComment": [ - "IndexPatternSpec" - ] + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.get", + "id": "def-server.IndexPatternsService.getFieldsForWildcard", "type": "Function", "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "string" + { + "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": 464, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464" + "lineNumber": 219 } } ], "signature": [ - "(id: string) => Promise<", + "(options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - ">" + ") => Promise" ], "description": [ - "\nGet an index pattern by id. Cache optimized" + "\nGet field list by providing { pattern }" ], - "label": "get", + "label": "getFieldsForWildcard", "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" + "lineNumber": 219 }, "tags": [], - "returnComment": [] + "returnComment": [ + "FieldSpec[]" + ] }, { - "id": "def-server.IndexPatternsService.create", + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", "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", + "type": "CompoundType", + "label": "indexPattern", "isRequired": true, "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", { "pluginId": "data", "scope": "common", @@ -17591,41 +16775,40 @@ "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" + "lineNumber": 236 } }, { - "type": "boolean", - "label": "skipFetchFields", - "isRequired": true, + "type": "Object", + "label": "options", + "isRequired": false, "signature": [ - "boolean" + { + "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": 483, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" + "lineNumber": 237 } } ], - "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: ", + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", { "pluginId": "data", "scope": "common", @@ -17633,85 +16816,53 @@ "section": "def-common.IndexPatternSpec", "text": "IndexPatternSpec" }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", + ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - ">" + " | undefined) => Promise" ], "description": [ - "\nCreate a new index pattern and save it right away" + "\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 + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.refreshFields", + "type": "Function", "children": [ { "type": "Object", - "label": "spec", + "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + "section": "def-common.IndexPattern", + "text": "IndexPattern" } ], "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" + "lineNumber": 250 } } ], - "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: ", { @@ -17721,252 +16872,265 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - ", override?: boolean) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ">" + ") => Promise" ], "description": [ - "\nSave a new index pattern" + "\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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.fieldArrayToMap", + "type": "Function", "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "Array", + "label": "fields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" ], "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" + "lineNumber": 327 } }, { - "type": "boolean", - "label": "override", - "isRequired": true, + "type": "Object", + "label": "fieldAttrs", + "isRequired": false, "signature": [ - "boolean" - ], - "description": [ - "Overwrite if existing index pattern exists" + { + "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": 521, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521" + "lineNumber": 327 } } ], - "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: ", + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[], fieldAttrs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + " | undefined) => Record" ], "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + "\nConverts field array to map" ], + "label": "fieldArrayToMap", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327 + }, + "tags": [], + "returnComment": [ + "Record" + ] + }, + { + "id": "def-server.IndexPatternsService.savedObjectToSpec", + "type": "Function", "children": [ { "type": "Object", - "label": "indexPattern", + "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.IndexPattern", - "text": "IndexPattern" - } + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" + }, + ">" ], "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" + "lineNumber": 343 } + } + ], + "signature": [ + "(savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" }, + "<", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" }, + ">) => ", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" } ], - "tags": [], - "returnComment": [], + "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": 546, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" - } + "lineNumber": 343 + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] }, { - "id": "def-server.IndexPatternsService.delete", + "id": "def-server.IndexPatternsService.get", "type": "Function", - "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "description": [ - "\nDeletes an index pattern from .kibana index" - ], "children": [ { "type": "string", - "label": "indexPatternId", + "label": "id", "isRequired": true, "signature": [ "string" ], - "description": [ - ": Id of kibana Index Pattern to delete" - ], + "description": [], "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" + "lineNumber": 464 } } ], - "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", - "tags": [], - "label": "IndexPatternsService", - "description": [], - "children": [ - { - "tags": [], - "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": [ + "(id: string) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.EnsureDefaultIndexPattern", - "text": "EnsureDefaultIndexPattern" - } - ] + "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 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.Unnamed", + "id": "def-server.IndexPatternsService.create", "type": "Function", - "label": "Constructor", + "label": "create", "signature": [ - "any" + "(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" ], - "description": [], "children": [ { "type": "Object", - "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "label": "spec", "isRequired": true, "signature": [ - "IndexPatternsServiceDeps" + { + "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": 69, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69" + "lineNumber": 483 } - } - ], - "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", + "label": "skipFetchFields", "isRequired": true, "signature": [ "boolean" @@ -17974,95 +17138,109 @@ "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" + "lineNumber": 483 } } ], - "signature": [ - "(refresh?: boolean) => Promise" - ], - "description": [ - "\nGet list of index pattern ids" + "tags": [], + "returnComment": [ + "IndexPattern" ], - "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" - }, - "tags": [], - "returnComment": [] + "lineNumber": 483 + } }, { - "id": "def-server.IndexPatternsService.getTitles", + "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": "boolean", - "label": "refresh", + "type": "Object", + "label": "spec", "isRequired": true, "signature": [ - "boolean" + { + "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": 122, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122" + "lineNumber": 508 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.find", - "type": "Function", - "children": [ + }, { - "type": "string", - "label": "search", + "type": "boolean", + "label": "override", "isRequired": true, "signature": [ - "string" + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists." ], - "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" + "lineNumber": 508 } }, { - "type": "number", - "label": "size", + "type": "boolean", + "label": "skipFetchFields", "isRequired": true, "signature": [ - "number" + "boolean" + ], + "description": [ + "Whether to skip field refresh step." ], - "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" + "lineNumber": 508 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 + } + }, + { + "id": "def-server.IndexPatternsService.createSavedObject", + "type": "Function", + "label": "createSavedObject", "signature": [ - "(search: string, size?: number) => Promise<", + "(indexPattern: ", { "pluginId": "data", "scope": "common", @@ -18070,129 +17248,68 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - "[]>" + ", override?: boolean) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" ], "description": [ - "\nFind and load index patterns by title" + "\nSave a new index pattern" ], - "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" - }, - "tags": [], - "returnComment": [ - "IndexPattern[]" - ] - }, - { - "id": "def-server.IndexPatternsService.getIdsWithTitle", - "type": "Function", "children": [ { - "type": "boolean", - "label": "refresh", + "type": "Object", + "label": "indexPattern", "isRequired": true, "signature": [ - "boolean" + { + "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": 157, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157" + "lineNumber": 521 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.clearCache", - "type": "Function", - "children": [ + }, { - "type": "string", - "label": "id", - "isRequired": false, + "type": "boolean", + "label": "override", + "isRequired": true, "signature": [ - "string | undefined" + "boolean" + ], + "description": [ + "Overwrite if existing index pattern exists" ], - "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" + "lineNumber": 521 } } ], - "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" - }, "tags": [], - "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", + "returnComment": [], "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" - }, - "tags": [], - "returnComment": [] + "lineNumber": 521 + } }, { - "id": "def-server.IndexPatternsService.getDefault", + "id": "def-server.IndexPatternsService.updateSavedObject", "type": "Function", - "children": [], + "label": "updateSavedObject", "signature": [ - "() => Promise<", + "(indexPattern: ", { "pluginId": "data", "scope": "common", @@ -18200,41 +17317,47 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - " | null>" + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], "description": [ - "\nGet default index pattern" + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.IndexPatternsService.setDefault", - "type": "Function", "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "indexPattern", "isRequired": true, "signature": [ - "string" + { + "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 + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" ], "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" + "lineNumber": 548 } }, { "type": "boolean", - "label": "force", + "label": "ignoreErrors", "isRequired": true, "signature": [ "boolean" @@ -18242,437 +17365,336 @@ "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" + "lineNumber": 549 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546 + } + }, + { + "id": "def-server.IndexPatternsService.delete", + "type": "Function", + "label": "delete", "signature": [ - "(id: string, force?: boolean) => Promise" + "(indexPatternId: string) => Promise<{}>" ], "description": [ - "\nOptionally set default index pattern, unless force = true" + "\nDeletes an index pattern from .kibana index" ], - "label": "setDefault", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632 + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.IndexPatternsService.ensureDefaultIndexPattern", + "type": "Function", + "label": "ensureDefaultIndexPattern", + "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" + "lineNumber": 67 }, - "tags": [], - "returnComment": [] + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] }, { - "id": "def-server.IndexPatternsService.getFieldsForWildcard", + "id": "def-server.IndexPatternsService.Unnamed", "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { "type": "Object", - "label": "options", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } + "IndexPatternsServiceDeps" ], "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" + "lineNumber": 69 } } ], - "signature": [ - "(options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - }, - ") => Promise" - ], - "description": [ - "\nGet field list by providing { pattern }" - ], - "label": "getFieldsForWildcard", + "tags": [], + "returnComment": [], "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" - }, - "tags": [], - "returnComment": [ - "FieldSpec[]" - ] + "lineNumber": 69 + } }, { - "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "id": "def-server.IndexPatternsService.getIds", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "indexPattern", + "type": "boolean", + "label": "refresh", "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" + "boolean" ], "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" + "lineNumber": 108 } } ], "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" + "(refresh?: boolean) => Promise" ], "description": [ - "\nGet field list by providing an index patttern (or spec)" + "\nGet list of index pattern ids" ], - "label": "getFieldsForIndexPattern", + "label": "getIds", "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" + "lineNumber": 108 }, "tags": [], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.refreshFields", + "id": "def-server.IndexPatternsService.getTitles", "type": "Function", "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "boolean", + "label": "refresh", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "boolean" ], "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" + "lineNumber": 122 } } ], "signature": [ - "(indexPattern: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ") => Promise" + "(refresh?: boolean) => Promise" ], "description": [ - "\nRefresh field list for a given index pattern" + "\nGet list of index pattern titles" ], - "label": "refreshFields", + "label": "getTitles", "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" + "lineNumber": 122 }, "tags": [], "returnComment": [] }, { - "id": "def-server.IndexPatternsService.fieldArrayToMap", + "id": "def-server.IndexPatternsService.find", "type": "Function", "children": [ { - "type": "Array", - "label": "fields", + "type": "string", + "label": "search", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - "[]" + "string" ], "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" + "lineNumber": 138 } }, { - "type": "Object", - "label": "fieldAttrs", - "isRequired": false, + "type": "number", + "label": "size", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "number" ], "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" + "lineNumber": 138 } } ], "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 Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ">" + "[]>" ], "description": [ - "\nConverts field array to map" + "\nFind and load index patterns by title" ], - "label": "fieldArrayToMap", + "label": "find", "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" + "lineNumber": 138 }, "tags": [], "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" - }, - ">" + "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": 343, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + "lineNumber": 157 } } ], "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" - } + "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" ], "description": [ - "\nConverts index pattern saved object to index pattern spec" + "\nGet list of index pattern ids with titles" ], - "label": "savedObjectToSpec", + "label": "getIdsWithTitle", "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" + "lineNumber": 156 }, "tags": [], - "returnComment": [ - "IndexPatternSpec" - ] + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.get", + "id": "def-server.IndexPatternsService.clearCache", "type": "Function", "children": [ { "type": "string", "label": "id", - "isRequired": true, + "isRequired": false, "signature": [ - "string" + "string | undefined" ], "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" + "lineNumber": 175 } } ], "signature": [ - "(id: string) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ">" + "(id?: string | undefined) => void" ], "description": [ - "\nGet an index pattern by id. Cache optimized" + "\nClear index pattern list cache" ], - "label": "get", + "label": "clearCache", "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" + "lineNumber": 175 }, "tags": [], "returnComment": [] }, { - "id": "def-server.IndexPatternsService.create", + "id": "def-server.IndexPatternsService.getCache", "type": "Function", - "label": "create", + "children": [], "signature": [ - "(spec: ", + "() => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + "section": "def-common.IndexPatternSavedObjectAttrs", + "text": "IndexPatternSavedObjectAttrs" }, - ", skipFetchFields?: boolean) => Promise<", + ">[] | null | undefined>" + ], + "description": [], + "label": "getCache", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 184 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.getDefault", + "type": "Function", + "children": [], + "signature": [ + "() => Promise<", { "pluginId": "data", "scope": "common", @@ -18680,35 +17702,39 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - ">" + " | null>" ], "description": [ - "\nCreate a new index pattern instance" + "\nGet default index pattern" ], + "label": "getDefault", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.setDefault", + "type": "Function", "children": [ { - "type": "Object", - "label": "spec", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - } + "string" ], "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" + "lineNumber": 208 } }, { "type": "boolean", - "label": "skipFetchFields", + "label": "force", "isRequired": true, "signature": [ "boolean" @@ -18716,53 +17742,89 @@ "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" + "lineNumber": 208 } } ], - "tags": [], - "returnComment": [ - "IndexPattern" + "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": 483, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483" - } + "lineNumber": 208 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-server.IndexPatternsService.createAndSave", + "id": "def-server.IndexPatternsService.getFieldsForWildcard", "type": "Function", - "label": "createAndSave", - "signature": [ - "(spec: ", + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", + "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 + } + } + ], + "signature": [ + "(options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - ">" + ") => Promise" ], "description": [ - "\nCreate a new index pattern and save it right away" + "\nGet field list by providing { pattern }" ], + "label": "getFieldsForWildcard", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.getFieldsForIndexPattern", + "type": "Function", "children": [ { - "type": "Object", - "label": "spec", + "type": "CompoundType", + "label": "indexPattern", "isRequired": true, "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", { "pluginId": "data", "scope": "common", @@ -18774,77 +17836,73 @@ "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" + "lineNumber": 236 } }, { - "type": "boolean", - "label": "skipFetchFields", - "isRequired": true, + "type": "Object", + "label": "options", + "isRequired": false, "signature": [ - "boolean" - ], - "description": [ - "Whether to skip field refresh step." + { + "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": 508, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + "lineNumber": 237 } } ], - "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" + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" }, - ", override?: boolean) => Promise<", + ", options?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - ">" + " | undefined) => Promise" ], "description": [ - "\nSave a new index pattern" + "\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 + }, + "tags": [], + "returnComment": [ + "FieldSpec[]" + ] + }, + { + "id": "def-server.IndexPatternsService.refreshFields", + "type": "Function", "children": [ { "type": "Object", @@ -18862,39 +17920,10 @@ "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" + "lineNumber": 250 } } ], - "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: ", { @@ -18904,605 +17933,639 @@ "section": "def-common.IndexPattern", "text": "IndexPattern" }, - ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ") => Promise" ], "description": [ - "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" + "\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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.IndexPatternsService.fieldArrayToMap", + "type": "Function", "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "Array", + "label": "fields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]" ], "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" + "lineNumber": 327 } }, { - "type": "number", - "label": "saveAttempts", - "isRequired": true, + "type": "Object", + "label": "fieldAttrs", + "isRequired": false, "signature": [ - "number" + { + "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": 548, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548" + "lineNumber": 327 } + } + ], + "signature": [ + "(fields: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], fieldAttrs?: ", { - "type": "boolean", - "label": "ignoreErrors", + "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 + }, + "tags": [], + "returnComment": [ + "Record" + ] + }, + { + "id": "def-server.IndexPatternsService.savedObjectToSpec", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "savedObject", "isRequired": true, "signature": [ - "boolean" + { + "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": 549, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549" + "lineNumber": 343 } } ], - "tags": [], - "returnComment": [], + "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": 546, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" - } + "lineNumber": 343 + }, + "tags": [], + "returnComment": [ + "IndexPatternSpec" + ] }, { - "id": "def-server.IndexPatternsService.delete", + "id": "def-server.IndexPatternsService.get", "type": "Function", - "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "description": [ - "\nDeletes an index pattern from .kibana index" - ], "children": [ { "type": "string", - "label": "indexPatternId", + "label": "id", "isRequired": true, "signature": [ "string" ], - "description": [ - ": Id of kibana Index Pattern to delete" - ], + "description": [], "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" + "lineNumber": 464 } } - ], - "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", - "tags": [], - "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": [ - { - "tags": [], - "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?: {} | ", + "(id: string) => Promise<", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - " | undefined; schema?: string | undefined; } | undefined) => TAggConfig" - ] - }, - { - "tags": [], - "id": "def-server.AggParamType.allowedAggs", - "type": "Array", - "label": "allowedAggs", - "description": [], + ">" + ], + "description": [ + "\nGet an index pattern by id. Cache optimized" + ], + "label": "get", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464 }, - "signature": [ - "string[]" - ] + "tags": [], + "returnComment": [] }, { - "id": "def-server.AggParamType.Unnamed", + "id": "def-server.IndexPatternsService.create", "type": "Function", - "label": "Constructor", + "label": "create", "signature": [ - "any" + "(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" ], - "description": [], "children": [ { "type": "Object", - "label": "config", + "label": "spec", "isRequired": true, "signature": [ - "Record" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 + } + }, + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 } } ], "tags": [], - "returnComment": [], + "returnComment": [ + "IndexPattern" + ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 } - } - ], - "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", - "tags": [], - "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": [ { - "tags": [], - "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" - }, + "id": "def-server.IndexPatternsService.createAndSave", + "type": "Function", + "label": "createAndSave", "signature": [ + "(spec: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.OptionedValueProp", - "text": "OptionedValueProp" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" }, - "[]" - ] - }, - { - "id": "def-server.OptionedParamType.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + ", 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" ], - "description": [], "children": [ { "type": "Object", - "label": "config", + "label": "spec", "isRequired": true, "signature": [ - "Record" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 + } + }, + { + "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 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 } - } - ], - "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", - "tags": [], - "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", + "id": "def-server.IndexPatternsService.createSavedObject", "type": "Function", - "label": "Constructor", + "label": "createSavedObject", "signature": [ - "any" + "(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" ], - "description": [], "children": [ { "type": "Object", - "label": "initializerContext", + "label": "indexPattern", "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; }>; }>; }>>" + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 } }, { - "id": "def-server.DataServerPlugin.setup", + "id": "def-server.IndexPatternsService.updateSavedObject", "type": "Function", - "label": "setup", + "label": "updateSavedObject", "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 }: ", + "(indexPattern: ", { "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginSetupDependencies", - "text": "DataPluginSetupDependencies" + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ") => { __enhance: (enhancements: ", - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataEnhancements", - "text": "DataEnhancements" - } + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" + ], + "description": [ + "\nSave existing index pattern. Will attempt to merge differences if there are conflicts" ], - "description": [], "children": [ { "type": "Object", - "label": "core", + "label": "indexPattern", "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" - }, - ">" + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 547 } }, { - "type": "Object", - "label": "{ bfetch, expressions, usageCollection }", + "type": "number", + "label": "saveAttempts", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataPluginApi", - "section": "def-server.DataPluginSetupDependencies", - "text": "DataPluginSetupDependencies" - } + "number" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548 + } + }, + { + "type": "boolean", + "label": "ignoreErrors", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546 } }, { - "id": "def-server.DataServerPlugin.start", + "id": "def-server.IndexPatternsService.delete", "type": "Function", - "label": "start", + "label": "delete", "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ") => { fieldFormats: { fieldFormatServiceFactory: (uiSettings: ", + "(indexPatternId: string) => Promise<{}>" + ], + "description": [ + "\nDeletes an index pattern from .kibana index" + ], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - }, - ") => Promise<", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632 + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "initialIsOpen": false + }, + { + "id": "def-server.OptionedParamType", + "type": "Class", + "tags": [], + "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": [ + { + "tags": [], + "id": "def-server.OptionedParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 20 + }, + "signature": [ { "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" + "docId": "kibDataSearchPluginApi", + "section": "def-common.OptionedValueProp", + "text": "OptionedValueProp" }, - ", \"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" - } + "[]" + ] + }, + { + "id": "def-server.OptionedParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], "description": [], "children": [ { "type": "Object", - "label": "core", + "label": "config", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } + "Record" ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 22 } } ], "source": { - "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 52, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L52" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 19 }, "initialIsOpen": false } @@ -19522,8 +18585,7 @@ "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" + "lineNumber": 39 } } ], @@ -19543,8 +18605,7 @@ "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" + "lineNumber": 39 }, "tags": [ "return" @@ -19602,8 +18663,7 @@ "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" + "lineNumber": 38 } }, { @@ -19622,8 +18682,7 @@ "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" + "lineNumber": 39 } }, { @@ -19641,8 +18700,7 @@ "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" + "lineNumber": 40 }, "signature": [ "Date | undefined" @@ -19656,8 +18714,7 @@ "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" + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -19666,8 +18723,7 @@ ], "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" + "lineNumber": 40 } } ], @@ -19675,8 +18731,7 @@ "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" + "lineNumber": 37 }, "initialIsOpen": false }, @@ -19699,8 +18754,7 @@ "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" + "lineNumber": 29 } } ], @@ -19708,745 +18762,408 @@ "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" + "lineNumber": 29 }, "initialIsOpen": false } ], "interfaces": [ { - "id": "def-server.EsQueryConfig", - "type": "Interface", - "label": "EsQueryConfig", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.FieldFormatConfig.id", - "type": "string", - "label": "id", - "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" - } - }, - { - "tags": [], - "id": "def-server.FieldFormatConfig.params", - "type": "Object", - "label": "params", - "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": [ - "Record" - ] - }, - { - "tags": [], - "id": "def-server.FieldFormatConfig.es", - "type": "CompoundType", - "label": "es", - "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 65, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L65" - }, - "signature": [ - "boolean | undefined" - ] - } - ], - "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" - }, - "initialIsOpen": false - }, - { - "id": "def-server.IFieldType", - "type": "Interface", - "label": "IFieldType", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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.AggFunctionsMapping", + "type": "Interface", + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." + ], + "tags": [], + "children": [ { "tags": [], - "id": "def-server.IFieldType.lang", - "type": "string", - "label": "lang", + "id": "def-server.AggFunctionsMapping.aggFilter", + "type": "Object", + "label": "aggFilter", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 204 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.count", - "type": "number", - "label": "count", + "id": "def-server.AggFunctionsMapping.aggFilters", + "type": "Object", + "label": "aggFilters", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 205 }, "signature": [ - "number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.esTypes", - "type": "Array", - "label": "esTypes", + "id": "def-server.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", + "label": "aggSignificantTerms", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 206 }, "signature": [ - "string[] | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.aggregatable", - "type": "CompoundType", - "label": "aggregatable", + "id": "def-server.AggFunctionsMapping.aggIpRange", + "type": "Object", + "label": "aggIpRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 207 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.filterable", - "type": "CompoundType", - "label": "filterable", + "id": "def-server.AggFunctionsMapping.aggDateRange", + "type": "Object", + "label": "aggDateRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.searchable", - "type": "CompoundType", - "label": "searchable", + "id": "def-server.AggFunctionsMapping.aggRange", + "type": "Object", + "label": "aggRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 209 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.sortable", - "type": "CompoundType", - "label": "sortable", + "id": "def-server.AggFunctionsMapping.aggGeoTile", + "type": "Object", + "label": "aggGeoTile", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 210 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.visualizable", - "type": "CompoundType", - "label": "visualizable", + "id": "def-server.AggFunctionsMapping.aggGeoHash", + "type": "Object", + "label": "aggGeoHash", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 211 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.readFromDocValues", - "type": "CompoundType", - "label": "readFromDocValues", + "id": "def-server.AggFunctionsMapping.aggHistogram", + "type": "Object", + "label": "aggHistogram", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 212 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.scripted", - "type": "CompoundType", - "label": "scripted", + "id": "def-server.AggFunctionsMapping.aggDateHistogram", + "type": "Object", + "label": "aggDateHistogram", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.subType", + "id": "def-server.AggFunctionsMapping.aggTerms", "type": "Object", - "label": "subType", + "label": "aggTerms", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 214 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" - }, - " | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.displayName", - "type": "string", - "label": "displayName", + "id": "def-server.AggFunctionsMapping.aggAvg", + "type": "Object", + "label": "aggAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 215 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.customLabel", - "type": "string", - "label": "customLabel", + "id": "def-server.AggFunctionsMapping.aggBucketAvg", + "type": "Object", + "label": "aggBucketAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 216 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldType.format", - "type": "Any", - "label": "format", + "id": "def-server.AggFunctionsMapping.aggBucketMax", + "type": "Object", + "label": "aggBucketMax", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 217 }, "signature": [ - "any" + "FunctionDefinition" ] }, { "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.IFieldSubType.multi", + "id": "def-server.AggFunctionsMapping.aggBucketMin", "type": "Object", - "label": "multi", + "label": "aggBucketMin", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 218 }, "signature": [ - "{ parent: string; } | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IFieldSubType.nested", + "id": "def-server.AggFunctionsMapping.aggBucketSum", "type": "Object", - "label": "nested", + "label": "aggBucketSum", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 219 }, "signature": [ - "{ path: string; } | undefined" + "FunctionDefinition" ] - } - ], - "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" - ], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.IndexPatternAttributes.type", - "type": "string", - "label": "type", + }, + { + "tags": [], + "id": "def-server.AggFunctionsMapping.aggCardinality", + "type": "Object", + "label": "aggCardinality", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 220 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.fields", - "type": "string", - "label": "fields", + "id": "def-server.AggFunctionsMapping.aggCount", + "type": "Object", + "label": "aggCount", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.title", - "type": "string", - "label": "title", + "id": "def-server.AggFunctionsMapping.aggCumulativeSum", + "type": "Object", + "label": "aggCumulativeSum", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 222 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.typeMeta", - "type": "string", - "label": "typeMeta", + "id": "def-server.AggFunctionsMapping.aggDerivative", + "type": "Object", + "label": "aggDerivative", "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" - } + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 223 + }, + "signature": [ + "FunctionDefinition" + ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.timeFieldName", - "type": "string", - "label": "timeFieldName", + "id": "def-server.AggFunctionsMapping.aggGeoBounds", + "type": "Object", + "label": "aggGeoBounds", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 224 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.intervalName", - "type": "string", - "label": "intervalName", + "id": "def-server.AggFunctionsMapping.aggGeoCentroid", + "type": "Object", + "label": "aggGeoCentroid", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 225 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.sourceFilters", - "type": "string", - "label": "sourceFilters", + "id": "def-server.AggFunctionsMapping.aggMax", + "type": "Object", + "label": "aggMax", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 226 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.fieldFormatMap", - "type": "string", - "label": "fieldFormatMap", + "id": "def-server.AggFunctionsMapping.aggMedian", + "type": "Object", + "label": "aggMedian", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 227 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.fieldAttrs", - "type": "string", - "label": "fieldAttrs", + "id": "def-server.AggFunctionsMapping.aggMin", + "type": "Object", + "label": "aggMin", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 228 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.runtimeFieldMap", - "type": "string", - "label": "runtimeFieldMap", + "id": "def-server.AggFunctionsMapping.aggMovingAvg", + "type": "Object", + "label": "aggMovingAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 229 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-server.IndexPatternAttributes.allowNoIndex", - "type": "CompoundType", - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" - ], + "id": "def-server.AggFunctionsMapping.aggPercentileRanks", + "type": "Object", + "label": "aggPercentileRanks", + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 230 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] - } - ], - "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." - ], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggFilter", + "id": "def-server.AggFunctionsMapping.aggPercentiles", "type": "Object", - "label": "aggFilter", + "label": "aggPercentiles", "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" + "lineNumber": 231 }, "signature": [ "FunctionDefinition" @@ -20454,14 +19171,13 @@ }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggFilters", + "id": "def-server.AggFunctionsMapping.aggSerialDiff", "type": "Object", - "label": "aggFilters", + "label": "aggSerialDiff", "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" + "lineNumber": 232 }, "signature": [ "FunctionDefinition" @@ -20469,14 +19185,13 @@ }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggSignificantTerms", + "id": "def-server.AggFunctionsMapping.aggStdDeviation", "type": "Object", - "label": "aggSignificantTerms", + "label": "aggStdDeviation", "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" + "lineNumber": 233 }, "signature": [ "FunctionDefinition" @@ -20484,14 +19199,13 @@ }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggIpRange", + "id": "def-server.AggFunctionsMapping.aggSum", "type": "Object", - "label": "aggIpRange", + "label": "aggSum", "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" + "lineNumber": 234 }, "signature": [ "FunctionDefinition" @@ -20499,591 +19213,781 @@ }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggDateRange", + "id": "def-server.AggFunctionsMapping.aggTopHit", "type": "Object", - "label": "aggDateRange", + "label": "aggTopHit", "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" + "lineNumber": 235 }, "signature": [ "FunctionDefinition" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 203 + }, + "initialIsOpen": false + }, + { + "id": "def-server.AggParamOption", + "type": "Interface", + "label": "AggParamOption", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.AggParamOption.val", + "type": "string", + "label": "val", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 31 + } + }, + { + "tags": [], + "id": "def-server.AggParamOption.display", + "type": "string", + "label": "display", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 32 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-server.EsQueryConfig", + "type": "Interface", + "label": "EsQueryConfig", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + } }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggRange", + "id": "def-server.EsQueryConfig.queryStringOptions", "type": "Object", - "label": "aggRange", + "label": "queryStringOptions", "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" + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 19 }, "signature": [ - "FunctionDefinition" + "Record" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggGeoTile", - "type": "Object", - "label": "aggGeoTile", + "id": "def-server.EsQueryConfig.ignoreFilterIfFieldNotInIndex", + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", "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" - ] + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 20 + } }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggGeoHash", - "type": "Object", - "label": "aggGeoHash", + "id": "def-server.EsQueryConfig.dateFormatTZ", + "type": "string", + "label": "dateFormatTZ", "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" + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 21 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/es_query/es_query/build_es_query.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-server.FieldFormatConfig", + "type": "Interface", + "label": "FieldFormatConfig", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-server.AggFunctionsMapping.aggHistogram", - "type": "Object", - "label": "aggHistogram", + "id": "def-server.FieldFormatConfig.id", + "type": "string", + "label": "id", "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" - ] + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 63 + } }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggDateHistogram", + "id": "def-server.FieldFormatConfig.params", "type": "Object", - "label": "aggDateHistogram", + "label": "params", "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 64 }, "signature": [ - "FunctionDefinition" + "Record" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggTerms", - "type": "Object", - "label": "aggTerms", + "id": "def-server.FieldFormatConfig.es", + "type": "CompoundType", + "label": "es", "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 65 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 62 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-server.AggFunctionsMapping.aggAvg", - "type": "Object", - "label": "aggAvg", + "id": "def-server.IEsSearchRequest.indexType", + "type": "string", + "label": "indexType", "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 20 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 19 + }, + "initialIsOpen": false + }, + { + "id": "def-server.IFieldSubType", + "type": "Interface", + "label": "IFieldSubType", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-server.AggFunctionsMapping.aggBucketAvg", + "id": "def-server.IFieldSubType.multi", "type": "Object", - "label": "aggBucketAvg", + "label": "multi", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 154 }, "signature": [ - "FunctionDefinition" + "{ parent: string; } | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggBucketMax", + "id": "def-server.IFieldSubType.nested", "type": "Object", - "label": "aggBucketMax", + "label": "nested", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 155 }, "signature": [ - "FunctionDefinition" + "{ path: string; } | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 153 + }, + "initialIsOpen": false + }, + { + "id": "def-server.IFieldType", + "type": "Interface", + "label": "IFieldType", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-server.AggFunctionsMapping.aggBucketMin", - "type": "Object", - "label": "aggBucketMin", + "id": "def-server.IFieldType.name", + "type": "string", + "label": "name", "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 12 + } }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggBucketSum", - "type": "Object", - "label": "aggBucketSum", + "id": "def-server.IFieldType.type", + "type": "string", + "label": "type", "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 13 + } }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggCardinality", - "type": "Object", - "label": "aggCardinality", + "id": "def-server.IFieldType.script", + "type": "string", + "label": "script", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 14 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggCount", - "type": "Object", - "label": "aggCount", + "id": "def-server.IFieldType.lang", + "type": "string", + "label": "lang", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 15 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggCumulativeSum", - "type": "Object", - "label": "aggCumulativeSum", + "id": "def-server.IFieldType.count", + "type": "number", + "label": "count", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 16 }, "signature": [ - "FunctionDefinition" + "number | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggDerivative", - "type": "Object", - "label": "aggDerivative", + "id": "def-server.IFieldType.esTypes", + "type": "Array", + "label": "esTypes", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 19 }, "signature": [ - "FunctionDefinition" + "string[] | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggGeoBounds", - "type": "Object", - "label": "aggGeoBounds", + "id": "def-server.IFieldType.aggregatable", + "type": "CompoundType", + "label": "aggregatable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 20 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggGeoCentroid", - "type": "Object", - "label": "aggGeoCentroid", + "id": "def-server.IFieldType.filterable", + "type": "CompoundType", + "label": "filterable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 21 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggMax", - "type": "Object", - "label": "aggMax", + "id": "def-server.IFieldType.searchable", + "type": "CompoundType", + "label": "searchable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 22 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggMedian", - "type": "Object", - "label": "aggMedian", + "id": "def-server.IFieldType.sortable", + "type": "CompoundType", + "label": "sortable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 23 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggMin", - "type": "Object", - "label": "aggMin", + "id": "def-server.IFieldType.visualizable", + "type": "CompoundType", + "label": "visualizable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 24 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggMovingAvg", - "type": "Object", - "label": "aggMovingAvg", + "id": "def-server.IFieldType.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 25 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggPercentileRanks", - "type": "Object", - "label": "aggPercentileRanks", + "id": "def-server.IFieldType.scripted", + "type": "CompoundType", + "label": "scripted", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 26 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggPercentiles", + "id": "def-server.IFieldType.subType", "type": "Object", - "label": "aggPercentiles", + "label": "subType", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27 }, "signature": [ - "FunctionDefinition" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggSerialDiff", - "type": "Object", - "label": "aggSerialDiff", + "id": "def-server.IFieldType.displayName", + "type": "string", + "label": "displayName", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 28 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggStdDeviation", - "type": "Object", - "label": "aggStdDeviation", + "id": "def-server.IFieldType.customLabel", + "type": "string", + "label": "customLabel", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 29 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggSum", - "type": "Object", - "label": "aggSum", + "id": "def-server.IFieldType.format", + "type": "Any", + "label": "format", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 30 }, "signature": [ - "FunctionDefinition" + "any" ] }, { "tags": [], - "id": "def-server.AggFunctionsMapping.aggTopHit", - "type": "Object", - "label": "aggTopHit", + "id": "def-server.IFieldType.toSpec", + "type": "Function", + "label": "toSpec", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31 }, "signature": [ - "FunctionDefinition" + "((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/search/aggs/types.ts", - "lineNumber": 203, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-server.AggParamOption", + "id": "def-server.IndexPatternAttributes", "type": "Interface", - "label": "AggParamOption", - "description": [], + "label": "IndexPatternAttributes", + "description": [ + "\nInterface for an index pattern saved object" + ], "tags": [], "children": [ { "tags": [], - "id": "def-server.AggParamOption.val", + "id": "def-server.IndexPatternAttributes.type", "type": "string", - "label": "val", + "label": "type", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 54 } }, { "tags": [], - "id": "def-server.AggParamOption.display", + "id": "def-server.IndexPatternAttributes.fields", "type": "string", - "label": "display", + "label": "fields", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 55 } }, { - "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" - ], + "tags": [], + "id": "def-server.IndexPatternAttributes.title", + "type": "string", + "label": "title", "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" - } - } - ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 56 + } + }, + { "tags": [], - "returnComment": [], + "id": "def-server.IndexPatternAttributes.typeMeta", + "type": "string", + "label": "typeMeta", + "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 57 } - } - ], - "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": [], - "tags": [], - "children": [ + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.timeFieldName", + "type": "string", + "label": "timeFieldName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 58 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.IndexPatternAttributes.intervalName", + "type": "string", + "label": "intervalName", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 59 + }, + "signature": [ + "string | undefined" + ] + }, { "tags": [], - "id": "def-server.OptionedValueProp.value", + "id": "def-server.IndexPatternAttributes.sourceFilters", "type": "string", - "label": "value", + "label": "sourceFilters", "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 60 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-server.OptionedValueProp.text", + "id": "def-server.IndexPatternAttributes.fieldFormatMap", "type": "string", - "label": "text", + "label": "fieldFormatMap", "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 61 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-server.OptionedValueProp.disabled", - "type": "CompoundType", - "label": "disabled", + "id": "def-server.IndexPatternAttributes.fieldAttrs", + "type": "string", + "label": "fieldAttrs", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 62 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-server.OptionedValueProp.isCompatible", - "type": "Function", - "label": "isCompatible", + "id": "def-server.IndexPatternAttributes.runtimeFieldMap", + "type": "string", + "label": "runtimeFieldMap", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 63 }, "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" ] } ], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53 }, "initialIsOpen": false }, @@ -21104,8 +20008,7 @@ ], "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" + "lineNumber": 87 }, "signature": [ "AbortSignal | undefined" @@ -21121,8 +20024,7 @@ ], "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" + "lineNumber": 92 }, "signature": [ "string | undefined" @@ -21138,8 +20040,7 @@ ], "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" + "lineNumber": 98 }, "signature": [ "boolean | undefined" @@ -21155,8 +20056,7 @@ ], "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" + "lineNumber": 103 }, "signature": [ "string | undefined" @@ -21172,8 +20072,7 @@ ], "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" + "lineNumber": 108 }, "signature": [ "boolean | undefined" @@ -21189,8 +20088,7 @@ ], "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" + "lineNumber": 114 }, "signature": [ "boolean | undefined" @@ -21206,8 +20104,7 @@ ], "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" + "lineNumber": 120 }, "signature": [ { @@ -21223,64 +20120,121 @@ ], "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" + "lineNumber": 83 }, "initialIsOpen": false }, { - "id": "def-server.IEsSearchRequest", + "id": "def-server.KueryNode", "type": "Interface", - "label": "IEsSearchRequest", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" - }, - " extends ", + "label": "KueryNode", + "description": [], + "tags": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchRequest", - "text": "IKibanaSearchRequest" + "tags": [], + "id": "def-server.KueryNode.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 12 + }, + "signature": [ + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + ] }, - "<", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchRequestParams", - "text": "ISearchRequestParams" - }, - ">>" + "id": "def-server.KueryNode.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 13 + }, + "signature": [ + "any" + ] + } ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-server.OptionedValueProp", + "type": "Interface", + "label": "OptionedValueProp", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.IEsSearchRequest.indexType", + "id": "def-server.OptionedValueProp.value", "type": "string", - "label": "indexType", + "label": "value", "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 13 + } + }, + { + "tags": [], + "id": "def-server.OptionedValueProp.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 14 + } + }, + { + "tags": [], + "id": "def-server.OptionedValueProp.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 15 }, "signature": [ - "string | undefined" + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-server.OptionedValueProp.isCompatible", + "type": "Function", + "label": "isCompatible", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 + }, + "signature": [ + "(agg: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12 }, "initialIsOpen": false }, @@ -21299,8 +20253,7 @@ "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" + "lineNumber": 12 } }, { @@ -21311,20 +20264,30 @@ "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" + "lineNumber": 13 } } ], "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" + "lineNumber": 11 }, "initialIsOpen": false } ], "enums": [ + { + "id": "def-server.BUCKET_TYPES", + "type": "Enum", + "label": "BUCKET_TYPES", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, { "id": "def-server.ES_FIELD_TYPES", "type": "Enum", @@ -21335,8 +20298,7 @@ "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" + "lineNumber": 18 }, "initialIsOpen": false }, @@ -21350,123 +20312,36 @@ "description": [], "source": { "path": "src/plugins/data/common/kbn_field_types/types.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L64" - }, - "initialIsOpen": false - }, - { - "id": "def-server.BUCKET_TYPES", - "type": "Enum", - "label": "BUCKET_TYPES", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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" + "lineNumber": 64 }, - "signature": [ - "{ init: (getConfig: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "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" - } - ], "initialIsOpen": false }, { - "id": "def-server.FieldFormatsGetConfigFn", - "type": "Type", - "label": "FieldFormatsGetConfigFn", + "id": "def-server.METRIC_TYPES", + "type": "Enum", + "label": "METRIC_TYPES", "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 68, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L68" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts", + "lineNumber": 9 }, - "signature": [ - "(key: string, defaultOverride: T | undefined) => T" - ], "initialIsOpen": false - }, + } + ], + "misc": [ { - "id": "def-server.IndexPatternLoadExpressionFunctionDefinition", + "id": "def-server.AggConfigOptions", "type": "Type", - "label": "IndexPatternLoadExpressionFunctionDefinition", + "label": "AggConfigOptions", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 43 }, "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" - }, - ", ", - "SerializableState", - ">>" + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "initialIsOpen": false }, @@ -21478,8 +20353,7 @@ "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" + "lineNumber": 18 }, "signature": [ "\"buckets\" | \"metrics\" | \"none\"" @@ -21494,8 +20368,7 @@ "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" + "lineNumber": 28 }, "signature": [ "BaseParamType" @@ -21503,18 +20376,17 @@ "initialIsOpen": false }, { - "id": "def-server.AggConfigOptions", - "type": "Type", - "label": "AggConfigOptions", "tags": [], + "id": "def-server.ES_SEARCH_STRATEGY", + "type": "string", + "label": "ES_SEARCH_STRATEGY", "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 13 }, "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + "\"es\"" ], "initialIsOpen": false }, @@ -21526,8 +20398,7 @@ "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" + "lineNumber": 35 }, "signature": [ "ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ", @@ -21553,245 +20424,301 @@ "initialIsOpen": false }, { - "id": "def-server.IAggConfig", + "id": "def-server.ExecutionContextSearch", "type": "Type", - "label": "IAggConfig", - "tags": [ - "name", - "description" + "label": "ExecutionContextSearch", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 14 + }, + "signature": [ + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionFunctionKibana", + "type": "Type", + "label": "ExpressionFunctionKibana", + "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17 }, "signature": [ - "AggConfig" + "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.IAggType", + "id": "def-server.ExpressionFunctionKibanaContext", "type": "Type", - "label": "IAggType", + "label": "ExpressionFunctionKibanaContext", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 23 }, "signature": [ - "AggType>" + "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.IFieldParamType", + "id": "def-server.ExpressionValueSearchContext", "type": "Type", - "label": "IFieldParamType", + "label": "ExpressionValueSearchContext", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 20 }, "signature": [ - "FieldParamType" + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { - "id": "def-server.IMetricAggType", + "id": "def-server.FieldFormatsGetConfigFn", "type": "Type", - "label": "IMetricAggType", + "label": "FieldFormatsGetConfigFn", "tags": [], "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 68 }, "signature": [ - "MetricAggType" + "(key: string, defaultOverride: T | undefined) => T" ], "initialIsOpen": false }, { - "id": "def-server.ParsedInterval", + "id": "def-server.Filter", "type": "Type", - "label": "ParsedInterval", + "label": "Filter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 41 }, "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" ], "initialIsOpen": false }, { - "id": "def-server.ExecutionContextSearch", + "id": "def-server.IAggConfig", "type": "Type", - "label": "ExecutionContextSearch", + "label": "IAggConfig", + "tags": [ + "name", + "description" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 53 + }, + "signature": [ + "AggConfig" + ], + "initialIsOpen": false + }, + { + "id": "def-server.IAggType", + "type": "Type", + "label": "IAggType", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 58 }, "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + "AggType>" ], "initialIsOpen": false }, { - "id": "def-server.ExpressionFunctionKibana", + "id": "def-server.IEsSearchResponse", "type": "Type", - "label": "ExpressionFunctionKibana", + "label": "IEsSearchResponse", "tags": [], "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 23 }, "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>" + "IKibanaSearchResponse>" ], "initialIsOpen": false }, { - "id": "def-server.ExpressionFunctionKibanaContext", + "id": "def-server.IFieldFormatsRegistry", "type": "Type", - "label": "ExpressionFunctionKibanaContext", + "label": "IFieldFormatsRegistry", "tags": [], "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" + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11 }, "signature": [ - "ExpressionFunctionDefinition<\"kibana_context\", ", + "{ init: (getConfig: ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, - "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "FieldFormatInstanceType", + "[]) => void; register: (fieldFormats: ", + "FieldFormatInstanceType", + "[]) => void; deserialize: ", + "FormatFactory", + "; getDefaultConfig: (fieldType: ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } ], "initialIsOpen": false }, { - "id": "def-server.ExpressionValueSearchContext", + "id": "def-server.IFieldParamType", "type": "Type", - "label": "ExpressionValueSearchContext", + "label": "IFieldParamType", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 21 }, "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "FieldParamType" ], "initialIsOpen": false }, { - "id": "def-server.KibanaContext", + "id": "def-server.IMetricAggType", "type": "Type", - "label": "KibanaContext", + "label": "IMetricAggType", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 35 }, "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "MetricAggType" ], "initialIsOpen": false }, { - "id": "def-server.IEsSearchResponse", + "id": "def-server.IndexPatternLoadExpressionFunctionDefinition", "type": "Type", - "label": "IEsSearchResponse", + "label": "IndexPatternLoadExpressionFunctionDefinition", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 34 }, "signature": [ - "IKibanaSearchResponse>" + "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" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { + "id": "def-server.KibanaContext", + "type": "Type", + "label": "KibanaContext", "tags": [], - "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 27 }, "signature": [ - "\"es\"" + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { - "id": "def-server.Filter", + "id": "def-server.ParsedInterval", "type": "Type", - "label": "Filter", + "label": "ParsedInterval", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 18 }, "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" ], "initialIsOpen": false }, @@ -21803,8 +20730,7 @@ "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" + "lineNumber": 12 }, "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" @@ -21819,8 +20745,7 @@ "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" + "lineNumber": 17 }, "signature": [ "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" @@ -21829,6 +20754,68 @@ } ], "objects": [ + { + "id": "def-server.AggGroupLabels", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + } + ], + "description": [], + "label": "AggGroupLabels", + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.AggGroupNames", + "type": "Object", + "label": "AggGroupNames", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 12 + }, + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], + "initialIsOpen": false + }, { "id": "def-server.esFilters", "type": "Object", @@ -21842,8 +20829,7 @@ "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" + "lineNumber": 30 }, "signature": [ "(query: any, index: string, alias: string) => ", @@ -21864,8 +20850,7 @@ "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" + "lineNumber": 31 }, "signature": [ "typeof ", @@ -21886,8 +20871,7 @@ "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" + "lineNumber": 32 }, "signature": [ "(isPinned: boolean, index?: string | undefined) => ", @@ -21908,8 +20892,7 @@ "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" + "lineNumber": 33 }, "signature": [ "(field: ", @@ -21946,8 +20929,7 @@ "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" + "lineNumber": 34 }, "signature": [ "typeof ", @@ -21968,8 +20950,7 @@ "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" + "lineNumber": 35 }, "signature": [ "(field: ", @@ -22006,8 +20987,7 @@ "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" + "lineNumber": 36 }, "signature": [ "(field: ", @@ -22044,8 +21024,7 @@ "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" + "lineNumber": 37 }, "signature": [ "(field: ", @@ -22090,8 +21069,7 @@ "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" + "lineNumber": 38 }, "signature": [ "(filter: ", @@ -22110,57 +21088,7 @@ "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" + "lineNumber": 29 }, "initialIsOpen": false }, @@ -22177,8 +21105,7 @@ "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" + "lineNumber": 65 }, "signature": [ { @@ -22198,8 +21125,7 @@ "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" + "lineNumber": 66 }, "signature": [ "(expression: any, parseOptions?: Partial<", @@ -22228,8 +21154,7 @@ "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" + "lineNumber": 67 }, "signature": [ "(node: ", @@ -22263,8 +21188,7 @@ "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" + "lineNumber": 64 }, "initialIsOpen": false }, @@ -22281,8 +21205,7 @@ "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" + "lineNumber": 71 }, "signature": [ "(filters: ", @@ -22328,8 +21251,7 @@ "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" + "lineNumber": 72 }, "signature": [ "typeof ", @@ -22350,8 +21272,7 @@ "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" + "lineNumber": 73 }, "signature": [ "typeof ", @@ -22369,8 +21290,53 @@ "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" + "lineNumber": 70 + }, + "initialIsOpen": false + }, + { + "id": "def-server.exporters", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.exporters.datatableToCSV", + "type": "Function", + "label": "datatableToCSV", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 47 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.datatableToCSV", + "text": "datatableToCSV" + } + ] + }, + { + "tags": [], + "id": "def-server.exporters.CSV_MIME_TYPE", + "type": "string", + "label": "CSV_MIME_TYPE", + "description": [], + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 48 + } + } + ], + "description": [], + "label": "exporters", + "source": { + "path": "src/plugins/data/server/index.ts", + "lineNumber": 46 }, "initialIsOpen": false }, @@ -22387,8 +21353,7 @@ "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" + "lineNumber": 102 }, "signature": [ "typeof ", @@ -22409,8 +21374,7 @@ "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" + "lineNumber": 103 }, "signature": [ "typeof ", @@ -22431,8 +21395,7 @@ "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" + "lineNumber": 104 }, "signature": [ "typeof ", @@ -22453,8 +21416,7 @@ "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" + "lineNumber": 105 }, "signature": [ "typeof ", @@ -22475,8 +21437,7 @@ "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" + "lineNumber": 106 }, "signature": [ "typeof ", @@ -22497,8 +21458,7 @@ "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" + "lineNumber": 107 }, "signature": [ "typeof ", @@ -22519,8 +21479,7 @@ "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" + "lineNumber": 108 }, "signature": [ "typeof ", @@ -22541,8 +21500,7 @@ "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" + "lineNumber": 109 }, "signature": [ "typeof ", @@ -22563,8 +21521,7 @@ "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" + "lineNumber": 110 }, "signature": [ "typeof ", @@ -22585,8 +21542,7 @@ "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" + "lineNumber": 111 }, "signature": [ "typeof ", @@ -22607,8 +21563,7 @@ "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" + "lineNumber": 112 }, "signature": [ "typeof ", @@ -22629,8 +21584,7 @@ "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" + "lineNumber": 113 }, "signature": [ "typeof ", @@ -22651,8 +21605,7 @@ "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" + "lineNumber": 114 }, "signature": [ "typeof ", @@ -22673,8 +21626,7 @@ "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" + "lineNumber": 115 }, "signature": [ "typeof ", @@ -22695,8 +21647,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 116, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L116" + "lineNumber": 116 }, "signature": [ "typeof ", @@ -22717,8 +21668,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L117" + "lineNumber": 117 }, "signature": [ "typeof ", @@ -22736,151 +21686,64 @@ "label": "fieldFormats", "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L101" - }, - "initialIsOpen": false - }, - { - "id": "def-server.indexPatterns", - "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.indexPatterns.isFilterable", - "type": "Function", - "label": "isFilterable", - "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 129, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L129" - }, - "signature": [ - "typeof ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.isFilterable", - "text": "isFilterable" - } - ] - }, - { - "tags": [], - "id": "def-server.indexPatterns.isNestedField", - "type": "Function", - "label": "isNestedField", - "description": [], - "source": { - "path": "src/plugins/data/server/index.ts", - "lineNumber": 130, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L130" - }, - "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": 128, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L128" - }, - "initialIsOpen": false - }, - { - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, + "lineNumber": 101 + }, + "initialIsOpen": false + }, + { + "id": "def-server.indexPatterns", + "type": "Object", + "tags": [], + "children": [ { "tags": [], - "id": "def-server.AggGroupLabels.[AggGroupNames.Metrics]", - "type": "string", - "label": "[AggGroupNames.Metrics]", + "id": "def-server.indexPatterns.isFilterable", + "type": "Function", + "label": "isFilterable", "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" - } + "path": "src/plugins/data/server/index.ts", + "lineNumber": 129 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.isFilterable", + "text": "isFilterable" + } + ] }, { "tags": [], - "id": "def-server.AggGroupLabels.[AggGroupNames.None]", - "type": "string", - "label": "[AggGroupNames.None]", + "id": "def-server.indexPatterns.isNestedField", + "type": "Function", + "label": "isNestedField", "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" - } + "path": "src/plugins/data/server/index.ts", + "lineNumber": 130 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.isNestedField", + "text": "isNestedField" + } + ] } ], "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 - }, - { - "tags": [], - "id": "def-server.AggGroupNames", - "type": "Object", - "label": "AggGroupNames", - "description": [], + "label": "indexPatterns", "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" + "path": "src/plugins/data/server/index.ts", + "lineNumber": 128 }, - "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" - ], "initialIsOpen": false }, { @@ -22901,8 +21764,7 @@ "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" + "lineNumber": 245 }, "signature": [ "typeof ", @@ -22923,8 +21785,7 @@ "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" + "lineNumber": 246 }, "signature": [ "typeof ", @@ -22945,8 +21806,7 @@ "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" + "lineNumber": 247 }, "signature": [ "({ display: string; val: string; enabled(agg: ", @@ -22968,8 +21828,7 @@ "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" + "lineNumber": 248 }, "signature": [ "typeof ", @@ -22990,8 +21849,7 @@ "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" + "lineNumber": 249 }, "signature": [ "typeof ", @@ -23012,8 +21870,7 @@ "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" + "lineNumber": 250 }, "signature": [ "typeof ", @@ -23034,8 +21891,7 @@ "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" + "lineNumber": 251 }, "signature": [ "(agg: ", @@ -23057,8 +21913,7 @@ "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" + "lineNumber": 252 }, "signature": [ "(agg: ", @@ -23080,8 +21935,7 @@ "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" + "lineNumber": 253 }, "signature": [ "(...types: string[]) => (agg: ", @@ -23103,8 +21957,7 @@ "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" + "lineNumber": 254 }, "signature": [ "typeof ", @@ -23125,8 +21978,7 @@ "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" + "lineNumber": 255 }, "signature": [ "typeof ", @@ -23147,8 +21999,7 @@ "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" + "lineNumber": 256 } }, { @@ -23159,8 +22010,7 @@ "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" + "lineNumber": 257 }, "signature": [ "typeof ", @@ -23181,8 +22031,7 @@ "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" + "lineNumber": 258 }, "signature": [ "typeof ", @@ -23203,8 +22052,7 @@ "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" + "lineNumber": 259 }, "signature": [ "typeof ", @@ -23225,8 +22073,7 @@ "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" + "lineNumber": 260 } }, { @@ -23237,8 +22084,7 @@ "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" + "lineNumber": 261 }, "signature": [ "string[]" @@ -23252,8 +22098,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 262, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L262" + "lineNumber": 262 }, "signature": [ "typeof ", @@ -23274,8 +22119,7 @@ "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" + "lineNumber": 263 }, "signature": [ "typeof ", @@ -23293,8 +22137,7 @@ "label": "aggs", "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 244, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L244" + "lineNumber": 244 } }, { @@ -23305,8 +22148,7 @@ "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" + "lineNumber": 265 }, "signature": [ "typeof ", @@ -23327,8 +22169,7 @@ "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" + "lineNumber": 266 }, "signature": [ "typeof ", @@ -23349,8 +22190,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 267, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L267" + "lineNumber": 267 }, "signature": [ "typeof ", @@ -23371,8 +22211,7 @@ "description": [], "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 268, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L268" + "lineNumber": 268 }, "signature": [ "typeof ", @@ -23390,9 +22229,23 @@ "label": "search", "source": { "path": "src/plugins/data/server/index.ts", - "lineNumber": 243, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L243" + "lineNumber": 243 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-server.UI_SETTINGS", + "type": "Object", + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 11 }, + "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 } ], @@ -23411,8 +22264,7 @@ "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" + "lineNumber": 29 }, "signature": [ { @@ -23432,8 +22284,7 @@ "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" + "lineNumber": 30 }, "signature": [ "{ register: (customFieldFormat: ", @@ -23450,8 +22301,7 @@ ], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L28" + "lineNumber": 28 }, "lifecycle": "setup", "initialIsOpen": true @@ -23471,8 +22321,7 @@ "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" + "lineNumber": 38 }, "signature": [ { @@ -23509,8 +22358,7 @@ "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" + "lineNumber": 39 }, "signature": [ "{ fieldFormatServiceFactory: (uiSettings: ", @@ -23540,8 +22388,7 @@ "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" + "lineNumber": 40 }, "signature": [ { @@ -23556,8 +22403,7 @@ ], "source": { "path": "src/plugins/data/server/plugin.ts", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L37" + "lineNumber": 37 }, "lifecycle": "start", "initialIsOpen": true @@ -23565,6 +22411,113 @@ }, "common": { "classes": [ + { + "id": "def-common.KbnFieldType", + "type": "Class", + "tags": [], + "label": "KbnFieldType", + "description": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 17 + } + } + ], + "source": { + "path": "src/plugins/data/common/kbn_field_types/kbn_field_type.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, { "id": "def-common.KQLSyntaxError", "type": "Class", @@ -23590,8 +22543,7 @@ "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" + "lineNumber": 42 } }, { @@ -23613,8 +22565,7 @@ "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" + "lineNumber": 44 } }, { @@ -23627,8 +22578,7 @@ "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" + "lineNumber": 44 } } ], @@ -23636,134 +22586,186 @@ "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" + "lineNumber": 44 } } ], "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" + "lineNumber": 41 }, "initialIsOpen": false - }, + } + ], + "functions": [ { - "id": "def-common.KbnFieldType", - "type": "Class", - "tags": [], - "label": "KbnFieldType", + "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": [ { - "tags": [], - "id": "def-common.KbnFieldType.name", "type": "string", - "label": "name", + "label": "indexPatternString", + "isRequired": true, + "signature": [ + "string" + ], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 40 + } + }, + { + "type": "Any", + "label": "queryDsl", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 41 } }, { - "tags": [], - "id": "def-common.KbnFieldType.sortable", "type": "boolean", - "label": "sortable", + "label": "disabled", + "isRequired": true, + "signature": [ + "boolean" + ], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 42 } }, { - "tags": [], - "id": "def-common.KbnFieldType.filterable", "type": "boolean", - "label": "filterable", + "label": "negate", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 43 + } + }, + { + "type": "CompoundType", + "label": "alias", + "isRequired": false, + "signature": [ + "string | null" + ], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 44 } }, { - "tags": [], - "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" - }, + "type": "Enum", + "label": "store", + "isRequired": true, "signature": [ - "readonly ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - "[]" - ] - }, + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 45 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 39 + }, + "initialIsOpen": false + }, + { + "id": "def-common.buildEmptyFilter", + "type": "Function", + "children": [ { - "id": "def-common.KbnFieldType.Unnamed", - "type": "Function", - "label": "Constructor", + "type": "boolean", + "label": "isPinned", + "isRequired": true, "signature": [ - "any" + "boolean" ], "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" - } - } + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52 + } + }, + { + "type": "string", + "label": "index", + "isRequired": false, + "signature": [ + "string | undefined" ], - "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52 } } ], + "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/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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 52 }, + "tags": [], + "returnComment": [], "initialIsOpen": false - } - ], - "functions": [ + }, { "id": "def-common.buildEsQuery", "type": "Function", @@ -23829,8 +22831,7 @@ "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" + "lineNumber": 33 } }, { @@ -23860,8 +22861,7 @@ ], "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" + "lineNumber": 34 } }, { @@ -23891,8 +22891,7 @@ ], "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" + "lineNumber": 35 } }, { @@ -23913,8 +22912,7 @@ ], "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" + "lineNumber": 36 } } ], @@ -23922,40 +22920,37 @@ "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" + "lineNumber": 32 }, "initialIsOpen": false }, { - "id": "def-common.buildQueryFromFilters", + "id": "def-common.buildExistsFilter", "type": "Function", "children": [ { - "type": "Array", - "label": "filters", + "type": "Object", + "label": "field", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 } }, { "type": "Object", "label": "indexPattern", - "isRequired": false, + "isRequired": true, "signature": [ { "pluginId": "data", @@ -23963,41 +22958,25 @@ "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 } } ], "signature": [ - "(filters: ", + "(field: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - "[] | undefined, indexPattern: ", + ", indexPattern: ", { "pluginId": "data", "scope": "common", @@ -24005,322 +22984,268 @@ "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" - }, - "[]; }" + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" + } ], "description": [], - "label": "buildQueryFromFilters", + "label": "buildExistsFilter", "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 29 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.luceneStringToDsl", + "id": "def-common.buildFilter", "type": "Function", - "label": "luceneStringToDsl", + "label": "buildFilter", "signature": [ - "(query: any) => ", + "(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.DslQuery", - "text": "DslQuery" + "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": "Any", - "label": "query", + "type": "Object", + "label": "indexPattern", "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" + { + "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 + } }, - ", 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": "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 + } + }, { - "type": "CompoundType", - "label": "query", + "type": "Enum", + "label": "type", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.DslQuery", - "text": "DslQuery" + "section": "def-common.FILTERS", + "text": "FILTERS" } ], - "description": [ - "object" + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 24 + } + }, + { + "type": "boolean", + "label": "negate", + "isRequired": true, + "signature": [ + "boolean" ], + "description": [], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 25 } }, { - "type": "CompoundType", - "label": "queryStringOptions", + "type": "boolean", + "label": "disabled", "isRequired": true, "signature": [ - "string | Record" + "boolean" ], - "description": [ - "query:queryString:options from UI settings" + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 26 + } + }, + { + "type": "Any", + "label": "params", + "isRequired": true, + "signature": [ + "any" ], + "description": [], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 27 } }, { - "type": "string", - "label": "dateFormatTZ", + "type": "CompoundType", + "label": "alias", "isRequired": false, "signature": [ - "string | undefined" - ], - "description": [ - "dateFormat:tz from UI settings" + "string | null" ], + "description": [], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 28 } - } - ], - "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", + "type": "Enum", + "label": "store", "isRequired": true, "signature": [ - "KibanaConfig" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.FilterStateStore", + "text": "FilterStateStore" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 29 } } ], "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" + "path": "src/plugins/data/common/es_query/filters/build_filters.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-common.cleanFilter", + "id": "def-common.buildPhraseFilter", "type": "Function", "children": [ { "type": "Object", - "label": "filter", + "label": "field", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" } ], "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 61 } - } - ], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isFilterDisabled", - "type": "Function", - "children": [ + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 62 + } + }, { "type": "Object", - "label": "filter", + "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" } ], "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 63 } } ], "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" - }, - "tags": [], - "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: ", + "(field: ", { "pluginId": "data", "scope": "common", @@ -24328,349 +23253,459 @@ "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: ", + ", value: any, indexPattern: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterStateStore", - "text": "FilterStateStore" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" }, ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" } ], "description": [], + "label": "buildPhraseFilter", + "source": { + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 60 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildPhrasesFilter", + "type": "Function", "children": [ { "type": "Object", - "label": "indexPattern", + "label": "field", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.IFieldType", + "text": "IFieldType" } ], "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 35 + } + }, + { + "type": "Array", + "label": "params", + "isRequired": true, + "signature": [ + "any[]" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 36 } }, { "type": "Object", - "label": "field", + "label": "indexPattern", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" } ], "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 37 } + } + ], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, + ", params: any[], indexPattern: ", { - "type": "Enum", - "label": "type", + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildQueryFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "query", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FILTERS", - "text": "FILTERS" - } + "any" ], "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" + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 } }, { - "type": "boolean", - "label": "negate", + "type": "string", + "label": "index", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 } }, { - "type": "boolean", - "label": "disabled", + "type": "string", + "label": "alias", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 26 } - }, + } + ], + "signature": [ + "(query: any, index: string, alias: string) => ", { - "type": "Any", - "label": "params", + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildQueryFromFilters", + "type": "Function", + "children": [ + { + "type": "Array", + "label": "filters", "isRequired": true, "signature": [ - "any" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" ], "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" + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 47 } }, { - "type": "CompoundType", - "label": "alias", + "type": "Object", + "label": "indexPattern", "isRequired": false, "signature": [ - "string | null" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 48 } }, { - "type": "Enum", - "label": "store", + "type": "boolean", + "label": "ignoreFilterIfFieldNotInIndex", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.FilterStateStore", - "text": "FilterStateStore" - } + "boolean" ], "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" + "path": "src/plugins/data/common/es_query/es_query/from_filters.ts", + "lineNumber": 49 } } ], - "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: ", + "(filters: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.FilterStateStore", - "text": "FilterStateStore" + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.buildRangeFilter", + "type": "Function", "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", + "type": "Object", + "label": "field", "isRequired": true, "signature": [ - "any" + { + "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": 41, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L41" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 94 } }, { - "type": "boolean", - "label": "disabled", + "type": "Object", + "label": "params", "isRequired": true, "signature": [ - "boolean" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 95 } }, { - "type": "boolean", - "label": "negate", + "type": "Object", + "label": "indexPattern", "isRequired": true, "signature": [ - "boolean" + { + "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": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L43" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 96 } }, { - "type": "CompoundType", - "label": "alias", + "type": "string", + "label": "formattedValue", "isRequired": false, "signature": [ - "string | null" + "string | undefined" ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 97 } + } + ], + "signature": [ + "(field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, + ", params: ", { - "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" - } + "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" } ], - "tags": [], - "returnComment": [], + "description": [], + "label": "buildRangeFilter", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 93 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isExistsFilter", + "id": "def-common.castEsToKbnFieldTypeName", "type": "Function", "children": [ { - "type": "Any", - "label": "filter", + "type": "string", + "label": "esType", "isRequired": true, "signature": [ - "any" + "string" ], "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 } } ], "signature": [ - "(filter: any) => filter is ", + "(esType: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" } ], - "description": [], - "label": "isExistsFilter", + "description": [ + "\n Get the KbnFieldType name for an esType string\n" + ], + "label": "castEsToKbnFieldTypeName", "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 39 }, - "tags": [], + "tags": [ + "return" + ], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getExistsFilterField", + "id": "def-common.cleanFilter", "type": "Function", "children": [ { - "type": "CompoundType", + "type": "Object", "label": "filter", "isRequired": true, "signature": [ @@ -24678,15 +23713,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + "section": "def-common.Filter", + "text": "Filter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 36 } } ], @@ -24696,150 +23730,180 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + "section": "def-common.Filter", + "text": "Filter" }, - ") => any" + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], - "description": [], - "label": "getExistsFilterField", + "description": [ + "\nClean out any invalid attributes from the filters" + ], + "label": "cleanFilter", "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" + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 36 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.buildExistsFilter", + "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": "field", + "label": "{ columns, rows }", "isRequired": true, "signature": [ { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" } ], "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" + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 42 } }, { "type": "Object", - "label": "indexPattern", + "label": "{ csvSeparator, quoteValues, formatFactory, raw }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - } + "CSVOptions" ], "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" + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 43 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 41 + }, + "initialIsOpen": false + }, + { + "id": "def-common.decorateQuery", + "type": "Function", + "label": "decorateQuery", "signature": [ - "(field: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", indexPattern: ", + "(query: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "docId": "kibDataPluginApi", + "section": "def-common.DslQuery", + "text": "DslQuery" }, - ") => ", + ", queryStringOptions: string | Record, dateFormatTZ: string | undefined) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ExistsFilter", - "text": "ExistsFilter" + "section": "def-common.DslQuery", + "text": "DslQuery" } ], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isGeoBoundingBoxFilter", - "type": "Function", + "description": [ + "\nDecorate queries with default parameters" + ], "children": [ { - "type": "Any", - "label": "filter", + "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 + } + }, + { + "type": "CompoundType", + "label": "queryStringOptions", "isRequired": true, "signature": [ - "any" + "string | Record" + ], + "description": [ + "query:queryString:options from UI settings" ], - "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" + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 23 } - } - ], - "signature": [ - "(filter: any) => filter is ", + }, { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GeoBoundingBoxFilter", - "text": "GeoBoundingBoxFilter" + "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 + } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/decorate_query.ts", + "lineNumber": 21 + }, "initialIsOpen": false }, { - "id": "def-common.getGeoBoundingBoxFilterField", + "id": "def-common.disableFilter", "type": "Function", "children": [ { - "type": "CompoundType", + "type": "Object", "label": "filter", "isRequired": true, "signature": [ @@ -24847,15 +23911,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.GeoBoundingBoxFilter", - "text": "GeoBoundingBoxFilter" + "section": "def-common.Filter", + "text": "Filter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 94 } } ], @@ -24865,68 +23928,65 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.GeoBoundingBoxFilter", - "text": "GeoBoundingBoxFilter" + "section": "def-common.Filter", + "text": "Filter" }, - ") => any" + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "description": [], - "label": "getGeoBoundingBoxFilterField", + "label": "disableFilter", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 94 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isGeoPolygonFilter", + "id": "def-common.doesKueryExpressionHaveLuceneSyntaxError", "type": "Function", "children": [ { "type": "Any", - "label": "filter", + "label": "expression", "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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 60 } } ], "signature": [ - "(filter: any) => filter is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GeoPolygonFilter", - "text": "GeoPolygonFilter" - } + "(expression: any) => boolean" ], "description": [], - "label": "isGeoPolygonFilter", + "label": "doesKueryExpressionHaveLuceneSyntaxError", "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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 59 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getGeoPolygonFilterField", + "id": "def-common.enableFilter", "type": "Function", "children": [ { - "type": "CompoundType", + "type": "Object", "label": "filter", "isRequired": true, "signature": [ @@ -24934,15 +23994,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.GeoPolygonFilter", - "text": "GeoPolygonFilter" + "section": "def-common.Filter", + "text": "Filter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 91 } } ], @@ -24952,196 +24011,166 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.GeoPolygonFilter", - "text": "GeoPolygonFilter" + "section": "def-common.Filter", + "text": "Filter" }, - ") => any" + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "description": [], - "label": "getGeoPolygonFilterField", + "label": "enableFilter", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 91 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getDisplayValueFromFilter", + "id": "def-common.fromKueryExpression", "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", + "type": "Any", + "label": "expression", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } + "any" ], "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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 45 } }, - { - "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", + "label": "parseOptions", "isRequired": true, "signature": [ + "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } + "section": "def-common.KueryParseOptions", + "text": "KueryParseOptions" + }, + ">" ], "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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 46 } } ], "signature": [ - "(filter: ", + "(expression: any, parseOptions?: Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.KueryParseOptions", + "text": "KueryParseOptions" }, - ") => any" + ">) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } ], "description": [], - "label": "getFilterField", + "label": "fromKueryExpression", "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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 44 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getFilterParams", + "id": "def-common.fromLiteralExpression", "type": "Function", - "label": "getFilterParams", - "signature": [ - "(filter: ", + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "type": "Any", + "label": "expression", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 31 + } }, - ") => any" - ], - "description": [], - "children": [ { "type": "Object", - "label": "filter", + "label": "parseOptions", "isRequired": true, "signature": [ + "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } + "section": "def-common.KueryParseOptions", + "text": "KueryParseOptions" + }, + ">" ], "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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 32 } } ], - "tags": [], - "returnComment": [], + "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/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" + "path": "src/plugins/data/common/es_query/kuery/ast/ast.ts", + "lineNumber": 30 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getIndexPatternFromFilter", + "id": "def-common.getDisplayValueFromFilter", "type": "Function", - "label": "getIndexPatternFromFilter", + "label": "getDisplayValueFromFilter", "signature": [ "(filter: ", { @@ -25159,15 +24188,7 @@ "section": "def-common.IIndexPattern", "text": "IIndexPattern" }, - "[]) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - " | undefined" + "[]) => string" ], "description": [], "children": [ @@ -25186,9 +24207,8 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31 } }, { @@ -25207,168 +24227,63 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31 } } ], "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" + "path": "src/plugins/data/common/es_query/filters/get_display_value.ts", + "lineNumber": 31 }, "initialIsOpen": false }, { - "id": "def-common.isMatchAllFilter", + "id": "def-common.getEsQueryConfig", "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" - } - } - ], + "label": "getEsQueryConfig", "signature": [ - "(filter: any) => filter is ", + "(config: KibanaConfig) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.MatchAllFilter", - "text": "MatchAllFilter" + "section": "def-common.EsQueryConfig", + "text": "EsQueryConfig" } ], "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.buildEmptyFilter", - "type": "Function", "children": [ { - "type": "boolean", - "label": "isPinned", + "type": "Object", + "label": "config", "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" + "KibanaConfig" ], "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" + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16 } } ], - "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" - }, "tags": [], "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" + "path": "src/plugins/data/common/es_query/es_query/get_es_query_config.ts", + "lineNumber": 16 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.toggleFilterDisabled", + "id": "def-common.getExistsFilterField", "type": "Function", "children": [ { - "type": "Object", + "type": "CompoundType", "label": "filter", "isRequired": true, "signature": [ @@ -25376,15 +24291,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 25 } } ], @@ -25394,87 +24308,44 @@ "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" + "section": "def-common.ExistsFilter", + "text": "ExistsFilter" }, - " | undefined; query?: any; }" + ") => any" ], "description": [], - "label": "toggleFilterDisabled", + "label": "getExistsFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.toggleFilterNegated", + "id": "def-common.getFilterableKbnTypeNames", "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" - } - } - ], + "children": [], "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; }" + "() => string[]" ], - "description": [], - "label": "toggleFilterNegated", + "description": [ + "\n Get filterable KbnFieldTypes\n" + ], + "label": "getFilterableKbnTypeNames", "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 50 }, - "tags": [], + "tags": [ + "return" + ], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.toggleFilterPinned", + "id": "def-common.getFilterField", "type": "Function", "children": [ { @@ -25492,9 +24363,8 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/get_filter_field.ts", + "lineNumber": 18 } } ], @@ -25507,38 +24377,34 @@ "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; }" + ") => any" ], "description": [], - "label": "toggleFilterPinned", + "label": "getFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/get_filter_field.ts", + "lineNumber": 18 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.enableFilter", + "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", @@ -25555,47 +24421,25 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", + "lineNumber": 11 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_filter_params.ts", + "lineNumber": 11 + }, "initialIsOpen": false }, { - "id": "def-common.disableFilter", + "id": "def-common.getGeoBoundingBoxFilterField", "type": "Function", "children": [ { - "type": "Object", + "type": "CompoundType", "label": "filter", "isRequired": true, "signature": [ @@ -25603,15 +24447,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 26 } } ], @@ -25621,35 +24464,27 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } + ") => any" ], "description": [], - "label": "disableFilter", + "label": "getGeoBoundingBoxFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 26 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.pinFilter", + "id": "def-common.getGeoPolygonFilterField", "type": "Function", "children": [ { - "type": "Object", + "type": "CompoundType", "label": "filter", "isRequired": true, "signature": [ @@ -25657,15 +24492,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 25 } } ], @@ -25675,32 +24509,53 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - } + ") => any" ], "description": [], - "label": "pinFilter", + "label": "getGeoPolygonFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.unpinFilter", + "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", @@ -25717,164 +24572,149 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", + "lineNumber": 13 } - } - ], - "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" + "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 + } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts", + "lineNumber": 12 + }, "initialIsOpen": false }, { - "id": "def-common.isFilter", + "id": "def-common.getKbnFieldType", "type": "Function", "children": [ { - "type": "Unknown", - "label": "x", + "type": "string", + "label": "typeName", "isRequired": true, "signature": [ - "unknown" + "string" ], "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 22 } } ], "signature": [ - "(x: unknown) => x is ", + "(typeName: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" + "section": "def-common.KbnFieldType", + "text": "KbnFieldType" } ], - "description": [], - "label": "isFilter", + "description": [ + "\n Get a type object by name\n" + ], + "label": "getKbnFieldType", "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 22 }, - "tags": [], + "tags": [ + "return" + ], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isFilters", + "id": "def-common.getKbnTypeNames", "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" - } - } - ], + "children": [], "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" + "() => string[]" ], - "description": [], - "label": "isFilters", + "description": [ + "\n Get the esTypes known by all kbnFieldTypes\n" + ], + "label": "getKbnTypeNames", "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" + "path": "src/plugins/data/common/kbn_field_types/kbn_field_types.ts", + "lineNumber": 30 }, - "tags": [], + "tags": [ + "return" + ], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isMissingFilter", + "id": "def-common.getMissingFilterField", "type": "Function", "children": [ { - "type": "Any", + "type": "CompoundType", "label": "filter", "isRequired": true, "signature": [ - "any" + { + "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": 18, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L18" + "lineNumber": 20 } } ], "signature": [ - "(filter: any) => filter is ", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.MissingFilter", "text": "MissingFilter" - } + }, + ") => any" ], "description": [], - "label": "isMissingFilter", + "label": "getMissingFilterField", "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" + "lineNumber": 20 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getMissingFilterField", + "id": "def-common.getPhraseFilterField", "type": "Function", "children": [ { @@ -25886,15 +24726,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.MissingFilter", - "text": "MissingFilter" + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 49 } } ], @@ -25904,104 +24743,126 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.MissingFilter", - "text": "MissingFilter" + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" }, - ") => any" + ") => string" ], "description": [], - "label": "getMissingFilterField", + "label": "getPhraseFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 49 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isPhraseFilter", + "id": "def-common.getPhraseFilterValue", "type": "Function", "children": [ { - "type": "Any", + "type": "CompoundType", "label": "filter", "isRequired": true, "signature": [ - "any" + { + "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": 34, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L34" + "lineNumber": 54 } } ], "signature": [ - "(filter: any) => filter is ", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", "section": "def-common.PhraseFilter", "text": "PhraseFilter" - } + }, + ") => PhraseFilterValue" ], "description": [], - "label": "isPhraseFilter", + "label": "getPhraseFilterValue", "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" + "lineNumber": 54 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isScriptedPhraseFilter", + "id": "def-common.getPhraseScript", "type": "Function", "children": [ { - "type": "Any", - "label": "filter", + "type": "Object", + "label": "field", "isRequired": true, "signature": [ - "any" + { + "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 + } + }, + { + "type": "string", + "label": "value", + "isRequired": true, + "signature": [ + "string" ], "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" + "lineNumber": 84 } } ], "signature": [ - "(filter: any) => filter is ", + "(field: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" - } + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + ", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }" ], "description": [], - "label": "isScriptedPhraseFilter", + "label": "getPhraseScript", "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" + "lineNumber": 84 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getPhraseFilterField", + "id": "def-common.getPhrasesFilterField", "type": "Function", "children": [ { @@ -26013,15 +24874,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 26 } } ], @@ -26031,24 +24891,23 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" }, - ") => string" + ") => string | undefined" ], "description": [], - "label": "getPhraseFilterField", + "label": "getPhrasesFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 26 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getPhraseFilterValue", + "id": "def-common.getRangeFilterField", "type": "Function", "children": [ { @@ -26060,15 +24919,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "section": "def-common.RangeFilter", + "text": "RangeFilter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 81 } } ], @@ -26078,24 +24936,23 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" + "section": "def-common.RangeFilter", + "text": "RangeFilter" }, - ") => PhraseFilterValue" + ") => string" ], "description": [], - "label": "getPhraseFilterValue", + "label": "getRangeFilterField", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 81 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.buildPhraseFilter", + "id": "def-common.getRangeScript", "type": "Function", "children": [ { @@ -26113,43 +24970,27 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140 } }, { "type": "Object", - "label": "indexPattern", + "label": "params", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" } ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140 } } ], @@ -26162,141 +25003,161 @@ "section": "def-common.IFieldType", "text": "IFieldType" }, - ", value: any, indexPattern: ", + ", params: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" }, - ") => ", + ") => { script: { source: string; params: Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhraseFilter", - "text": "PhraseFilter" - } + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + ">; lang: string | undefined; }; }" ], "description": [], - "label": "buildPhraseFilter", + "label": "getRangeScript", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 140 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getPhraseScript", + "id": "def-common.isExistsFilter", "type": "Function", "children": [ { - "type": "Object", - "label": "field", + "type": "Any", + "label": "filter", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } + "any" ], "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 23 } - }, + } + ], + "signature": [ + "(filter: any) => filter is ", { - "type": "string", - "label": "value", + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isFilter", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", "isRequired": true, "signature": [ - "string" + "unknown" ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103 } } ], "signature": [ - "(field: ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - ", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }" + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "description": [], - "label": "getPhraseScript", + "label": "isFilter", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 103 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isPhrasesFilter", + "id": "def-common.isFilterDisabled", "type": "Function", "children": [ { - "type": "Any", + "type": "Object", "label": "filter", "isRequired": true, "signature": [ - "any" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 38 } } ], "signature": [ - "(filter: any) => filter is ", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" - } + "section": "def-common.Filter", + "text": "Filter" + }, + ") => boolean" ], "description": [], - "label": "isPhrasesFilter", + "label": "isFilterDisabled", "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" + "path": "src/plugins/data/common/es_query/filters/index.ts", + "lineNumber": 38 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getPhrasesFilterField", + "id": "def-common.isFilterPinned", "type": "Function", "children": [ { - "type": "CompoundType", + "type": "Object", "label": "filter", "isRequired": true, "signature": [ @@ -26304,15 +25165,14 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" + "section": "def-common.Filter", + "text": "Filter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 66 } } ], @@ -26322,120 +25182,62 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" + "section": "def-common.Filter", + "text": "Filter" }, - ") => string | undefined" + ") => boolean | undefined" ], "description": [], - "label": "getPhrasesFilterField", + "label": "isFilterPinned", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 66 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.buildPhrasesFilter", + "id": "def-common.isFilters", "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", + "type": "Unknown", + "label": "x", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - } + "unknown" ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 110 } } ], "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" - }, - ") => ", + "(x: unknown) => x is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.PhrasesFilter", - "text": "PhrasesFilter" - } + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" ], "description": [], - "label": "buildPhrasesFilter", + "label": "isFilters", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 110 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isQueryStringFilter", + "id": "def-common.isGeoBoundingBoxFilter", "type": "Function", "children": [ { @@ -26447,9 +25249,8 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 23 } } ], @@ -26459,91 +25260,60 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.QueryStringFilter", - "text": "QueryStringFilter" + "section": "def-common.GeoBoundingBoxFilter", + "text": "GeoBoundingBoxFilter" } ], "description": [], - "label": "isQueryStringFilter", + "label": "isGeoBoundingBoxFilter", "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" + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 23 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.buildQueryFilter", + "id": "def-common.isGeoPolygonFilter", "type": "Function", "children": [ { "type": "Any", - "label": "query", + "label": "filter", "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" + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 22 } } ], "signature": [ - "(query: any, index: string, alias: string) => ", + "(filter: any) => filter is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.QueryStringFilter", - "text": "QueryStringFilter" + "section": "def-common.GeoPolygonFilter", + "text": "GeoPolygonFilter" } ], "description": [], - "label": "buildQueryFilter", + "label": "isGeoPolygonFilter", "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" + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 22 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isRangeFilter", + "id": "def-common.isMatchAllFilter", "type": "Function", "children": [ { @@ -26555,9 +25325,8 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 21 } } ], @@ -26567,23 +25336,22 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + "section": "def-common.MatchAllFilter", + "text": "MatchAllFilter" } ], "description": [], - "label": "isRangeFilter", + "label": "isMatchAllFilter", "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" + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 21 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isScriptedRangeFilter", + "id": "def-common.isMissingFilter", "type": "Function", "children": [ { @@ -26595,9 +25363,8 @@ ], "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" + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 18 } } ], @@ -26607,446 +25374,371 @@ "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + "section": "def-common.MissingFilter", + "text": "MissingFilter" } ], "description": [], - "label": "isScriptedRangeFilter", + "label": "isMissingFilter", "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" + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 18 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getRangeFilterField", + "id": "def-common.isPhraseFilter", "type": "Function", "children": [ { - "type": "CompoundType", + "type": "Any", "label": "filter", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" - } + "any" ], "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 34 } } ], "signature": [ - "(filter: ", + "(filter: any) => filter is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" - }, - ") => string" + "section": "def-common.PhraseFilter", + "text": "PhraseFilter" + } ], "description": [], - "label": "getRangeFilterField", + "label": "isPhraseFilter", "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 34 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.buildRangeFilter", + "id": "def-common.isPhrasesFilter", "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", + "type": "Any", + "label": "filter", "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" + "any" ], "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23 } } ], "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) => ", + "(filter: any) => filter is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilter", - "text": "RangeFilter" + "section": "def-common.PhrasesFilter", + "text": "PhrasesFilter" } ], "description": [], - "label": "buildRangeFilter", + "label": "isPhrasesFilter", "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 23 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getRangeScript", + "id": "def-common.isQueryStringFilter", "type": "Function", "children": [ { - "type": "Object", - "label": "field", + "type": "Any", + "label": "filter", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } + "any" ], "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" + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 22 } - }, + } + ], + "signature": [ + "(filter: any) => filter is ", { - "type": "Object", - "label": "params", + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isRangeFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.RangeFilterParams", - "text": "RangeFilterParams" - } + "any" ], "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" + "lineNumber": 73 } } ], "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<", + "(filter: any) => filter is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.RangeFilterParams", - "text": "RangeFilterParams" - }, - ">; lang: string | undefined; }; }" + "section": "def-common.RangeFilter", + "text": "RangeFilter" + } ], "description": [], - "label": "getRangeScript", + "label": "isRangeFilter", "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" + "lineNumber": 73 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.fromLiteralExpression", + "id": "def-common.isScriptedPhraseFilter", "type": "Function", "children": [ { "type": "Any", - "label": "expression", + "label": "filter", "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 46 } - }, + } + ], + "signature": [ + "(filter: any) => filter is ", { - "type": "Object", - "label": "parseOptions", + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isScriptedRangeFilter", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "filter", "isRequired": true, "signature": [ - "Partial<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryParseOptions", - "text": "KueryParseOptions" - }, - ">" + "any" ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 75 } } ], "signature": [ - "(expression: any, parseOptions?: Partial<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KueryParseOptions", - "text": "KueryParseOptions" - }, - ">) => ", + "(filter: any) => filter is ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" + "section": "def-common.RangeFilter", + "text": "RangeFilter" } ], "description": [], - "label": "fromLiteralExpression", + "label": "isScriptedRangeFilter", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 75 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.fromKueryExpression", + "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": "expression", + "label": "query", "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" + "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", + "lineNumber": 12 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-common.pinFilter", + "type": "Function", + "children": [ { "type": "Object", - "label": "parseOptions", + "label": "filter", "isRequired": true, "signature": [ - "Partial<", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.KueryParseOptions", - "text": "KueryParseOptions" - }, - ">" + "section": "def-common.Filter", + "text": "Filter" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 97 } } ], "signature": [ - "(expression: any, parseOptions?: Partial<", + "(filter: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.KueryParseOptions", - "text": "KueryParseOptions" + "section": "def-common.Filter", + "text": "Filter" }, - ">) => ", + ") => ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.KueryNode", - "text": "KueryNode" + "section": "def-common.Filter", + "text": "Filter" } ], "description": [], - "label": "fromKueryExpression", + "label": "pinFilter", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 97 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.doesKueryExpressionHaveLuceneSyntaxError", + "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": "expression", + "label": "input", "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" + "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", + "lineNumber": 17 } } ], - "signature": [ - "(expression: any) => boolean" + "tags": [ + "return" ], - "description": [], - "label": "doesKueryExpressionHaveLuceneSyntaxError", + "returnComment": [], "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" + "path": "src/plugins/data/common/utils/shorten_dotted_string.ts", + "lineNumber": 17 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { @@ -27069,8 +25761,7 @@ "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" + "lineNumber": 78 } }, { @@ -27090,8 +25781,7 @@ "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" + "lineNumber": 79 } }, { @@ -27104,8 +25794,7 @@ "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" + "lineNumber": 80 } }, { @@ -27118,8 +25807,7 @@ "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" + "lineNumber": 81 } } ], @@ -27153,244 +25841,231 @@ "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" + "lineNumber": 77 }, "tags": [ - "params", "params" ], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.castEsToKbnFieldTypeName", + "id": "def-common.toggleFilterDisabled", "type": "Function", "children": [ { - "type": "string", - "label": "esType", + "type": "Object", + "label": "filter", "isRequired": true, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 70 } } ], "signature": [ - "(esType: string) => ", + "(filter: ", { "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" + "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; }" ], - "label": "castEsToKbnFieldTypeName", + "description": [], + "label": "toggleFilterDisabled", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 70 }, - "tags": [ - "return" - ], + "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getKbnFieldType", + "id": "def-common.toggleFilterNegated", "type": "Function", "children": [ { - "type": "string", - "label": "typeName", + "type": "Object", + "label": "filter", "isRequired": true, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 77 } } ], "signature": [ - "(typeName: string) => ", + "(filter: ", { "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" - }, - "tags": [ - "return" - ], - "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" - }, - "tags": [ - "return" - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getFilterableKbnTypeNames", - "type": "Function", - "children": [], - "signature": [ - "() => string[]" - ], - "description": [ - "\n Get filterable KbnFieldTypes\n" + "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; }" ], - "label": "getFilterableKbnTypeNames", + "description": [], + "label": "toggleFilterNegated", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 77 }, - "tags": [ - "return" - ], + "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.shortenDottedString", + "id": "def-common.toggleFilterPinned", "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", + "type": "Object", + "label": "filter", "isRequired": true, "signature": [ - "any" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 84 } } ], - "tags": [ - "return" + "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; }" ], - "returnComment": [], + "description": [], + "label": "toggleFilterPinned", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 84 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.datatableToCSV", + "id": "def-common.unpinFilter", "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 }", + "label": "filter", "isRequired": true, "signature": [ { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 100 } + } + ], + "signature": [ + "(filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" }, + ") => ", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" } ], - "tags": [], - "returnComment": [], + "description": [], + "label": "unpinFilter", "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 100 }, + "tags": [], + "returnComment": [], "initialIsOpen": false } ], @@ -27410,8 +26085,7 @@ "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" + "lineNumber": 18 } }, { @@ -27422,8 +26096,7 @@ "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" + "lineNumber": 19 }, "signature": [ "Record" @@ -27437,8 +26110,7 @@ "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" + "lineNumber": 20 } }, { @@ -27449,8 +26121,7 @@ "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" + "lineNumber": 21 }, "signature": [ "string | undefined" @@ -27459,97 +26130,71 @@ ], "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" + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.FilterExistsProperty", + "id": "def-common.EsRangeFilter", "type": "Interface", - "label": "FilterExistsProperty", + "label": "EsRangeFilter", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.FilterExistsProperty.field", - "type": "Any", - "label": "field", + "id": "def-common.EsRangeFilter.range", + "type": "Object", + "label": "range", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 57 }, "signature": [ - "any" + "{ [key: string]: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.RangeFilterParams", + "text": "RangeFilterParams" + }, + "; }" ] } ], "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 56 }, "initialIsOpen": false }, { - "id": "def-common.MatchAllFilterMeta", + "id": "def-common.FilterExistsProperty", "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" - } - ], + "label": "FilterExistsProperty", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.MatchAllFilterMeta.field", + "id": "def-common.FilterExistsProperty.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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 15 }, "signature": [ "any" ] - }, - { - "tags": [], - "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 14 }, "initialIsOpen": false }, @@ -27568,8 +26213,7 @@ "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" + "lineNumber": 21 }, "signature": [ "FilterFormatterFunction" @@ -27583,8 +26227,7 @@ "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" + "lineNumber": 22 }, "signature": [ "(type: string) => FilterFormatterFunction" @@ -27593,346 +26236,412 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.LatLon", + "id": "def-common.KbnFieldTypeOptions", "type": "Interface", - "label": "LatLon", + "label": "KbnFieldTypeOptions", "description": [], - "tags": [], + "tags": [ + "public" + ], "children": [ { "tags": [], - "id": "def-common.LatLon.lat", - "type": "number", - "label": "lat", + "id": "def-common.KbnFieldTypeOptions.sortable", + "type": "boolean", + "label": "sortable", "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" + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 11 } }, { "tags": [], - "id": "def-common.LatLon.lon", - "type": "number", - "label": "lon", + "id": "def-common.KbnFieldTypeOptions.filterable", + "type": "boolean", + "label": "filterable", "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" + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 12 + } + }, + { + "tags": [], + "id": "def-common.KbnFieldTypeOptions.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 13 } + }, + { + "tags": [], + "id": "def-common.KbnFieldTypeOptions.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 14 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + "[]" + ] } ], "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" + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 10 }, "initialIsOpen": false }, { - "id": "def-common.RangeFilterParams", + "id": "def-common.KueryNode", "type": "Interface", - "label": "RangeFilterParams", + "label": "KueryNode", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.RangeFilterParams.from", + "id": "def-common.KueryNode.type", "type": "CompoundType", - "label": "from", + "label": "type", "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 12 }, "signature": [ - "string | number | undefined" + "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" ] }, { + "id": "def-common.KueryNode.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 13 }, "signature": [ - "string | number | undefined" + "any" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.KueryParseOptions", + "type": "Interface", + "label": "KueryParseOptions", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.RangeFilterParams.gt", - "type": "CompoundType", - "label": "gt", + "id": "def-common.KueryParseOptions.helpers", + "type": "Object", + "label": "helpers", "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 19 }, "signature": [ - "string | number | undefined" + "{ [key: string]: any; }" ] }, { "tags": [], - "id": "def-common.RangeFilterParams.lt", - "type": "CompoundType", - "label": "lt", + "id": "def-common.KueryParseOptions.startRule", + "type": "string", + "label": "startRule", "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" - ] + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 22 + } }, { "tags": [], - "id": "def-common.RangeFilterParams.gte", - "type": "CompoundType", - "label": "gte", + "id": "def-common.KueryParseOptions.allowLeadingWildcards", + "type": "boolean", + "label": "allowLeadingWildcards", "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" - ] + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 23 + } }, { "tags": [], - "id": "def-common.RangeFilterParams.lte", - "type": "CompoundType", - "label": "lte", + "id": "def-common.KueryParseOptions.errorOnLuceneSyntax", + "type": "boolean", + "label": "errorOnLuceneSyntax", "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 24 + } + }, + { + "tags": [], + "id": "def-common.KueryParseOptions.cursorSymbol", + "type": "string", + "label": "cursorSymbol", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 25 }, "signature": [ - "string | number | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.RangeFilterParams.format", - "type": "string", - "label": "format", + "id": "def-common.KueryParseOptions.parseCursor", + "type": "CompoundType", + "label": "parseCursor", "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 26 }, "signature": [ - "string | undefined" + "boolean | 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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-common.EsRangeFilter", + "id": "def-common.LatLon", "type": "Interface", - "label": "EsRangeFilter", + "label": "LatLon", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.EsRangeFilter.range", - "type": "Object", - "label": "range", + "id": "def-common.LatLon.lat", + "type": "number", + "label": "lat", "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" - }, - "; }" - ] + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 48 + } + }, + { + "tags": [], + "id": "def-common.LatLon.lon", + "type": "number", + "label": "lon", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 49 + } } ], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 47 }, "initialIsOpen": false }, { - "id": "def-common.KueryNode", + "id": "def-common.MatchAllFilterMeta", "type": "Interface", - "label": "KueryNode", + "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": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.KueryNode.type", - "type": "CompoundType", - "label": "type", + "id": "def-common.MatchAllFilterMeta.field", + "type": "Any", + "label": "field", "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" + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 12 }, "signature": [ - "\"function\" | \"literal\" | \"namedArg\" | \"wildcard\"" + "any" ] }, { - "id": "def-common.KueryNode.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-common.MatchAllFilterMeta.formattedValue", + "type": "string", + "label": "formattedValue", "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" - ] + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 13 + } } ], "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" + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-common.KueryParseOptions", + "id": "def-common.RangeFilterParams", "type": "Interface", - "label": "KueryParseOptions", + "label": "RangeFilterParams", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.KueryParseOptions.helpers", - "type": "Object", - "label": "helpers", + "id": "def-common.RangeFilterParams.from", + "type": "CompoundType", + "label": "from", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 36 }, "signature": [ - "{ [key: string]: any; }" + "string | number | undefined" ] }, { "tags": [], - "id": "def-common.KueryParseOptions.startRule", - "type": "string", - "label": "startRule", + "id": "def-common.RangeFilterParams.to", + "type": "CompoundType", + "label": "to", "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" - } + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 37 + }, + "signature": [ + "string | number | undefined" + ] }, { "tags": [], - "id": "def-common.KueryParseOptions.allowLeadingWildcards", - "type": "boolean", - "label": "allowLeadingWildcards", + "id": "def-common.RangeFilterParams.gt", + "type": "CompoundType", + "label": "gt", "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" - } + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 38 + }, + "signature": [ + "string | number | undefined" + ] }, { "tags": [], - "id": "def-common.KueryParseOptions.errorOnLuceneSyntax", - "type": "boolean", - "label": "errorOnLuceneSyntax", + "id": "def-common.RangeFilterParams.lt", + "type": "CompoundType", + "label": "lt", "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" - } + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 39 + }, + "signature": [ + "string | number | undefined" + ] }, { "tags": [], - "id": "def-common.KueryParseOptions.cursorSymbol", - "type": "string", - "label": "cursorSymbol", + "id": "def-common.RangeFilterParams.gte", + "type": "CompoundType", + "label": "gte", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 40 }, "signature": [ - "string | undefined" + "string | number | undefined" ] }, { "tags": [], - "id": "def-common.KueryParseOptions.parseCursor", + "id": "def-common.RangeFilterParams.lte", "type": "CompoundType", - "label": "parseCursor", + "label": "lte", "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 41 }, "signature": [ - "boolean | undefined" + "string | number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.RangeFilterParams.format", + "type": "string", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 42 + }, + "signature": [ + "string | 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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 35 }, "initialIsOpen": false }, @@ -27957,8 +26666,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71" + "lineNumber": 71 } }, { @@ -27971,8 +26679,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 73, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73" + "lineNumber": 73 } }, { @@ -27985,8 +26692,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75" + "lineNumber": 75 }, "signature": [ "string | undefined" @@ -28002,8 +26708,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 77, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77" + "lineNumber": 77 }, "signature": [ "string | undefined" @@ -28017,8 +26722,7 @@ "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" + "lineNumber": 78 }, "signature": [ { @@ -28041,8 +26745,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80" + "lineNumber": 80 }, "signature": [ "T" @@ -28058,8 +26761,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 82, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82" + "lineNumber": 82 }, "signature": [ { @@ -28082,8 +26784,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 84, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84" + "lineNumber": 84 }, "signature": [ { @@ -28106,8 +26807,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86" + "lineNumber": 86 }, "signature": [ "string | undefined" @@ -28123,8 +26823,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 88, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88" + "lineNumber": 88 }, "signature": [ "string[] | undefined" @@ -28140,8 +26839,7 @@ ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95" + "lineNumber": 95 }, "signature": [ "string | undefined" @@ -28150,98 +26848,23 @@ ], "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": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" + "lineNumber": 69 }, "initialIsOpen": false } ], "enums": [ { - "id": "def-common.FilterStateStore", + "id": "def-common.ES_FIELD_TYPES", "type": "Enum", - "label": "FilterStateStore", - "tags": [], + "label": "ES_FIELD_TYPES", + "tags": [ + "public" + ], "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" + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 18 }, "initialIsOpen": false }, @@ -28253,23 +26876,19 @@ "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" + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-common.ES_FIELD_TYPES", + "id": "def-common.FilterStateStore", "type": "Enum", - "label": "ES_FIELD_TYPES", - "tags": [ - "public" - ], + "label": "FilterStateStore", + "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/meta_filter.ts", + "lineNumber": 9 }, "initialIsOpen": false }, @@ -28277,176 +26896,173 @@ "id": "def-common.KBN_FIELD_TYPES", "type": "Enum", "label": "KBN_FIELD_TYPES", - "tags": [ - "public" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/kbn_field_types/types.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L64" - }, - "initialIsOpen": false - } - ], - "misc": [ - { - "tags": [], - "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", - "tags": [], + "tags": [ + "public" + ], "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" + "path": "src/plugins/data/common/kbn_field_types/types.ts", + "lineNumber": 64 }, - "signature": [ - "Filter & { query: any; }" - ], "initialIsOpen": false - }, + } + ], + "misc": [ { - "id": "def-common.ExistsFilterMeta", - "type": "Type", - "label": "ExistsFilterMeta", "tags": [], + "id": "def-common.CSV_MIME_TYPE", + "type": "string", + "label": "CSV_MIME_TYPE", "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" + "path": "src/plugins/data/common/exports/export_csv.tsx", + "lineNumber": 17 }, "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; }" + "\"text/plain;charset=utf-8\"" ], "initialIsOpen": false }, { - "id": "def-common.ExistsFilter", + "id": "def-common.CustomFilter", "type": "Type", - "label": "ExistsFilter", + "label": "CustomFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/custom_filter.ts", + "lineNumber": 11 }, "signature": [ - "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" + "Filter & { query: any; }" ], "initialIsOpen": false }, { - "id": "def-common.GeoBoundingBoxFilterMeta", - "type": "Type", - "label": "GeoBoundingBoxFilterMeta", "tags": [], + "id": "def-common.DEFAULT_QUERY_LANGUAGE", + "type": "string", + "label": "DEFAULT_QUERY_LANGUAGE", "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" + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 9 }, "signature": [ - "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" + "\"kuery\"" ], "initialIsOpen": false }, { - "id": "def-common.GeoBoundingBoxFilter", + "id": "def-common.DslQuery", "type": "Type", - "label": "GeoBoundingBoxFilter", + "label": "DslQuery", "tags": [], "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" + "path": "src/plugins/data/common/es_query/kuery/types.ts", + "lineNumber": 16 }, "signature": [ - "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" + "any" ], "initialIsOpen": false }, { - "id": "def-common.GeoPolygonFilterMeta", + "id": "def-common.ExistsFilter", "type": "Type", - "label": "GeoPolygonFilterMeta", + "label": "ExistsFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 18 }, "signature": [ - "FilterMeta & { params: { points: LatLon[];}; }" + "Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.GeoPolygonFilter", + "id": "def-common.ExistsFilterMeta", "type": "Type", - "label": "GeoPolygonFilter", + "label": "ExistsFilterMeta", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/exists_filter.ts", + "lineNumber": 12 }, "signature": [ - "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" + "{ 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.MatchAllFilter", + "id": "def-common.FieldFilter", "type": "Type", - "label": "MatchAllFilter", + "label": "FieldFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/types.ts", + "lineNumber": 19 }, "signature": [ - "Filter & { meta: MatchAllFilterMeta; match_all: any; }" + { + "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.FilterState", + "id": "def-common.Filter", "type": "Type", - "label": "FilterState", + "label": "Filter", "tags": [], "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" + "lineNumber": 41 }, "signature": [ - "{ store: FilterStateStore; }" + "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" ], "initialIsOpen": false }, @@ -28458,8 +27074,7 @@ "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" + "lineNumber": 26 }, "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; }" @@ -28467,404 +27082,264 @@ "initialIsOpen": false }, { - "id": "def-common.Filter", + "id": "def-common.FilterState", "type": "Type", - "label": "Filter", + "label": "FilterState", "tags": [], "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" + "lineNumber": 15 }, "signature": [ - "{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }" + "{ store: FilterStateStore; }" ], "initialIsOpen": false }, { - "id": "def-common.MissingFilterMeta", + "id": "def-common.GeoBoundingBoxFilter", "type": "Type", - "label": "MissingFilterMeta", + "label": "GeoBoundingBoxFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 18 }, "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; }" + "Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }" ], "initialIsOpen": false }, { - "id": "def-common.MissingFilter", + "id": "def-common.GeoBoundingBoxFilterMeta", "type": "Type", - "label": "MissingFilter", + "label": "GeoBoundingBoxFilterMeta", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts", + "lineNumber": 11 }, "signature": [ - "Filter & { meta: MissingFilterMeta; missing: any; }" + "FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }" ], "initialIsOpen": false }, { - "id": "def-common.PhraseFilterMeta", + "id": "def-common.GeoPolygonFilter", "type": "Type", - "label": "PhraseFilterMeta", + "label": "GeoPolygonFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 17 }, "signature": [ - "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" + "Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }" ], "initialIsOpen": false }, { - "id": "def-common.PhraseFilter", + "id": "def-common.GeoPolygonFilterMeta", "type": "Type", - "label": "PhraseFilter", + "label": "GeoPolygonFilterMeta", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/geo_polygon_filter.ts", + "lineNumber": 11 }, "signature": [ - "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" + "FilterMeta & { params: { points: LatLon[];}; }" ], "initialIsOpen": false }, { - "id": "def-common.PhrasesFilterMeta", + "id": "def-common.GetConfigFn", "type": "Type", - "label": "PhrasesFilterMeta", + "label": "GetConfigFn", "tags": [], - "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; }" + "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." ], - "initialIsOpen": false - }, - { - "id": "def-common.PhrasesFilter", - "type": "Type", - "label": "PhrasesFilter", - "tags": [], - "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" + "path": "src/plugins/data/common/types.ts", + "lineNumber": 23 }, "signature": [ - "Filter & { meta: PhrasesFilterMeta; }" + "(key: string, defaultOverride: T | undefined) => T" ], "initialIsOpen": false }, { - "id": "def-common.QueryStringFilterMeta", + "id": "def-common.MatchAllFilter", "type": "Type", - "label": "QueryStringFilterMeta", + "label": "MatchAllFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/match_all_filter.ts", + "lineNumber": 16 }, "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; }" + "Filter & { meta: MatchAllFilterMeta; match_all: any; }" ], "initialIsOpen": false }, { - "id": "def-common.QueryStringFilter", + "id": "def-common.MissingFilter", "type": "Type", - "label": "QueryStringFilter", + "label": "MissingFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 13 }, "signature": [ - "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" + "Filter & { meta: MissingFilterMeta; missing: any; }" ], "initialIsOpen": false }, { - "id": "def-common.RangeFilterMeta", + "id": "def-common.MissingFilterMeta", "type": "Type", - "label": "RangeFilterMeta", + "label": "MissingFilterMeta", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/missing_filter.ts", + "lineNumber": 11 }, "signature": [ - "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + "{ 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.RangeFilter", + "id": "def-common.PhraseFilter", "type": "Type", - "label": "RangeFilter", + "label": "PhraseFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 21 }, "signature": [ - "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + "Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.FieldFilter", + "id": "def-common.PhraseFilterMeta", "type": "Type", - "label": "FieldFilter", + "label": "PhraseFilterMeta", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts", + "lineNumber": 13 }, "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" - } + "FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }" ], "initialIsOpen": false }, { - "id": "def-common.DslQuery", + "id": "def-common.PhrasesFilter", "type": "Type", - "label": "DslQuery", + "label": "PhrasesFilter", "tags": [], "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" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 19 }, "signature": [ - "any" + "Filter & { meta: PhrasesFilterMeta; }" ], "initialIsOpen": false }, { - "id": "def-common.GetConfigFn", + "id": "def-common.PhrasesFilterMeta", "type": "Type", - "label": "GetConfigFn", + "label": "PhrasesFilterMeta", "tags": [], - "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." - ], + "description": [], "source": { - "path": "src/plugins/data/common/types.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/types.ts#L23" + "path": "src/plugins/data/common/es_query/filters/phrases_filter.ts", + "lineNumber": 14 }, "signature": [ - "(key: string, defaultOverride: T | undefined) => T" + "FilterMeta & { params: string[]; field?: string | undefined; }" ], "initialIsOpen": false }, { + "id": "def-common.QueryStringFilter", + "type": "Type", + "label": "QueryStringFilter", "tags": [], - "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" + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 13 }, "signature": [ - "\"text/plain;charset=utf-8\"" + "Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }" ], "initialIsOpen": false - } - ], - "objects": [ + }, { + "id": "def-common.QueryStringFilterMeta", + "type": "Type", + "label": "QueryStringFilterMeta", "tags": [], - "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" + "path": "src/plugins/data/common/es_query/filters/query_string_filter.ts", + "lineNumber": 11 }, "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\"; }" + "{ 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.nodeTypes", - "type": "Object", + "id": "def-common.RangeFilter", + "type": "Type", + "label": "RangeFilter", "tags": [], - "children": [ - { - "tags": [], - "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 ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/function" - } - ] - }, - { - "tags": [], - "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 ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/literal" - } - ] - }, - { - "tags": [], - "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 ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "src/plugins/data/common/es_query/kuery/node_types/named_arg" - } - ] - }, - { - "tags": [], - "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 ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "text": "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" + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 60 }, + "signature": [ + "Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }" + ], "initialIsOpen": false }, + { + "id": "def-common.RangeFilterMeta", + "type": "Type", + "label": "RangeFilterMeta", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/es_query/filters/range_filter.ts", + "lineNumber": 50 + }, + "signature": [ + "FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }" + ], + "initialIsOpen": false + } + ], + "objects": [ { "id": "def-common.nodeBuilder", "type": "Object", @@ -28884,8 +27359,7 @@ "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" + "lineNumber": 12 } }, { @@ -28905,8 +27379,7 @@ "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" + "lineNumber": 12 } } ], @@ -28932,8 +27405,7 @@ "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" + "lineNumber": 12 }, "tags": [], "returnComment": [] @@ -28959,8 +27431,7 @@ "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" + "lineNumber": 19 } } ], @@ -28986,8 +27457,7 @@ "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" + "lineNumber": 19 }, "tags": [], "returnComment": [] @@ -29013,8 +27483,7 @@ "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" + "lineNumber": 22 } } ], @@ -29040,8 +27509,7 @@ "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" + "lineNumber": 22 }, "tags": [], "returnComment": [] @@ -29051,9 +27519,119 @@ "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" + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.nodeTypes", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/function" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/literal" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "src/plugins/data/common/es_query/kuery/node_types/named_arg" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "typeof ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "text": "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 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.UI_SETTINGS", + "type": "Object", + "label": "UI_SETTINGS", + "description": [], + "source": { + "path": "src/plugins/data/common/constants.ts", + "lineNumber": 11 }, + "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 } ] diff --git a/api_docs/data_autocomplete.json b/api_docs/data_autocomplete.json index 6d78369b25d1f..a66ca49d0c181 100644 --- a/api_docs/data_autocomplete.json +++ b/api_docs/data_autocomplete.json @@ -4,138 +4,6 @@ "classes": [], "functions": [], "interfaces": [ - { - "id": "def-public.QuerySuggestionGetFnArgs", - "type": "Interface", - "label": "QuerySuggestionGetFnArgs", - "description": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, - "[]" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", @@ -153,8 +21,7 @@ "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" + "lineNumber": 37 }, "signature": [ { @@ -174,8 +41,7 @@ "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" + "lineNumber": 38 }, "signature": [ "string | JSX.Element | undefined" @@ -189,8 +55,7 @@ "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" + "lineNumber": 39 } }, { @@ -201,8 +66,7 @@ "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" + "lineNumber": 40 } }, { @@ -213,8 +77,7 @@ "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" + "lineNumber": 41 } }, { @@ -225,8 +88,7 @@ "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" + "lineNumber": 42 }, "signature": [ "number | undefined" @@ -235,8 +97,7 @@ ], "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" + "lineNumber": 36 }, "initialIsOpen": false }, @@ -274,8 +135,7 @@ "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" + "lineNumber": 47 }, "signature": [ { @@ -296,8 +156,7 @@ "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" + "lineNumber": 48 }, "signature": [ { @@ -312,8 +171,130 @@ ], "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" + "lineNumber": 46 + }, + "initialIsOpen": false + }, + { + "id": "def-public.QuerySuggestionGetFnArgs", + "type": "Interface", + "label": "QuerySuggestionGetFnArgs", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.language", + "type": "string", + "label": "language", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 25 + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.indexPatterns", + "type": "Array", + "label": "indexPatterns", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 26 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.query", + "type": "string", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 27 + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.selectionStart", + "type": "number", + "label": "selectionStart", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 28 + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.selectionEnd", + "type": "number", + "label": "selectionEnd", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 29 + } + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.signal", + "type": "Object", + "label": "signal", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 30 + }, + "signature": [ + "AbortSignal | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.useTimeRange", + "type": "CompoundType", + "label": "useTimeRange", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 31 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QuerySuggestionGetFnArgs.boolFilter", + "type": "Any", + "label": "boolFilter", + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 32 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", + "lineNumber": 24 }, "initialIsOpen": false } @@ -327,13 +308,29 @@ "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" + "lineNumber": 11 }, "initialIsOpen": false } ], "misc": [ + { + "id": "def-public.AutocompleteStart", + "type": "Type", + "label": "AutocompleteStart", + "tags": [ + "public" + ], + "description": [], + "source": { + "path": "src/plugins/data/public/autocomplete/autocomplete_service.ts", + "lineNumber": 93 + }, + "signature": [ + "{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }" + ], + "initialIsOpen": false + }, { "id": "def-public.QuerySuggestion", "type": "Type", @@ -344,8 +341,7 @@ "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" + "lineNumber": 52 }, "signature": [ { @@ -374,8 +370,7 @@ "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" + "lineNumber": 19 }, "signature": [ "(args: ", @@ -397,24 +392,6 @@ "[]> | undefined" ], "initialIsOpen": false - }, - { - "id": "def-public.AutocompleteStart", - "type": "Type", - "label": "AutocompleteStart", - "tags": [ - "public" - ], - "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": [] diff --git a/api_docs/data_enhanced.json b/api_docs/data_enhanced.json index 02c69f4a68fc5..0505e87e796f4 100644 --- a/api_docs/data_enhanced.json +++ b/api_docs/data_enhanced.json @@ -14,8 +14,7 @@ "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" + "lineNumber": 17 }, "signature": [ "\"ese\"" @@ -30,8 +29,7 @@ "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" + "lineNumber": 19 }, "signature": [ "\"eql\"" @@ -48,8 +46,7 @@ "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" + "lineNumber": 40 }, "signature": [ "void" @@ -113,8 +110,7 @@ "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" + "lineNumber": 48 } } ], @@ -122,8 +118,7 @@ "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" + "lineNumber": 48 } }, { @@ -176,8 +171,7 @@ "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" + "lineNumber": 53 } }, { @@ -190,8 +184,7 @@ "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" + "lineNumber": 53 } } ], @@ -199,8 +192,7 @@ "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" + "lineNumber": 53 } }, { @@ -244,8 +236,7 @@ "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" + "lineNumber": 95 } }, { @@ -264,8 +255,7 @@ "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" + "lineNumber": 95 } } ], @@ -273,8 +263,7 @@ "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" + "lineNumber": 95 } }, { @@ -290,15 +279,13 @@ "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" + "lineNumber": 101 } } ], "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" + "lineNumber": 42 }, "initialIsOpen": false } @@ -315,8 +302,7 @@ "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" + "lineNumber": 17 }, "signature": [ "\"ese\"" @@ -331,8 +317,7 @@ "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" + "lineNumber": 19 }, "signature": [ "\"eql\"" @@ -359,8 +344,7 @@ "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" + "lineNumber": 16 } }, { @@ -373,8 +357,7 @@ "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" + "lineNumber": 17 } }, { @@ -393,8 +376,7 @@ "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" + "lineNumber": 18 } } ], @@ -423,8 +405,7 @@ "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" + "lineNumber": 15 }, "tags": [], "returnComment": [], @@ -473,8 +454,7 @@ "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" + "lineNumber": 24 }, "signature": [ "TransportRequestOptions", @@ -484,8 +464,7 @@ ], "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" + "lineNumber": 23 }, "initialIsOpen": false }, @@ -523,8 +502,7 @@ ], "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" + "lineNumber": 33 }, "signature": [ "number | undefined" @@ -533,8 +511,76 @@ ], "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" + "lineNumber": 29 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SearchSessionRequestInfo", + "type": "Interface", + "label": "SearchSessionRequestInfo", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/data_enhanced/common/search/session/types.ts", + "lineNumber": 68 }, "initialIsOpen": false }, @@ -553,8 +599,7 @@ "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" + "lineNumber": 12 } }, { @@ -567,8 +612,7 @@ ], "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" + "lineNumber": 16 }, "signature": [ "string | undefined" @@ -584,8 +628,7 @@ ], "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" + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -601,8 +644,7 @@ ], "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" + "lineNumber": 24 } }, { @@ -615,8 +657,7 @@ ], "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" + "lineNumber": 28 } }, { @@ -629,8 +670,7 @@ ], "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" + "lineNumber": 32 } }, { @@ -643,8 +683,7 @@ ], "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" + "lineNumber": 36 }, "signature": [ { @@ -666,8 +705,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -683,8 +721,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ "Record | undefined" @@ -700,8 +737,7 @@ ], "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" + "lineNumber": 50 }, "signature": [ "Record | undefined" @@ -717,8 +753,7 @@ ], "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" + "lineNumber": 54 }, "signature": [ "Record>" @@ -964,8 +900,7 @@ "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" + "lineNumber": 27 }, "signature": [ "IKibanaSearchResponse>" ], "initialIsOpen": false + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"search-session\"" + ], + "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json index b772eebe44161..273acdf5fc9ee 100644 --- a/api_docs/data_field_formats.json +++ b/api_docs/data_field_formats.json @@ -14,8 +14,7 @@ "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" + "lineNumber": 12 }, "signature": [ "(typeof ", @@ -38,8 +37,7 @@ "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" + "lineNumber": 55 }, "signature": [ "Pick & { deserialize: FormatFactory; }" @@ -60,274 +58,282 @@ "common": { "classes": [ { - "id": "def-common.FieldFormatsRegistry", + "id": "def-common.BoolFormat", "type": "Class", "tags": [], - "label": "FieldFormatsRegistry", + "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": [ { "tags": [], - "id": "def-common.FieldFormatsRegistry.fieldFormats", - "type": "Object", - "label": "fieldFormats", + "id": "def-common.BoolFormat.id", + "type": "Enum", + "label": "id", "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" + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 16 }, "signature": [ - "Map" + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } ] }, { - "id": "def-common.FieldFormatsRegistry.defaultMap", - "type": "Object", - "tags": [], - "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", "tags": [], - "children": [], + "id": "def-common.BoolFormat.title", + "type": "string", + "label": "title", "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" + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 17 } }, { "tags": [], - "id": "def-common.FieldFormatsRegistry.getConfig", - "type": "Function", - "label": "getConfig", + "id": "def-common.BoolFormat.fieldType", + "type": "Array", + "label": "fieldType", "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" + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 20 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" }, - " | undefined" + "[]" ] }, { - "id": "def-common.FieldFormatsRegistry.deserialize", + "id": "def-common.BoolFormat.textConvert", "type": "Function", "children": [ { - "type": "Object", - "label": "mapping", - "isRequired": false, + "type": "Any", + "label": "value", + "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "> | undefined" + "any" ], "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" + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 22 } } ], "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" - } + "(value: any) => string" ], "description": [], - "label": "deserialize", + "label": "textConvert", "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" + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 22 }, "tags": [], "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/boolean.ts", + "lineNumber": 15 + }, + "initialIsOpen": false + }, + { + "id": "def-common.BytesFormat", + "type": "Class", + "tags": [], + "label": "BytesFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.BytesFormat", + "text": "BytesFormat" }, + " extends ", + "NumeralFormat" + ], + "children": [ { - "id": "def-common.FieldFormatsRegistry.init", - "type": "Function", - "label": "init", + "tags": [], + "id": "def-common.BytesFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 14 + }, "signature": [ - "(getConfig: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - }, - ", metaParamsOptions?: Record, defaultFieldConverters?: ", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.BytesFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "id": "def-common.BytesFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 19 + }, + "signature": [ { "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" - } + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" } - ], + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.BytesFormat.title", + "type": "string", + "label": "title", + "description": [], "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" + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 20 } }, { - "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" - } - }, + "tags": [], + "id": "def-common.BytesFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 21 + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/bytes.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ColorFormat", + "type": "Class", + "tags": [], + "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": [ + { + "tags": [], + "id": "def-common.ColorFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 20 + }, + "signature": [ { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" } - ], + ] + }, + { + "tags": [], + "id": "def-common.ColorFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 21 + } + }, + { + "tags": [], + "id": "def-common.ColorFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 24 + }, "signature": [ - "(fieldType: ", { "pluginId": "data", "scope": "common", @@ -335,658 +341,851 @@ "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" + "[]" + ] + }, + { + "id": "def-common.ColorFormat.getParamDefaults", + "type": "Function", + "label": "getParamDefaults", + "signature": [ + "() => { fieldType: null; colors: { range: string; regex: string; text: string; background: string; }[]; }" ], - "label": "getDefaultConfig", + "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - }, - "tags": [ - "return" - ], - "returnComment": [] + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 26 + } }, { - "id": "def-common.FieldFormatsRegistry.getType", + "id": "def-common.ColorFormat.findColorRuleForVal", "type": "Function", + "label": "findColorRuleForVal", + "signature": [ + "(val: any) => any" + ], + "description": [], "children": [ { - "type": "string", - "label": "formatId", + "type": "Any", + "label": "val", "isRequired": true, "signature": [ - "string" + "any" ], "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" + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 33 } } ], - "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", + "tags": [], + "returnComment": [], "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" - }, - "tags": [ - "return" - ], - "returnComment": [] + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 33 + } }, { - "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams", + "id": "def-common.ColorFormat.htmlConvert", "type": "Function", "children": [ { - "type": "string", - "label": "formatId", + "type": "Any", + "label": "val", "isRequired": true, "signature": [ - "string" + "any" ], "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" + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 52 } } ], "signature": [ - "(formatId: string) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, - " | undefined" + "(val: any) => string" ], "description": [], - "label": "getTypeWithoutMetaParams", + "label": "htmlConvert", "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" + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 52 }, "tags": [], "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/color.ts", + "lineNumber": 19 + }, + "initialIsOpen": false + }, + { + "id": "def-common.DurationFormat", + "type": "Class", + "tags": [], + "label": "DurationFormat", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.DurationFormat", + "text": "DurationFormat" }, + " extends ", { - "id": "def-common.FieldFormatsRegistry.getDefaultType", - "type": "Function", - "children": [ + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.DurationFormat.id", + "type": "Enum", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 158 + }, + "signature": [ { - "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" - } - }, + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 159 + } + }, + { + "tags": [], + "id": "def-common.DurationFormat.fieldType", + "type": "Enum", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 162 + }, + "signature": [ { - "type": "Array", - "label": "esTypes", - "isRequired": false, + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.inputFormats", + "type": "Array", + "label": "inputFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 163 + }, + "signature": [ + "{ text: string; kind: string; }[]" + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.outputFormats", + "type": "Array", + "label": "outputFormats", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 164 + }, + "signature": [ + "{ text: string; method: string; }[]" + ] + }, + { + "tags": [], + "id": "def-common.DurationFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 165 + } + }, + { + "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 + } + }, + { + "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 + } + }, + { + "id": "def-common.DurationFormat.textConvert", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "val", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" - }, - "[] | undefined" + "any" ], "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" + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 178 } } ], "signature": [ - "(fieldType: ", + "(val: any) => string" + ], + "description": [], + "label": "textConvert", + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 178 + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/converters/duration.ts", + "lineNumber": 157 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormat", + "type": "Class", + "tags": [], + "label": "FieldFormat", + "description": [], + "children": [ + { + "tags": [ + "property", + "static", + "public" + ], + "id": "def-common.FieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 32 + } + }, + { + "tags": [ + "property", + "static", + "public" + ], + "id": "def-common.FieldFormat.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 38 + } + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-common.FieldFormat.fieldType", + "type": "CompoundType", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 44 + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [ + "property", + "private" + ], + "id": "def-common.FieldFormat.convertObject", + "type": "Object", + "label": "convertObject", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 52 + }, + "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvert", + "text": "FieldFormatConvert" }, - ", esTypes?: ", + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-common.FieldFormat.htmlConvert", + "type": "Function", + "label": "htmlConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 60 + }, + "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeConvert", + "text": "HtmlContextTypeConvert" }, - "[] | undefined) => ", + " | undefined" + ] + }, + { + "tags": [ + "property", + "protected" + ], + "id": "def-common.FieldFormat.textConvert", + "type": "Function", + "label": "textConvert", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 68 + }, + "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" + "section": "def-common.TextContextTypeConvert", + "text": "TextContextTypeConvert" }, " | undefined" + ] + }, + { + "tags": [ + "property", + "private" ], - "description": [ - "\nGet the default FieldFormat type (class) for\na field type, using the format:defaultTypeMap.\nused by the field editor\n" - ], - "label": "getDefaultType", + "id": "def-common.FieldFormat.type", + "type": "Any", + "label": "type", + "description": [], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 74 }, - "tags": [ - "return" - ], - "returnComment": [] + "signature": [ + "any" + ] }, { - "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes", + "tags": [], + "id": "def-common.FieldFormat.allowsNumericalAggregations", + "type": "CompoundType", + "label": "allowsNumericalAggregations", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 75 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldFormat._params", + "type": "Any", + "label": "_params", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 77 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.FieldFormat.getConfig", "type": "Function", + "label": "getConfig", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 78 + }, + "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": "Array", - "label": "esTypes", + "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 + } + }, + { + "type": "Function", + "label": "getConfig", "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, - "[] | undefined" + " | 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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 80 + } + }, + { + "id": "def-common.FieldFormat.convert", + "type": "Function", + "label": "convert", "signature": [ - "(esTypes: ", + "(value: any, contentType?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" }, - "[] | undefined) => ", + ", options?: Record | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" }, - " | undefined" + " | undefined) => string" ], "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" - }, - "tags": [ - "return" + "\nConvert a raw value to a formatted string" ], - "returnComment": [] - }, - { - "id": "def-common.FieldFormatsRegistry.getDefaultTypeName", - "type": "Function", "children": [ { - "type": "Enum", - "label": "fieldType", + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 99 + } + }, + { + "type": "CompoundType", + "label": "contentType", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" } ], - "description": [], + "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_formats_registry.ts", - "lineNumber": 148, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L148" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 100 } }, { - "type": "Array", - "label": "esTypes", + "type": "CompoundType", + "label": "options", "isRequired": false, "signature": [ + "Record | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" }, - "[] | undefined" + " | 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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 101 } } ], + "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 + } + }, + { + "id": "def-common.FieldFormat.getConverterFor", + "type": "Function", + "label": "getConverterFor", "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) => ", + "(contentType?: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" }, - " | ", + ") => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" } ], "description": [ - "\nGet the default FieldFormat type name for\na field type, using the format:defaultTypeMap.\n" + "\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 + } + } ], - "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" - }, "tags": [ - "return" + "return", + "public" ], - "returnComment": [] + "returnComment": [ + "- a bound converter function" + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 118 + } }, { - "tags": [ - "return" - ], - "id": "def-common.FieldFormatsRegistry.getInstance", + "id": "def-common.FieldFormat.getParamDefaults", "type": "Function", - "label": "getInstance", + "label": "getParamDefaults", + "signature": [ + "() => Record" + ], "description": [ - "\nGet the singleton instance of the FieldFormat type by its id.\n" + "\nGet parameter defaults" + ], + "children": [], + "tags": [ + "return", + "public" + ], + "returnComment": [ + "- parameter defaults" ], "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" - ] + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 133 + } }, { - "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain", + "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": "Enum", - "label": "fieldType", + "type": "string", + "label": "name", "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" + "string" ], - "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": [ + "- the param name to fetch" ], - "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144 } } ], + "tags": [ + "return", + "public" + ], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 144 + } + }, + { + "id": "def-common.FieldFormat.params", + "type": "Function", + "label": "params", "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" - } + "() => Record" ], "description": [ - "\nGet the default fieldFormat instance for a field format.\n" + "\nGet all of the params in a single object" ], - "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" - }, + "children": [], "tags": [ - "return" + "return", + "public" ], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 161 + } }, { - "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver", + "id": "def-common.FieldFormat.toJSON", "type": "Function", - "label": "getDefaultInstanceCacheResolver", + "label": "toJSON", "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" + "() => { id: any; params: any; }" ], "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" - } - } + "\nSerialize this format to a simple POJO, with only the params\nthat are not default\n" ], + "children": [], "tags": [ - "return" + "return", + "public" ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 172 } }, { - "id": "def-common.FieldFormatsRegistry.getByFieldType", + "id": "def-common.FieldFormat.from", "type": "Function", - "label": "getByFieldType", + "label": "from", "signature": [ - "(fieldType: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - }, - ") => ", + "typeof ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, - "[]" - ], - "description": [ - "\nGet filtered list of field formats by format type\n" + ".from" ], + "description": [], "children": [ { - "type": "Enum", - "label": "fieldType", + "type": "Function", + "label": "convertFn", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatConvertFunction", + "text": "FieldFormatConvertFunction" } ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193 } } ], - "tags": [ - "return" - ], + "tags": [], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 193 } }, { - "tags": [ - "return" - ], - "id": "def-common.FieldFormatsRegistry.getDefaultInstance", + "id": "def-common.FieldFormat.setupContentType", "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" - }, + "label": "setupContentType", "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) => ", + "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 + } + }, + { + "id": "def-common.FieldFormat.isInstanceOfFieldFormat", + "type": "Function", + "label": "isInstanceOfFieldFormat", + "signature": [ + "typeof ", { "pluginId": "data", "scope": "common", @@ -994,288 +1193,248 @@ "section": "def-common.FieldFormat", "text": "FieldFormat" }, - ") & _.MemoizedFunction" - ] - }, - { - "id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap", - "type": "Function", - "label": "parseDefaultTypeMap", - "signature": [ - "(value: any) => void" + ".isInstanceOfFieldFormat" ], "description": [], "children": [ { "type": "Any", - "label": "value", + "label": "fieldFormat", "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204 } } ], "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" + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 204 + } + } + ], + "source": { + "path": "src/plugins/data/common/field_formats/field_format.ts", + "lineNumber": 26 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldFormatNotFoundError", + "type": "Class", + "tags": [], + "label": "FieldFormatNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatNotFoundError", + "text": "FieldFormatNotFoundError" + }, + " extends Error" + ], + "children": [ + { + "tags": [], + "id": "def-common.FieldFormatNotFoundError.formatId", + "type": "string", + "label": "formatId", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 10 } }, { - "id": "def-common.FieldFormatsRegistry.register", + "id": "def-common.FieldFormatNotFoundError.Unnamed", "type": "Function", - "label": "register", + "label": "Constructor", "signature": [ - "(fieldFormats: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, - "[]) => void" + "any" ], "description": [], "children": [ { - "type": "Array", - "label": "fieldFormats", + "type": "string", + "label": "message", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatInstanceType", - "text": "FieldFormatInstanceType" - }, - "[]" + "string" ], "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" + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11 + } + }, + { + "type": "string", + "label": "formatId", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11 } } ], "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" + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 11 } } ], "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" + "path": "src/plugins/data/common/field_formats/errors.ts", + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-common.FieldFormat", + "id": "def-common.FieldFormatsRegistry", "type": "Class", "tags": [], - "label": "FieldFormat", + "label": "FieldFormatsRegistry", "description": [], "children": [ { - "tags": [ - "property", - "static", - "public" - ], - "id": "def-common.FieldFormat.id", - "type": "string", - "label": "id", + "tags": [], + "id": "def-common.FieldFormatsRegistry.fieldFormats", + "type": "Object", + "label": "fieldFormats", "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" - } + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 29 + }, + "signature": [ + "Map" + ] }, { - "tags": [ - "property", - "static", - "public" - ], - "id": "def-common.FieldFormat.title", - "type": "string", - "label": "title", + "id": "def-common.FieldFormatsRegistry.defaultMap", + "type": "Object", + "tags": [], + "children": [], "description": [], + "label": "defaultMap", "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 30 } }, { - "tags": [ - "property", - "private" - ], - "id": "def-common.FieldFormat.fieldType", - "type": "CompoundType", - "label": "fieldType", + "id": "def-common.FieldFormatsRegistry.metaParamsOptions", + "type": "Object", + "tags": [], + "children": [], "description": [], + "label": "metaParamsOptions", "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[]" - ] + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 31 + } }, { - "tags": [ - "property", - "private" - ], - "id": "def-common.FieldFormat.convertObject", - "type": "Object", - "label": "convertObject", + "tags": [], + "id": "def-common.FieldFormatsRegistry.getConfig", + "type": "Function", + "label": "getConfig", "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 32 }, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvert", - "text": "FieldFormatConvert" + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, " | undefined" ] }, { - "tags": [ - "property", - "protected" - ], - "id": "def-common.FieldFormat.htmlConvert", + "id": "def-common.FieldFormatsRegistry.deserialize", "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" - }, + "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 + } + } + ], "signature": [ + "(mapping?: ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeConvert", - "text": "HtmlContextTypeConvert" + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - " | undefined" - ] - }, - { - "tags": [ - "property", - "protected" - ], - "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": [ + "> | undefined) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.TextContextTypeConvert", - "text": "TextContextTypeConvert" - }, - " | undefined" - ] - }, - { - "tags": [ - "property", - "private" + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], - "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" - ] - }, - { - "tags": [], - "id": "def-common.FieldFormat.allowsNumericalAggregations", - "type": "CompoundType", - "label": "allowsNumericalAggregations", "description": [], + "label": "deserialize", "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 34 }, - "signature": [ - "boolean | undefined" - ] - }, - { "tags": [], - "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" - ] + "returnComment": [] }, { - "tags": [], - "id": "def-common.FieldFormat.getConfig", + "id": "def-common.FieldFormatsRegistry.init", "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" - }, + "label": "init", "signature": [ + "(getConfig: ", { "pluginId": "data", "scope": "common", @@ -1283,744 +1442,743 @@ "section": "def-common.GetConfigFn", "text": "GetConfigFn" }, - " | undefined" - ] - }, - { - "id": "def-common.FieldFormat.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + ", metaParamsOptions?: Record, defaultFieldConverters?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]) => void" ], "description": [], "children": [ { - "type": "Object", - "label": "_params", + "type": "Function", + "label": "getConfig", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.IFieldFormatMetaParams", - "text": "IFieldFormatMetaParams" + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" } ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 52 } }, { - "type": "Function", - "label": "getConfig", - "isRequired": false, + "type": "Object", + "label": "metaParamsOptions", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 53 + } + }, + { + "type": "Array", + "label": "defaultFieldConverters", + "isRequired": true, "signature": [ { "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" }, - " | 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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 54 } } ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 51 } }, { - "id": "def-common.FieldFormat.convert", + "id": "def-common.FieldFormatsRegistry.getDefaultConfig", "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", + "type": "Enum", + "label": "fieldType", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" } ], - "description": [ - "- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts" - ], + "description": [], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 72 } }, { - "type": "CompoundType", - "label": "options", + "type": "Array", + "label": "esTypes", "isRequired": false, "signature": [ - "Record | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HtmlContextTypeOptions", - "text": "HtmlContextTypeOptions" + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" }, - " | undefined" + "[] | 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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 73 } } ], - "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?: ", + "(fieldType: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" + "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.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" + "section": "def-common.FieldFormatConfig", + "text": "FieldFormatConfig" } ], "description": [ - "\nGet a convert function that is bound to a specific contentType" + "\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 + }, + "tags": [ + "return" ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getType", + "type": "Function", "children": [ { - "type": "CompoundType", - "label": "contentType", + "type": "string", + "label": "formatId", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "string" ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 88 } } ], - "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" + "(formatId: string) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + " | undefined" ], "description": [ - "\nGet parameter defaults" + "\nGet a derived FieldFormat class by its id.\n" ], - "children": [], + "label": "getType", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 88 + }, "tags": [ - "return", - "public" - ], - "returnComment": [ - "- parameter defaults" + "return" ], - "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" - } + "returnComment": [] }, { - "id": "def-common.FieldFormat.param", + "id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams", "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", + "label": "formatId", "isRequired": true, "signature": [ "string" ], - "description": [ - "- the param name to fetch" - ], + "description": [], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 102 } } ], - "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 ", + "(formatId: string) => ", { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" }, - ".from" + " | undefined" ], "description": [], + "label": "getTypeWithoutMetaParams", + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 102 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultType", + "type": "Function", "children": [ { - "type": "Function", - "label": "convertFn", + "type": "Enum", + "label": "fieldType", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatConvertFunction", - "text": "FieldFormatConvertFunction" + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" } ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 116 + } + }, + { + "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 } } ], - "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": [ - "() => ", + "(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.FieldFormatConvert", - "text": "FieldFormatConvert" - } + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + " | undefined" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], + "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_format.ts", - "lineNumber": 197, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L197" - } + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 115 + }, + "tags": [ + "return" + ], + "returnComment": [] }, { - "id": "def-common.FieldFormat.isInstanceOfFieldFormat", + "id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes", "type": "Function", - "label": "isInstanceOfFieldFormat", + "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 + } + } + ], "signature": [ - "typeof ", + "(esTypes: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" }, - ".isInstanceOfFieldFormat" + "[] | undefined) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" + }, + " | undefined" ], - "description": [], + "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 + }, + "tags": [ + "return" + ], + "returnComment": [] + }, + { + "id": "def-common.FieldFormatsRegistry.getDefaultTypeName", + "type": "Function", "children": [ { - "type": "Any", - "label": "fieldFormat", + "type": "Enum", + "label": "fieldType", "isRequired": true, "signature": [ - "any" + { + "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_format.ts", - "lineNumber": 204, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 148 + } + }, + { + "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 } } ], - "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", - "tags": [], - "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": [ - { - "tags": [], - "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": [ + "(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": "kibDataFieldFormatsPluginApi", - "section": "def-common.FIELD_FORMAT_IDS", - "text": "FIELD_FORMAT_IDS" + "docId": "kibDataPluginApi", + "section": "def-common.ES_FIELD_TYPES", + "text": "ES_FIELD_TYPES" } - ] - }, - { - "tags": [], - "id": "def-common.BoolFormat.title", - "type": "string", - "label": "title", - "description": [], + ], + "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/converters/boolean.ts", - "lineNumber": 17, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L17" - } + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 147 + }, + "tags": [ + "return" + ], + "returnComment": [] }, { - "tags": [], - "id": "def-common.BoolFormat.fieldType", - "type": "Array", - "label": "fieldType", - "description": [], + "tags": [ + "return" + ], + "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/converters/boolean.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L20" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 162 }, "signature": [ + "((formatId: string, params?: Record) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, - "[]" + ") & _.MemoizedFunction" ] }, { - "id": "def-common.BoolFormat.textConvert", + "id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain", "type": "Function", "children": [ { - "type": "Any", - "label": "value", + "type": "Enum", + "label": "fieldType", "isRequired": true, "signature": [ - "any" + { + "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/converters/boolean.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L22" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 187 + } + }, + { + "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 + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 189 } } ], "signature": [ - "(value: any) => string" + "(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": [], - "label": "textConvert", + "description": [ + "\nGet the default fieldFormat instance for a field format.\n" + ], + "label": "getDefaultInstancePlain", "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 186 }, - "tags": [], + "tags": [ + "return" + ], "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", - "tags": [], - "label": "BytesFormat", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.BytesFormat", - "text": "BytesFormat" }, - " extends ", - "NumeralFormat" - ], - "children": [ { - "tags": [], - "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" - }, + "id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver", + "type": "Function", + "label": "getDefaultInstanceCacheResolver", "signature": [ + "(fieldType: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FIELD_FORMAT_IDS", - "text": "FIELD_FORMAT_IDS" - } - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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": [ + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + ", esTypes: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FIELD_FORMAT_IDS", - "text": "FIELD_FORMAT_IDS" + "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 + } + }, + { + "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 + } } - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.BytesFormat.allowsNumericalAggregations", - "type": "boolean", - "label": "allowsNumericalAggregations", - "description": [], + ], + "tags": [ + "return" + ], + "returnComment": [], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 210 } - } - ], - "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", - "tags": [], - "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": [ { - "tags": [], - "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" - }, + "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.FIELD_FORMAT_IDS", - "text": "FIELD_FORMAT_IDS" + "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 + } } - ] - }, - { - "tags": [], - "id": "def-common.ColorFormat.title", - "type": "string", - "label": "title", - "description": [], + ], + "tags": [ + "return" + ], + "returnComment": [], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 223 } }, { - "tags": [], - "id": "def-common.ColorFormat.fieldType", - "type": "Array", - "label": "fieldType", - "description": [], + "tags": [ + "return" + ], + "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/converters/color.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L24" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 242 }, "signature": [ + "((fieldType: ", { "pluginId": "data", "scope": "common", @@ -2028,111 +2186,120 @@ "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.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", + "id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap", "type": "Function", - "label": "findColorRuleForVal", + "label": "parseDefaultTypeMap", "signature": [ - "(val: any) => any" + "(value: any) => void" ], "description": [], "children": [ { "type": "Any", - "label": "val", + "label": "value", "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 244 } } ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 244 } }, { - "id": "def-common.ColorFormat.htmlConvert", + "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": "Any", - "label": "val", + "type": "Array", + "label": "fieldFormats", "isRequired": true, "signature": [ - "any" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatInstanceType", + "text": "FieldFormatInstanceType" + }, + "[]" ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 255 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 255 + } } ], "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" + "path": "src/plugins/data/common/field_formats/field_formats_registry.ts", + "lineNumber": 28 }, "initialIsOpen": false }, { - "id": "def-common.DurationFormat", + "id": "def-common.HistogramFormat", "type": "Class", "tags": [], - "label": "DurationFormat", + "label": "HistogramFormat", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.DurationFormat", - "text": "DurationFormat" + "section": "def-common.HistogramFormat", + "text": "HistogramFormat" }, " extends ", { @@ -2146,14 +2313,13 @@ "children": [ { "tags": [], - "id": "def-common.DurationFormat.id", + "id": "def-common.HistogramFormat.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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 18 }, "signature": [ { @@ -2167,26 +2333,13 @@ }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.DurationFormat.fieldType", + "id": "def-common.HistogramFormat.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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 19 }, "signature": [ { @@ -2200,82 +2353,75 @@ }, { "tags": [], - "id": "def-common.DurationFormat.inputFormats", - "type": "Array", - "label": "inputFormats", + "id": "def-common.HistogramFormat.title", + "type": "string", + "label": "title", "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; }[]" - ] + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 20 + } }, { "tags": [], - "id": "def-common.DurationFormat.outputFormats", - "type": "Array", - "label": "outputFormats", + "id": "def-common.HistogramFormat.id", + "type": "Enum", + "label": "id", "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 24 }, "signature": [ - "{ text: string; method: string; }[]" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FIELD_FORMAT_IDS", + "text": "FIELD_FORMAT_IDS" + } ] }, { "tags": [], - "id": "def-common.DurationFormat.allowsNumericalAggregations", - "type": "boolean", - "label": "allowsNumericalAggregations", + "id": "def-common.HistogramFormat.title", + "type": "string", + "label": "title", "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 25 } }, { - "id": "def-common.DurationFormat.isHuman", - "type": "Function", - "label": "isHuman", - "signature": [ - "() => boolean" - ], - "description": [], - "children": [], "tags": [], - "returnComment": [], + "id": "def-common.HistogramFormat.allowsNumericalAggregations", + "type": "boolean", + "label": "allowsNumericalAggregations", + "description": [], "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 26 } }, { - "id": "def-common.DurationFormat.getParamDefaults", + "id": "def-common.HistogramFormat.getParamDefaults", "type": "Function", "label": "getParamDefaults", "signature": [ - "() => { inputFormat: string; outputFormat: string; outputPrecision: number; }" + "() => { id: string; params: {}; }" ], "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 29 } }, { - "id": "def-common.DurationFormat.textConvert", + "id": "def-common.HistogramFormat.textConvert", "type": "Function", "children": [ { @@ -2287,9 +2433,8 @@ ], "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 36 } } ], @@ -2299,18 +2444,16 @@ "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 36 }, "tags": [], "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" + "path": "src/plugins/data/common/field_formats/converters/histogram.ts", + "lineNumber": 17 }, "initialIsOpen": false }, @@ -2346,8 +2489,7 @@ "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" + "lineNumber": 15 }, "signature": [ { @@ -2367,8 +2509,7 @@ "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" + "lineNumber": 16 } }, { @@ -2379,8 +2520,7 @@ "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" + "lineNumber": 19 }, "signature": [ { @@ -2406,8 +2546,7 @@ "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" + "lineNumber": 21 } } ], @@ -2418,8 +2557,7 @@ "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" + "lineNumber": 21 }, "tags": [], "returnComment": [] @@ -2427,8 +2565,7 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -2458,8 +2595,7 @@ "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" + "lineNumber": 14 }, "signature": [ { @@ -2479,8 +2615,7 @@ "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" + "lineNumber": 15 } }, { @@ -2491,8 +2626,7 @@ "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" + "lineNumber": 19 }, "signature": [ { @@ -2512,8 +2646,7 @@ "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" + "lineNumber": 20 } }, { @@ -2524,15 +2657,13 @@ "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" + "lineNumber": 21 } } ], "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" + "lineNumber": 13 }, "initialIsOpen": false }, @@ -2562,8 +2693,7 @@ "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" + "lineNumber": 15 }, "signature": [ { @@ -2583,8 +2713,7 @@ "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" + "lineNumber": 16 } }, { @@ -2595,8 +2724,7 @@ "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" + "lineNumber": 20 }, "signature": [ { @@ -2616,8 +2744,7 @@ "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" + "lineNumber": 21 } }, { @@ -2628,8 +2755,7 @@ "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" + "lineNumber": 22 } }, { @@ -2643,8 +2769,7 @@ "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" + "lineNumber": 24 }, "tags": [], "returnComment": [] @@ -2663,8 +2788,7 @@ "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" + "lineNumber": 29 } } ], @@ -2675,8 +2799,7 @@ "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" + "lineNumber": 29 }, "tags": [], "returnComment": [] @@ -2684,8 +2807,7 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -2721,8 +2843,7 @@ "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" + "lineNumber": 16 }, "signature": [ { @@ -2742,8 +2863,7 @@ "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" + "lineNumber": 17 } }, { @@ -2754,8 +2874,7 @@ "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" + "lineNumber": 20 }, "signature": [ { @@ -2781,8 +2900,7 @@ "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" + "lineNumber": 22 } } ], @@ -2793,8 +2911,7 @@ "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" + "lineNumber": 22 }, "tags": [], "returnComment": [] @@ -2802,8 +2919,7 @@ ], "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" + "lineNumber": 15 }, "initialIsOpen": false }, @@ -2839,8 +2955,7 @@ "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" + "lineNumber": 45 }, "signature": [ { @@ -2860,8 +2975,7 @@ "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" + "lineNumber": 46 } }, { @@ -2872,8 +2986,7 @@ "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" + "lineNumber": 47 }, "signature": [ { @@ -2899,8 +3012,7 @@ "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" + "lineNumber": 49 } } ], @@ -2911,8 +3023,7 @@ "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" + "lineNumber": 49 }, "tags": [], "returnComment": [] @@ -2931,8 +3042,7 @@ "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" + "lineNumber": 51 } }, { @@ -2952,8 +3062,7 @@ "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" + "lineNumber": 51 } } ], @@ -2972,8 +3081,7 @@ "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" + "lineNumber": 51 }, "tags": [], "returnComment": [] @@ -2981,8 +3089,7 @@ ], "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" + "lineNumber": 44 }, "initialIsOpen": false }, @@ -3018,144 +3125,7 @@ "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" - } - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, - "tags": [], - "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", - "tags": [], - "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": [ - { - "tags": [], - "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" + "lineNumber": 25 }, "signature": [ { @@ -3163,212 +3133,92 @@ "scope": "common", "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FIELD_FORMAT_IDS", - "text": "FIELD_FORMAT_IDS" - } - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, - "[]" - ] - }, - { - "tags": [], - "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" - } + "text": "FIELD_FORMAT_IDS" } - ], + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.StaticLookupFormat.title", + "type": "string", + "label": "title", + "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" + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 26 } }, { - "id": "def-common.UrlFormat.getParamDefaults", + "tags": [], + "id": "def-common.StaticLookupFormat.fieldType", + "type": "Array", + "label": "fieldType", + "description": [], + "source": { + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 29 + }, + "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": [ - "() => { type: string; urlTemplate: null; labelTemplate: null; width: null; height: null; }" + "() => { lookupEntries: {}[]; unknownKeyValue: 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" + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 36 } }, { - "id": "def-common.UrlFormat.textConvert", + "id": "def-common.StaticLookupFormat.textConvert", "type": "Function", "children": [ { "type": "Any", - "label": "value", + "label": "val", "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" + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 43 } } ], "signature": [ - "(value: any) => string" + "(val: any) => any" ], "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" - }, - "tags": [], - "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" + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 43 }, "tags": [], "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" + "path": "src/plugins/data/common/field_formats/converters/static_lookup.ts", + "lineNumber": 24 }, "initialIsOpen": false }, @@ -3404,8 +3254,7 @@ "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" + "lineNumber": 63 }, "signature": [ { @@ -3425,8 +3274,7 @@ "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" + "lineNumber": 64 } }, { @@ -3437,8 +3285,7 @@ "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" + "lineNumber": 67 }, "signature": [ { @@ -3459,8 +3306,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 83, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L83" + "lineNumber": 83 }, "signature": [ "({ kind: boolean; text: string; } | { kind: string; text: string; })[]" @@ -3479,8 +3325,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 85, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L85" + "lineNumber": 85 } }, { @@ -3497,8 +3342,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 105, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L105" + "lineNumber": 105 } } ], @@ -3509,8 +3353,7 @@ "label": "textConvert", "source": { "path": "src/plugins/data/common/field_formats/converters/string.ts", - "lineNumber": 105, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L105" + "lineNumber": 105 }, "tags": [], "returnComment": [] @@ -3518,8 +3361,7 @@ ], "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" + "lineNumber": 62 }, "initialIsOpen": false }, @@ -3555,8 +3397,7 @@ "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" + "lineNumber": 18 }, "signature": [ { @@ -3576,8 +3417,7 @@ "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" + "lineNumber": 19 } }, { @@ -3588,8 +3428,7 @@ "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" + "lineNumber": 22 }, "signature": [ { @@ -3615,8 +3454,7 @@ "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" + "lineNumber": 24 } } ], @@ -3627,8 +3465,7 @@ "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" + "lineNumber": 24 }, "tags": [], "returnComment": [] @@ -3636,24 +3473,23 @@ ], "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" + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.HistogramFormat", + "id": "def-common.UrlFormat", "type": "Class", "tags": [], - "label": "HistogramFormat", + "label": "UrlFormat", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.HistogramFormat", - "text": "HistogramFormat" + "section": "def-common.UrlFormat", + "text": "UrlFormat" }, " extends ", { @@ -3667,14 +3503,13 @@ "children": [ { "tags": [], - "id": "def-common.HistogramFormat.id", + "id": "def-common.UrlFormat.id", "type": "Enum", "label": "id", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L18" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 47 }, "signature": [ { @@ -3688,219 +3523,194 @@ }, { "tags": [], - "id": "def-common.HistogramFormat.fieldType", - "type": "Enum", - "label": "fieldType", - "description": [], - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L19" - }, - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - } - ] - }, - { - "tags": [], - "id": "def-common.HistogramFormat.title", + "id": "def-common.UrlFormat.title", "type": "string", "label": "title", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L20" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 48 } }, { "tags": [], - "id": "def-common.HistogramFormat.id", - "type": "Enum", - "label": "id", + "id": "def-common.UrlFormat.fieldType", + "type": "Array", + "label": "fieldType", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L24" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 51 }, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FIELD_FORMAT_IDS", - "text": "FIELD_FORMAT_IDS" - } + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + }, + "[]" ] }, { "tags": [], - "id": "def-common.HistogramFormat.title", - "type": "string", - "label": "title", + "id": "def-common.UrlFormat.urlTypes", + "type": "Array", + "label": "urlTypes", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L25" - } + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 61 + }, + "signature": [ + "{ kind: string; text: string; }[]" + ] }, { - "tags": [], - "id": "def-common.HistogramFormat.allowsNumericalAggregations", - "type": "boolean", - "label": "allowsNumericalAggregations", + "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 + } + } + ], + "tags": [], + "returnComment": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L26" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 63 } }, { - "id": "def-common.HistogramFormat.getParamDefaults", + "id": "def-common.UrlFormat.getParamDefaults", "type": "Function", "label": "getParamDefaults", "signature": [ - "() => { id: string; params: {}; }" + "() => { type: string; urlTemplate: null; labelTemplate: null; width: null; height: null; }" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L29" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 68 } }, { - "id": "def-common.HistogramFormat.textConvert", + "id": "def-common.UrlFormat.textConvert", "type": "Function", "children": [ { "type": "Any", - "label": "val", + "label": "value", "isRequired": true, "signature": [ "any" ], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L36" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 131 } } - ], - "signature": [ - "(val: any) => string" - ], - "description": [], - "label": "textConvert", - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L36" - }, - "tags": [], - "returnComment": [] - } - ], - "source": { - "path": "src/plugins/data/common/field_formats/converters/histogram.ts", - "lineNumber": 17, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/histogram.ts#L17" - }, - "initialIsOpen": false - }, - { - "id": "def-common.FieldFormatNotFoundError", - "type": "Class", - "tags": [], - "label": "FieldFormatNotFoundError", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatNotFoundError", - "text": "FieldFormatNotFoundError" - }, - " extends Error" - ], - "children": [ - { - "tags": [], - "id": "def-common.FieldFormatNotFoundError.formatId", - "type": "string", - "label": "formatId", + ], + "signature": [ + "(value: any) => string" + ], "description": [], + "label": "textConvert", "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" - } + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 131 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.FieldFormatNotFoundError.Unnamed", + "id": "def-common.UrlFormat.htmlConvert", "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], "children": [ { - "type": "string", - "label": "message", + "type": "Any", + "label": "rawValue", "isRequired": true, "signature": [ - "string" + "any" ], "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" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133 } }, { - "type": "string", - "label": "formatId", - "isRequired": true, + "type": "Object", + "label": "options", + "isRequired": false, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.HtmlContextTypeOptions", + "text": "HtmlContextTypeOptions" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133 } } ], - "tags": [], - "returnComment": [], + "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/errors.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11" - } + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 133 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "src/plugins/data/common/field_formats/converters/url.ts", + "lineNumber": 46 }, "initialIsOpen": false } @@ -3925,8 +3735,7 @@ "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" + "lineNumber": 13 } }, { @@ -3939,8 +3748,7 @@ "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" + "lineNumber": 13 } } ], @@ -3948,8 +3756,7 @@ "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" + "lineNumber": 13 }, "initialIsOpen": false } @@ -3970,8 +3777,7 @@ "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" + "lineNumber": 63 } }, { @@ -3982,8 +3788,7 @@ "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" + "lineNumber": 64 }, "signature": [ "Record" @@ -3997,8 +3802,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 65, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L65" + "lineNumber": 65 }, "signature": [ "boolean | undefined" @@ -4007,8 +3811,7 @@ ], "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" + "lineNumber": 62 }, "initialIsOpen": false } @@ -4024,50 +3827,12 @@ "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" + "lineNumber": 42 }, "initialIsOpen": false } ], "misc": [ - { - "id": "def-common.IFieldFormatsRegistry", - "type": "Type", - "label": "IFieldFormatsRegistry", - "tags": [], - "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?: ", - "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" - } - ], - "initialIsOpen": false - }, { "tags": [], "id": "def-common.baseFormatters", @@ -4076,8 +3841,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/constants/base_formatters.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/base_formatters.ts#L28" + "lineNumber": 28 }, "signature": [ "FieldFormatInstanceType", @@ -4086,46 +3850,36 @@ "initialIsOpen": false }, { - "tags": [], - "id": "def-common.HTML_CONTEXT_TYPE", - "type": "CompoundType", - "label": "HTML_CONTEXT_TYPE", + "id": "def-common.FieldFormatId", + "type": "Type", + "label": "FieldFormatId", + "tags": [ + "string" + ], "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 75 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "string" ], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.TEXT_CONTEXT_TYPE", - "type": "CompoundType", - "label": "TEXT_CONTEXT_TYPE", + "id": "def-common.FieldFormatsContentType", + "type": "Type", + "label": "FieldFormatsContentType", + "tags": [ + "public" + ], "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" + "path": "src/plugins/data/common/field_formats/types.ts", + "lineNumber": 14 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormatsContentType", - "text": "FieldFormatsContentType" - } + "\"html\" | \"text\"" ], "initialIsOpen": false }, @@ -4137,8 +3891,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 68, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L68" + "lineNumber": 68 }, "signature": [ "(key: string, defaultOverride: T | undefined) => T" @@ -4146,38 +3899,71 @@ "initialIsOpen": false }, { - "id": "def-common.FieldFormatsContentType", + "id": "def-common.FieldFormatsStartCommon", "type": "Type", - "label": "FieldFormatsContentType", - "tags": [ - "public" - ], + "label": "FieldFormatsStartCommon", + "tags": [], "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" + "lineNumber": 97 }, "signature": [ - "\"html\" | \"text\"" + "{ 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 }, { - "id": "def-common.FieldFormatId", - "type": "Type", - "label": "FieldFormatId", - "tags": [ - "string" - ], + "tags": [], + "id": "def-common.HTML_CONTEXT_TYPE", + "type": "CompoundType", + "label": "HTML_CONTEXT_TYPE", "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L75" + "path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts", + "lineNumber": 13 }, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" + } ], "initialIsOpen": false }, @@ -4189,8 +3975,7 @@ "description": [], "source": { "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 70, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L70" + "lineNumber": 70 }, "signature": [ "FieldFormat" @@ -4198,50 +3983,58 @@ "initialIsOpen": false }, { - "id": "def-common.FieldFormatsStartCommon", + "id": "def-common.IFieldFormatsRegistry", "type": "Type", - "label": "FieldFormatsStartCommon", + "label": "IFieldFormatsRegistry", "tags": [], "description": [], "source": { - "path": "src/plugins/data/common/field_formats/types.ts", - "lineNumber": 97, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L97" + "path": "src/plugins/data/common/field_formats/index.ts", + "lineNumber": 11 }, "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?: ", + "{ init: (getConfig: ", { "pluginId": "data", "scope": "common", "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, - "[] | undefined) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (fieldType: ", + ", 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?: ", + } + ], + "initialIsOpen": false + }, + { + "tags": [], + "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 + }, + "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ES_FIELD_TYPES", - "text": "ES_FIELD_TYPES" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormatsContentType", + "text": "FieldFormatsContentType" } ], "initialIsOpen": false @@ -4261,8 +4054,7 @@ "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" + "lineNumber": 10 } }, { @@ -4273,8 +4065,7 @@ "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" + "lineNumber": 11 } }, { @@ -4285,8 +4076,7 @@ "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" + "lineNumber": 12 } }, { @@ -4297,8 +4087,7 @@ "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" + "lineNumber": 13 } } ], @@ -4306,8 +4095,7 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false } diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json index ab1a9cc2ca8fe..03cea4016aa4a 100644 --- a/api_docs/data_index_patterns.json +++ b/api_docs/data_index_patterns.json @@ -42,8 +42,7 @@ "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" + "lineNumber": 39 } }, { @@ -56,8 +55,7 @@ "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" + "lineNumber": 39 } } ], @@ -65,8 +63,7 @@ "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" + "lineNumber": 39 } }, { @@ -103,8 +100,7 @@ "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" + "lineNumber": 54 }, "signature": [ "string | string[]" @@ -118,8 +114,7 @@ "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" + "lineNumber": 55 }, "signature": [ "string[] | undefined" @@ -133,8 +128,7 @@ "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" + "lineNumber": 56 }, "signature": [ "{ allow_no_indices: boolean; } | undefined" @@ -148,8 +142,7 @@ "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" + "lineNumber": 57 }, "signature": [ "string | undefined" @@ -163,8 +156,7 @@ "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" + "lineNumber": 58 }, "signature": [ "string | undefined" @@ -173,21 +165,18 @@ ], "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" + "lineNumber": 53 } } ], "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" + "lineNumber": 53 } }, { @@ -224,8 +213,7 @@ "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" + "lineNumber": 116 } }, { @@ -236,8 +224,7 @@ "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" + "lineNumber": 117 }, "signature": [ "string[]" @@ -251,8 +238,7 @@ "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" + "lineNumber": 118 } }, { @@ -263,29 +249,24 @@ "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" + "lineNumber": 119 } } ], "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" + "lineNumber": 115 } } ], "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" + "lineNumber": 115 } }, { @@ -311,8 +292,7 @@ ], "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" + "lineNumber": 136 } } ], @@ -322,15 +302,13 @@ "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" + "lineNumber": 136 } } ], "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" + "lineNumber": 35 }, "initialIsOpen": false }, @@ -435,8 +413,7 @@ "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" + "lineNumber": 47 } }, { @@ -455,8 +432,7 @@ "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" + "lineNumber": 48 } } ], @@ -464,8 +440,7 @@ "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" + "lineNumber": 46 } }, { @@ -532,8 +507,7 @@ "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" + "lineNumber": 58 } }, { @@ -552,8 +526,7 @@ "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" + "lineNumber": 58 } } ], @@ -561,64 +534,60 @@ "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" + "lineNumber": 58 } } ], "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" + "lineNumber": 45 }, "initialIsOpen": false } ], "functions": [ { - "id": "def-server.shouldReadFieldFromDocValues", + "id": "def-server.getCapabilitiesForRollupIndices", "type": "Function", - "label": "shouldReadFieldFromDocValues", + "label": "getCapabilitiesForRollupIndices", "signature": [ - "(aggregatable: boolean, esType: string) => boolean" + "(indices: { [key: string]: any; }) => { [key: string]: any; }" ], "description": [], "children": [ { - "type": "boolean", - "label": "aggregatable", - "isRequired": true, - "signature": [ - "boolean" - ], + "id": "def-server.getCapabilitiesForRollupIndices.indices", + "type": "Object", + "label": "indices", + "tags": [], "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" + "children": [ + { + "id": "def-server.getCapabilitiesForRollupIndices.indices.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11 + }, + "signature": [ + "any" + ] + } ], - "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" + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11 } } ], "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" + "path": "src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts", + "lineNumber": 11 }, "initialIsOpen": false }, @@ -641,8 +610,7 @@ "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" + "lineNumber": 14 }, "signature": [ "any" @@ -651,8 +619,7 @@ ], "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" + "lineNumber": 14 } }, { @@ -670,8 +637,7 @@ "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" + "lineNumber": 15 }, "signature": [ "any" @@ -680,8 +646,7 @@ ], "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" + "lineNumber": 15 } }, { @@ -701,8 +666,7 @@ "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" + "lineNumber": 16 } } ], @@ -729,58 +693,53 @@ "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" + "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-server.getCapabilitiesForRollupIndices", + "id": "def-server.shouldReadFieldFromDocValues", "type": "Function", - "label": "getCapabilitiesForRollupIndices", + "label": "shouldReadFieldFromDocValues", "signature": [ - "(indices: { [key: string]: any; }) => { [key: string]: any; }" + "(aggregatable: boolean, esType: string) => boolean" ], "description": [], "children": [ { - "id": "def-server.getCapabilitiesForRollupIndices.indices", - "type": "Object", - "label": "indices", - "tags": [], + "type": "boolean", + "label": "aggregatable", + "isRequired": true, + "signature": [ + "boolean" + ], "description": [], - "children": [ - { - "id": "def-server.getCapabilitiesForRollupIndices.indices.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "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/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9 + } + }, + { + "type": "string", + "label": "esType", + "isRequired": true, + "signature": [ + "string" ], + "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" + "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9 } } ], "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" + "path": "src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts", + "lineNumber": 9 }, "initialIsOpen": false } @@ -801,8 +760,7 @@ "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" + "lineNumber": 21 } }, { @@ -813,8 +771,7 @@ "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" + "lineNumber": 22 } }, { @@ -825,8 +782,7 @@ "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" + "lineNumber": 23 } }, { @@ -837,8 +793,7 @@ "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" + "lineNumber": 24 } }, { @@ -849,8 +804,7 @@ "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" + "lineNumber": 25 } }, { @@ -861,8 +815,7 @@ "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" + "lineNumber": 26 }, "signature": [ "string[]" @@ -876,8 +829,7 @@ "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" + "lineNumber": 27 }, "signature": [ "FieldSubType | undefined" @@ -886,8 +838,7 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, @@ -906,8 +857,7 @@ "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" + "lineNumber": 21 } }, { @@ -918,8 +868,7 @@ "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" + "lineNumber": 22 } }, { @@ -930,8 +879,7 @@ "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" + "lineNumber": 23 } }, { @@ -942,8 +890,7 @@ "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" + "lineNumber": 24 } }, { @@ -954,8 +901,7 @@ "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" + "lineNumber": 25 } }, { @@ -966,8 +912,7 @@ "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" + "lineNumber": 26 }, "signature": [ "string[]" @@ -981,8 +926,7 @@ "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" + "lineNumber": 27 }, "signature": [ "FieldSubType | undefined" @@ -991,8 +935,7 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false } @@ -1004,35 +947,24 @@ "common": { "classes": [ { - "id": "def-common.IndexPatternsService", + "id": "def-common.DuplicateIndexPatternError", "type": "Class", "tags": [], - "label": "IndexPatternsService", + "label": "DuplicateIndexPatternError", "description": [], - "children": [ + "signature": [ { - "tags": [], - "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" - } - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.DuplicateIndexPatternError", + "text": "DuplicateIndexPatternError" }, + " extends Error" + ], + "children": [ { - "id": "def-common.IndexPatternsService.Unnamed", + "id": "def-common.DuplicateIndexPatternError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -1041,588 +973,749 @@ "description": [], "children": [ { - "type": "Object", - "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", + "type": "string", + "label": "message", "isRequired": true, "signature": [ - "IndexPatternsServiceDeps" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10 } } ], "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" + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 10 } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPattern", + "type": "Class", + "tags": [], + "label": "IndexPattern", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, + " implements ", { - "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", + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + } + ], + "children": [ + { + "tags": [], + "id": "def-common.IndexPattern.id", + "type": "string", + "label": "id", + "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 45 }, + "signature": [ + "string | undefined" + ] + }, + { "tags": [], - "returnComment": [] + "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 + } }, { - "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" - } - } - ], + "tags": [], + "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 + }, "signature": [ - "(refresh?: boolean) => Promise" - ], + "Record" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.typeMeta", + "type": "Object", + "label": "typeMeta", "description": [ - "\nGet list of index pattern titles" + "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" ], - "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 51 }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.IndexPatternsService.find", - "type": "Function", - "children": [ + "signature": [ { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.TypeMeta", + "text": "TypeMeta" }, - { - "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" - } - } - ], + " | undefined" + ] + }, + { + "tags": [], + "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 + }, "signature": [ - "(search: string, size?: number) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" }, - "[]>" + " & { toSpec: () => Record; }" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "deprecated" ], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPattern.type", + "type": "string", + "label": "type", "description": [ - "\nFind and load index patterns by title" + "\nType is used to identify rollup index patterns" ], - "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 62 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 }, + "signature": [ + "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + ] + }, + { "tags": [], - "returnComment": [ - "IndexPattern[]" + "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 + }, + "signature": [ + "FormatFieldFn" ] }, { - "id": "def-common.IndexPatternsService.getIdsWithTitle", + "tags": [], + "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 + }, + "signature": [ + "(hit: Record, deep?: boolean | undefined) => Record" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.SourceFilter", + "text": "SourceFilter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "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 + } + }, + { + "id": "def-common.IndexPattern.Unnamed", "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { - "type": "boolean", - "label": "refresh", + "type": "Object", + "label": "{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }", "isRequired": true, "signature": [ - "boolean" + "IndexPatternDeps" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 86 + } + }, + { + "id": "def-common.IndexPattern.getOriginalSavedObjectBody", + "type": "Function", + "children": [], "signature": [ - "(refresh?: boolean) => Promise<{ id: string; title: string; }[]>" + "() => { 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 list of index pattern ids with titles" + "\nGet last saved saved object fields" ], - "label": "getIdsWithTitle", + "label": "getOriginalSavedObjectBody", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 128 }, "tags": [], "returnComment": [] }, { - "id": "def-common.IndexPatternsService.clearCache", + "id": "def-common.IndexPattern.resetOriginalSavedObjectBody", "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" - } - } - ], + "children": [], "signature": [ - "(id?: string | undefined) => void" + "() => void" ], "description": [ - "\nClear index pattern list cache" + "\nReset last saved saved object fields. used after saving" ], - "label": "clearCache", + "label": "resetOriginalSavedObjectBody", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 133 }, "tags": [], "returnComment": [] }, { - "id": "def-common.IndexPatternsService.getCache", + "id": "def-common.IndexPattern.getFieldAttrs", "type": "Function", "children": [], "signature": [ - "() => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", + "() => { [x: string]: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSavedObjectAttrs", - "text": "IndexPatternSavedObjectAttrs" + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - ">[] | null | undefined>" + "; }" ], "description": [], - "label": "getCache", + "label": "getFieldAttrs", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 137 }, "tags": [], "returnComment": [] }, { - "id": "def-common.IndexPatternsService.getDefault", + "id": "def-common.IndexPattern.getComputedFields", "type": "Function", - "children": [], + "label": "getComputedFields", "signature": [ - "() => Promise<", + "() => { 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 + } + }, + { + "id": "def-common.IndexPattern.toSpec", + "type": "Function", + "label": "toSpec", + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ], "description": [ - "\nGet default index pattern" + "\nCreate static representation of index pattern" ], - "label": "getDefault", + "children": [], + "tags": [], + "returnComment": [], "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" - }, + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 208 + } + }, + { + "id": "def-common.IndexPattern.getSourceFiltering", + "type": "Function", + "label": "getSourceFiltering", + "signature": [ + "() => { excludes: any[]; }" + ], + "description": [ + "\nGet the source filtering configuration for that index." + ], + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 230 + } }, { - "id": "def-common.IndexPatternsService.setDefault", + "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": "id", + "label": "name", "isRequired": true, "signature": [ "string" ], - "description": [], + "description": [ + "field name" + ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 } }, { - "type": "boolean", - "label": "force", + "type": "string", + "label": "script", "isRequired": true, "signature": [ - "boolean" + "string" + ], + "description": [ + "script code" ], - "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.IndexPatternsService.getFieldsForWildcard", - "type": "Function", - "children": [ + }, { - "type": "Object", - "label": "options", + "type": "string", + "label": "fieldType", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" - } + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 } } ], - "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" - }, "tags": [], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 244 + } }, { - "id": "def-common.IndexPatternsService.getFieldsForIndexPattern", + "id": "def-common.IndexPattern.removeScriptedField", "type": "Function", + "label": "removeScriptedField", + "signature": [ + "(fieldName: string) => void" + ], + "description": [ + "\nRemove scripted field from field list" + ], "children": [ { - "type": "CompoundType", - "label": "indexPattern", + "type": "string", + "label": "fieldName", "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" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 270 + } + }, + { + "id": "def-common.IndexPattern.getNonScriptedFields", + "type": "Function", + "label": "getNonScriptedFields", "signature": [ - "(indexPattern: ", + "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "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 + } + }, + { + "id": "def-common.IndexPattern.getScriptedFields", + "type": "Function", + "label": "getScriptedFields", + "signature": [ + "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - ", 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", + "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - }, + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 281 + } + }, + { + "id": "def-common.IndexPattern.isTimeBased", + "type": "Function", + "label": "isTimeBased", + "signature": [ + "() => boolean" + ], + "description": [], + "children": [], "tags": [], - "returnComment": [ - "FieldSpec[]" - ] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 285 + } }, { - "id": "def-common.IndexPatternsService.refreshFields", + "id": "def-common.IndexPattern.isTimeNanosBased", "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" - } - } + "label": "isTimeNanosBased", + "signature": [ + "() => boolean" ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 289 + } + }, + { + "id": "def-common.IndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", "signature": [ - "(indexPattern: ", + "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - ") => Promise" - ], - "description": [ - "\nRefresh field list for a given index pattern" + " | undefined" ], - "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" - }, + "description": [], + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 294 + } }, { - "id": "def-common.IndexPatternsService.fieldArrayToMap", + "id": "def-common.IndexPattern.getFieldByName", "type": "Function", - "children": [ + "label": "getFieldByName", + "signature": [ + "(name: string) => ", { - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, + " | undefined" + ], + "description": [], + "children": [ { - "type": "Object", - "label": "fieldAttrs", - "isRequired": false, + "type": "string", + "label": "name", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 299 + } + }, + { + "id": "def-common.IndexPattern.getAggregationRestrictions", + "type": "Function", + "label": "getAggregationRestrictions", "signature": [ - "(fields: ", + "() => Record> | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 304 + } + }, + { + "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 + } + }, + { + "id": "def-common.IndexPattern.getFormatterForField", + "type": "Function", + "label": "getFormatterForField", + "signature": [ + "(field: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.IFieldType", + "text": "IFieldType" }, - "[], fieldAttrs?: ", + " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, - " | undefined) => Record" + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + } ], "description": [ - "\nConverts field array to map" + "\nProvide a field, get its formatter" ], - "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" - }, - "tags": [], - "returnComment": [ - "Record" - ] - }, - { - "id": "def-common.IndexPatternsService.savedObjectToSpec", - "type": "Function", "children": [ { - "type": "Object", - "label": "savedObject", + "type": "CompoundType", + "label": "field", "isRequired": true, "signature": [ { - "pluginId": "core", + "pluginId": "data", "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - "<", + " | ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" + "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_patterns.ts", - "lineNumber": 343, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 340 } } ], - "signature": [ - "(savedObject: ", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "<", + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 339 + } + }, + { + "id": "def-common.IndexPattern.addRuntimeField", + "type": "Function", + "label": "addRuntimeField", + "signature": [ + "(name: string, runtimeField: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternAttributes", - "text": "IndexPatternAttributes" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - ">) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - } + ") => void" ], "description": [ - "\nConverts index pattern saved object to index pattern spec" + "\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate" ], - "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" - }, - "tags": [], - "returnComment": [ - "IndexPatternSpec" - ] - }, - { - "id": "def-common.IndexPatternsService.get", - "type": "Function", "children": [ { "type": "string", - "label": "id", + "label": "name", "isRequired": true, "signature": [ "string" ], - "description": [], + "description": [ + "Field name" + ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 + } + }, + { + "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 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 360 + } + }, + { + "id": "def-common.IndexPattern.removeRuntimeField", + "type": "Function", + "label": "removeRuntimeField", "signature": [ - "(id: string) => Promise<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ">" + "(name: string) => void" ], "description": [ - "\nGet an index pattern by id. Cache optimized" + "\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 + } + } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 384 + } }, { - "id": "def-common.IndexPatternsService.create", + "id": "def-common.IndexPattern.getFormatterForFieldNoDefault", "type": "Function", - "label": "create", + "label": "getFormatterForFieldNoDefault", "signature": [ - "(spec: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", skipFetchFields?: boolean) => Promise<", + "(fieldname: string) => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" }, - ">" + " | undefined" ], "description": [ - "\nCreate a new index pattern instance" + "\nGet formatter for a given field name. Return undefined if none exists" ], "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", + "type": "string", + "label": "fieldname", "isRequired": true, "signature": [ - "boolean" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 } } ], "tags": [], - "returnComment": [ - "IndexPattern" - ], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 404 } }, { - "id": "def-common.IndexPatternsService.createAndSave", + "id": "def-common.IndexPattern.setFieldAttrs", "type": "Function", - "label": "createAndSave", + "label": "setFieldAttrs", "signature": [ - "(spec: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - }, - ", override?: boolean, skipFetchFields?: boolean) => Promise<", + "(fieldName: string, attrName: K, value: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.FieldAttrSet", + "text": "FieldAttrSet" }, - ">" - ], - "description": [ - "\nCreate a new index pattern and save it right away" + "[K]) => void" ], + "description": [], "children": [ { - "type": "Object", - "label": "spec", + "type": "string", + "label": "fieldName", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - } + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 412 } }, { - "type": "boolean", - "label": "override", + "type": "Uncategorized", + "label": "attrName", "isRequired": true, "signature": [ - "boolean" - ], - "description": [ - "Overwrite if existing index pattern exists." + "K" ], + "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 413 } }, { - "type": "boolean", - "label": "skipFetchFields", + "type": "Uncategorized", + "label": "value", "isRequired": true, "signature": [ - "boolean" - ], - "description": [ - "Whether to skip field refresh step." + { + "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_patterns.ts", - "lineNumber": 508, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 414 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 411 } }, { - "id": "def-common.IndexPatternsService.createSavedObject", + "id": "def-common.IndexPattern.setFieldCustomLabel", "type": "Function", - "label": "createSavedObject", + "label": "setFieldCustomLabel", "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" + "(fieldName: string, customLabel: string | null | undefined) => void" ], + "description": [], "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "string", + "label": "fieldName", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 } }, { - "type": "boolean", - "label": "override", - "isRequired": true, + "type": "CompoundType", + "label": "customLabel", + "isRequired": false, "signature": [ - "boolean" - ], - "description": [ - "Overwrite if existing index pattern exists" + "string | null | undefined" ], + "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 422 } }, { - "id": "def-common.IndexPatternsService.updateSavedObject", + "id": "def-common.IndexPattern.setFieldCount", "type": "Function", - "label": "updateSavedObject", + "label": "setFieldCount", "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" + "(fieldName: string, count: number | null | undefined) => void" ], + "description": [], "children": [ { - "type": "Object", - "label": "indexPattern", + "type": "string", + "label": "fieldName", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - } + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 } }, { - "type": "number", - "label": "saveAttempts", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 433 + } + }, + { + "id": "def-common.IndexPattern.setFieldFormat", + "type": "Function", + "children": [ + { + "type": "string", + "label": "fieldName", "isRequired": true, "signature": [ - "number" + "string" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 } }, { - "type": "boolean", - "label": "ignoreErrors", + "type": "Object", + "label": "format", "isRequired": true, "signature": [ - "boolean" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 } } ], - "tags": [], - "returnComment": [], + "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_patterns.ts", - "lineNumber": 546, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 446 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.IndexPatternsService.delete", + "id": "def-common.IndexPattern.deleteFieldFormat", "type": "Function", - "label": "delete", - "signature": [ - "(indexPatternId: string) => Promise<{}>" - ], - "description": [ - "\nDeletes an index pattern from .kibana index" - ], "children": [ { "type": "string", - "label": "indexPatternId", + "label": "fieldName", "isRequired": true, "signature": [ "string" ], - "description": [ - ": Id of kibana Index Pattern to delete" - ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(fieldName: string) => void" + ], + "description": [], + "label": "deleteFieldFormat", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 450 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts", + "lineNumber": 44 }, "initialIsOpen": false }, { - "id": "def-common.IndexPattern", + "id": "def-common.IndexPatternField", "type": "Class", "tags": [], - "label": "IndexPattern", + "label": "IndexPatternField", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" }, " implements ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.IFieldType", + "text": "IFieldType" } ], "children": [ { "tags": [], - "id": "def-common.IndexPattern.id", - "type": "string", - "label": "id", + "id": "def-common.IndexPatternField.spec", + "type": "Object", + "label": "spec", "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 17 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } ] }, { - "tags": [], - "id": "def-common.IndexPattern.title", - "type": "string", - "label": "title", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 21 } }, { + "id": "def-common.IndexPatternField.count", + "type": "number", + "label": "count", "tags": [], - "id": "def-common.IndexPattern.fieldFormatMap", - "type": "Object", - "label": "fieldFormatMap", - "description": [], + "description": [ + "\nCount is used for field popularity" + ], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 31 + } }, { + "id": "def-common.IndexPatternField.count", + "type": "number", + "label": "count", "tags": [], - "id": "def-common.IndexPattern.typeMeta", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 35 + } + }, + { + "id": "def-common.IndexPatternField.runtimeField", "type": "Object", - "label": "typeMeta", - "description": [ - "\nOnly used by rollup indices, used by rollup specific endpoint to load field list" - ], + "label": "runtimeField", + "tags": [], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 39 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.TypeMeta", - "text": "TypeMeta" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, " | undefined" ] }, { + "id": "def-common.IndexPatternField.runtimeField", + "type": "Object", + "label": "runtimeField", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 43 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPatternFieldList", - "text": "IIndexPatternFieldList" - }, - " & { toSpec: () => Record; }" + " | undefined" ] }, { - "tags": [], - "id": "def-common.IndexPattern.timeFieldName", + "id": "def-common.IndexPatternField.script", "type": "string", - "label": "timeFieldName", - "description": [], + "label": "script", + "tags": [], + "description": [ + "\nScript field code" + ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 50 }, "signature": [ "string | undefined" ] }, { - "tags": [ - "deprecated" - ], - "id": "def-common.IndexPattern.intervalName", + "id": "def-common.IndexPatternField.script", "type": "string", - "label": "intervalName", + "label": "script", + "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 54 }, "signature": [ "string | undefined" ] }, { - "tags": [], - "id": "def-common.IndexPattern.type", + "id": "def-common.IndexPatternField.lang", "type": "string", - "label": "type", + "label": "lang", + "tags": [], "description": [ - "\nType is used to identify rollup index patterns" + "\nScript field language" ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 61 }, "signature": [ "string | undefined" ] }, { + "id": "def-common.IndexPatternField.lang", + "type": "string", + "label": "lang", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 65 }, "signature": [ - "{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }" + "string | undefined" ] }, { + "id": "def-common.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 69 }, "signature": [ - "FormatFieldFn" + "string | undefined" ] }, { + "id": "def-common.IndexPatternField.customLabel", + "type": "string", + "label": "customLabel", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 73 }, "signature": [ - "(hit: Record, deep?: boolean | undefined) => Record" + "string | undefined" ] }, { + "id": "def-common.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", "tags": [], - "id": "def-common.IndexPattern.metaFields", - "type": "Array", - "label": "metaFields", - "description": [], + "description": [ + "\nDescription of field type conflicts across different indices in the same index pattern" + ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 80 }, "signature": [ - "string[]" + "Record | undefined" ] }, { + "id": "def-common.IndexPatternField.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", "tags": [], - "id": "def-common.IndexPattern.version", - "type": "string", - "label": "version", - "description": [ - "\nSavedObject version" - ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 84 }, "signature": [ - "string | undefined" + "Record | undefined" ] }, { + "id": "def-common.IndexPatternField.name", + "type": "string", + "label": "name", "tags": [], - "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 89 + } }, { + "id": "def-common.IndexPatternField.displayName", + "type": "string", + "label": "displayName", "tags": [], - "id": "def-common.IndexPattern.allowNoIndex", - "type": "boolean", - "label": "allowNoIndex", - "description": [ - "\nprevents errors when index pattern exists before indices" - ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 93 } }, { - "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" - } - } - ], + "id": "def-common.IndexPatternField.type", + "type": "string", + "label": "type", "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 101 } }, { - "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", + "id": "def-common.IndexPatternField.esTypes", + "type": "Array", + "label": "esTypes", + "tags": [], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 107 }, - "tags": [], - "returnComment": [] + "signature": [ + "string[] | undefined" + ] }, { - "id": "def-common.IndexPattern.resetOriginalSavedObjectBody", - "type": "Function", - "children": [], - "signature": [ - "() => void" - ], - "description": [ - "\nReset last saved saved object fields. used after saving" - ], - "label": "resetOriginalSavedObjectBody", + "id": "def-common.IndexPatternField.scripted", + "type": "boolean", + "label": "scripted", + "tags": [], + "description": [], "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" - }, + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 111 + } + }, + { + "id": "def-common.IndexPatternField.searchable", + "type": "boolean", + "label": "searchable", "tags": [], - "returnComment": [] + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 115 + } }, { - "id": "def-common.IndexPattern.getFieldAttrs", - "type": "Function", - "children": [], - "signature": [ - "() => { [x: string]: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "; }" - ], + "id": "def-common.IndexPatternField.aggregatable", + "type": "boolean", + "label": "aggregatable", + "tags": [], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 119 + } }, { - "id": "def-common.IndexPattern.getComputedFields", - "type": "Function", - "label": "getComputedFields", - "signature": [ - "() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }" - ], - "description": [], - "children": [], + "id": "def-common.IndexPatternField.readFromDocValues", + "type": "boolean", + "label": "readFromDocValues", "tags": [], - "returnComment": [], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 123 } }, { - "id": "def-common.IndexPattern.toSpec", - "type": "Function", - "label": "toSpec", + "id": "def-common.IndexPatternField.subType", + "type": "Object", + "label": "subType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 127 + }, "signature": [ - "() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - } - ], + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" + ] + }, + { + "id": "def-common.IndexPatternField.isMapped", + "type": "CompoundType", + "label": "isMapped", + "tags": [], "description": [ - "\nCreate static representation of index pattern" + "\nIs the field part of the index mapping?" ], - "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" - } + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 134 + }, + "signature": [ + "boolean | undefined" + ] }, { - "id": "def-common.IndexPattern.getSourceFiltering", - "type": "Function", - "label": "getSourceFiltering", - "signature": [ - "() => { excludes: any[]; }" - ], - "description": [ - "\nGet the source filtering configuration for that index." - ], - "children": [], + "id": "def-common.IndexPatternField.sortable", + "type": "boolean", + "label": "sortable", "tags": [], - "returnComment": [], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 139 } }, { - "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" - } - } - ], + "id": "def-common.IndexPatternField.filterable", + "type": "boolean", + "label": "filterable", "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 146 } }, { - "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" - } - } - ], + "id": "def-common.IndexPatternField.visualizable", + "type": "boolean", + "label": "visualizable", "tags": [], - "returnComment": [], + "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 154 } }, { - "id": "def-common.IndexPattern.getNonScriptedFields", + "id": "def-common.IndexPatternField.deleteCount", "type": "Function", - "label": "getNonScriptedFields", + "label": "deleteCount", "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - "[]" + "() => void" ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 159 } }, { - "id": "def-common.IndexPattern.getScriptedFields", + "id": "def-common.IndexPatternField.toJSON", "type": "Function", - "label": "getScriptedFields", + "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.IndexPatternField", - "text": "IndexPatternField" + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" }, - "[]" - ], - "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" + " | undefined; customLabel: string | undefined; }" ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 163 } }, { - "id": "def-common.IndexPattern.getTimeField", + "id": "def-common.IndexPatternField.toSpec", "type": "Function", - "label": "getTimeField", + "label": "toSpec", "signature": [ - "() => ", + "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", { "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" + "section": "def-common.IFieldType", + "text": "IFieldType" }, " | ", { @@ -2882,1755 +2669,1384 @@ "docId": "kibDataFieldFormatsPluginApi", "section": "def-common.FieldFormat", "text": "FieldFormat" + }, + ") | undefined; }) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" } ], - "description": [ - "\nProvide a field, get its formatter" - ], + "description": [], "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" - }, - " | ", + "id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }", + "type": "Object", + "label": "{\n getFormatterForField,\n }", + "tags": [], + "description": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "tags": [], + "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 + }, + "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" + ] } ], - "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 183 } } ], "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" + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 181 } - }, + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/index_pattern_field.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternsService", + "type": "Class", + "tags": [], + "label": "IndexPatternsService", + "description": [], + "children": [ { - "id": "def-common.IndexPattern.addRuntimeField", + "tags": [], + "id": "def-common.IndexPatternsService.ensureDefaultIndexPattern", "type": "Function", - "label": "addRuntimeField", + "label": "ensureDefaultIndexPattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 67 + }, "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" + "section": "def-common.EnsureDefaultIndexPattern", + "text": "EnsureDefaultIndexPattern" + } + ] + }, + { + "id": "def-common.IndexPatternsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], + "description": [], "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", + "label": "{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - } - ], - "description": [ - "Runtime field definition" + "IndexPatternsServiceDeps" ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 69 } }, { - "id": "def-common.IndexPattern.removeRuntimeField", + "id": "def-common.IndexPatternsService.getIds", "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", + "type": "boolean", + "label": "refresh", "isRequired": true, "signature": [ - "string" - ], - "description": [ - "Field name" + "boolean" ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 } } ], - "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" + "(refresh?: boolean) => Promise" ], "description": [ - "\nGet formatter for a given field name. Return undefined if none exists" + "\nGet list of index pattern ids" ], + "label": "getIds", + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 108 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.getTitles", + "type": "Function", "children": [ { - "type": "string", - "label": "fieldname", + "type": "boolean", + "label": "refresh", "isRequired": true, "signature": [ - "string" + "boolean" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(refresh?: boolean) => Promise" + ], + "description": [ + "\nGet list of index pattern titles" + ], + "label": "getTitles", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 122 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.IndexPattern.setFieldAttrs", + "id": "def-common.IndexPatternsService.find", "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", + "label": "search", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 } }, { - "type": "Uncategorized", - "label": "value", + "type": "number", + "label": "size", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrSet", - "text": "FieldAttrSet" - }, - "[K]" + "number" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 } } ], - "tags": [], - "returnComment": [], + "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_pattern.ts", - "lineNumber": 411, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 138 + }, + "tags": [], + "returnComment": [ + "IndexPattern[]" + ] }, { - "id": "def-common.IndexPattern.setFieldCustomLabel", + "id": "def-common.IndexPatternsService.getIdsWithTitle", "type": "Function", - "label": "setFieldCustomLabel", - "signature": [ - "(fieldName: string, customLabel: string | null | undefined) => void" - ], - "description": [], "children": [ { - "type": "string", - "label": "fieldName", + "type": "boolean", + "label": "refresh", "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" + "boolean" ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 157 } } ], - "tags": [], - "returnComment": [], + "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_pattern.ts", - "lineNumber": 422, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 156 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.IndexPattern.setFieldCount", + "id": "def-common.IndexPatternsService.clearCache", "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", + "label": "id", "isRequired": false, "signature": [ - "number | null | undefined" + "string | 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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(id?: string | undefined) => void" + ], + "description": [ + "\nClear index pattern list cache" + ], + "label": "clearCache", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 175 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.IndexPattern.setFieldFormat", + "id": "def-common.IndexPatternsService.getCache", "type": "Function", - "children": [ + "children": [], + "signature": [ + "() => Promise<", { - "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" - } + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" }, + "<", { - "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" - } - } + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.IndexPatternsService.getDefault", + "type": "Function", + "children": [], "signature": [ - "(fieldName: string, format: ", + "() => Promise<", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - ">) => void" + " | null>" ], - "description": [], - "label": "setFieldFormat", + "description": [ + "\nGet default index pattern" + ], + "label": "getDefault", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 194 }, "tags": [], "returnComment": [] }, { - "id": "def-common.IndexPattern.deleteFieldFormat", + "id": "def-common.IndexPatternsService.setDefault", "type": "Function", "children": [ { "type": "string", - "label": "fieldName", + "label": "id", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 + } + }, + { + "type": "boolean", + "label": "force", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 } } ], "signature": [ - "(fieldName: string) => void" + "(id: string, force?: boolean) => Promise" ], - "description": [], - "label": "deleteFieldFormat", + "description": [ + "\nOptionally set default index pattern, unless force = true" + ], + "label": "setDefault", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 208 }, "tags": [], "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", - "tags": [], - "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": [ - { - "tags": [], - "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", + "id": "def-common.IndexPatternsService.getFieldsForWildcard", "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], "children": [ { "type": "Object", - "label": "spec", + "label": "options", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 } } ], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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": [ + "(options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - " | undefined" - ] - }, - { - "id": "def-common.IndexPatternField.script", - "type": "string", - "label": "script", - "tags": [], - "description": [ - "\nScript field code" + ") => Promise" ], - "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", - "tags": [], - "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", - "tags": [], "description": [ - "\nScript field language" + "\nGet field list by providing { pattern }" ], + "label": "getFieldsForWildcard", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 219 }, - "signature": [ - "string | undefined" + "tags": [], + "returnComment": [ + "FieldSpec[]" ] }, { - "id": "def-common.IndexPatternField.lang", - "type": "string", - "label": "lang", - "tags": [], - "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" - }, + "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 + } + }, + { + "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 + } + } + ], "signature": [ - "string | undefined" - ] - }, - { - "id": "def-common.IndexPatternField.customLabel", - "type": "string", - "label": "customLabel", - "tags": [], - "description": [], + "(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/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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 235 }, - "signature": [ - "string | undefined" - ] - }, - { - "id": "def-common.IndexPatternField.customLabel", - "type": "string", - "label": "customLabel", "tags": [], - "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" + "returnComment": [ + "FieldSpec[]" ] }, { - "id": "def-common.IndexPatternField.conflictDescriptions", - "type": "Object", - "label": "conflictDescriptions", - "tags": [], + "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 + } + } + ], + "signature": [ + "(indexPattern: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ") => Promise" + ], "description": [ - "\nDescription of field type conflicts across different indices in the same index pattern" + "\nRefresh field list for a given index pattern" ], + "label": "refreshFields", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 250 }, - "signature": [ - "Record | undefined" - ] + "tags": [], + "returnComment": [] }, { - "id": "def-common.IndexPatternField.conflictDescriptions", - "type": "Object", - "label": "conflictDescriptions", - "tags": [], - "description": [], + "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 + } + }, + { + "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 + } + } + ], + "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/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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 327 }, - "signature": [ - "Record | undefined" - ] - }, - { - "id": "def-common.IndexPatternField.name", - "type": "string", - "label": "name", "tags": [], - "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" - } + "returnComment": [ + "Record" + ] }, { - "id": "def-common.IndexPatternField.displayName", - "type": "string", - "label": "displayName", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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" - }, + "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 + } + } + ], "signature": [ + "(savedObject: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" + "section": "def-common.IndexPatternAttributes", + "text": "IndexPatternAttributes" }, - " | undefined" - ] - }, - { - "id": "def-common.IndexPatternField.isMapped", - "type": "CompoundType", - "label": "isMapped", - "tags": [], + ">) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } + ], "description": [ - "\nIs the field part of the index mapping?" + "\nConverts index pattern saved object to index pattern spec" ], + "label": "savedObjectToSpec", "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 343 }, - "signature": [ - "boolean | undefined" - ] - }, - { - "id": "def-common.IndexPatternField.sortable", - "type": "boolean", - "label": "sortable", - "tags": [], - "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", - "tags": [], - "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", "tags": [], - "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" - } + "returnComment": [ + "IndexPatternSpec" + ] }, { - "id": "def-common.IndexPatternField.deleteCount", + "id": "def-common.IndexPatternsService.get", "type": "Function", - "label": "deleteCount", - "signature": [ - "() => void" + "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 + } + } ], - "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: ", + "(id: string) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - " | undefined; customLabel: string | undefined; }" + ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], + "description": [ + "\nGet an index pattern by id. Cache optimized" + ], + "label": "get", "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" - } + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 464 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.IndexPatternField.toSpec", + "id": "def-common.IndexPatternsService.create", "type": "Function", - "label": "toSpec", + "label": "create", "signature": [ - "({ getFormatterForField, }?: { getFormatterForField?: ((field: ", + "(spec: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" }, - " | ", + ", skipFetchFields?: boolean) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - " | ", + ">" + ], + "description": [ + "\nCreate a new index pattern instance" + ], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "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 + } }, - ") => ", + { + "type": "boolean", + "label": "skipFetchFields", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 + } + } + ], + "tags": [], + "returnComment": [ + "IndexPattern" + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 483 + } + }, + { + "id": "def-common.IndexPatternsService.createAndSave", + "type": "Function", + "label": "createAndSave", + "signature": [ + "(spec: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" }, - ") | undefined; }) => ", + ", override?: boolean, skipFetchFields?: boolean) => Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - } + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ">" + ], + "description": [ + "\nCreate a new index pattern and save it right away" ], - "description": [], "children": [ { - "id": "def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }", "type": "Object", - "label": "{\n getFormatterForField,\n }", - "tags": [], - "description": [], - "children": [ + "label": "spec", + "isRequired": true, + "signature": [ { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" } ], + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 + } + }, + { + "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 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 508 } - } - ], - "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", - "tags": [], - "label": "DuplicateIndexPatternError", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.DuplicateIndexPatternError", - "text": "DuplicateIndexPatternError" }, - " extends Error" - ], - "children": [ { - "id": "def-common.DuplicateIndexPatternError.Unnamed", + "id": "def-common.IndexPatternsService.createSavedObject", "type": "Function", - "label": "Constructor", + "label": "createSavedObject", "signature": [ - "any" + "(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" ], - "description": [], "children": [ { - "type": "string", - "label": "message", + "type": "Object", + "label": "indexPattern", "isRequired": true, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 521 } - } - ], - "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, + "id": "def-common.IndexPatternsService.updateSavedObject", + "type": "Function", + "label": "updateSavedObject", "signature": [ + "(indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - "[]" - ], - "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" + ", saveAttempts?: number, ignoreErrors?: boolean) => Promise" ], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "id": "def-common.IndexPatternAttributes", - "type": "Interface", - "label": "IndexPatternAttributes", - "description": [ - "\nInterface for an index pattern saved object" - ], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.IndexPatternAttributes.allowNoIndex", - "type": "CompoundType", - "label": "allowNoIndex", "description": [ - "\nprevents errors when index pattern exists before indices" + "\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 + } + }, + { + "type": "number", + "label": "saveAttempts", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 548 + } + }, + { + "type": "boolean", + "label": "ignoreErrors", + "isRequired": true, + "signature": [ + "boolean" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 549 + } + } ], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { "tags": [], - "id": "def-common.IFieldType.aggregatable", - "type": "CompoundType", - "label": "aggregatable", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 546 + } }, { + "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 + } + } + ], "tags": [], - "id": "def-common.IFieldType.filterable", - "type": "CompoundType", - "label": "filterable", - "description": [], + "returnComment": [], "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" - ] - }, + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 632 + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 57 + }, + "initialIsOpen": false + } + ], + "functions": [ + { + "id": "def-common.fieldList", + "type": "Function", + "children": [ { - "tags": [], - "id": "def-common.IFieldType.searchable", - "type": "CompoundType", - "label": "searchable", + "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/types.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22" - }, - "signature": [ - "boolean | undefined" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 35 + } }, { - "tags": [], - "id": "def-common.IFieldType.sortable", - "type": "CompoundType", - "label": "sortable", + "type": "boolean", + "label": "shortDotsEnable", + "isRequired": true, + "signature": [ + "boolean" + ], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 36 + } + } + ], + "signature": [ + "(specs?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, + "[], shortDotsEnable?: boolean) => ", { - "tags": [], - "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" - ] + "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 + }, + "tags": [], + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.isFilterable", + "type": "Function", + "label": "isFilterable", + "signature": [ + "(field: ", { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, + ") => boolean" + ], + "description": [], + "children": [ { - "tags": [], - "id": "def-common.IFieldType.scripted", - "type": "CompoundType", - "label": "scripted", + "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/types.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26" - }, - "signature": [ - "boolean | undefined" - ] + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 14 + }, + "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": [ { - "tags": [], - "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" - }, + "label": "field", + "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" - }, - " | undefined" - ] - }, + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/utils.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.FieldAttrs", + "type": "Interface", + "label": "FieldAttrs", + "description": [], + "tags": [ + "intenal" + ], + "children": [ { + "id": "def-common.FieldAttrs.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 75 }, "signature": [ - "string | undefined" + "any" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 74 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FieldAttrSet", + "type": "Interface", + "label": "FieldAttrSet", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.IFieldType.customLabel", + "id": "def-common.FieldAttrSet.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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 79 }, "signature": [ "string | undefined" @@ -4638,712 +4054,495 @@ }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.IFieldType.toSpec", - "type": "Function", - "label": "toSpec", + "id": "def-common.FieldAttrSet.count", + "type": "number", + "label": "count", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 80 }, "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" - } + "number | undefined" ] } ], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 78 }, "initialIsOpen": false }, { - "id": "def-common.IIndexPatternFieldList", + "id": "def-common.FieldSpec", "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" - }, - "[]" + "label": "FieldSpec", + "description": [ + "\nSerialized version of IndexPatternField" ], - "description": [], "tags": [], "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" - }, - "[]" + "id": "def-common.FieldSpec.count", + "type": "number", + "label": "count", + "description": [ + "\nPopularity count is used by discover" ], - "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 190 + }, + "signature": [ + "number | undefined" + ] }, { - "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" + "tags": [], + "id": "def-common.FieldSpec.script", + "type": "string", + "label": "script", + "description": [ + "\nScripted field painless script" ], - "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" - } - } + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 194 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.FieldSpec.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 200 + }, + "signature": [ + "Record | undefined" + ] }, { - "id": "def-common.IIndexPatternFieldList.getByType", - "type": "Function", - "label": "getByType", + "tags": [], + "id": "def-common.FieldSpec.format", + "type": "Object", + "label": "format", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 201 + }, "signature": [ - "(type: string) => ", { - "pluginId": "data", + "pluginId": "expressions", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - "[]" - ], - "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" - } - } - ], + "> | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.FieldSpec.name", + "type": "string", + "label": "name", + "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 202 } }, { - "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": [], + "id": "def-common.FieldSpec.type", + "type": "string", + "label": "type", + "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 203 } }, { - "id": "def-common.IIndexPatternFieldList.removeAll", - "type": "Function", - "label": "removeAll", + "tags": [], + "id": "def-common.FieldSpec.esTypes", + "type": "Array", + "label": "esTypes", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 204 + }, "signature": [ - "() => void" - ], + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.scripted", + "type": "CompoundType", + "label": "scripted", "description": [], - "children": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 205 + }, + "signature": [ + "boolean | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.FieldSpec.searchable", + "type": "boolean", + "label": "searchable", + "description": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 206 } }, { - "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": [], + "id": "def-common.FieldSpec.aggregatable", + "type": "boolean", + "label": "aggregatable", + "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 207 } }, { - "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": [], + "id": "def-common.FieldSpec.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", + "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 208 + }, + "signature": [ + "boolean | undefined" + ] }, { - "id": "def-common.IIndexPatternFieldList.toSpec", - "type": "Function", - "label": "toSpec", + "tags": [], + "id": "def-common.FieldSpec.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 209 + }, "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" + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" }, - " | ", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.indexed", + "type": "CompoundType", + "label": "indexed", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 210 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.customLabel", + "type": "string", + "label": "customLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 211 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpec.runtimeField", + "type": "Object", + "label": "runtimeField", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 212 + }, + "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" + "section": "def-common.RuntimeField", + "text": "RuntimeField" }, - ") | 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" - } - } - ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 214 + }, + "signature": [ + "boolean | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.FieldSpec.isMapped", + "type": "CompoundType", + "label": "isMapped", + "description": [], "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" - } + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 215 + }, + "signature": [ + "boolean | undefined" + ] } ], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 186 }, "initialIsOpen": false }, { - "id": "def-common.RuntimeField", + "id": "def-common.FieldSpecExportFmt", "type": "Interface", - "label": "RuntimeField", + "label": "FieldSpecExportFmt", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.RuntimeField.type", - "type": "CompoundType", - "label": "type", + "id": "def-common.FieldSpecExportFmt.count", + "type": "number", + "label": "count", "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" + "lineNumber": 167 }, "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + "number | undefined" ] }, { "tags": [], - "id": "def-common.RuntimeField.script", - "type": "Object", + "id": "def-common.FieldSpecExportFmt.script", + "type": "string", "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" + "lineNumber": 168 }, "signature": [ - "{ source: string; } | undefined" + "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" - ], - "tags": [], - "children": [ + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.lang", + "type": "string", + "label": "lang", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 169 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.conflictDescriptions", + "type": "Object", + "label": "conflictDescriptions", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 170 + }, + "signature": [ + "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 171 + } + }, + { + "tags": [], + "id": "def-common.FieldSpecExportFmt.type", + "type": "Enum", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 172 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.KBN_FIELD_TYPES", + "text": "KBN_FIELD_TYPES" + } + ] + }, { "tags": [], - "id": "def-common.IIndexPattern.fields", + "id": "def-common.FieldSpecExportFmt.esTypes", "type": "Array", - "label": "fields", + "label": "esTypes", "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" + "lineNumber": 173 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - "[]" + "string[] | undefined" ] }, { "tags": [], - "id": "def-common.IIndexPattern.title", - "type": "string", - "label": "title", + "id": "def-common.FieldSpecExportFmt.scripted", + "type": "boolean", + "label": "scripted", "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" + "lineNumber": 174 } }, { "tags": [], - "id": "def-common.IIndexPattern.id", - "type": "string", - "label": "id", + "id": "def-common.FieldSpecExportFmt.searchable", + "type": "boolean", + "label": "searchable", "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" - ] + "lineNumber": 175 + } }, { "tags": [], - "id": "def-common.IIndexPattern.type", - "type": "string", - "label": "type", - "description": [ - "\nType is used for identifying rollup indices, otherwise left undefined" - ], + "id": "def-common.FieldSpecExportFmt.aggregatable", + "type": "boolean", + "label": "aggregatable", + "description": [], "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" - ] + "lineNumber": 176 + } }, { "tags": [], - "id": "def-common.IIndexPattern.timeFieldName", - "type": "string", - "label": "timeFieldName", + "id": "def-common.FieldSpecExportFmt.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", "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" + "lineNumber": 177 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { - "id": "def-common.IIndexPattern.getTimeField", - "type": "Function", - "label": "getTimeField", + "tags": [], + "id": "def-common.FieldSpecExportFmt.subType", + "type": "Object", + "label": "subType", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 178 + }, "signature": [ - "(() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" }, - " | 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" - } + " | undefined" + ] }, { "tags": [], - "id": "def-common.IIndexPattern.fieldFormatMap", + "id": "def-common.FieldSpecExportFmt.format", "type": "Object", - "label": "fieldFormatMap", + "label": "format", "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" + "lineNumber": 179 }, "signature": [ - "Record | undefined> | undefined" + "> | undefined" ] }, { "tags": [], - "id": "def-common.IIndexPattern.getFormatterForField", - "type": "Function", - "label": "getFormatterForField", - "description": [ - "\nLook up a formatter for a given field" - ], + "id": "def-common.FieldSpecExportFmt.indexed", + "type": "CompoundType", + "label": "indexed", + "description": [], "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" + "lineNumber": 180 }, "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" + "boolean | 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" + "lineNumber": 166 }, "initialIsOpen": false }, { - "id": "def-common.FieldAttrs", + "id": "def-common.GetFieldsOptions", "type": "Interface", - "label": "FieldAttrs", + "label": "GetFieldsOptions", "description": [], - "tags": [ - "intenal" - ], + "tags": [], "children": [ { - "id": "def-common.FieldAttrs.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-common.GetFieldsOptions.pattern", + "type": "string", + "label": "pattern", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 119 + } + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.type", + "type": "string", + "label": "type", "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" + "lineNumber": 120 }, "signature": [ - "any" + "string | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.FieldAttrSet.customLabel", + "id": "def-common.GetFieldsOptions.lookBack", + "type": "CompoundType", + "label": "lookBack", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 121 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.metaFields", + "type": "Array", + "label": "metaFields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 122 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.GetFieldsOptions.rollupIndex", "type": "string", - "label": "customLabel", + "label": "rollupIndex", "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" + "lineNumber": 123 }, "signature": [ "string | undefined" @@ -5467,149 +4650,194 @@ }, { "tags": [], - "id": "def-common.FieldAttrSet.count", - "type": "number", - "label": "count", + "id": "def-common.GetFieldsOptions.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", "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" + "lineNumber": 124 }, "signature": [ - "number | undefined" + "boolean | 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" + "lineNumber": 118 }, "initialIsOpen": false }, { - "id": "def-common.UiSettingsCommon", + "id": "def-common.GetFieldsOptionsTimePattern", "type": "Interface", - "label": "UiSettingsCommon", + "label": "GetFieldsOptionsTimePattern", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.UiSettingsCommon.get", - "type": "Function", - "label": "get", + "id": "def-common.GetFieldsOptionsTimePattern.pattern", + "type": "string", + "label": "pattern", "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" - ] + "lineNumber": 128 + } }, { "tags": [], - "id": "def-common.UiSettingsCommon.getAll", - "type": "Function", - "label": "getAll", + "id": "def-common.GetFieldsOptionsTimePattern.metaFields", + "type": "Array", + "label": "metaFields", "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" + "lineNumber": 129 }, "signature": [ - "() => Promise>" + "string[]" ] }, { "tags": [], - "id": "def-common.UiSettingsCommon.set", - "type": "Function", - "label": "set", + "id": "def-common.GetFieldsOptionsTimePattern.lookBack", + "type": "number", + "label": "lookBack", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 130 + } + }, + { + "tags": [], + "id": "def-common.GetFieldsOptionsTimePattern.interval", + "type": "string", + "label": "interval", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 131 + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 127 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IFieldSubType", + "type": "Interface", + "label": "IFieldSubType", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.IFieldSubType.multi", + "type": "Object", + "label": "multi", "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" + "lineNumber": 154 }, "signature": [ - "(key: string, value: any) => Promise" + "{ parent: string; } | undefined" ] }, { "tags": [], - "id": "def-common.UiSettingsCommon.remove", - "type": "Function", - "label": "remove", + "id": "def-common.IFieldSubType.nested", + "type": "Object", + "label": "nested", "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" + "lineNumber": 155 }, "signature": [ - "(key: string) => Promise" + "{ path: string; } | undefined" ] } ], "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" + "lineNumber": 153 }, "initialIsOpen": false }, { - "id": "def-common.SavedObjectsClientCommonFindArgs", + "id": "def-common.IFieldType", "type": "Interface", - "label": "SavedObjectsClientCommonFindArgs", + "label": "IFieldType", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.SavedObjectsClientCommonFindArgs.type", - "type": "CompoundType", + "id": "def-common.IFieldType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 12 + } + }, + { + "tags": [], + "id": "def-common.IFieldType.type", + "type": "string", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 13 + } + }, + { + "tags": [], + "id": "def-common.IFieldType.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 14 }, "signature": [ - "string | string[]" + "string | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommonFindArgs.fields", - "type": "Array", - "label": "fields", + "id": "def-common.IFieldType.lang", + "type": "string", + "label": "lang", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 15 }, "signature": [ - "string[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", + "id": "def-common.IFieldType.count", "type": "number", - "label": "perPage", + "label": "count", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 16 }, "signature": [ "number | undefined" @@ -5617,961 +4845,1055 @@ }, { "tags": [], - "id": "def-common.SavedObjectsClientCommonFindArgs.search", - "type": "string", - "label": "search", + "id": "def-common.IFieldType.esTypes", + "type": "Array", + "label": "esTypes", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 19 }, "signature": [ - "string | undefined" + "string[] | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", - "type": "Array", - "label": "searchFields", + "id": "def-common.IFieldType.aggregatable", + "type": "CompoundType", + "label": "aggregatable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 20 }, "signature": [ - "string[] | undefined" + "boolean | 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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.SavedObjectsClientCommon.find", - "type": "Function", - "label": "find", + "id": "def-common.IFieldType.filterable", + "type": "CompoundType", + "label": "filterable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 21 }, "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" - }, - "[]>" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommon.get", - "type": "Function", - "label": "get", + "id": "def-common.IFieldType.searchable", + "type": "CompoundType", + "label": "searchable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 22 }, "signature": [ - "(type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommon.update", - "type": "Function", - "label": "update", + "id": "def-common.IFieldType.sortable", + "type": "CompoundType", + "label": "sortable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 23 }, "signature": [ - "(type: string, id: string, attributes: Record, options: Record) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommon.create", - "type": "Function", - "label": "create", + "id": "def-common.IFieldType.visualizable", + "type": "CompoundType", + "label": "visualizable", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 24 }, "signature": [ - "(type: string, attributes: Record, options: Record) => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - ">" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.SavedObjectsClientCommon.delete", - "type": "Function", - "label": "delete", + "id": "def-common.IFieldType.readFromDocValues", + "type": "CompoundType", + "label": "readFromDocValues", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 25 }, "signature": [ - "(type: string, id: string) => Promise<{}>" + "boolean | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.GetFieldsOptions.pattern", - "type": "string", - "label": "pattern", + "id": "def-common.IFieldType.scripted", + "type": "CompoundType", + "label": "scripted", "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" - } + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 26 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-common.GetFieldsOptions.type", - "type": "string", - "label": "type", + "id": "def-common.IFieldType.subType", + "type": "Object", + "label": "subType", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 27 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldSubType", + "text": "IFieldSubType" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.GetFieldsOptions.lookBack", - "type": "CompoundType", - "label": "lookBack", + "id": "def-common.IFieldType.displayName", + "type": "string", + "label": "displayName", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 28 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.GetFieldsOptions.metaFields", - "type": "Array", - "label": "metaFields", + "id": "def-common.IFieldType.customLabel", + "type": "string", + "label": "customLabel", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 29 }, "signature": [ - "string[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.GetFieldsOptions.rollupIndex", - "type": "string", - "label": "rollupIndex", + "id": "def-common.IFieldType.format", + "type": "Any", + "label": "format", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 30 }, "signature": [ - "string | undefined" + "any" ] }, { "tags": [], - "id": "def-common.GetFieldsOptions.allowNoIndex", - "type": "CompoundType", - "label": "allowNoIndex", + "id": "def-common.IFieldType.toSpec", + "type": "Function", + "label": "toSpec", "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" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 31 }, "signature": [ - "boolean | undefined" + "((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/types.ts", - "lineNumber": 118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L118" + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-common.GetFieldsOptionsTimePattern", + "id": "def-common.IIndexPattern", "type": "Interface", - "label": "GetFieldsOptionsTimePattern", - "description": [], + "label": "IIndexPattern", + "description": [ + "\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided" + ], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.GetFieldsOptionsTimePattern.metaFields", + "id": "def-common.IIndexPattern.fields", "type": "Array", - "label": "metaFields", + "label": "fields", "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" + "lineNumber": 32 }, "signature": [ - "string[]" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + "[]" ] }, { "tags": [], - "id": "def-common.GetFieldsOptionsTimePattern.lookBack", - "type": "number", - "label": "lookBack", + "id": "def-common.IIndexPattern.title", + "type": "string", + "label": "title", "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" + "lineNumber": 33 } }, { "tags": [], - "id": "def-common.GetFieldsOptionsTimePattern.interval", + "id": "def-common.IIndexPattern.id", "type": "string", - "label": "interval", + "label": "id", "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": [], - "tags": [], - "children": [ + "lineNumber": 34 + }, + "signature": [ + "string | undefined" + ] + }, { "tags": [], - "id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern", - "type": "Function", - "label": "getFieldsForTimePattern", - "description": [], + "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": 135, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L135" + "lineNumber": 38 }, "signature": [ - "(options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptionsTimePattern", - "text": "GetFieldsOptionsTimePattern" - }, - ") => Promise" + "string | undefined" ] }, { "tags": [], - "id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard", - "type": "Function", - "label": "getFieldsForWildcard", + "id": "def-common.IIndexPattern.timeFieldName", + "type": "string", + "label": "timeFieldName", "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" + "lineNumber": 39 }, "signature": [ - "(options: ", + "string | undefined" + ] + }, + { + "id": "def-common.IIndexPattern.getTimeField", + "type": "Function", + "label": "getTimeField", + "signature": [ + "(() => ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.GetFieldsOptions", - "text": "GetFieldsOptions" + "section": "def-common.IFieldType", + "text": "IFieldType" }, - ") => 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": [], - "tags": [], - "children": [ + " | undefined) | undefined" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 40 + } + }, { "tags": [], - "id": "def-common.IFieldSubType.multi", + "id": "def-common.IIndexPattern.fieldFormatMap", "type": "Object", - "label": "multi", + "label": "fieldFormatMap", "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" + "lineNumber": 41 }, "signature": [ - "{ parent: string; } | undefined" + "Record | undefined> | undefined" ] }, { "tags": [], - "id": "def-common.IFieldSubType.nested", - "type": "Object", - "label": "nested", - "description": [], + "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": 155, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155" + "lineNumber": 45 }, "signature": [ - "{ path: string; } | undefined" + "((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": 153, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153" + "lineNumber": 31 }, "initialIsOpen": false }, { - "id": "def-common.TypeMeta", + "id": "def-common.IIndexPatternFieldList", "type": "Interface", - "label": "TypeMeta", - "description": [], - "tags": [], - "children": [ + "label": "IIndexPatternFieldList", + "signature": [ { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IIndexPatternFieldList", + "text": "IIndexPatternFieldList" }, + " extends ", { - "id": "def-common.TypeMeta.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "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" - ] - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + "[]" ], - "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": [], "tags": [], "children": [ { - "tags": [], - "id": "def-common.FieldSpecExportFmt.count", - "type": "number", - "label": "count", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 18 + } }, { - "tags": [], - "id": "def-common.FieldSpecExportFmt.script", - "type": "string", - "label": "script", + "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/types.ts", - "lineNumber": 168, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L168" - }, - "signature": [ - "string | undefined" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 19 + } }, { - "tags": [], - "id": "def-common.FieldSpecExportFmt.lang", - "type": "string", - "label": "lang", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 20 + } }, { - "tags": [], - "id": "def-common.FieldSpecExportFmt.conflictDescriptions", - "type": "Object", - "label": "conflictDescriptions", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 21 + } }, { + "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 + } + } + ], "tags": [], - "id": "def-common.FieldSpecExportFmt.name", - "type": "string", - "label": "name", + "returnComment": [], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 22 + } + }, + { + "id": "def-common.IIndexPatternFieldList.removeAll", + "type": "Function", + "label": "removeAll", + "signature": [ + "() => void" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 23 } }, { - "tags": [], - "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" - }, + "id": "def-common.IIndexPatternFieldList.replaceAll", + "type": "Function", + "label": "replaceAll", "signature": [ + "(specs: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.KBN_FIELD_TYPES", - "text": "KBN_FIELD_TYPES" - } - ] - }, - { - "tags": [], - "id": "def-common.FieldSpecExportFmt.esTypes", - "type": "Array", - "label": "esTypes", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + "[]) => void" + ], "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" - ] - }, - { + "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 + } + } + ], "tags": [], - "id": "def-common.FieldSpecExportFmt.scripted", - "type": "boolean", - "label": "scripted", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 24 } }, { - "tags": [], - "id": "def-common.FieldSpecExportFmt.searchable", - "type": "boolean", - "label": "searchable", + "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": [], - "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" - } - }, - { + "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 + } + } + ], "tags": [], - "id": "def-common.FieldSpecExportFmt.aggregatable", - "type": "boolean", - "label": "aggregatable", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 25 } }, { - "tags": [], - "id": "def-common.FieldSpecExportFmt.readFromDocValues", - "type": "CompoundType", - "label": "readFromDocValues", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] - }, + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 26 + } + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/fields/field_list.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IIndexPatternsApiClient", + "type": "Interface", + "label": "IIndexPatternsApiClient", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.FieldSpecExportFmt.subType", - "type": "Object", - "label": "subType", + "id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern", + "type": "Function", + "label": "getFieldsForTimePattern", "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" + "lineNumber": 135 }, "signature": [ + "(options: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" + "section": "def-common.GetFieldsOptionsTimePattern", + "text": "GetFieldsOptionsTimePattern" }, - " | undefined" + ") => Promise" ] }, { "tags": [], - "id": "def-common.FieldSpecExportFmt.format", - "type": "Object", - "label": "format", + "id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard", + "type": "Function", + "label": "getFieldsForWildcard", "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" + "lineNumber": 136 }, "signature": [ + "(options: ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.GetFieldsOptions", + "text": "GetFieldsOptions" }, - "> | undefined" - ] - }, - { - "tags": [], - "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" + ") => Promise" ] } ], "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" + "lineNumber": 134 }, "initialIsOpen": false }, { - "id": "def-common.FieldSpec", + "id": "def-common.IndexPatternAttributes", "type": "Interface", - "label": "FieldSpec", + "label": "IndexPatternAttributes", "description": [ - "\nSerialized version of IndexPatternField" + "\nInterface for an index pattern saved object" ], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.FieldSpec.lang", + "id": "def-common.IndexPatternAttributes.type", "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" - ] - }, - { - "tags": [], - "id": "def-common.FieldSpec.conflictDescriptions", - "type": "Object", - "label": "conflictDescriptions", + "label": "type", "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" - ] + "lineNumber": 54 + } }, { "tags": [], - "id": "def-common.FieldSpec.format", - "type": "Object", - "label": "format", + "id": "def-common.IndexPatternAttributes.fields", + "type": "string", + "label": "fields", "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" - ] + "lineNumber": 55 + } }, { "tags": [], - "id": "def-common.FieldSpec.name", + "id": "def-common.IndexPatternAttributes.title", "type": "string", - "label": "name", + "label": "title", "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" + "lineNumber": 56 } }, { "tags": [], - "id": "def-common.FieldSpec.type", + "id": "def-common.IndexPatternAttributes.typeMeta", "type": "string", - "label": "type", + "label": "typeMeta", "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" + "lineNumber": 57 } }, { "tags": [], - "id": "def-common.FieldSpec.esTypes", - "type": "Array", - "label": "esTypes", + "id": "def-common.IndexPatternAttributes.timeFieldName", + "type": "string", + "label": "timeFieldName", "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" + "lineNumber": 58 }, "signature": [ - "string[] | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.FieldSpec.scripted", - "type": "CompoundType", - "label": "scripted", + "id": "def-common.IndexPatternAttributes.intervalName", + "type": "string", + "label": "intervalName", "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" + "lineNumber": 59 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.FieldSpec.readFromDocValues", - "type": "CompoundType", - "label": "readFromDocValues", + "id": "def-common.IndexPatternAttributes.sourceFilters", + "type": "string", + "label": "sourceFilters", "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" + "lineNumber": 60 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.FieldSpec.subType", - "type": "Object", - "label": "subType", + "id": "def-common.IndexPatternAttributes.fieldFormatMap", + "type": "string", + "label": "fieldFormatMap", "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" + "lineNumber": 61 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldSubType", - "text": "IFieldSubType" - }, - " | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.FieldSpec.indexed", - "type": "CompoundType", - "label": "indexed", + "id": "def-common.IndexPatternAttributes.fieldAttrs", + "type": "string", + "label": "fieldAttrs", "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" + "lineNumber": 62 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.FieldSpec.customLabel", + "id": "def-common.IndexPatternAttributes.runtimeFieldMap", "type": "string", - "label": "customLabel", + "label": "runtimeFieldMap", "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" + "lineNumber": 63 }, "signature": [ "string | undefined" @@ -6579,61 +5901,72 @@ }, { "tags": [], - "id": "def-common.FieldSpec.runtimeField", - "type": "Object", - "label": "runtimeField", - "description": [], + "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": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L212" + "lineNumber": 67 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.RuntimeField", - "text": "RuntimeField" - }, - " | undefined" + "boolean | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 53 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IndexPatternExpressionType", + "type": "Interface", + "label": "IndexPatternExpressionType", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.FieldSpec.shortDotsEnable", - "type": "CompoundType", - "label": "shortDotsEnable", + "id": "def-common.IndexPatternExpressionType.type", + "type": "string", + "label": "type", "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" + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 18 }, "signature": [ - "boolean | undefined" + "\"index_pattern\"" ] }, { "tags": [], - "id": "def-common.FieldSpec.isMapped", - "type": "CompoundType", - "label": "isMapped", + "id": "def-common.IndexPatternExpressionType.value", + "type": "Object", + "label": "value", "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" + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 19 }, "signature": [ - "boolean | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternSpec", + "text": "IndexPatternSpec" + } ] } ], "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" + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 17 }, "initialIsOpen": false }, @@ -6656,8 +5989,7 @@ ], "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" + "lineNumber": 228 }, "signature": [ "string | undefined" @@ -6673,8 +6005,7 @@ ], "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" + "lineNumber": 232 }, "signature": [ "string | undefined" @@ -6688,8 +6019,7 @@ "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" + "lineNumber": 233 }, "signature": [ "string | undefined" @@ -6705,8 +6035,7 @@ "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" + "lineNumber": 238 }, "signature": [ "string | undefined" @@ -6720,8 +6049,7 @@ "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" + "lineNumber": 239 }, "signature": [ "string | undefined" @@ -6735,8 +6063,7 @@ "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" + "lineNumber": 240 }, "signature": [ { @@ -6757,8 +6084,7 @@ "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" + "lineNumber": 241 }, "signature": [ "Record | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.fieldAttrs", + "type": "Object", + "label": "fieldAttrs", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 246 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldAttrs", + "text": "FieldAttrs" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexPatternSpec.allowNoIndex", + "type": "CompoundType", + "label": "allowNoIndex", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 247 + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 224 + }, + "initialIsOpen": false + }, + { + "id": "def-common.RuntimeField", + "type": "Interface", + "label": "RuntimeField", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.RuntimeField.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 21 + }, + "signature": [ + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + ] + }, + { + "tags": [], + "id": "def-common.RuntimeField.script", + "type": "Object", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 22 + }, + "signature": [ + "{ source: string; } | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 20 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedObjectsClientCommon", + "type": "Interface", + "label": "SavedObjectsClientCommon", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.find", + "type": "Function", + "label": "find", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 102 + }, + "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" + }, + "[]>" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 103 + }, + "signature": [ + "(type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.update", + "type": "Function", + "label": "update", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 104 + }, + "signature": [ + "(type: string, id: string, attributes: Record, options: Record) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.create", + "type": "Function", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 110 + }, + "signature": [ + "(type: string, attributes: Record, options: Record) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommon.delete", + "type": "Function", + "label": "delete", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 115 + }, + "signature": [ + "(type: string, id: string) => Promise<{}>" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 101 + }, + "initialIsOpen": false + }, + { + "id": "def-common.SavedObjectsClientCommonFindArgs", + "type": "Interface", + "label": "SavedObjectsClientCommonFindArgs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 94 + }, + "signature": [ + "string | string[]" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.fields", + "type": "Array", + "label": "fields", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 95 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SavedObjectsClientCommonFindArgs.perPage", + "type": "number", + "label": "perPage", "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" + "lineNumber": 96 }, "signature": [ - "Record | undefined" + "number | undefined" ] }, { "tags": [], - "id": "def-common.IndexPatternSpec.fieldAttrs", - "type": "Object", - "label": "fieldAttrs", + "id": "def-common.SavedObjectsClientCommonFindArgs.search", + "type": "string", + "label": "search", "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" + "lineNumber": 97 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.FieldAttrs", - "text": "FieldAttrs" - }, - " | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.IndexPatternSpec.allowNoIndex", - "type": "CompoundType", - "label": "allowNoIndex", + "id": "def-common.SavedObjectsClientCommonFindArgs.searchFields", + "type": "Array", + "label": "searchFields", "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" + "lineNumber": 98 }, "signature": [ - "boolean | undefined" + "string[] | 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" + "lineNumber": 93 }, "initialIsOpen": false }, @@ -6915,66 +6484,125 @@ "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" + "lineNumber": 251 } } ], "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" + "lineNumber": 250 }, "initialIsOpen": false }, { - "id": "def-common.IndexPatternExpressionType", + "id": "def-common.TypeMeta", "type": "Interface", - "label": "IndexPatternExpressionType", + "label": "TypeMeta", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.IndexPatternExpressionType.type", - "type": "string", - "label": "type", + "id": "def-common.TypeMeta.aggs", + "type": "Object", + "label": "aggs", "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 159 }, "signature": [ - "\"index_pattern\"" + "Record> | undefined" ] }, { + "id": "def-common.TypeMeta.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 160 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternSpec", - "text": "IndexPatternSpec" - } + "any" ] } ], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 158 + }, + "initialIsOpen": false + }, + { + "id": "def-common.UiSettingsCommon", + "type": "Interface", + "label": "UiSettingsCommon", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.UiSettingsCommon.get", + "type": "Function", + "label": "get", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 87 + }, + "signature": [ + "(key: string) => Promise" + ] + }, + { + "tags": [], + "id": "def-common.UiSettingsCommon.getAll", + "type": "Function", + "label": "getAll", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 88 + }, + "signature": [ + "() => Promise>" + ] + }, + { + "tags": [], + "id": "def-common.UiSettingsCommon.set", + "type": "Function", + "label": "set", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 89 + }, + "signature": [ + "(key: string, value: any) => Promise" + ] + }, + { + "tags": [], + "id": "def-common.UiSettingsCommon.remove", + "type": "Function", + "label": "remove", + "description": [], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 90 + }, + "signature": [ + "(key: string) => Promise" + ] + } + ], + "source": { + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 86 }, "initialIsOpen": false } @@ -6982,18 +6610,17 @@ "enums": [], "misc": [ { - "id": "def-common.IndexPatternsContract", + "id": "def-common.AggregationRestrictions", "type": "Type", - "label": "IndexPatternsContract", + "label": "AggregationRestrictions", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 141 }, "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; }" + "{ [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 }, @@ -7005,8 +6632,7 @@ "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" + "lineNumber": 17 }, "signature": [ "{ [x: string]: SerializedFieldFormat>; }" @@ -7014,148 +6640,141 @@ "initialIsOpen": false }, { - "id": "def-common.RuntimeType", + "id": "def-common.FieldSpecConflictDescriptions", "type": "Type", - "label": "RuntimeType", + "label": "FieldSpecConflictDescriptions", "tags": [], "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" + "lineNumber": 163 }, "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" + "{ [x: string]: string[]; }" ], "initialIsOpen": false }, { - "id": "def-common.OnNotification", + "id": "def-common.IndexPatternFieldMap", "type": "Type", - "label": "OnNotification", + "label": "IndexPatternFieldMap", "tags": [], "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" + "lineNumber": 218 }, "signature": [ - "(toastInputFields: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInputFields", - "text": "ToastInputFields" - }, - ") => void" + "{ [x: string]: FieldSpec; }" ], "initialIsOpen": false }, { - "id": "def-common.OnError", + "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", "type": "Type", - "label": "OnError", + "label": "IndexPatternLoadExpressionFunctionDefinition", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts", + "lineNumber": 34 }, "signature": [ - "(error: Error, toastInputFields: ", + "ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, - ") => void" + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-common.AggregationRestrictions", + "id": "def-common.IndexPatternsContract", "type": "Type", - "label": "AggregationRestrictions", + "label": "IndexPatternsContract", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", + "lineNumber": 638 }, "signature": [ - "{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }" + "{ 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.FieldSpecConflictDescriptions", + "id": "def-common.OnError", "type": "Type", - "label": "FieldSpecConflictDescriptions", + "label": "OnError", "tags": [], "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" + "lineNumber": 84 }, "signature": [ - "{ [x: string]: string[]; }" + "(error: Error, toastInputFields: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => void" ], "initialIsOpen": false }, { - "id": "def-common.IndexPatternFieldMap", + "id": "def-common.OnNotification", "type": "Type", - "label": "IndexPatternFieldMap", + "label": "OnNotification", "tags": [], "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" + "lineNumber": 83 }, "signature": [ - "{ [x: string]: FieldSpec; }" + "(toastInputFields: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInputFields", + "text": "ToastInputFields" + }, + ") => void" ], "initialIsOpen": false }, { - "id": "def-common.IndexPatternLoadExpressionFunctionDefinition", + "id": "def-common.RuntimeType", "type": "Type", - "label": "IndexPatternLoadExpressionFunctionDefinition", + "label": "RuntimeType", "tags": [], "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" + "path": "src/plugins/data/common/index_patterns/types.ts", + "lineNumber": 19 }, "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" - }, - ", ", - "SerializableState", - ">>" + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\"" ], "initialIsOpen": false } @@ -7169,8 +6788,7 @@ "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" + "lineNumber": 9 }, "signature": [ "readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]" diff --git a/api_docs/data_query.json b/api_docs/data_query.json index e8d5ff79ec80c..c7af23cf107bf 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -34,8 +34,7 @@ "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" + "lineNumber": 35 } } ], @@ -43,8 +42,7 @@ "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" + "lineNumber": 35 } }, { @@ -68,8 +66,7 @@ "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" + "lineNumber": 92 } }, { @@ -93,8 +90,7 @@ "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" + "lineNumber": 96 } }, { @@ -118,8 +114,7 @@ "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" + "lineNumber": 101 } }, { @@ -142,8 +137,7 @@ "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" + "lineNumber": 106 } }, { @@ -161,8 +155,7 @@ "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" + "lineNumber": 110 } }, { @@ -180,8 +173,7 @@ "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" + "lineNumber": 114 } }, { @@ -234,8 +226,7 @@ "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" + "lineNumber": 121 } }, { @@ -248,8 +239,7 @@ "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" + "lineNumber": 122 } } ], @@ -257,8 +247,7 @@ "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" + "lineNumber": 120 } }, { @@ -295,8 +284,7 @@ "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" + "lineNumber": 149 } }, { @@ -309,8 +297,7 @@ "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" + "lineNumber": 150 } } ], @@ -318,8 +305,7 @@ "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" + "lineNumber": 148 } }, { @@ -358,8 +344,7 @@ "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" + "lineNumber": 167 } } ], @@ -367,8 +352,7 @@ "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" + "lineNumber": 167 } }, { @@ -407,8 +391,7 @@ "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" + "lineNumber": 184 } } ], @@ -416,8 +399,7 @@ "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" + "lineNumber": 184 } }, { @@ -453,8 +435,7 @@ "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" + "lineNumber": 195 } } ], @@ -462,8 +443,7 @@ "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" + "lineNumber": 195 } }, { @@ -479,8 +459,7 @@ "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" + "lineNumber": 207 } }, { @@ -517,8 +496,7 @@ "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" + "lineNumber": 212 } }, { @@ -537,8 +515,7 @@ "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" + "lineNumber": 213 } }, { @@ -551,8 +528,7 @@ "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" + "lineNumber": 214 } } ], @@ -560,15 +536,13 @@ "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" + "lineNumber": 211 } } ], "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" + "lineNumber": 29 }, "initialIsOpen": false }, @@ -605,8 +579,7 @@ "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" + "lineNumber": 18 } } ], @@ -614,8 +587,7 @@ "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" + "lineNumber": 18 } }, { @@ -651,8 +623,7 @@ "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" + "lineNumber": 29 } } ], @@ -660,8 +631,7 @@ "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" + "lineNumber": 29 } }, { @@ -685,76 +655,18 @@ "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" + "lineNumber": 42 } } ], "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" + "lineNumber": 15 }, "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, { "id": "def-public.connectToQueryState", "type": "Function", @@ -802,8 +714,7 @@ "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" + "lineNumber": 24 } }, { @@ -823,8 +734,7 @@ "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" + "lineNumber": 30 } }, { @@ -842,8 +752,7 @@ "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" + "lineNumber": 32 }, "signature": [ "boolean | undefined" @@ -857,8 +766,7 @@ "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" + "lineNumber": 33 }, "signature": [ "boolean | undefined" @@ -872,8 +780,7 @@ "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" + "lineNumber": 34 }, "signature": [ "boolean | ", @@ -895,8 +802,7 @@ "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" + "lineNumber": 35 }, "signature": [ "boolean | undefined" @@ -905,8 +811,7 @@ ], "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" + "lineNumber": 31 } } ], @@ -952,13 +857,107 @@ "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" + "lineNumber": 23 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "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 + } + } + ], + "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 }, "tags": [], "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/query/lib/get_default_query.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, { "id": "def-public.syncQueryStateWithUrl", "type": "Function", @@ -1006,8 +1005,7 @@ "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" + "lineNumber": 27 } }, { @@ -1026,8 +1024,7 @@ "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" + "lineNumber": 28 } } ], @@ -1067,55 +1064,11 @@ "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" + "lineNumber": 26 }, "tags": [], "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": [ @@ -1136,8 +1089,7 @@ "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" + "lineNumber": 15 }, "signature": [ { @@ -1158,8 +1110,7 @@ "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" + "lineNumber": 16 }, "signature": [ { @@ -1180,8 +1131,7 @@ "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" + "lineNumber": 17 }, "signature": [ { @@ -1202,8 +1152,7 @@ "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" + "lineNumber": 18 }, "signature": [ { @@ -1219,8 +1168,59 @@ ], "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" + "lineNumber": 14 + }, + "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": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.QueryStateChange.appFilters", + "type": "CompoundType", + "label": "appFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 26 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.QueryStateChange.globalFilters", + "type": "CompoundType", + "label": "globalFilters", + "description": [], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 27 + }, + "signature": [ + "boolean | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/public/query/state_sync/types.ts", + "lineNumber": 25 }, "initialIsOpen": false }, @@ -1239,8 +1239,7 @@ "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" + "lineNumber": 16 } }, { @@ -1251,8 +1250,7 @@ "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" + "lineNumber": 17 }, "signature": [ { @@ -1267,8 +1265,7 @@ ], "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" + "lineNumber": 15 }, "initialIsOpen": false }, @@ -1287,8 +1284,7 @@ "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" + "lineNumber": 29 }, "signature": [ "(attributes: ", @@ -1318,8 +1314,7 @@ "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" + "lineNumber": 33 }, "signature": [ "() => Promise<", @@ -1341,8 +1336,7 @@ "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" + "lineNumber": 34 }, "signature": [ "(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ", @@ -1364,8 +1358,7 @@ "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" + "lineNumber": 39 }, "signature": [ "(id: string) => Promise<", @@ -1387,8 +1380,7 @@ "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" + "lineNumber": 40 }, "signature": [ "(id: string) => Promise<{}>" @@ -1402,8 +1394,7 @@ "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" + "lineNumber": 41 }, "signature": [ "() => Promise" @@ -1412,105 +1403,95 @@ ], "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" + "lineNumber": 28 }, "initialIsOpen": false - }, + } + ], + "enums": [], + "misc": [ { - "id": "def-public.QueryStateChange", - "type": "Interface", - "label": "QueryStateChange", + "id": "def-public.InputTimeRange", + "type": "Type", + "label": "InputTimeRange", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/query/timefilter/types.ts", + "lineNumber": 19 + }, "signature": [ { "pluginId": "data", - "scope": "public", + "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" + "section": "def-common.TimeRange", + "text": "TimeRange" }, - " extends QueryStateChangePartial" + " | { from: moment.Moment; to: moment.Moment; }" ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", + "id": "def-public.QueryStart", "type": "Type", - "label": "SavedQueryTimeFilter", + "label": "QueryStart", "tags": [], "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" + "path": "src/plugins/data/public/query/query_service.ts", + "lineNumber": 103 }, "signature": [ - "TimeRange & { refreshInterval: RefreshInterval; }" + "{ 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 }, { - "id": "def-public.InputTimeRange", + "id": "def-public.SavedQueryTimeFilter", "type": "Type", - "label": "InputTimeRange", + "label": "SavedQueryTimeFilter", "tags": [], "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" + "path": "src/plugins/data/public/query/saved_query/types.ts", + "lineNumber": 11 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | { from: moment.Moment; to: moment.Moment; }" + "TimeRange & { refreshInterval: RefreshInterval; }" ], "initialIsOpen": false }, @@ -1522,8 +1503,7 @@ "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" + "lineNumber": 240 }, "signature": [ "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ", @@ -1547,62 +1527,12 @@ "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" + "lineNumber": 47 }, "signature": [ "{ add: (time: TimeRange) => void; get: () => TimeRange[]; }" ], "initialIsOpen": false - }, - { - "id": "def-public.QueryStart", - "type": "Type", - "label": "QueryStart", - "tags": [], - "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": [] @@ -1619,194 +1549,68 @@ "classes": [], "functions": [ { - "id": "def-common.dedupFilters", + "id": "def-common.calculateBounds", "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" - } - } - ], + "label": "calculateBounds", "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?: ", + "(timeRange: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.FilterCompareOptions", - "text": "FilterCompareOptions" + "section": "def-common.TimeRange", + "text": "TimeRange" }, - ") => ", + ", options: CalculateBoundsOptions) => ", { "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" - }, - "tags": [], - "returnComment": [ - "An array of filters that were not in existing" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + } ], - "initialIsOpen": false - }, - { - "id": "def-common.uniqFilters", - "type": "Function", + "description": [], "children": [ { - "type": "Array", - "label": "filters", + "type": "Object", + "label": "timeRange", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "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" + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 17 } }, { - "type": "Any", - "label": "comparatorOptions", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "any" + "CalculateBoundsOptions" ], "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" + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 18 } } ], - "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", + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/query/timefilter/get_time.ts", + "lineNumber": 16 }, - "tags": [], - "returnComment": [ - "The original filters array with duplicates removed" - ], "initialIsOpen": false }, { @@ -1838,8 +1642,7 @@ "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" + "lineNumber": 65 } }, { @@ -1867,8 +1670,7 @@ "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" + "lineNumber": 66 } }, { @@ -1887,8 +1689,7 @@ "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" + "lineNumber": 67 } } ], @@ -1940,8 +1741,7 @@ "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" + "lineNumber": 64 }, "tags": [], "returnComment": [ @@ -1950,71 +1750,116 @@ "initialIsOpen": false }, { - "id": "def-common.calculateBounds", + "id": "def-common.dedupFilters", "type": "Function", - "label": "calculateBounds", - "signature": [ - "(timeRange: ", + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "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 + } }, - ", options: CalculateBoundsOptions) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRangeBounds", - "text": "TimeRangeBounds" - } - ], - "description": [], - "children": [ { - "type": "Object", - "label": "timeRange", + "type": "Array", + "label": "filters", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[]" ], "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" + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 24 } }, { "type": "Object", - "label": "options", + "label": "comparatorOptions", "isRequired": true, "signature": [ - "CalculateBoundsOptions" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.FilterCompareOptions", + "text": "FilterCompareOptions" + } ], "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" + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 25 } } ], - "tags": [], - "returnComment": [], + "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/timefilter/get_time.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L16" + "path": "src/plugins/data/common/query/filter_manager/dedup_filters.ts", + "lineNumber": 22 }, + "tags": [], + "returnComment": [ + "An array of filters that were not in existing" + ], "initialIsOpen": false }, { @@ -2057,8 +1902,7 @@ "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" + "lineNumber": 27 } }, { @@ -2076,8 +1920,7 @@ "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" + "lineNumber": 28 }, "signature": [ "Date | undefined" @@ -2086,8 +1929,7 @@ ], "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" + "lineNumber": 28 } } ], @@ -2095,8 +1937,7 @@ "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" + "lineNumber": 26 }, "initialIsOpen": false }, @@ -2150,8 +1991,7 @@ "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" + "lineNumber": 38 } }, { @@ -2170,8 +2010,7 @@ "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" + "lineNumber": 39 } }, { @@ -2189,8 +2028,7 @@ "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" + "lineNumber": 40 }, "signature": [ "Date | undefined" @@ -2204,8 +2042,7 @@ "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" + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -2214,8 +2051,7 @@ ], "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" + "lineNumber": 40 } } ], @@ -2223,13 +2059,12 @@ "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" + "lineNumber": 37 }, "initialIsOpen": false }, { - "id": "def-common.isTimeRange", + "id": "def-common.isQuery", "type": "Function", "children": [ { @@ -2241,9 +2076,8 @@ ], "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" + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11 } } ], @@ -2253,23 +2087,22 @@ "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "section": "def-common.Query", + "text": "Query" } ], "description": [], - "label": "isTimeRange", + "label": "isQuery", "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" + "path": "src/plugins/data/common/query/is_query.ts", + "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isQuery", + "id": "def-common.isTimeRange", "type": "Function", "children": [ { @@ -2281,9 +2114,8 @@ ], "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" + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11 } } ], @@ -2293,20 +2125,90 @@ "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" + "section": "def-common.TimeRange", + "text": "TimeRange" } ], "description": [], - "label": "isQuery", + "label": "isTimeRange", "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" + "path": "src/plugins/data/common/query/timefilter/is_time_range.ts", + "lineNumber": 11 }, "tags": [], "returnComment": [], "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 + } + }, + { + "type": "Any", + "label": "comparatorOptions", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/query/filter_manager/uniq_filters.ts", + "lineNumber": 21 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [ + "The original filters array with duplicates removed" + ], + "initialIsOpen": false } ], "interfaces": [ @@ -2325,8 +2227,7 @@ "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" + "lineNumber": 13 }, "signature": [ "boolean | undefined" @@ -2340,8 +2241,7 @@ "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" + "lineNumber": 14 }, "signature": [ "boolean | undefined" @@ -2355,8 +2255,7 @@ "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" + "lineNumber": 15 }, "signature": [ "boolean | undefined" @@ -2370,8 +2269,7 @@ "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" + "lineNumber": 16 }, "signature": [ "boolean | undefined" @@ -2385,8 +2283,7 @@ "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" + "lineNumber": 17 }, "signature": [ "boolean | undefined" @@ -2395,8 +2292,7 @@ ], "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" + "lineNumber": 12 }, "initialIsOpen": false }, @@ -2415,8 +2311,7 @@ "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" + "lineNumber": 12 } }, { @@ -2427,15 +2322,13 @@ "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" + "lineNumber": 13 } } ], "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" + "lineNumber": 11 }, "initialIsOpen": false }, @@ -2454,8 +2347,7 @@ "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" + "lineNumber": 24 }, "signature": [ "moment.Moment | undefined" @@ -2469,8 +2361,7 @@ "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" + "lineNumber": 25 }, "signature": [ "moment.Moment | undefined" @@ -2479,8 +2370,7 @@ ], "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" + "lineNumber": 23 }, "initialIsOpen": false } @@ -2495,8 +2385,7 @@ "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" + "lineNumber": 12 }, "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" @@ -2511,8 +2400,7 @@ "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" + "lineNumber": 17 }, "signature": [ "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" @@ -2534,8 +2422,7 @@ "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" + "lineNumber": 24 }, "signature": [ "true" @@ -2549,8 +2436,7 @@ "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" + "lineNumber": 25 }, "signature": [ "true" @@ -2564,8 +2450,7 @@ "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" + "lineNumber": 26 }, "signature": [ "true" @@ -2579,8 +2464,7 @@ "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" + "lineNumber": 27 }, "signature": [ "true" @@ -2594,8 +2478,7 @@ "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" + "lineNumber": 28 }, "signature": [ "true" @@ -2608,8 +2491,7 @@ "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" + "lineNumber": 23 }, "initialIsOpen": false } diff --git a/api_docs/data_search.json b/api_docs/data_search.json index 61c3c3835fb59..bf067795aae0a 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -2,6 +2,166 @@ "id": "data.search", "client": { "classes": [ + { + "id": "def-public.PainlessError", + "type": "Class", + "tags": [], + "label": "PainlessError", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.PainlessError", + "text": "PainlessError" + }, + " extends ", + "EsError" + ], + "children": [ + { + "tags": [], + "id": "def-public.PainlessError.painlessStack", + "type": "string", + "label": "painlessStack", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 20 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.PainlessError.indexPattern", + "type": "Object", + "label": "indexPattern", + "description": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 21 + }, + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 22 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 27 + } + } + ], + "source": { + "path": "src/plugins/data/public/search/errors/painless_error.tsx", + "lineNumber": 19 + }, + "initialIsOpen": false + }, { "id": "def-public.SearchInterceptor", "type": "Class", @@ -34,8 +194,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L75" + "lineNumber": 75 } } ], @@ -43,8 +202,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L75" + "lineNumber": 75 } }, { @@ -67,8 +225,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 91, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L91" + "lineNumber": 91 } }, { @@ -128,8 +285,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 100, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L100" + "lineNumber": 100 } }, { @@ -142,8 +298,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L101" + "lineNumber": 101 } }, { @@ -163,8 +318,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 102, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L102" + "lineNumber": 102 } } ], @@ -172,8 +326,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 99, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L99" + "lineNumber": 99 } }, { @@ -230,8 +383,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 247, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L247" + "lineNumber": 247 } }, { @@ -251,8 +403,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 248, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L248" + "lineNumber": 248 } } ], @@ -264,8 +415,7 @@ ], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 246, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L246" + "lineNumber": 246 } }, { @@ -287,8 +437,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 275, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L275" + "lineNumber": 275 } } ], @@ -296,15 +445,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 275, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L275" + "lineNumber": 275 } } ], "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" + "lineNumber": 50 }, "initialIsOpen": false }, @@ -342,8 +489,7 @@ "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" + "lineNumber": 26 }, "signature": [ { @@ -374,8 +520,7 @@ "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" + "lineNumber": 27 } }, { @@ -394,8 +539,7 @@ "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" + "lineNumber": 27 } } ], @@ -403,8 +547,7 @@ "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" + "lineNumber": 27 } }, { @@ -440,8 +583,7 @@ "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" + "lineNumber": 80 } } ], @@ -449,299 +591,124 @@ "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" + "lineNumber": 80 } } ], "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" + "lineNumber": 25 }, "initialIsOpen": false - }, + } + ], + "functions": [ { - "id": "def-public.PainlessError", - "type": "Class", - "tags": [], - "label": "PainlessError", - "description": [], + "id": "def-public.getEsPreference", + "type": "Function", + "label": "getEsPreference", "signature": [ + "(uiSettings: ", { - "pluginId": "data", + "pluginId": "core", "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.PainlessError", - "text": "PainlessError" + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" }, - " extends ", - "EsError" + ", sessionId: string) => any" ], + "description": [], "children": [ { - "tags": [], - "id": "def-public.PainlessError.painlessStack", + "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 + } + }, + { "type": "string", - "label": "painlessStack", + "label": "sessionId", + "isRequired": true, + "signature": [ + "string" + ], "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" + "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", + "lineNumber": 14 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/public/search/es_search/get_es_preference.ts", + "lineNumber": 14 + }, + "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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.ISearchSetup.aggs", + "type": "Object", + "label": "aggs", + "description": [], + "source": { + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 29 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggsCommonSetup", + "text": "AggsCommonSetup" + } ] }, { "tags": [], - "id": "def-public.PainlessError.indexPattern", + "id": "def-public.ISearchSetup.usageCollector", "type": "Object", - "label": "indexPattern", + "label": "usageCollector", "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" + "path": "src/plugins/data/public/search/types.ts", + "lineNumber": 30 }, "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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.SearchUsageCollector", + "text": "SearchUsageCollector" }, " | undefined" ] @@ -756,8 +723,7 @@ ], "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" + "lineNumber": 35 }, "signature": [ "Pick<", @@ -781,8 +747,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ "Pick<", @@ -799,8 +764,7 @@ ], "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" + "lineNumber": 28 }, "initialIsOpen": false }, @@ -825,8 +789,7 @@ ], "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" + "lineNumber": 57 }, "signature": [ "Pick void" @@ -904,8 +865,7 @@ ], "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" + "lineNumber": 69 }, "signature": [ { @@ -927,8 +887,7 @@ ], "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" + "lineNumber": 74 }, "signature": [ "Pick<", @@ -952,8 +911,7 @@ ], "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" + "lineNumber": 79 }, "signature": [ "Pick<", @@ -970,8 +928,7 @@ ], "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" + "lineNumber": 51 }, "initialIsOpen": false }, @@ -990,8 +947,7 @@ "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" + "lineNumber": 41 }, "signature": [ { @@ -1011,8 +967,7 @@ "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" + "lineNumber": 42 }, "signature": [ { @@ -1032,8 +987,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L43" + "lineNumber": 43 }, "signature": [ { @@ -1053,8 +1007,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L44" + "lineNumber": 44 }, "signature": [ "Promise<[", @@ -1076,8 +1029,7 @@ "description": [], "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" + "lineNumber": 45 }, "signature": [ "Pick<", @@ -1099,8 +1051,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 46, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L46" + "lineNumber": 46 }, "signature": [ { @@ -1121,8 +1072,7 @@ "description": [], "source": { "path": "src/plugins/data/public/search/search_interceptor.ts", - "lineNumber": 47, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L47" + "lineNumber": 47 }, "signature": [ "Pick<", @@ -1139,8 +1089,7 @@ ], "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" + "lineNumber": 40 }, "initialIsOpen": false }, @@ -1173,8 +1122,7 @@ ], "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" + "lineNumber": 39 }, "signature": [ "() => Promise" @@ -1188,8 +1136,7 @@ "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" + "lineNumber": 40 }, "signature": [ "() => Promise<{ urlGeneratorId: ID; initialState: ", @@ -1214,8 +1161,7 @@ ], "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" + "lineNumber": 34 }, "initialIsOpen": false } @@ -1233,8 +1179,7 @@ ], "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" + "lineNumber": 19 }, "initialIsOpen": false }, @@ -1246,8 +1191,7 @@ "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" + "lineNumber": 15 }, "initialIsOpen": false } @@ -1261,8 +1205,7 @@ "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" + "lineNumber": 30 }, "signature": [ "ExpressionFunctionDefinition<\"esdsl\", ", @@ -1310,8 +1253,7 @@ "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" + "lineNumber": 57 }, "signature": [ "ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>" @@ -1319,33 +1261,17 @@ "initialIsOpen": false }, { + "id": "def-public.ISessionsClient", + "type": "Type", + "label": "ISessionsClient", "tags": [], - "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 - }, - { - "tags": [], - "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" + "path": "src/plugins/data/public/search/session/sessions_client.ts", + "lineNumber": 13 }, "signature": [ - "\"search_sessions\"" + "{ 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 }, @@ -1357,8 +1283,7 @@ "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" + "lineNumber": 25 }, "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; }" @@ -1366,18 +1291,31 @@ "initialIsOpen": false }, { - "id": "def-public.ISessionsClient", - "type": "Type", - "label": "ISessionsClient", "tags": [], + "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 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.SEARCH_SESSIONS_MANAGEMENT_ID", + "type": "string", + "label": "SEARCH_SESSIONS_MANAGEMENT_ID", "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" + "path": "src/plugins/data/public/search/session/constants.ts", + "lineNumber": 9 }, "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>; }" + "\"search_sessions\"" ], "initialIsOpen": false } @@ -1424,8 +1362,7 @@ "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" + "lineNumber": 20 } } ], @@ -1433,8 +1370,7 @@ "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" + "lineNumber": 19 }, "initialIsOpen": false }, @@ -1472,8 +1408,7 @@ "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" + "lineNumber": 14 } } ], @@ -1481,68 +1416,12 @@ "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" + "lineNumber": 14 }, "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", + "id": "def-server.searchUsageObserver", "type": "Function", "label": "searchUsageObserver", "signature": [ @@ -1580,8 +1459,7 @@ "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 82, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L82" + "lineNumber": 82 } }, { @@ -1601,8 +1479,60 @@ "description": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 82, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L82" + "lineNumber": 82 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/server/search/collectors/usage.ts", + "lineNumber": 82 + }, + "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 } } ], @@ -1610,132 +1540,71 @@ "returnComment": [], "source": { "path": "src/plugins/data/server/search/collectors/usage.ts", - "lineNumber": 82, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L82" + "lineNumber": 22 }, "initialIsOpen": false } ], "interfaces": [ { - "id": "def-server.ISearchStrategy", + "id": "def-server.ISearchSessionService", "type": "Interface", - "label": "ISearchStrategy", + "label": "ISearchSessionService", "signature": [ { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", - "section": "def-server.ISearchStrategy", - "text": "ISearchStrategy" + "section": "def-server.ISearchSessionService", + "text": "ISearchSessionService" }, - "" - ], - "description": [ - "\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response." + "" ], + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-server.ISearchStrategy.search", + "id": "def-server.ISearchSessionService.asScopedProvider", "type": "Function", - "label": "search", + "label": "asScopedProvider", "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" + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 37 }, "signature": [ - "(request: SearchStrategyRequest, options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - ", deps: ", + "(core: ", { - "pluginId": "data", + "pluginId": "core", "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.SearchStrategyDependencies", - "text": "SearchStrategyDependencies" - }, - ") => ", - "Observable", - "" - ] - }, - { - "tags": [], - "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" + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" }, - ", deps: ", + ") => (request: ", { - "pluginId": "data", + "pluginId": "core", "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.SearchStrategyDependencies", - "text": "SearchStrategyDependencies" - }, - ") => Promise) | undefined" - ] - }, - { - "tags": [], - "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" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - ", deps: ", + ") => ", { "pluginId": "data", "scope": "server", "docId": "kibDataSearchPluginApi", - "section": "def-server.SearchStrategyDependencies", - "text": "SearchStrategyDependencies" + "section": "def-server.IScopedSearchSessionsClient", + "text": "IScopedSearchSessionsClient" }, - ") => 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" + "path": "src/plugins/data/server/search/session/types.ts", + "lineNumber": 36 }, "initialIsOpen": false }, @@ -1754,8 +1623,7 @@ "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" + "lineNumber": 43 }, "signature": [ { @@ -1777,8 +1645,7 @@ ], "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" + "lineNumber": 48 }, "signature": [ " ", @@ -1926,8 +1789,7 @@ "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" + "lineNumber": 112 }, "signature": [ "(request: ", @@ -1956,8 +1818,7 @@ "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" + "lineNumber": 113 }, "signature": [ "{ asScoped: (request: ", @@ -1982,51 +1843,166 @@ ], "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" + "lineNumber": 99 }, "initialIsOpen": false }, { - "id": "def-server.SearchStrategyDependencies", + "id": "def-server.ISearchStrategy", "type": "Interface", - "label": "SearchStrategyDependencies", - "description": [], + "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." + ], "tags": [], "children": [ { "tags": [], - "id": "def-server.SearchStrategyDependencies.savedObjectsClient", - "type": "Object", - "label": "savedObjectsClient", + "id": "def-server.ISearchStrategy.search", + "type": "Function", + "label": "search", "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" + "lineNumber": 75 }, "signature": [ - "Pick<", + "(request: SearchStrategyRequest, options: ", { - "pluginId": "core", + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ", deps: ", + { + "pluginId": "data", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">" + ") => ", + "Observable", + "" ] }, { "tags": [], - "id": "def-server.SearchStrategyDependencies.esClient", - "type": "Object", - "label": "esClient", + "id": "def-server.ISearchStrategy.cancel", + "type": "Function", + "label": "cancel", "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" + "lineNumber": 80 + }, + "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" + ] + }, + { + "tags": [], + "id": "def-server.ISearchStrategy.extend", + "type": "Function", + "label": "extend", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 81 + }, + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-server.SearchStrategyDependencies", + "type": "Interface", + "label": "SearchStrategyDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.SearchStrategyDependencies.savedObjectsClient", + "type": "Object", + "label": "savedObjectsClient", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 36 + }, + "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\">" + ] + }, + { + "tags": [], + "id": "def-server.SearchStrategyDependencies.esClient", + "type": "Object", + "label": "esClient", + "description": [], + "source": { + "path": "src/plugins/data/server/search/types.ts", + "lineNumber": 37 }, "signature": [ { @@ -2046,8 +2022,7 @@ "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" + "lineNumber": 38 }, "signature": [ { @@ -2067,8 +2042,7 @@ "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" + "lineNumber": 39 }, "signature": [ { @@ -2084,8 +2058,7 @@ ], "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" + "lineNumber": 35 }, "initialIsOpen": false }, @@ -2109,8 +2082,7 @@ "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" + "lineNumber": 18 } }, { @@ -2132,8 +2104,7 @@ "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" + "lineNumber": 19 } } ], @@ -2141,79 +2112,13 @@ "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" + "lineNumber": 19 } } ], "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" + "lineNumber": 17 }, "initialIsOpen": false } @@ -2228,8 +2133,7 @@ "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" + "lineNumber": 118 }, "signature": [ "IScopedSearchClient" @@ -2279,8 +2183,7 @@ ], "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" + "lineNumber": 63 } } ], @@ -2292,8 +2195,7 @@ ], "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" + "lineNumber": 63 } }, { @@ -2332,8 +2234,7 @@ "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" + "lineNumber": 83 } } ], @@ -2345,8 +2246,7 @@ ], "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" + "lineNumber": 83 } }, { @@ -2357,8 +2257,7 @@ "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" + "lineNumber": 92 }, "signature": [ { @@ -2378,8 +2277,7 @@ "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" + "lineNumber": 93 } }, { @@ -2390,8 +2288,7 @@ "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" + "lineNumber": 94 } }, { @@ -2402,8 +2299,7 @@ "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" + "lineNumber": 95 }, "signature": [ "any" @@ -2417,8 +2313,7 @@ "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" + "lineNumber": 96 }, "signature": [ { @@ -2439,8 +2334,7 @@ "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" + "lineNumber": 97 }, "signature": [ "boolean | undefined" @@ -2454,8 +2348,7 @@ "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" + "lineNumber": 98 }, "signature": [ "string | undefined" @@ -2486,8 +2379,7 @@ "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" + "lineNumber": 104 } }, { @@ -2524,8 +2416,7 @@ "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" + "lineNumber": 104 } } ], @@ -2533,8 +2424,7 @@ "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" + "lineNumber": 104 } }, { @@ -2560,8 +2450,7 @@ ], "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" + "lineNumber": 134 } } ], @@ -2571,8 +2460,7 @@ "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" + "lineNumber": 134 } }, { @@ -2594,8 +2482,7 @@ "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" + "lineNumber": 171 } } ], @@ -2603,8 +2490,7 @@ "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" + "lineNumber": 171 } }, { @@ -2641,8 +2527,7 @@ "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" + "lineNumber": 175 } } ], @@ -2650,8 +2535,7 @@ "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" + "lineNumber": 175 } }, { @@ -2667,8 +2551,7 @@ "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" + "lineNumber": 179 } }, { @@ -2690,8 +2573,7 @@ "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" + "lineNumber": 183 } }, { @@ -2704,8 +2586,7 @@ "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" + "lineNumber": 183 } } ], @@ -2713,8 +2594,7 @@ "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" + "lineNumber": 183 } }, { @@ -2762,8 +2642,7 @@ "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" + "lineNumber": 209 } }, { @@ -2783,8 +2662,7 @@ "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" + "lineNumber": 209 } } ], @@ -2794,8 +2672,7 @@ "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" + "lineNumber": 209 } }, { @@ -2836,8 +2713,7 @@ ], "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" + "lineNumber": 230 } } ], @@ -2849,8 +2725,7 @@ ], "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" + "lineNumber": 230 } }, { @@ -2876,8 +2751,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 263, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L263" + "lineNumber": 263 } }, { @@ -2903,8 +2777,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 294, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L294" + "lineNumber": 294 } }, { @@ -2924,8 +2797,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 305, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L305" + "lineNumber": 305 } }, { @@ -2951,8 +2823,7 @@ ], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 314, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L314" + "lineNumber": 314 } }, { @@ -2984,8 +2855,7 @@ "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" + "lineNumber": 369 } }, { @@ -3009,8 +2879,7 @@ "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" + "lineNumber": 373 } }, { @@ -3034,8 +2903,7 @@ "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" + "lineNumber": 377 } }, { @@ -3057,8 +2925,7 @@ "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" + "lineNumber": 381 } } ], @@ -3066,8 +2933,7 @@ "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" + "lineNumber": 381 } }, { @@ -3089,8 +2955,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 385, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L385" + "lineNumber": 385 } }, { @@ -3103,8 +2968,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 385, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L385" + "lineNumber": 385 } } ], @@ -3112,8 +2976,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 385, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L385" + "lineNumber": 385 } }, { @@ -3129,8 +2992,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 393, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L393" + "lineNumber": 393 } }, { @@ -3146,8 +3008,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 399, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L399" + "lineNumber": 399 } }, { @@ -3165,8 +3026,7 @@ "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" + "lineNumber": 408 } }, { @@ -3188,8 +3048,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 412, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L412" + "lineNumber": 412 } } ], @@ -3197,8 +3056,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 412, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L412" + "lineNumber": 412 } }, { @@ -3221,8 +3079,7 @@ "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" + "lineNumber": 426 } }, { @@ -3246,8 +3103,7 @@ "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" + "lineNumber": 430 } }, { @@ -3263,8 +3119,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 434, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L434" + "lineNumber": 434 } }, { @@ -3280,8 +3135,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 439, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L439" + "lineNumber": 439 } }, { @@ -3292,8 +3146,7 @@ "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" + "lineNumber": 446 }, "signature": [ { @@ -3313,8 +3166,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 450, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L450" + "lineNumber": 450 }, "signature": [ { @@ -3359,8 +3211,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 480, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L480" + "lineNumber": 480 } } ], @@ -3368,15 +3219,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/aggs/agg_config.ts", - "lineNumber": 480, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L480" + "lineNumber": 480 } } ], "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" + "lineNumber": 55 }, "initialIsOpen": false }, @@ -3395,8 +3244,7 @@ "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" + "lineNumber": 58 }, "signature": [ { @@ -3416,8 +3264,7 @@ "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" + "lineNumber": 59 }, "signature": [ { @@ -3438,8 +3285,7 @@ "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" + "lineNumber": 62 }, "signature": [ { @@ -3477,8 +3323,7 @@ "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" + "lineNumber": 65 } }, { @@ -3515,8 +3360,7 @@ "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" + "lineNumber": 66 } }, { @@ -3535,8 +3379,7 @@ "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" + "lineNumber": 67 } } ], @@ -3544,8 +3387,7 @@ "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" + "lineNumber": 64 } }, { @@ -3581,8 +3423,7 @@ "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" + "lineNumber": 79 } } ], @@ -3590,8 +3431,7 @@ "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" + "lineNumber": 79 } }, { @@ -3620,8 +3460,7 @@ "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" + "lineNumber": 97 } } ], @@ -3629,8 +3468,7 @@ "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" + "lineNumber": 97 } }, { @@ -3671,8 +3509,7 @@ "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" + "lineNumber": 111 } }, { @@ -3685,8 +3522,7 @@ "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" + "lineNumber": 112 } } ], @@ -3736,8 +3572,7 @@ "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" + "lineNumber": 110 }, "tags": [], "returnComment": [] @@ -3780,8 +3615,7 @@ ], "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" + "lineNumber": 153 } } ], @@ -3789,8 +3623,7 @@ "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" + "lineNumber": 153 } }, { @@ -3812,8 +3645,7 @@ "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" + "lineNumber": 165 } } ], @@ -3821,8 +3653,7 @@ "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" + "lineNumber": 165 } }, { @@ -3846,8 +3677,7 @@ "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" + "lineNumber": 227 } }, { @@ -3876,8 +3706,7 @@ "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" + "lineNumber": 231 } } ], @@ -3885,8 +3714,7 @@ "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" + "lineNumber": 231 } }, { @@ -3916,8 +3744,7 @@ "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" + "lineNumber": 235 } } ], @@ -3925,8 +3752,7 @@ "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" + "lineNumber": 235 } }, { @@ -3956,8 +3782,7 @@ "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" + "lineNumber": 239 } } ], @@ -3965,8 +3790,7 @@ "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" + "lineNumber": 239 } }, { @@ -3996,8 +3820,7 @@ "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" + "lineNumber": 243 } } ], @@ -4005,8 +3828,7 @@ "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" + "lineNumber": 243 } }, { @@ -4036,8 +3858,7 @@ "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" + "lineNumber": 247 } } ], @@ -4045,8 +3866,7 @@ "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" + "lineNumber": 247 } }, { @@ -4076,8 +3896,7 @@ "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" + "lineNumber": 251 } } ], @@ -4085,8 +3904,7 @@ "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" + "lineNumber": 251 } }, { @@ -4110,8 +3928,7 @@ "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" + "lineNumber": 255 } }, { @@ -4141,8 +3958,7 @@ "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" + "lineNumber": 269 } } ], @@ -4150,8 +3966,7 @@ "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" + "lineNumber": 269 } }, { @@ -4179,8 +3994,7 @@ "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" + "lineNumber": 284 } }, { @@ -4214,8 +4028,7 @@ ], "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" + "lineNumber": 298 } } ], @@ -4225,8 +4038,7 @@ "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" + "lineNumber": 298 } }, { @@ -4272,8 +4084,7 @@ "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" + "lineNumber": 307 } }, { @@ -4293,8 +4104,7 @@ "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" + "lineNumber": 307 } } ], @@ -4302,111 +4112,320 @@ "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" + "lineNumber": 307 } } ], "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" + "lineNumber": 57 }, "initialIsOpen": false }, { - "id": "def-common.AggType", + "id": "def-common.AggParamType", "type": "Class", "tags": [], - "label": "AggType", + "label": "AggParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggType", - "text": "AggType" + "section": "def-common.AggParamType", + "text": "AggParamType" }, - "" - ], - "children": [ + " extends ", { - "tags": [ - "property", - "type" - ], - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" }, + "" + ], + "children": [ { "tags": [], - "id": "def-common.AggType.type", - "type": "string", - "label": "type", + "id": "def-common.AggParamType.makeAgg", + "type": "Function", + "label": "makeAgg", "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" - } + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 15 + }, + "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" + ] }, { "tags": [], - "id": "def-common.AggType.subtype", - "type": "string", - "label": "subtype", + "id": "def-common.AggParamType.allowedAggs", + "type": "Array", + "label": "allowedAggs", "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" + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 16 }, "signature": [ - "string | undefined" + "string[]" ] }, { - "tags": [ - "property", - "type" + "id": "def-common.AggParamType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], - "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" + "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 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 18 } - }, - { - "tags": [ - "property", - "type" - ], - "id": "def-common.AggType.expressionName", - "type": "string", - "label": "expressionName", + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/agg.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggsCommonService", + "type": "Class", + "tags": [], + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 56 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 73 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/aggs_service.ts", + "lineNumber": 53 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggType", + "type": "Class", + "tags": [], + "label": "AggType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggType", + "text": "AggType" + }, + "" + ], + "children": [ + { + "tags": [ + "property", + "type" + ], + "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 + } + }, + { + "tags": [], + "id": "def-common.AggType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 72 + } + }, + { + "tags": [], + "id": "def-common.AggType.subtype", + "type": "string", + "label": "subtype", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 73 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [ + "property", + "type" + ], + "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 + } + }, + { + "tags": [ + "property", + "type" + ], + "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" + "lineNumber": 87 } }, { @@ -4422,8 +4441,7 @@ ], "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" + "lineNumber": 94 } }, { @@ -4436,8 +4454,7 @@ ], "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" + "lineNumber": 99 }, "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" @@ -4455,8 +4472,7 @@ ], "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" + "lineNumber": 108 }, "signature": [ "((aggConfig: TAggConfig) => string) | (() => string)" @@ -4475,8 +4491,7 @@ ], "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" + "lineNumber": 123 }, "signature": [ "any" @@ -4494,8 +4509,7 @@ ], "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" + "lineNumber": 131 } }, { @@ -4508,8 +4522,7 @@ ], "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" + "lineNumber": 138 }, "signature": [ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" @@ -4528,8 +4541,7 @@ ], "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" + "lineNumber": 145 }, "signature": [ "TParam[]" @@ -4547,8 +4559,7 @@ ], "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" + "lineNumber": 155 }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" @@ -4566,8 +4577,7 @@ ], "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" + "lineNumber": 166 }, "signature": [ "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])" @@ -4583,8 +4593,7 @@ ], "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" + "lineNumber": 171 }, "signature": [ "() => any" @@ -4602,8 +4611,7 @@ ], "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" + "lineNumber": 184 }, "signature": [ "(resp: any, aggConfigs: ", @@ -4645,8 +4653,7 @@ ], "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" + "lineNumber": 202 }, "signature": [ "(agg: TAggConfig) => ", @@ -4668,8 +4675,7 @@ "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" + "lineNumber": 204 }, "signature": [ "(agg: TAggConfig, bucket: any) => any" @@ -4683,8 +4689,7 @@ "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" + "lineNumber": 206 }, "signature": [ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" @@ -4704,8 +4709,7 @@ "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" + "lineNumber": 208 } } ], @@ -4716,8 +4720,7 @@ "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" + "lineNumber": 208 }, "tags": [], "returnComment": [] @@ -4736,8 +4739,7 @@ "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" + "lineNumber": 212 } } ], @@ -4748,8 +4750,7 @@ "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" + "lineNumber": 212 }, "tags": [], "returnComment": [] @@ -4792,8 +4793,7 @@ ], "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" + "lineNumber": 225 } } ], @@ -4804,15 +4804,13 @@ "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" + "lineNumber": 225 } } ], "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" + "lineNumber": 60 }, "initialIsOpen": false }, @@ -4866,8 +4864,7 @@ "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" + "lineNumber": 31 }, "tags": [], "returnComment": [] @@ -4883,8 +4880,7 @@ "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" + "lineNumber": 60 }, "tags": [], "returnComment": [] @@ -4892,131 +4888,262 @@ ], "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" + "lineNumber": 27 }, "initialIsOpen": false }, { - "id": "def-common.AggsCommonService", + "id": "def-common.BaseParamType", "type": "Class", "tags": [], - "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." + "label": "BaseParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" + }, + "" ], "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": [], + "id": "def-common.BaseParamType.name", + "type": "string", + "label": "name", + "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" + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 15 } }, { - "id": "def-common.AggsCommonService.start", + "tags": [], + "id": "def-common.BaseParamType.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.displayName", + "type": "string", + "label": "displayName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 18 + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.advanced", + "type": "boolean", + "label": "advanced", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-common.BaseParamType.default", + "type": "Any", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 20 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.write", "type": "Function", - "label": "start", + "label": "write", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 21 + }, "signature": [ - "({ getConfig, getIndexPattern, isDefaultTimezone, }: ", + "(aggConfig: TAggConfig, output: Record, aggConfigs?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStartDependencies", - "text": "AggsCommonStartDependencies" + "section": "def-common.AggConfigs", + "text": "AggConfigs" }, - ") => ", + " | undefined, locals?: Record | undefined) => void" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.serialize", + "type": "Function", + "label": "serialize", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 27 + }, + "signature": [ + "(value: any, aggConfig?: TAggConfig | undefined) => any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 28 + }, + "signature": [ + "(value: any, aggConfig?: TAggConfig | undefined) => any" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.toExpressionAst", + "type": "Function", + "label": "toExpressionAst", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 29 + }, + "signature": [ + "((value: any) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 30 + }, + "signature": [ + "any[]" + ] + }, + { + "tags": [], + "id": "def-common.BaseParamType.valueType", + "type": "Any", + "label": "valueType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 31 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "(aggConfig: TAggConfig, searchSource?: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStart", - "text": "AggsCommonStart" - } + "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": "{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }", + "label": "config", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggsCommonStartDependencies", - "text": "AggsCommonStartDependencies" - } + "Record" ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 51 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 51 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/base.ts", + "lineNumber": 14 }, "initialIsOpen": false }, @@ -5061,8 +5188,7 @@ "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" + "lineNumber": 35 }, "signature": [ "(bucket: any, key: any, agg: TBucketAggConfig) => any" @@ -5076,8 +5202,7 @@ "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" + "lineNumber": 36 } }, { @@ -5099,8 +5224,7 @@ "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" + "lineNumber": 38 } } ], @@ -5108,15 +5232,13 @@ "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" + "lineNumber": 38 } } ], "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" + "lineNumber": 31 }, "initialIsOpen": false }, @@ -5135,8 +5257,7 @@ "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" + "lineNumber": 18 }, "signature": [ { @@ -5156,8 +5277,7 @@ "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" + "lineNumber": 19 } }, { @@ -5179,8 +5299,7 @@ "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" + "lineNumber": 21 } } ], @@ -5188,8 +5307,7 @@ "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" + "lineNumber": 21 } }, { @@ -5205,8 +5323,7 @@ "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" + "lineNumber": 33 } }, { @@ -5222,109 +5339,104 @@ "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" + "lineNumber": 44 } } ], "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" + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.MetricAggType", + "id": "def-common.FieldParamType", "type": "Class", "tags": [], - "label": "MetricAggType", + "label": "FieldParamType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "section": "def-common.FieldParamType", + "text": "FieldParamType" }, - " extends ", + " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggType", - "text": "AggType" + "section": "def-common.BaseParamType", + "text": "BaseParamType" }, - ">" + ">" ], "children": [ { "tags": [], - "id": "def-common.MetricAggType.subtype", - "type": "string", - "label": "subtype", + "id": "def-common.FieldParamType.required", + "type": "boolean", + "label": "required", "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 24 } }, { "tags": [], - "id": "def-common.MetricAggType.isScalable", - "type": "Function", - "label": "isScalable", + "id": "def-common.FieldParamType.scriptable", + "type": "boolean", + "label": "scriptable", "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" - ] + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 25 + } }, { "tags": [], - "id": "def-common.MetricAggType.type", - "type": "string", - "label": "type", + "id": "def-common.FieldParamType.filterFieldTypes", + "type": "CompoundType", + "label": "filterFieldTypes", "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": [], + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 26 + }, "signature": [ - "() => void" - ], + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FieldTypes", + "text": "FieldTypes" + } + ] + }, + { + "tags": [], + "id": "def-common.FieldParamType.onlyAggregatable", + "type": "boolean", + "label": "onlyAggregatable", "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 27 + } }, { - "id": "def-common.MetricAggType.Unnamed", + "id": "def-common.FieldParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -5337,97 +5449,102 @@ "label": "config", "isRequired": true, "signature": [ - "MetricAggTypeConfig" + "Record" ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 29 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 29 } + }, + { + "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 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 23 }, "initialIsOpen": false }, { - "id": "def-common.AggParamType", + "id": "def-common.InvalidEsCalendarIntervalError", "type": "Class", "tags": [], - "label": "AggParamType", + "label": "InvalidEsCalendarIntervalError", "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" + "section": "def-common.InvalidEsCalendarIntervalError", + "text": "InvalidEsCalendarIntervalError" }, - "" + " extends Error" ], "children": [ { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", + "id": "def-common.InvalidEsCalendarIntervalError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -5436,269 +5553,237 @@ "description": [], "children": [ { - "type": "Object", - "label": "config", + "type": "string", + "label": "interval", "isRequired": true, "signature": [ - "Record" + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 14 + } + }, + { + "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 + } + }, + { + "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 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 13 } } ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts", + "lineNumber": 12 }, "initialIsOpen": false }, { - "id": "def-common.BaseParamType", + "id": "def-common.InvalidEsIntervalFormatError", "type": "Class", "tags": [], - "label": "BaseParamType", + "label": "InvalidEsIntervalFormatError", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" + "section": "def-common.InvalidEsIntervalFormatError", + "text": "InvalidEsIntervalFormatError" }, - "" + " extends Error" ], "children": [ { - "tags": [], - "id": "def-common.BaseParamType.name", - "type": "string", - "label": "name", + "id": "def-common.InvalidEsIntervalFormatError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], "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" - } - }, - { + "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 + } + } + ], "tags": [], - "id": "def-common.BaseParamType.type", - "type": "string", - "label": "type", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 12 } - }, + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.Ipv4Address", + "type": "Class", + "tags": [], + "label": "Ipv4Address", + "description": [], + "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, + "id": "def-common.Ipv4Address.Unnamed", + "type": "Function", + "label": "Constructor", "signature": [ "any" - ] - }, - { - "tags": [], - "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?: ", + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfigs", - "text": "AggConfigs" - }, - " | undefined, locals?: Record | undefined) => void" - ] - }, - { + "type": "CompoundType", + "label": "ipAddress", + "isRequired": true, + "signature": [ + "React.ReactText" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 25 + } + } + ], "tags": [], - "id": "def-common.BaseParamType.serialize", - "type": "Function", - "label": "serialize", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 25 + } }, { - "tags": [], - "id": "def-common.BaseParamType.deserialize", + "id": "def-common.Ipv4Address.toString", "type": "Function", - "label": "deserialize", + "label": "toString", + "signature": [ + "() => string" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 50 + } }, { - "tags": [], - "id": "def-common.BaseParamType.toExpressionAst", + "id": "def-common.Ipv4Address.valueOf", "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" - }, + "label": "valueOf", "signature": [ - "((value: any) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - " | undefined) | undefined" - ] - }, - { - "tags": [], - "id": "def-common.BaseParamType.options", - "type": "Array", - "label": "options", + "() => number" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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[]" - ] + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 60 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/ipv4_address.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + }, + { + "id": "def-common.JsonParamType", + "type": "Class", + "tags": [], + "label": "JsonParamType", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.JsonParamType", + "text": "JsonParamType" }, + " extends ", { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BaseParamType", + "text": "BaseParamType" }, + "<", { - "tags": [], - "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" - ] + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, + ">" + ], + "children": [ { - "id": "def-common.BaseParamType.Unnamed", + "id": "def-common.JsonParamType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -5715,249 +5800,112 @@ ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 15 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 15 } } ], "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" + "path": "src/plugins/data/common/search/aggs/param_types/json.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-common.FieldParamType", + "id": "def-common.MetricAggType", "type": "Class", "tags": [], - "label": "FieldParamType", + "label": "MetricAggType", "description": [], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldParamType", - "text": "FieldParamType" + "section": "def-common.MetricAggType", + "text": "MetricAggType" }, - " extends ", + " extends ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" + "section": "def-common.AggType", + "text": "AggType" }, - "<", + "" + ">" ], "children": [ { "tags": [], - "id": "def-common.FieldParamType.required", - "type": "boolean", - "label": "required", + "id": "def-common.MetricAggType.subtype", + "type": "string", + "label": "subtype", "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 41 } }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.FieldParamType.filterFieldTypes", - "type": "CompoundType", - "label": "filterFieldTypes", + "id": "def-common.MetricAggType.isScalable", + "type": "Function", + "label": "isScalable", "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 42 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FieldTypes", - "text": "FieldTypes" - } + "() => boolean" ] }, { "tags": [], - "id": "def-common.FieldParamType.onlyAggregatable", - "type": "boolean", - "label": "onlyAggregatable", + "id": "def-common.MetricAggType.type", + "type": "string", + "label": "type", "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 43 } }, { - "id": "def-common.FieldParamType.Unnamed", + "id": "def-common.MetricAggType.getKey", "type": "Function", - "label": "Constructor", + "children": [], "signature": [ - "any" + "() => void" ], "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", + "label": "getKey", "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 45 }, "tags": [], "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", - "tags": [], - "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", + "id": "def-common.MetricAggType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -5970,29 +5918,26 @@ "label": "config", "isRequired": true, "signature": [ - "Record" + "MetricAggTypeConfig" ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 47 } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 47 } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 37 }, "initialIsOpen": false }, @@ -6037,8 +5982,7 @@ "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" + "lineNumber": 20 }, "signature": [ { @@ -6070,8 +6014,7 @@ "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" + "lineNumber": 22 } } ], @@ -6079,53 +6022,59 @@ "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" + "lineNumber": 22 } } ], "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" + "lineNumber": 19 }, "initialIsOpen": false }, { - "id": "def-common.StringParamType", + "id": "def-common.RequestFailure", "type": "Class", "tags": [], - "label": "StringParamType", - "description": [], + "label": "RequestFailure", + "description": [ + "\nRequest Failure - When an entire multi request fails" + ], "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.StringParamType", - "text": "StringParamType" + "section": "def-common.RequestFailure", + "text": "RequestFailure" }, " extends ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BaseParamType", - "text": "BaseParamType" - }, - "<", - { - "pluginId": "data", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ">" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.KbnError", + "text": "KbnError" + } ], "children": [ { - "id": "def-common.StringParamType.Unnamed", + "tags": [], + "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 + }, + "signature": [ + "SearchResponse", + " | undefined" + ] + }, + { + "id": "def-common.RequestFailure.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -6133,57 +6082,81 @@ ], "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 + } + }, { "type": "Object", - "label": "config", - "isRequired": true, + "label": "resp", + "isRequired": false, "signature": [ - "Record" + "SearchResponse", + " | undefined" ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 20 } } ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 20 } } ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/request_error.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-common.InvalidEsCalendarIntervalError", + "id": "def-common.SearchSource", "type": "Class", - "tags": [], - "label": "InvalidEsCalendarIntervalError", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.InvalidEsCalendarIntervalError", - "text": "InvalidEsCalendarIntervalError" - }, - " extends Error" + "tags": [ + "public" ], + "label": "SearchSource", + "description": [], "children": [ { - "id": "def-common.InvalidEsCalendarIntervalError.Unnamed", - "type": "Function", + "tags": [], + "id": "def-common.SearchSource.history", + "type": "Array", + "label": "history", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 111 + }, + "signature": [ + "Record[]" + ] + }, + { + "id": "def-common.SearchSource.Unnamed", + "type": "Function", "label": "Constructor", "signature": [ "any" @@ -6191,391 +6164,317 @@ "description": [], "children": [ { - "type": "string", - "label": "interval", + "type": "Object", + "label": "fields", "isRequired": true, "signature": [ - "string" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 115 } }, { - "type": "number", - "label": "value", + "type": "Object", + "label": "dependencies", "isRequired": true, "signature": [ - "number" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceDependencies", + "text": "SearchSourceDependencies" + } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 115 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 115 + } + }, + { + "id": "def-common.SearchSource.setPreferredSearchStrategyId", + "type": "Function", + "label": "setPreferredSearchStrategyId", + "signature": [ + "(searchStrategyId: string) => void" + ], + "description": [ + "**\nPUBLIC API\n\ninternal, dont use" + ], + "children": [ { - "type": "CompoundType", - "label": "unit", + "type": "string", + "label": "searchStrategyId", "isRequired": true, "signature": [ - "Unit" + "string" ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 133 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 133 + } + }, + { + "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": "string", - "label": "type", + "type": "Uncategorized", + "label": "field", "isRequired": true, "signature": [ - "string" + "K" + ], + "description": [ + ": field name" ], - "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 142 + } + }, + { + "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": 142 } } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 142 } - } - ], - "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", - "tags": [], - "label": "InvalidEsIntervalFormatError", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.InvalidEsIntervalFormatError", - "text": "InvalidEsIntervalFormatError" }, - " extends Error" - ], - "children": [ { - "id": "def-common.InvalidEsIntervalFormatError.Unnamed", + "id": "def-common.SearchSource.removeField", "type": "Function", - "label": "Constructor", + "label": "removeField", "signature": [ - "any" + "(field: K) => this" + ], + "description": [ + "\nremove field" ], - "description": [], "children": [ { - "type": "string", - "label": "interval", + "type": "Uncategorized", + "label": "field", "isRequired": true, "signature": [ - "string" + "K" + ], + "description": [ + ": field name" ], - "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 154 } } ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 154 } - } - ], - "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", - "tags": [], - "label": "Ipv4Address", - "description": [], - "children": [ + }, { - "id": "def-common.Ipv4Address.Unnamed", + "id": "def-common.SearchSource.setFields", "type": "Function", - "label": "Constructor", + "label": "setFields", "signature": [ - "any" + "(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" ], - "description": [], "children": [ { - "type": "CompoundType", - "label": "ipAddress", + "type": "Object", + "label": "newFields", "isRequired": true, "signature": [ - "React.ReactText" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + } + ], + "description": [ + "New field array." ], - "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 165 } } ], - "tags": [], + "tags": [ + "private" + ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 165 } }, { - "id": "def-common.Ipv4Address.toString", + "id": "def-common.SearchSource.getId", "type": "Function", - "label": "toString", + "label": "getId", "signature": [ "() => string" ], - "description": [], + "description": [ + "\nreturns search source id" + ], "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 173 } }, { - "id": "def-common.Ipv4Address.valueOf", + "id": "def-common.SearchSource.getFields", "type": "Function", - "label": "valueOf", + "label": "getFields", "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", - "tags": [], - "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": [ - { - "tags": [], - "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" - } + "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/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", - "tags": [ - "public" - ], - "label": "SearchSource", - "description": [], - "children": [ - { - "tags": [], - "id": "def-common.SearchSource.history", - "type": "Array", - "label": "history", - "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 111, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L111" - }, - "signature": [ - "Record[]" - ] + "lineNumber": 180 + } }, { - "id": "def-common.SearchSource.Unnamed", + "id": "def-common.SearchSource.getField", "type": "Function", - "label": "Constructor", + "label": "getField", "signature": [ - "any" + "(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" ], - "description": [], "children": [ { - "type": "Object", - "label": "fields", + "type": "Uncategorized", + "label": "field", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "K" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L115" + "lineNumber": 187 } }, { - "type": "Object", - "label": "dependencies", + "type": "boolean", + "label": "recurse", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceDependencies", - "text": "SearchSourceDependencies" - } + "boolean" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L115" + "lineNumber": 187 } } ], @@ -6583,33 +6482,39 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L115" + "lineNumber": 187 } }, { - "id": "def-common.SearchSource.setPreferredSearchStrategyId", + "id": "def-common.SearchSource.getOwnField", "type": "Function", - "label": "setPreferredSearchStrategyId", + "label": "getOwnField", "signature": [ - "(searchStrategyId: string) => void" + "(field: K) => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + "[K]" ], "description": [ - "**\nPUBLIC API\n\ninternal, dont use" + "\nGet the field from our own fields, don't traverse up the chain" ], "children": [ { - "type": "string", - "label": "searchStrategyId", + "type": "Uncategorized", + "label": "field", "isRequired": true, "signature": [ - "string" + "K" ], "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L133" + "lineNumber": 198 } } ], @@ -6617,338 +6522,38 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 133, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L133" + "lineNumber": 198 } }, { - "id": "def-common.SearchSource.setField", + "id": "def-common.SearchSource.create", "type": "Function", - "label": "setField", + "label": "create", "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": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L142" - } - }, - { - "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": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L142" - } + "section": "def-common.SearchSource", + "text": "SearchSource" } ], - "tags": [], + "description": [], + "children": [], + "tags": [ + "deprecated" + ], "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L142" + "lineNumber": 205 } }, { - "id": "def-common.SearchSource.removeField", + "id": "def-common.SearchSource.createCopy", "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": 154, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L154" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 154, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L154" - } - }, - { - "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": 165, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L165" - } - } - ], - "tags": [ - "private" - ], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 165, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L165" - } - }, - { - "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": 173, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L173" - } - }, - { - "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": 180, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L180" - } - }, - { - "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": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L187" - } - }, - { - "type": "boolean", - "label": "recurse", - "isRequired": true, - "signature": [ - "boolean" - ], - "description": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L187" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L187" - } - }, - { - "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": 198, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L198" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 198, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L198" - } - }, - { - "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": 205, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L205" - } - }, - { - "id": "def-common.SearchSource.createCopy", - "type": "Function", - "label": "createCopy", + "label": "createCopy", "signature": [ "() => ", { @@ -6967,8 +6572,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L212" + "lineNumber": 212 } }, { @@ -6999,8 +6603,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L226" + "lineNumber": 226 } } ], @@ -7008,8 +6611,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L226" + "lineNumber": 226 } }, { @@ -7059,8 +6661,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L238" + "lineNumber": 238 } }, { @@ -7081,8 +6682,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L238" + "lineNumber": 238 } } ], @@ -7094,8 +6694,7 @@ ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L238" + "lineNumber": 238 } }, { @@ -7123,8 +6722,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 248, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L248" + "lineNumber": 248 } }, { @@ -7166,8 +6764,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L256" + "lineNumber": 256 } } ], @@ -7175,8 +6772,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L256" + "lineNumber": 256 } }, { @@ -7216,8 +6812,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L283" + "lineNumber": 283 } } ], @@ -7227,8 +6822,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 283, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L283" + "lineNumber": 283 } }, { @@ -7284,8 +6878,7 @@ "description": [], "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" + "lineNumber": 293 } } ], @@ -7295,8 +6888,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 292, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L292" + "lineNumber": 292 } }, { @@ -7314,8 +6906,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 301, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L301" + "lineNumber": 301 } }, { @@ -7335,8 +6926,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 310, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L310" + "lineNumber": 310 } }, { @@ -7367,8 +6957,7 @@ "description": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L688" + "lineNumber": 688 } } ], @@ -7376,8 +6965,7 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 688, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L688" + "lineNumber": 688 } }, { @@ -7405,15 +6993,13 @@ "returnComment": [], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 717, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L717" + "lineNumber": 717 } } ], "source": { "path": "src/plugins/data/common/search/search_source/search_source.ts", - "lineNumber": 103, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L103" + "lineNumber": 103 }, "initialIsOpen": false }, @@ -7437,8 +7023,7 @@ "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" + "lineNumber": 13 } }, { @@ -7507,8 +7092,7 @@ "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" + "lineNumber": 15 } }, { @@ -7527,8 +7111,7 @@ "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" + "lineNumber": 15 } } ], @@ -7536,8 +7119,7 @@ "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" + "lineNumber": 15 } }, { @@ -7553,982 +7135,511 @@ "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" + "lineNumber": 30 } } ], "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" + "lineNumber": 12 }, "initialIsOpen": false - } - ], - "functions": [ + }, { - "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" - } - } - ], + "id": "def-common.StringParamType", + "type": "Class", + "tags": [], + "label": "StringParamType", + "description": [], "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isBucketAggType", - "type": "Function", - "label": "isBucketAggType", - "signature": [ - "(aggConfig: any) => boolean" + { + "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" + }, + ">" ], - "description": [], "children": [ { - "type": "Any", - "label": "aggConfig", - "isRequired": true, + "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 + } + } + ], + "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" + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 13 } } ], - "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" + "path": "src/plugins/data/common/search/aggs/param_types/string.ts", + "lineNumber": 12 }, "initialIsOpen": false - }, + } + ], + "functions": [ { - "id": "def-common.aggDateHistogram", + "id": "def-common.aggAvg", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggDateHistogram", + "label": "aggAvg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", + "lineNumber": 20 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isDateHistogramBucketAggConfig", + "id": "def-common.aggBucketAvg", "type": "Function", - "label": "isDateHistogramBucketAggConfig", + "children": [], "signature": [ - "(agg: any) => boolean" + "() => FunctionDefinition" ], "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": [], + "label": "aggBucketAvg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", + "lineNumber": 30 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getDateHistogramBucketAgg", + "id": "def-common.aggBucketMax", "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" - } - } - ], + "children": [], "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getDateHistogramBucketAgg", + "label": "aggBucketMax", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggDateRange", + "id": "def-common.aggBucketMin", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggDateRange", + "label": "aggBucketMin", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getDateRangeBucketAgg", + "id": "def-common.aggBucketSum", "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" - } - } - ], + "children": [], "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getDateRangeBucketAgg", + "label": "aggBucketSum", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggFilter", + "id": "def-common.aggCardinality", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggFilter", + "label": "aggCardinality", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getFilterBucketAgg", + "id": "def-common.aggCount", "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getFilterBucketAgg", + "label": "aggCount", "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" + "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggFilters", + "id": "def-common.aggCumulativeSum", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggFilters", + "label": "aggCumulativeSum", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", + "lineNumber": 27 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getFiltersBucketAgg", + "id": "def-common.aggDateHistogram", "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" - } - } - ], + "children": [], "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getFiltersBucketAgg", + "label": "aggDateHistogram", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggGeoHash", + "id": "def-common.aggDateRange", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggGeoHash", + "label": "aggDateRange", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getGeoHashBucketAgg", + "id": "def-common.aggDerivative", "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getGeoHashBucketAgg", + "label": "aggDerivative", "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", + "lineNumber": 27 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggGeoTile", + "id": "def-common.aggFilter", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggGeoTile", + "label": "aggFilter", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getGeoTitleBucketAgg", + "id": "def-common.aggFilters", "type": "Function", "children": [], "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.BucketAggType", - "text": "BucketAggType" - }, - "" + "() => FunctionDefinition" ], "description": [], - "label": "getGeoTitleBucketAgg", + "label": "aggFilters", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggHistogram", + "id": "def-common.aggGeoBounds", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggHistogram", + "label": "aggGeoBounds", "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getHistogramBucketAgg", + "id": "def-common.aggGeoCentroid", "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" - } - } - ], + "children": [], "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getHistogramBucketAgg", + "label": "aggGeoCentroid", "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggIpRange", + "id": "def-common.aggGeoHash", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggIpRange", + "label": "aggGeoHash", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", + "lineNumber": 29 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getIpRangeBucketAgg", + "id": "def-common.aggGeoTile", "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getIpRangeBucketAgg", + "label": "aggGeoTile", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", + "lineNumber": 26 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.convertDateRangeToString", + "id": "def-common.aggHistogram", "type": "Function", - "label": "convertDateRangeToString", + "children": [], "signature": [ - "({ from, to }: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.DateRangeKey", - "text": "DateRangeKey" - }, - ", format: (val: any) => string) => string" + "() => FunctionDefinition" ], "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": [], + "label": "aggHistogram", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", + "lineNumber": 30 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.convertIPRangeToString", + "id": "def-common.aggIpRange", "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" - } - } - ], + "children": [], "signature": [ - "(range: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IpRangeKey", - "text": "IpRangeKey" - }, - ", format: (val: any) => string) => string" + "() => FunctionDefinition" ], "description": [], - "label": "convertIPRangeToString", + "label": "aggIpRange", "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" + "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.calcAutoIntervalNear", + "id": "def-common.aggMax", "type": "Function", - "label": "calcAutoIntervalNear", + "children": [], "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" - } - } + "() => FunctionDefinition" ], - "tags": [], - "returnComment": [], + "description": [], + "label": "aggMax", "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" + "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", + "lineNumber": 20 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.calcAutoIntervalLessThan", + "id": "def-common.aggMedian", "type": "Function", - "label": "calcAutoIntervalLessThan", + "children": [], "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" - } - } + "() => FunctionDefinition" ], - "tags": [], - "returnComment": [], + "description": [], + "label": "aggMedian", "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" + "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", + "lineNumber": 25 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isType", + "id": "def-common.aggMin", "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" - } - } - ], + "children": [], "signature": [ - "(...types: string[]) => (agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" + "() => FunctionDefinition" ], "description": [], - "label": "isType", + "label": "aggMin", "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" + "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", + "lineNumber": 20 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.isNumberType", + "id": "def-common.aggMovingAvg", "type": "Function", - "label": "isNumberType", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], "description": [], + "label": "aggMovingAvg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", + "lineNumber": 27 }, - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.isStringType", + "id": "def-common.aggPercentileRanks", "type": "Function", - "label": "isStringType", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], "description": [], + "label": "aggPercentileRanks", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", + "lineNumber": 25 }, - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.isStringOrNumberType", + "id": "def-common.aggPercentiles", "type": "Function", - "label": "isStringOrNumberType", + "children": [], + "signature": [ + "() => FunctionDefinition" + ], "description": [], + "label": "aggPercentiles", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", + "lineNumber": 25 }, - "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" - ], + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -8542,71 +7653,24 @@ "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" + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getRangeBucketAgg", + "id": "def-common.aggSerialDiff", "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" - } - } - ], + "children": [], "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getRangeBucketAgg", + "label": "aggSerialDiff", "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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", + "lineNumber": 27 }, "tags": [], "returnComment": [], @@ -8623,275 +7687,909 @@ "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" + "lineNumber": 28 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getSignificantTermsBucketAgg", + "id": "def-common.aggStdDeviation", "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getSignificantTermsBucketAgg", + "label": "aggStdDeviation", "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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggTerms", + "id": "def-common.aggSum", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggTerms", + "label": "aggSum", "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" + "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", + "lineNumber": 20 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getTermsBucketAgg", + "id": "def-common.aggTerms", "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" - }, - ">" + "() => FunctionDefinition" ], "description": [], - "label": "getTermsBucketAgg", + "label": "aggTerms", "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" + "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", + "lineNumber": 31 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggAvg", + "id": "def-common.aggTopHit", "type": "Function", "children": [], "signature": [ "() => FunctionDefinition" ], "description": [], - "label": "aggAvg", + "label": "aggTopHit", "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" + "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getAvgMetricAgg", + "id": "def-common.calcAutoIntervalLessThan", "type": "Function", - "children": [], + "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": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "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 + } }, - "<", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" - }, - ">" + "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 + } + } ], - "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" - }, "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 252 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getBucketAvgMetricAgg", + "id": "def-common.calcAutoIntervalNear", "type": "Function", - "children": [], + "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": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "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 + } }, - "<", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" - }, - ">" + "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 + } + } ], - "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" - }, "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 225 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getBucketMaxMetricAgg", + "id": "def-common.convertDateRangeToString", "type": "Function", - "children": [], + "label": "convertDateRangeToString", "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" - }, - "<", + "({ from, to }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.DateRangeKey", + "text": "DateRangeKey" }, - ">" + ", format: (val: any) => string) => string" ], "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" - }, - "tags": [], + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 14 + }, + "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 + } + }, + { + "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + }, + { + "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 + } + } + ], + "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 + }, + "tags": [ + "return", + "public" + ], + "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.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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts", + "lineNumber": 31 + }, + "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 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [], + "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 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/legacy/fetch_soon.ts", + "lineNumber": 19 + }, + "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 + } + } + ], + "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" + }, + ", ", + "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 + }, + "tags": [], + "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 + }, + "tags": [], + "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 + }, + "tags": [], + "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 + }, + "tags": [], + "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 + }, + "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggBucketMin", + "id": "def-common.getBucketSumMetricAgg", "type": "Function", "children": [], "signature": [ - "() => FunctionDefinition" + "() => ", + { + "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": "aggBucketMin", + "label": "getBucketSumMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getBucketMinMetricAgg", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts", + "lineNumber": 16 + }, + "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 + }, + "tags": [], + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.getCumulativeSumMetricAgg", "type": "Function", "children": [], "signature": [ @@ -8908,42 +8606,145 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + }, + ">" + ], + "description": [], + "label": "getCumulativeSumMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 31 + }, + "tags": [], + "returnComment": [], + "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + } + ], + "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": "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.aggBucketSum", - "type": "Function", - "children": [], - "signature": [ - "() => FunctionDefinition" - ], - "description": [], - "label": "aggBucketSum", + "label": "getDateRangeBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 37 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getBucketSumMetricAgg", + "id": "def-common.getDerivativeMetricAgg", "type": "Function", "children": [], "signature": [ @@ -8966,36 +8767,17 @@ ">" ], "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.aggCardinality", - "type": "Function", - "children": [], - "signature": [ - "() => FunctionDefinition" - ], - "description": [], - "label": "aggCardinality", + "label": "getDerivativeMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 31 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getCardinalityMetricAgg", + "id": "def-common.getFilterBucketAgg", "type": "Function", "children": [], "signature": [ @@ -9004,102 +8786,92 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "section": "def-common.BucketAggType", + "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" }, ">" ], "description": [], - "label": "getCardinalityMetricAgg", + "label": "getFilterBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 24 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getCountMetricAgg", + "id": "def-common.getFiltersBucketAgg", "type": "Function", - "children": [], + "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 + } + } + ], "signature": [ - "() => ", + "({ getConfig }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "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.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" }, ">" ], "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" - }, - "tags": [], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.aggCumulativeSum", - "type": "Function", - "children": [], - "signature": [ - "() => FunctionDefinition" - ], - "description": [], - "label": "aggCumulativeSum", + "label": "getFiltersBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 43 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getCumulativeSumMetricAgg", + "id": "def-common.getGeoBoundsMetricAgg", "type": "Function", "children": [], "signature": [ @@ -9122,36 +8894,17 @@ ">" ], "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.aggDerivative", - "type": "Function", - "children": [], - "signature": [ - "() => FunctionDefinition" - ], - "description": [], - "label": "aggDerivative", + "label": "getGeoBoundsMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 28 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getDerivativeMetricAgg", + "id": "def-common.getGeoCentroidMetricAgg", "type": "Function", "children": [], "signature": [ @@ -9174,36 +8927,17 @@ ">" ], "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.aggGeoBounds", - "type": "Function", - "children": [], - "signature": [ - "() => FunctionDefinition" - ], - "description": [], - "label": "aggGeoBounds", + "label": "getGeoCentroidMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 28 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getGeoBoundsMetricAgg", + "id": "def-common.getGeoHashBucketAgg", "type": "Function", "children": [], "signature": [ @@ -9212,95 +8946,143 @@ "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "section": "def-common.BucketAggType", + "text": "BucketAggType" }, "<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" }, ">" ], "description": [], - "label": "getGeoBoundsMetricAgg", + "label": "getGeoHashBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 37 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggGeoCentroid", + "id": "def-common.getGeoTitleBucketAgg", "type": "Function", "children": [], "signature": [ - "() => FunctionDefinition" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "" ], "description": [], - "label": "aggGeoCentroid", + "label": "getGeoTitleBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 29 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getGeoCentroidMetricAgg", + "id": "def-common.getHistogramBucketAgg", "type": "Function", - "children": [], + "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 + } + } + ], "signature": [ - "() => ", + "({ getConfig, getFieldFormatsStart, }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "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.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.IBucketHistogramAggConfig", + "text": "IBucketHistogramAggConfig" }, ">" ], "description": [], - "label": "getGeoCentroidMetricAgg", + "label": "getHistogramBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 51 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggMax", + "id": "def-common.getIpRangeBucketAgg", "type": "Function", "children": [], "signature": [ - "() => FunctionDefinition" + "() => ", + { + "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": "aggMax", + "label": "getIpRangeBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 38 }, "tags": [], "returnComment": [], @@ -9333,26 +9115,7 @@ "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" - }, - "tags": [], - "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" + "lineNumber": 24 }, "tags": [], "returnComment": [], @@ -9385,59 +9148,7 @@ "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" - }, - "tags": [], - "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" + "lineNumber": 24 }, "tags": [], "returnComment": [], @@ -9470,26 +9181,7 @@ "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" - }, - "tags": [], - "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" + "lineNumber": 24 }, "tags": [], "returnComment": [], @@ -9522,26 +9214,54 @@ "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" + "lineNumber": 33 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggPercentileRanks", + "id": "def-common.getNumberHistogramIntervalByDatatableColumn", "type": "Function", - "children": [], + "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 + } + } + ], "signature": [ - "() => FunctionDefinition" + "(column: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + ") => number | undefined" ], - "description": [], - "label": "aggPercentileRanks", + "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/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" + "path": "src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts", + "lineNumber": 19 }, "tags": [], "returnComment": [], @@ -9567,8 +9287,7 @@ "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" + "lineNumber": 52 } } ], @@ -9585,143 +9304,26 @@ { "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.aggStdDeviation", - "type": "Function", - "children": [], - "signature": [ - "() => FunctionDefinition" + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + "IResponseAggConfig", + ">" ], "description": [], - "label": "aggStdDeviation", + "label": "getPercentileRanksMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 52 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getStdDeviationMetricAgg", + "id": "def-common.getPercentilesMetricAgg", "type": "Function", "children": [], "signature": [ @@ -9734,185 +9336,267 @@ "text": "MetricAggType" }, "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IStdDevAggConfig", - "text": "IStdDevAggConfig" - }, + "IResponseAggConfig", ">" ], "description": [], - "label": "getStdDeviationMetricAgg", + "label": "getPercentilesMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 38 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggSum", + "id": "def-common.getPreference", "type": "Function", - "children": [], + "label": "getPreference", "signature": [ - "() => FunctionDefinition" + "(getConfig: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + }, + ") => any" ], "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" - }, + "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 + } + } + ], "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 22 + }, "initialIsOpen": false }, { - "id": "def-common.getSumMetricAgg", + "id": "def-common.getRangeBucketAgg", "type": "Function", - "children": [], + "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 + } + } + ], "signature": [ - "() => ", + "({ getFieldFormatsStart }: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "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.IMetricAggConfig", - "text": "IMetricAggConfig" + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" }, ">" ], "description": [], - "label": "getSumMetricAgg", + "label": "getRangeBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 38 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.aggTopHit", + "id": "def-common.getRequestInspectorStats", "type": "Function", - "children": [], + "label": "getRequestInspectorStats", "signature": [ - "() => FunctionDefinition" + "(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": [], - "label": "aggTopHit", + "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 + } + } + ], + "tags": [ + "public" + ], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 22 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getTopHitMetricAgg", + "id": "def-common.getResponseInspectorStats", "type": "Function", - "children": [], + "label": "getResponseInspectorStats", "signature": [ - "() => ", + "(resp: ", + "SearchResponse", + ", searchSource: Pick<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" + "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": [], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.getNumberHistogramIntervalByDatatableColumn", - "type": "Function", "children": [ { "type": "Object", - "label": "column", + "label": "resp", "isRequired": true, "signature": [ + "SearchResponse", + "" + ], + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 53 + } + }, + { + "type": "Object", + "label": "searchSource", + "isRequired": false, + "signature": [ + "Pick<", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - } + "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/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" + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 54 } } ], - "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." + "tags": [ + "public" ], - "label": "getNumberHistogramIntervalByDatatableColumn", + "returnComment": [], "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" + "path": "src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts", + "lineNumber": 52 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getCalculateAutoTimeExpression", + "id": "def-common.getSearchParams", "type": "Function", - "label": "getCalculateAutoTimeExpression", + "label": "getSearchParams", "signature": [ - "(getConfig: (key: string) => any) => (range: ", + "(getConfig: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" }, - ") => string | undefined" + ") => { preference: any; }" ], "description": [], "children": [ @@ -9921,337 +9605,346 @@ "label": "getConfig", "isRequired": true, "signature": [ - "(key: string) => any" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 16 } } ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 16 }, "initialIsOpen": false }, { - "id": "def-common.dateHistogramInterval", + "id": "def-common.getSearchParamsFromRequest", "type": "Function", - "label": "dateHistogramInterval", + "label": "getSearchParamsFromRequest", "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." + "(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": "string", - "label": "interval", + "type": "Object", + "label": "searchRequest", "isRequired": true, "signature": [ - "string" + "Record" ], - "description": [ - "The interval string to return the appropriate date_histogram key for." + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 34 + } + }, + { + "id": "def-common.getSearchParamsFromRequest.dependencies", + "type": "Object", + "label": "dependencies", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } + ] + } ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 35 } } ], "tags": [ - "example" + "public" ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/get_search_params.ts", + "lineNumber": 33 }, "initialIsOpen": false }, { - "id": "def-common.isValidEsInterval", + "id": "def-common.getSerialDiffMetricAgg", "type": "Function", - "label": "isValidEsInterval", + "children": [], "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" + "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/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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 31 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.isValidInterval", + "id": "def-common.getSignificantTermsBucketAgg", "type": "Function", - "label": "isValidInterval", + "children": [], "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" }, + "<", { - "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" - } - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" ], - "tags": [], - "returnComment": [], + "description": [], + "label": "getSignificantTermsBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 29 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.parseInterval", + "id": "def-common.getStdDeviationMetricAgg", "type": "Function", - "label": "parseInterval", + "children": [], "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" - } - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IStdDevAggConfig", + "text": "IStdDevAggConfig" + }, + ">" ], - "tags": [], - "returnComment": [], + "description": [], + "label": "getStdDeviationMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 73 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.splitStringInterval", + "id": "def-common.getSumMetricAgg", "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" - } - } - ], + "children": [], "signature": [ - "(interval: string) => { value: number; unit: ", - "Unit", - "; } | null" + "() => ", + { + "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": "splitStringInterval", + "label": "getSumMetricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 24 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.parseEsInterval", + "id": "def-common.getTermsBucketAgg", "type": "Function", - "label": "parseEsInterval", + "children": [], "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" - } - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.BucketAggType", + "text": "BucketAggType" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IBucketAggConfig", + "text": "IBucketAggConfig" + }, + ">" ], - "tags": [], - "returnComment": [], + "description": [], + "label": "getTermsBucketAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 65 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.toAbsoluteDates", + "id": "def-common.getTopHitMetricAgg", "type": "Function", - "label": "toAbsoluteDates", + "children": [], "signature": [ - "(range: ", + "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggType", + "text": "MetricAggType" }, - ") => { from: Date; to: Date; } | undefined" + "" ], "description": [], + "label": "getTopHitMetricAgg", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 31 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.handleRequest", + "type": "Function", "children": [ { "type": "Object", - "label": "range", + "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": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibDataSearchPluginApi", + "section": "def-common.RequestHandlerParams", + "text": "RequestHandlerParams" } ], "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" + "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", + "lineNumber": 44 } } ], - "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": [ + "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, metricsAtAllLevels, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", + "RequestHandlerParams", + ") => Promise<", { - "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" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + ">" ], + "description": [], + "label": "handleRequest", "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" + "path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts", + "lineNumber": 44 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -10295,8 +9988,7 @@ "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" + "lineNumber": 14 } }, { @@ -10315,8 +10007,7 @@ "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" + "lineNumber": 15 } }, { @@ -10329,8 +10020,7 @@ "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" + "lineNumber": 16 } }, { @@ -10343,8 +10033,7 @@ "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" + "lineNumber": 17 } } ], @@ -10352,957 +10041,765 @@ "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" + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-common.handleRequest", + "id": "def-common.injectReferences", "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}", + "type": "CompoundType", + "label": "searchSourceFields", "isRequired": true, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.RequestHandlerParams", - "text": "RequestHandlerParams" - } + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " & { indexRefName: string; }" ], "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" + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 13 + } + }, + { + "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 } } ], "signature": [ - "({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, metricsAtAllLevels, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ", - "RequestHandlerParams", - ") => Promise<", + "(searchSourceFields: ", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "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": "handleRequest", + "label": "injectReferences", "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" + "path": "src/plugins/data/common/search/search_source/inject_references.ts", + "lineNumber": 12 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getRequestInspectorStats", + "id": "def-common.isAutoInterval", "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", + "type": "Unknown", + "label": "value", "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\">" + "unknown" ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 13 } } ], - "tags": [ - "public" + "signature": [ + "(value: unknown) => boolean" ], - "returnComment": [], + "description": [], + "label": "isAutoInterval", "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" + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 13 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getResponseInspectorStats", + "id": "def-common.isBucketAggType", "type": "Function", - "label": "getResponseInspectorStats", + "label": "isBucketAggType", "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" - } + "(aggConfig: any) => boolean" ], "description": [], "children": [ { - "type": "Object", - "label": "resp", + "type": "Any", + "label": "aggConfig", "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" + "any" ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 49 } } ], - "tags": [ - "public" - ], + "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 49 }, "initialIsOpen": false }, { - "id": "def-common.functionWrapper", + "id": "def-common.isCompleteResponse", "type": "Function", "children": [ { "type": "Object", - "label": "spec", - "isRequired": true, + "label": "response", + "isRequired": false, "signature": [ { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - } + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21 } } ], "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" - }, - "<", + "(response?: ", { - "pluginId": "inspector", + "pluginId": "data", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - ", ", - "SerializableState", - ">) => any" - ], - "description": [ - "\nTakes a function spec and passes in default args,\noverriding with any provided args." + " | undefined) => boolean" ], - "label": "functionWrapper", + "description": [], + "label": "isCompleteResponse", "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 21 }, "tags": [], - "returnComment": [], + "returnComment": [ + "true if response is completed successfully" + ], "initialIsOpen": false }, { - "id": "def-common.createSearchSource", + "id": "def-common.isDateHistogramBucketAggConfig", "type": "Function", + "label": "isDateHistogramBucketAggConfig", + "signature": [ + "(agg: any) => boolean" + ], + "description": [], "children": [ { - "type": "Object", - "label": "indexPatterns", + "type": "Any", + "label": "agg", "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\">" + "any" ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 57 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 57 + }, + "initialIsOpen": false + }, + { + "id": "def-common.isErrorResponse", + "type": "Function", + "children": [ { "type": "Object", - "label": "searchSourceDependencies", - "isRequired": true, + "label": "response", + "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceDependencies", - "text": "SearchSourceDependencies" - } + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 14 } } ], "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<", + "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - ">" - ], - "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" + " | undefined) => boolean | undefined" ], - "label": "createSearchSource", + "description": [], + "label": "isErrorResponse", "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 14 }, - "tags": [ - "return", - "public" - ], + "tags": [], "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`." + "true if response had an error while executing in ES" ], "initialIsOpen": false }, { - "id": "def-common.injectReferences", + "id": "def-common.isMetricAggType", "type": "Function", + "label": "isMetricAggType", + "signature": [ + "(aggConfig: any) => boolean" + ], + "description": [], "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", + "type": "Any", + "label": "aggConfig", "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, - "[]" + "signature": [ + "any" ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 75 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 75 + }, + "initialIsOpen": false + }, + { + "tags": [], + "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 + }, "signature": [ - "(searchSourceFields: ", + "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "section": "def-common.AggConfig", + "text": "AggConfig" }, - " & { indexRefName: string; }, references: ", - "SavedObjectReference", - "[]) => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + ") => boolean" ], - "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" - }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.extractReferences", + "id": "def-common.isPartialResponse", "type": "Function", "children": [ { "type": "Object", - "label": "state", - "isRequired": true, + "label": "response", + "isRequired": false, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" + }, + " | undefined" ], "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28 } } ], "signature": [ - "(state: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - }, - ") => [", + "(response?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, - " & { indexRefName?: string | undefined; }, ", - "SavedObjectReference", - "[]]" + " | undefined) => boolean" ], "description": [], - "label": "extractReferences", + "label": "isPartialResponse", "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" + "path": "src/plugins/data/common/search/utils.ts", + "lineNumber": 28 }, "tags": [], - "returnComment": [], + "returnComment": [ + "true if request is still running an/d response contains partial results" + ], "initialIsOpen": false }, { - "id": "def-common.parseSearchSourceJSON", + "tags": [], + "id": "def-common.isStringOrNumberType", "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" - } - } - ], + "label": "isStringOrNumberType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 23 + }, "signature": [ - "(searchSourceJSON: string) => ", + "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSourceFields", - "text": "SearchSourceFields" - } + "section": "def-common.AggConfig", + "text": "AggConfig" + }, + ") => boolean" ], - "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" - }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getSearchParams", + "tags": [], + "id": "def-common.isStringType", "type": "Function", - "label": "getSearchParams", + "label": "isStringType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 22 + }, "signature": [ - "(getConfig: ", + "(agg: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggConfig", + "text": "AggConfig" }, - ") => { preference: any; }" + ") => boolean" ], - "description": [], + "initialIsOpen": false + }, + { + "id": "def-common.isType", + "type": "Function", "children": [ { - "type": "Function", - "label": "getConfig", + "type": "Array", + "label": "types", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - } + "string[]" ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts", + "lineNumber": 13 } } ], - "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" - }, - "; }) => ", + "(...types: string[]) => (agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchRequestParams", - "text": "ISearchRequestParams" + "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 + }, + "tags": [], + "returnComment": [], + "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": "Object", - "label": "searchRequest", + "type": "string", + "label": "interval", "isRequired": true, "signature": [ - "Record" + "string" ], - "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", - "tags": [], - "description": [], - "children": [ - { - "tags": [], - "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" - } - ] - } + "description": [ + "The interval string like 1w, 24h" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "lineNumber": 20 } } ], - "tags": [ - "public" + "tags": [], + "returnComment": [ + "True if the interval is valid for Elasticsearch" ], - "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.getPreference", + "id": "def-common.isValidInterval", "type": "Function", - "label": "getPreference", + "label": "isValidInterval", "signature": [ - "(getConfig: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - }, - ") => any" + "(value: string, baseInterval: string | undefined) => boolean" ], "description": [], "children": [ { - "type": "Function", - "label": "getConfig", + "type": "string", + "label": "value", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - } + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts", + "lineNumber": 24 }, "initialIsOpen": false }, { - "id": "def-common.fetchSoon", + "id": "def-common.parseEsInterval", "type": "Function", - "label": "fetchSoon", + "label": "parseEsInterval", "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", - ">" + "(interval: string) => { value: number; unit: ", + "Unit", + "; type: \"calendar\" | \"fixed\"; }" ], "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)." + "\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": "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", + "type": "string", + "label": "interval", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - } + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 39 + }, + "initialIsOpen": false + }, + { + "id": "def-common.parseInterval", + "type": "Function", + "label": "parseInterval", + "signature": [ + "(interval: string) => moment.Duration | null" + ], + "description": [], + "children": [ { - "type": "Object", - "label": "fetchHandlers", + "type": "string", + "label": "interval", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FetchHandlers", - "text": "FetchHandlers" - } + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29 } } ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-common.tabify", + "id": "def-common.parseSearchSourceJSON", "type": "Function", "children": [ { - "type": "Object", - "label": "searchSource", + "type": "string", + "label": "searchSourceJSON", "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchSource", - "text": "SearchSource" - } + "string" ], "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" + "path": "src/plugins/data/common/search/search_source/parse_json.ts", + "lineNumber": 12 } - }, + } + ], + "signature": [ + "(searchSourceJSON: string) => ", { - "type": "Object", - "label": "esResponse", + "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 + }, + "tags": [], + "returnComment": [], + "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": [ - "SearchResponse", - "" + "P" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/prop_filter.ts", + "lineNumber": 20 } - }, + } + ], + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.splitStringInterval", + "type": "Function", + "children": [ { - "type": "CompoundType", - "label": "opts", + "type": "string", + "label": "interval", "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" - } + "string" ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 16 } } ], "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" - } + "(interval: string) => { value: number; unit: ", + "Unit", + "; } | null" ], "description": [], - "label": "tabify", + "label": "splitStringInterval", "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts", + "lineNumber": 16 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.tabifyDocs", + "id": "def-common.tabify", "type": "Function", "children": [ { "type": "Object", - "label": "esResponse", + "label": "searchSource", "isRequired": true, "signature": [ - "SearchResponse", - "" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" + } ], "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" + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 16 } }, { "type": "Object", - "label": "index", - "isRequired": false, + "label": "esResponse", + "isRequired": true, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined" + "SearchResponse", + "" ], "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" + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 17 } }, { - "type": "Object", - "label": "params", + "type": "CompoundType", + "label": "opts", "isRequired": true, "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.TabbedResponseWriterOptions", + "text": "TabbedResponseWriterOptions" + }, + "> | ", { "pluginId": "data", "scope": "common", @@ -11313,24 +10810,25 @@ ], "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" + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 18 } } ], "signature": [ - "(esResponse: ", - "SearchResponse", - ", index?: ", + "(searchSource: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSource", + "text": "SearchSource" }, - " | undefined, params?: ", + ", esResponse: ", + "SearchResponse", + ", opts: Partial<", + "TabbedResponseWriterOptions", + "> | ", "TabifyDocsOptions", ") => ", { @@ -11342,11 +10840,10 @@ } ], "description": [], - "label": "tabifyDocs", + "label": "tabify", "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" + "path": "src/plugins/data/common/search/tabify/index.ts", + "lineNumber": 15 }, "tags": [], "returnComment": [], @@ -11396,8 +10893,7 @@ "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" + "lineNumber": 20 } }, { @@ -11410,8 +10906,7 @@ "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" + "lineNumber": 21 } }, { @@ -11432,8 +10927,7 @@ "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" + "lineNumber": 22 } } ], @@ -11441,9 +10935,98 @@ "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" + "lineNumber": 19 + }, + "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 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "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 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -11486,8 +11069,7 @@ ], "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" + "lineNumber": 34 } }, { @@ -11502,8 +11084,7 @@ ], "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" + "lineNumber": 34 } } ], @@ -11511,159 +11092,53 @@ "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" + "lineNumber": 34 }, - "tags": [], - "returnComment": [ - "true if response had an error while executing in ES" - ], "initialIsOpen": false }, { - "id": "def-common.isCompleteResponse", + "id": "def-common.toAbsoluteDates", "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" - } - } - ], + "label": "toAbsoluteDates", "signature": [ - "(response?: ", + "(range: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" }, - " | undefined) => boolean" + ") => { from: Date; to: Date; } | undefined" ], "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" - }, - "tags": [], - "returnComment": [ - "true if response is completed successfully" - ], - "initialIsOpen": false - }, - { - "id": "def-common.isPartialResponse", - "type": "Function", "children": [ { "type": "Object", - "label": "response", - "isRequired": false, + "label": "range", + "isRequired": true, "signature": [ { "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined" + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } ], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12 } } ], - "signature": [ - "(response?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - " | undefined) => boolean" - ], - "description": [], - "label": "isPartialResponse", + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts", + "lineNumber": 12 }, - "tags": [], - "returnComment": [ - "true if request is still running an/d response contains partial results" - ], "initialIsOpen": false } ], @@ -11683,8 +11158,7 @@ "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" + "lineNumber": 38 }, "signature": [ { @@ -11699,887 +11173,565 @@ ], "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" + "lineNumber": 37 }, "initialIsOpen": false }, { - "id": "def-common.AggTypeConfig", + "id": "def-common.AggFunctionsMapping", "type": "Interface", - "label": "AggTypeConfig", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggTypeConfig", - "text": "AggTypeConfig" - }, - "" + "label": "AggFunctionsMapping", + "description": [ + "\nA global list of the expression function definitions for each agg type function." ], - "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.AggTypeConfig.params", - "type": "Array", - "label": "params", + "id": "def-common.AggFunctionsMapping.aggFilter", + "type": "Object", + "label": "aggFilter", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 204 }, "signature": [ - "Partial[] | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.valueType", - "type": "CompoundType", - "label": "valueType", + "id": "def-common.AggFunctionsMapping.aggFilters", + "type": "Object", + "label": "aggFilters", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 205 }, "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.getRequestAggs", - "type": "CompoundType", - "label": "getRequestAggs", + "id": "def-common.AggFunctionsMapping.aggSignificantTerms", + "type": "Object", + "label": "aggSignificantTerms", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 206 }, "signature": [ - "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.getResponseAggs", - "type": "CompoundType", - "label": "getResponseAggs", + "id": "def-common.AggFunctionsMapping.aggIpRange", + "type": "Object", + "label": "aggIpRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 207 }, "signature": [ - "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.customLabels", - "type": "CompoundType", - "label": "customLabels", + "id": "def-common.AggFunctionsMapping.aggDateRange", + "type": "Object", + "label": "aggDateRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 208 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.json", - "type": "CompoundType", - "label": "json", + "id": "def-common.AggFunctionsMapping.aggRange", + "type": "Object", + "label": "aggRange", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 209 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.decorateAggConfig", - "type": "Function", - "label": "decorateAggConfig", + "id": "def-common.AggFunctionsMapping.aggGeoTile", + "type": "Object", + "label": "aggGeoTile", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 210 }, "signature": [ - "(() => any) | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.postFlightRequest", - "type": "Function", - "label": "postFlightRequest", + "id": "def-common.AggFunctionsMapping.aggGeoHash", + "type": "Object", + "label": "aggGeoHash", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 211 }, - "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" + "signature": [ + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.getSerializedFormat", - "type": "Function", - "label": "getSerializedFormat", + "id": "def-common.AggFunctionsMapping.aggHistogram", + "type": "Object", + "label": "aggHistogram", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 212 }, "signature": [ - "((agg: TAggConfig) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - ">) | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.getValue", - "type": "Function", - "label": "getValue", + "id": "def-common.AggFunctionsMapping.aggDateHistogram", + "type": "Object", + "label": "aggDateHistogram", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 213 }, "signature": [ - "((agg: TAggConfig, bucket: any) => any) | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.getKey", - "type": "Function", - "label": "getKey", + "id": "def-common.AggFunctionsMapping.aggTerms", + "type": "Object", + "label": "aggTerms", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 214 }, "signature": [ - "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggTypeConfig.getValueBucketPath", - "type": "Function", - "label": "getValueBucketPath", + "id": "def-common.AggFunctionsMapping.aggAvg", + "type": "Object", + "label": "aggAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 215 }, "signature": [ - "((agg: TAggConfig) => string) | undefined" + "FunctionDefinition" ] - } - ], - "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.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": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.IBucketAggConfig.type", + "id": "def-common.AggFunctionsMapping.aggBucketAvg", "type": "Object", - "label": "type", + "label": "aggBucketAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 216 }, "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" - }, - ">" + "FunctionDefinition" ] - } - ], - "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" + "tags": [], + "id": "def-common.AggFunctionsMapping.aggBucketMax", + "type": "Object", + "label": "aggBucketMax", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 217 + }, + "signature": [ + "FunctionDefinition" + ] }, - "" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.BucketAggParam.scriptable", - "type": "CompoundType", - "label": "scriptable", + "id": "def-common.AggFunctionsMapping.aggBucketMin", + "type": "Object", + "label": "aggBucketMin", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 218 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.BucketAggParam.filterFieldTypes", - "type": "CompoundType", - "label": "filterFieldTypes", + "id": "def-common.AggFunctionsMapping.aggBucketSum", + "type": "Object", + "label": "aggBucketSum", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 219 }, "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" + "FunctionDefinition" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", - "type": "Function", - "label": "calculateBounds", + "id": "def-common.AggFunctionsMapping.aggCardinality", + "type": "Object", + "label": "aggCardinality", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 220 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.CalculateBoundsFn", - "text": "CalculateBoundsFn" - } + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", - "type": "Function", - "label": "isDefaultTimezone", + "id": "def-common.AggFunctionsMapping.aggCount", + "type": "Object", + "label": "aggCount", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 221 }, "signature": [ - "() => boolean" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.DateHistogramBucketAggDependencies.getConfig", - "type": "Function", - "label": "getConfig", + "id": "def-common.AggFunctionsMapping.aggCumulativeSum", + "type": "Object", + "label": "aggCumulativeSum", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 222 }, "signature": [ - "(key: string) => T" + "FunctionDefinition" ] - } - ], - "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" + "tags": [], + "id": "def-common.AggFunctionsMapping.aggDerivative", + "type": "Object", + "label": "aggDerivative", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 223 + }, + "signature": [ + "FunctionDefinition" + ] }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketAggConfig", - "text": "IBucketAggConfig" - } - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.IBucketDateHistogramAggConfig.buckets", + "id": "def-common.AggFunctionsMapping.aggGeoBounds", "type": "Object", - "label": "buckets", + "label": "aggGeoBounds", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 224 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.TimeBuckets", - "text": "TimeBuckets" - } + "FunctionDefinition" ] - } - ], - "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" + "tags": [], + "id": "def-common.AggFunctionsMapping.aggGeoCentroid", + "type": "Object", + "label": "aggGeoCentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 225 + }, + "signature": [ + "FunctionDefinition" + ] }, - " extends ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsDateHistogram.field", - "type": "CompoundType", - "label": "field", + "id": "def-common.AggFunctionsMapping.aggMax", + "type": "Object", + "label": "aggMax", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 226 }, "signature": [ - "string | ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.timeRange", + "id": "def-common.AggFunctionsMapping.aggMedian", "type": "Object", - "label": "timeRange", + "label": "aggMedian", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 227 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval", - "type": "CompoundType", - "label": "useNormalizedEsInterval", + "id": "def-common.AggFunctionsMapping.aggMin", + "type": "Object", + "label": "aggMin", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 228 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.scaleMetricValues", - "type": "CompoundType", - "label": "scaleMetricValues", + "id": "def-common.AggFunctionsMapping.aggMovingAvg", + "type": "Object", + "label": "aggMovingAvg", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 229 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.interval", - "type": "string", - "label": "interval", + "id": "def-common.AggFunctionsMapping.aggPercentileRanks", + "type": "Object", + "label": "aggPercentileRanks", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 230 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.time_zone", - "type": "string", - "label": "time_zone", + "id": "def-common.AggFunctionsMapping.aggPercentiles", + "type": "Object", + "label": "aggPercentiles", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 231 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.drop_partials", - "type": "CompoundType", - "label": "drop_partials", + "id": "def-common.AggFunctionsMapping.aggSerialDiff", + "type": "Object", + "label": "aggSerialDiff", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 232 }, "signature": [ - "boolean | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.format", - "type": "string", - "label": "format", + "id": "def-common.AggFunctionsMapping.aggStdDeviation", + "type": "Object", + "label": "aggStdDeviation", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 233 }, "signature": [ - "string | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.min_doc_count", - "type": "number", - "label": "min_doc_count", + "id": "def-common.AggFunctionsMapping.aggSum", + "type": "Object", + "label": "aggSum", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 234 }, "signature": [ - "number | undefined" + "FunctionDefinition" ] }, { "tags": [], - "id": "def-common.AggParamsDateHistogram.extended_bounds", + "id": "def-common.AggFunctionsMapping.aggTopHit", "type": "Object", - "label": "extended_bounds", + "label": "aggTopHit", "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 235 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ExtendedBounds", - "text": "ExtendedBounds" - }, - " | undefined" + "FunctionDefinition" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 203 }, "initialIsOpen": false }, { - "id": "def-common.DateRangeBucketAggDependencies", + "id": "def-common.AggParamOption", "type": "Interface", - "label": "DateRangeBucketAggDependencies", + "label": "AggParamOption", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", - "type": "Function", - "label": "isDefaultTimezone", + "id": "def-common.AggParamOption.val", + "type": "string", + "label": "val", "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" - ] + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 31 + } }, { "tags": [], - "id": "def-common.DateRangeBucketAggDependencies.getConfig", - "type": "Function", - "label": "getConfig", + "id": "def-common.AggParamOption.display", + "type": "string", + "label": "display", "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" - }, + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 32 + } + }, + { + "id": "def-common.AggParamOption.enabled", + "type": "Function", + "label": "enabled", "signature": [ - "(key: string) => T" - ] + "((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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 33 + } } ], "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" + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 30 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsDateRange", + "id": "def-common.AggParamsAvg", "type": "Interface", - "label": "AggParamsDateRange", + "label": "AggParamsAvg", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsDateRange", - "text": "AggParamsDateRange" + "section": "def-common.AggParamsAvg", + "text": "AggParamsAvg" }, " extends ", "BaseAggParams" @@ -12589,75 +11741,33 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsDateRange.field", + "id": "def-common.AggParamsAvg.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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] + "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", + "lineNumber": 21 + } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/avg.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsFilter", + "id": "def-common.AggParamsBucketAvg", "type": "Interface", - "label": "AggParamsFilter", + "label": "AggParamsBucketAvg", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsFilter", - "text": "AggParamsFilter" + "section": "def-common.AggParamsBucketAvg", + "text": "AggParamsBucketAvg" }, " extends ", "BaseAggParams" @@ -12667,118 +11777,135 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsFilter.geo_bounding_box", - "type": "CompoundType", - "label": "geo_bounding_box", + "id": "def-common.AggParamsBucketAvg.customMetric", + "type": "Object", + "label": "customMetric", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 19 }, "signature": [ - "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" + "{ 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/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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.FiltersBucketAggDependencies.getConfig", - "type": "Function", - "label": "getConfig", + "id": "def-common.AggParamsBucketAvg.customBucket", + "type": "Object", + "label": "customBucket", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 20 }, "signature": [ - "(key: string) => any" + "{ 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/buckets/filters.ts", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L32" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsFilters", + "id": "def-common.AggParamsBucketMax", "type": "Interface", - "label": "AggParamsFilters", + "label": "AggParamsBucketMax", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsFilters", - "text": "AggParamsFilters" + "section": "def-common.AggParamsBucketMax", + "text": "AggParamsBucketMax" }, - " extends Pick<", - "BaseAggParams", - ", \"json\">" + " extends ", + "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AggParamsFilters.filters", - "type": "Array", - "label": "filters", + "id": "def-common.AggParamsBucketMax.customMetric", + "type": "Object", + "label": "customMetric", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 18 }, "signature": [ - "{ input: ", + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.Query", - "text": "Query" + "docId": "kibDataSearchPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - "; label: string; }[] | undefined" + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsBucketMax.customBucket", + "type": "Object", + "label": "customBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 19 + }, + "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/buckets/filters.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L36" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsGeoHash", + "id": "def-common.AggParamsBucketMin", "type": "Interface", - "label": "AggParamsGeoHash", + "label": "AggParamsBucketMin", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsGeoHash", - "text": "AggParamsGeoHash" + "section": "def-common.AggParamsBucketMin", + "text": "AggParamsBucketMin" }, " extends ", "BaseAggParams" @@ -12788,110 +11915,66 @@ "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.AggParamsGeoHash.isFilteredByCollar", - "type": "CompoundType", - "label": "isFilteredByCollar", + "id": "def-common.AggParamsBucketMin.customMetric", + "type": "Object", + "label": "customMetric", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 18 }, "signature": [ - "boolean | undefined" + "{ 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" ] }, { "tags": [], - "id": "def-common.AggParamsGeoHash.boundingBox", - "type": "CompoundType", - "label": "boundingBox", + "id": "def-common.AggParamsBucketMin.customBucket", + "type": "Object", + "label": "customBucket", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 19 }, "signature": [ - "Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined" + "{ 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/buckets/geo_hash.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L28" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsGeoTile", + "id": "def-common.AggParamsBucketSum", "type": "Interface", - "label": "AggParamsGeoTile", + "label": "AggParamsBucketSum", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsGeoTile", - "text": "AggParamsGeoTile" + "section": "def-common.AggParamsBucketSum", + "text": "AggParamsBucketSum" }, " extends ", "BaseAggParams" @@ -12901,353 +11984,334 @@ "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.AggParamsGeoTile.useGeocentroid", - "type": "CompoundType", - "label": "useGeocentroid", + "id": "def-common.AggParamsBucketSum.customMetric", + "type": "Object", + "label": "customMetric", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 18 }, "signature": [ - "boolean | undefined" + "{ 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" ] }, { "tags": [], - "id": "def-common.AggParamsGeoTile.precision", - "type": "number", - "label": "precision", + "id": "def-common.AggParamsBucketSum.customBucket", + "type": "Object", + "label": "customBucket", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 19 }, "signature": [ - "number | undefined" + "{ 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/buckets/geo_tile.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L23" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.AutoBounds", + "id": "def-common.AggParamsCardinality", "type": "Interface", - "label": "AutoBounds", + "label": "AggParamsCardinality", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsCardinality", + "text": "AggParamsCardinality" + }, + " extends ", + "BaseAggParams" + ], "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.AutoBounds.max", - "type": "number", - "label": "max", + "id": "def-common.AggParamsCardinality.field", + "type": "string", + "label": "field", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "lineNumber": 21 } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/cardinality.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.HistogramBucketAggDependencies", + "id": "def-common.AggParamsCumulativeSum", "type": "Interface", - "label": "HistogramBucketAggDependencies", + "label": "AggParamsCumulativeSum", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsCumulativeSum", + "text": "AggParamsCumulativeSum" + }, + " extends ", + "BaseAggParams" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.HistogramBucketAggDependencies.getConfig", - "type": "Function", - "label": "getConfig", + "id": "def-common.AggParamsCumulativeSum.buckets_path", + "type": "string", + "label": "buckets_path", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 18 }, "signature": [ - "(key: string) => T" + "string | undefined" ] }, { "tags": [], - "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", - "type": "Function", - "label": "getFieldFormatsStart", + "id": "def-common.AggParamsCumulativeSum.customMetric", + "type": "Object", + "label": "customMetric", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 19 }, "signature": [ - "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsCumulativeSum.metricAgg", + "type": "string", + "label": "metricAgg", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 20 + }, + "signature": [ + "string | undefined" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.IBucketHistogramAggConfig", + "id": "def-common.AggParamsDateHistogram", "type": "Interface", - "label": "IBucketHistogramAggConfig", + "label": "AggParamsDateHistogram", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketHistogramAggConfig", - "text": "IBucketHistogramAggConfig" + "section": "def-common.AggParamsDateHistogram", + "text": "AggParamsDateHistogram" }, " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IBucketAggConfig", - "text": "IBucketAggConfig" - } + "BaseAggParams" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.IBucketHistogramAggConfig.setAutoBounds", - "type": "Function", - "label": "setAutoBounds", + "id": "def-common.AggParamsDateHistogram.field", + "type": "CompoundType", + "label": "field", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 62 }, "signature": [ - "(bounds: ", + "string | ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AutoBounds", - "text": "AutoBounds" + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - ") => void" + " | undefined" ] }, { "tags": [], - "id": "def-common.IBucketHistogramAggConfig.getAutoBounds", - "type": "Function", - "label": "getAutoBounds", + "id": "def-common.AggParamsDateHistogram.timeRange", + "type": "Object", + "label": "timeRange", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 63 }, "signature": [ - "() => ", { "pluginId": "data", "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AutoBounds", - "text": "AutoBounds" - } + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" ] - } - ], - "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 ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsHistogram.field", - "type": "string", - "label": "field", + "id": "def-common.AggParamsDateHistogram.useNormalizedEsInterval", + "type": "CompoundType", + "label": "useNormalizedEsInterval", "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" - } + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 64 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-common.AggParamsHistogram.interval", + "id": "def-common.AggParamsDateHistogram.scaleMetricValues", "type": "CompoundType", - "label": "interval", + "label": "scaleMetricValues", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 65 }, "signature": [ - "React.ReactText" + "boolean | undefined" ] }, - { - "tags": [], - "id": "def-common.AggParamsHistogram.used_interval", - "type": "CompoundType", - "label": "used_interval", + { + "tags": [], + "id": "def-common.AggParamsDateHistogram.interval", + "type": "string", + "label": "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 66 }, "signature": [ - "string | number | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsHistogram.maxBars", - "type": "number", - "label": "maxBars", + "id": "def-common.AggParamsDateHistogram.time_zone", + "type": "string", + "label": "time_zone", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 67 }, "signature": [ - "number | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsHistogram.intervalBase", - "type": "number", - "label": "intervalBase", + "id": "def-common.AggParamsDateHistogram.drop_partials", + "type": "CompoundType", + "label": "drop_partials", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 68 }, "signature": [ - "number | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsHistogram.min_doc_count", - "type": "CompoundType", - "label": "min_doc_count", + "id": "def-common.AggParamsDateHistogram.format", + "type": "string", + "label": "format", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 69 }, "signature": [ - "boolean | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsHistogram.has_extended_bounds", - "type": "CompoundType", - "label": "has_extended_bounds", + "id": "def-common.AggParamsDateHistogram.min_doc_count", + "type": "number", + "label": "min_doc_count", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 70 }, "signature": [ - "boolean | undefined" + "number | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsHistogram.extended_bounds", + "id": "def-common.AggParamsDateHistogram.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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 71 }, "signature": [ { @@ -13262,23 +12326,22 @@ } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 61 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsIpRange", + "id": "def-common.AggParamsDateRange", "type": "Interface", - "label": "AggParamsIpRange", + "label": "AggParamsDateRange", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsIpRange", - "text": "AggParamsIpRange" + "section": "def-common.AggParamsDateRange", + "text": "AggParamsDateRange" }, " extends ", "BaseAggParams" @@ -13288,267 +12351,233 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsIpRange.field", + "id": "def-common.AggParamsDateRange.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" - } + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 32 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-common.AggParamsIpRange.ipRangeType", - "type": "CompoundType", - "label": "ipRangeType", + "id": "def-common.AggParamsDateRange.ranges", + "type": "Array", + "label": "ranges", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 33 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IP_RANGE_TYPES", - "text": "IP_RANGE_TYPES" + "section": "def-common.DateRangeKey", + "text": "DateRangeKey" }, - " | undefined" + "[] | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsIpRange.ranges", - "type": "Object", - "label": "ranges", + "id": "def-common.AggParamsDateRange.time_zone", + "type": "string", + "label": "time_zone", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 34 }, "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" + "string | 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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 31 }, "initialIsOpen": false }, { - "id": "def-common.DateRangeKey", + "id": "def-common.AggParamsDerivative", "type": "Interface", - "label": "DateRangeKey", + "label": "AggParamsDerivative", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsDerivative", + "text": "AggParamsDerivative" + }, + " extends ", + "BaseAggParams" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.DateRangeKey.from", - "type": "CompoundType", - "label": "from", + "id": "def-common.AggParamsDerivative.buckets_path", + "type": "string", + "label": "buckets_path", "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 18 }, "signature": [ - "React.ReactText" + "string | undefined" ] }, { "tags": [], - "id": "def-common.DateRangeKey.to", - "type": "CompoundType", - "label": "to", + "id": "def-common.AggParamsDerivative.customMetric", + "type": "Object", + "label": "customMetric", "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 19 }, "signature": [ - "React.ReactText" + "{ 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/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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.CidrMaskIpRangeAggKey.type", + "id": "def-common.AggParamsDerivative.metricAgg", "type": "string", - "label": "type", + "label": "metricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 20 }, "signature": [ - "\"mask\"" + "string | undefined" ] - }, - { - "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.RangeIpRangeAggKey", + "id": "def-common.AggParamsFilter", "type": "Interface", - "label": "RangeIpRangeAggKey", + "label": "AggParamsFilter", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsFilter", + "text": "AggParamsFilter" + }, + " extends ", + "BaseAggParams" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.RangeIpRangeAggKey.type", - "type": "string", - "label": "type", + "id": "def-common.AggParamsFilter.geo_bounding_box", + "type": "CompoundType", + "label": "geo_bounding_box", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", + "lineNumber": 21 }, "signature": [ - "\"range\"" + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsFilters", + "type": "Interface", + "label": "AggParamsFilters", + "signature": [ { - "tags": [], - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsFilters", + "text": "AggParamsFilters" }, - { - "tags": [], - "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" - } - } + " extends Pick<", + "BaseAggParams", + ", \"json\">" ], - "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": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart", - "type": "Function", - "label": "getFieldFormatsStart", + "id": "def-common.AggParamsFilters.filters", + "type": "Array", + "label": "filters", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 37 }, "signature": [ - "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + "; label: string; }[] | undefined" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 36 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsRange", + "id": "def-common.AggParamsGeoBounds", "type": "Interface", - "label": "AggParamsRange", + "label": "AggParamsGeoBounds", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsRange", - "text": "AggParamsRange" + "section": "def-common.AggParamsGeoBounds", + "text": "AggParamsGeoBounds" }, " extends ", "BaseAggParams" @@ -13558,50 +12587,69 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsRange.field", + "id": "def-common.AggParamsGeoBounds.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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 17 } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsGeoCentroid", + "type": "Interface", + "label": "AggParamsGeoCentroid", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsGeoCentroid", + "text": "AggParamsGeoCentroid" }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggParamsRange.ranges", - "type": "Array", - "label": "ranges", + "id": "def-common.AggParamsGeoCentroid.field", + "type": "string", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 17 + } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid.ts", + "lineNumber": 16 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsSignificantTerms", + "id": "def-common.AggParamsGeoHash", "type": "Interface", - "label": "AggParamsSignificantTerms", + "label": "AggParamsGeoHash", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsSignificantTerms", - "text": "AggParamsSignificantTerms" + "section": "def-common.AggParamsGeoHash", + "text": "AggParamsGeoHash" }, " extends ", "BaseAggParams" @@ -13611,26 +12659,38 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsSignificantTerms.field", + "id": "def-common.AggParamsGeoHash.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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 29 } }, { "tags": [], - "id": "def-common.AggParamsSignificantTerms.size", + "id": "def-common.AggParamsGeoHash.autoPrecision", + "type": "CompoundType", + "label": "autoPrecision", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 30 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.precision", "type": "number", - "label": "size", + "label": "precision", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 31 }, "signature": [ "number | undefined" @@ -13638,53 +12698,64 @@ }, { "tags": [], - "id": "def-common.AggParamsSignificantTerms.exclude", - "type": "string", - "label": "exclude", + "id": "def-common.AggParamsGeoHash.useGeocentroid", + "type": "CompoundType", + "label": "useGeocentroid", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 32 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsSignificantTerms.include", - "type": "string", - "label": "include", + "id": "def-common.AggParamsGeoHash.isFilteredByCollar", + "type": "CompoundType", + "label": "isFilteredByCollar", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 33 }, "signature": [ - "string | undefined" + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoHash.boundingBox", + "type": "CompoundType", + "label": "boundingBox", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 34 + }, + "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/significant_terms.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L22" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash.ts", + "lineNumber": 28 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsTerms", + "id": "def-common.AggParamsGeoTile", "type": "Interface", - "label": "AggParamsTerms", + "label": "AggParamsGeoTile", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsTerms", - "text": "AggParamsTerms" + "section": "def-common.AggParamsGeoTile", + "text": "AggParamsGeoTile" }, " extends ", "BaseAggParams" @@ -13694,76 +12765,130 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsTerms.field", + "id": "def-common.AggParamsGeoTile.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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 24 } }, { "tags": [], - "id": "def-common.AggParamsTerms.orderBy", + "id": "def-common.AggParamsGeoTile.useGeocentroid", + "type": "CompoundType", + "label": "useGeocentroid", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 25 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsGeoTile.precision", + "type": "number", + "label": "precision", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 26 + }, + "signature": [ + "number | undefined" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile.ts", + "lineNumber": 23 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsHistogram", + "type": "Interface", + "label": "AggParamsHistogram", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsHistogram", + "text": "AggParamsHistogram" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.AggParamsHistogram.field", "type": "string", - "label": "orderBy", + "label": "field", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 41 } }, { "tags": [], - "id": "def-common.AggParamsTerms.orderAgg", - "type": "Object", - "label": "orderAgg", + "id": "def-common.AggParamsHistogram.interval", + "type": "CompoundType", + "label": "interval", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 42 }, "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" + "React.ReactText" ] }, { "tags": [], - "id": "def-common.AggParamsTerms.order", + "id": "def-common.AggParamsHistogram.used_interval", "type": "CompoundType", - "label": "order", + "label": "used_interval", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 43 }, "signature": [ - "\"asc\" | \"desc\" | undefined" + "string | number | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsTerms.size", + "id": "def-common.AggParamsHistogram.maxBars", "type": "number", - "label": "size", + "label": "maxBars", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 44 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsHistogram.intervalBase", + "type": "number", + "label": "intervalBase", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 45 }, "signature": [ "number | undefined" @@ -13771,14 +12896,13 @@ }, { "tags": [], - "id": "def-common.AggParamsTerms.missingBucket", + "id": "def-common.AggParamsHistogram.min_doc_count", "type": "CompoundType", - "label": "missingBucket", + "label": "min_doc_count", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 46 }, "signature": [ "boolean | undefined" @@ -13786,98 +12910,144 @@ }, { "tags": [], - "id": "def-common.AggParamsTerms.missingBucketLabel", - "type": "string", - "label": "missingBucketLabel", + "id": "def-common.AggParamsHistogram.has_extended_bounds", + "type": "CompoundType", + "label": "has_extended_bounds", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 47 }, "signature": [ - "string | undefined" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsTerms.otherBucket", - "type": "CompoundType", - "label": "otherBucket", + "id": "def-common.AggParamsHistogram.extended_bounds", + "type": "Object", + "label": "extended_bounds", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 48 }, "signature": [ - "boolean | undefined" + { + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsIpRange", + "type": "Interface", + "label": "AggParamsIpRange", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsIpRange", + "text": "AggParamsIpRange" }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggParamsTerms.otherBucketLabel", + "id": "def-common.AggParamsIpRange.field", "type": "string", - "label": "otherBucketLabel", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 30 + } }, { "tags": [], - "id": "def-common.AggParamsTerms.exclude", - "type": "string", - "label": "exclude", + "id": "def-common.AggParamsIpRange.ipRangeType", + "type": "CompoundType", + "label": "ipRangeType", "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" + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 31 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IP_RANGE_TYPES", + "text": "IP_RANGE_TYPES" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsTerms.include", - "type": "string", - "label": "include", + "id": "def-common.AggParamsIpRange.ranges", + "type": "Object", + "label": "ranges", "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" + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 32 }, "signature": [ - "string | undefined" + "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/terms.ts", - "lineNumber": 50, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L50" + "path": "src/plugins/data/common/search/aggs/buckets/ip_range.ts", + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsAvg", + "id": "def-common.AggParamsMax", "type": "Interface", - "label": "AggParamsAvg", + "label": "AggParamsMax", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsAvg", - "text": "AggParamsAvg" + "section": "def-common.AggParamsMax", + "text": "AggParamsMax" }, " extends ", "BaseAggParams" @@ -13887,35 +13057,33 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsAvg.field", + "id": "def-common.AggParamsMax.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" + "path": "src/plugins/data/common/search/aggs/metrics/max.ts", + "lineNumber": 21 } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/max.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsBucketAvg", + "id": "def-common.AggParamsMedian", "type": "Interface", - "label": "AggParamsBucketAvg", + "label": "AggParamsMedian", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsBucketAvg", - "text": "AggParamsBucketAvg" + "section": "def-common.AggParamsMedian", + "text": "AggParamsMedian" }, " extends ", "BaseAggParams" @@ -13925,86 +13093,127 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsBucketAvg.customMetric", - "type": "Object", - "label": "customMetric", + "id": "def-common.AggParamsMedian.field", + "type": "string", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/metrics/median.ts", + "lineNumber": 21 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/median.ts", + "lineNumber": 20 + }, + "initialIsOpen": false + }, + { + "id": "def-common.AggParamsMin", + "type": "Interface", + "label": "AggParamsMin", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamsMin", + "text": "AggParamsMin" }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggParamsBucketAvg.customBucket", - "type": "Object", - "label": "customBucket", + "id": "def-common.AggParamsMin.field", + "type": "string", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/metrics/min.ts", + "lineNumber": 21 + } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/min.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsBucketMax", + "id": "def-common.AggParamsMovingAvg", "type": "Interface", - "label": "AggParamsBucketMax", + "label": "AggParamsMovingAvg", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsBucketMax", - "text": "AggParamsBucketMax" + "section": "def-common.AggParamsMovingAvg", + "text": "AggParamsMovingAvg" + }, + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.window", + "type": "number", + "label": "window", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 19 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsMovingAvg.script", + "type": "string", + "label": "script", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 20 + }, + "signature": [ + "string | undefined" + ] }, - " extends ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsBucketMax.customMetric", + "id": "def-common.AggParamsMovingAvg.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" + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 21 }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", @@ -14020,46 +13229,36 @@ }, { "tags": [], - "id": "def-common.AggParamsBucketMax.customBucket", - "type": "Object", - "label": "customBucket", + "id": "def-common.AggParamsMovingAvg.metricAgg", + "type": "string", + "label": "metricAgg", "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" + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 22 }, "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" + "string | 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" + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsBucketMin", + "id": "def-common.AggParamsPercentileRanks", "type": "Interface", - "label": "AggParamsBucketMin", + "label": "AggParamsPercentileRanks", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsBucketMin", - "text": "AggParamsBucketMin" + "section": "def-common.AggParamsPercentileRanks", + "text": "AggParamsPercentileRanks" }, " extends ", "BaseAggParams" @@ -14069,69 +13268,47 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsBucketMin.customMetric", - "type": "Object", - "label": "customMetric", + "id": "def-common.AggParamsPercentileRanks.field", + "type": "string", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 22 + } }, { "tags": [], - "id": "def-common.AggParamsBucketMin.customBucket", - "type": "Object", - "label": "customBucket", + "id": "def-common.AggParamsPercentileRanks.values", + "type": "Array", + "label": "values", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 23 }, "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" + "number[] | 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" + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsBucketSum", + "id": "def-common.AggParamsPercentiles", "type": "Interface", - "label": "AggParamsBucketSum", + "label": "AggParamsPercentiles", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsBucketSum", - "text": "AggParamsBucketSum" + "section": "def-common.AggParamsPercentiles", + "text": "AggParamsPercentiles" }, " extends ", "BaseAggParams" @@ -14141,69 +13318,47 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsBucketSum.customMetric", - "type": "Object", - "label": "customMetric", + "id": "def-common.AggParamsPercentiles.field", + "type": "string", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 20 + } }, { "tags": [], - "id": "def-common.AggParamsBucketSum.customBucket", - "type": "Object", - "label": "customBucket", + "id": "def-common.AggParamsPercentiles.percents", + "type": "Array", + "label": "percents", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 21 }, "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" + "number[] | 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" + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 19 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsCardinality", + "id": "def-common.AggParamsRange", "type": "Interface", - "label": "AggParamsCardinality", + "label": "AggParamsRange", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsCardinality", - "text": "AggParamsCardinality" + "section": "def-common.AggParamsRange", + "text": "AggParamsRange" }, " extends ", "BaseAggParams" @@ -14213,35 +13368,47 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsCardinality.field", + "id": "def-common.AggParamsRange.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" + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 30 } + }, + { + "tags": [], + "id": "def-common.AggParamsRange.ranges", + "type": "Array", + "label": "ranges", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 31 + }, + "signature": [ + "{ from: number; to: number; label?: string | undefined; }[] | undefined" + ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsCumulativeSum", + "id": "def-common.AggParamsSerialDiff", "type": "Interface", - "label": "AggParamsCumulativeSum", + "label": "AggParamsSerialDiff", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsCumulativeSum", - "text": "AggParamsCumulativeSum" + "section": "def-common.AggParamsSerialDiff", + "text": "AggParamsSerialDiff" }, " extends ", "BaseAggParams" @@ -14251,14 +13418,13 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsCumulativeSum.buckets_path", + "id": "def-common.AggParamsSerialDiff.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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 18 }, "signature": [ "string | undefined" @@ -14266,14 +13432,13 @@ }, { "tags": [], - "id": "def-common.AggParamsCumulativeSum.customMetric", + "id": "def-common.AggParamsSerialDiff.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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 19 }, "signature": [ "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", @@ -14289,14 +13454,13 @@ }, { "tags": [], - "id": "def-common.AggParamsCumulativeSum.metricAgg", + "id": "def-common.AggParamsSerialDiff.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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -14304,23 +13468,22 @@ } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsDerivative", + "id": "def-common.AggParamsSignificantTerms", "type": "Interface", - "label": "AggParamsDerivative", + "label": "AggParamsSignificantTerms", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsDerivative", - "text": "AggParamsDerivative" + "section": "def-common.AggParamsSignificantTerms", + "text": "AggParamsSignificantTerms" }, " extends ", "BaseAggParams" @@ -14330,114 +13493,75 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsDerivative.buckets_path", + "id": "def-common.AggParamsSignificantTerms.field", "type": "string", - "label": "buckets_path", + "label": "field", "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" - ] + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 23 + } }, { "tags": [], - "id": "def-common.AggParamsDerivative.customMetric", - "type": "Object", - "label": "customMetric", + "id": "def-common.AggParamsSignificantTerms.size", + "type": "number", + "label": "size", "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" + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 24 }, "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" + "number | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsDerivative.metricAgg", + "id": "def-common.AggParamsSignificantTerms.exclude", "type": "string", - "label": "metricAgg", + "label": "exclude", "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" + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 25 }, "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 ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsGeoBounds.field", + "id": "def-common.AggParamsSignificantTerms.include", "type": "string", - "label": "field", + "label": "include", "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" - } + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 26 + }, + "signature": [ + "string | undefined" + ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms.ts", + "lineNumber": 22 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsGeoCentroid", + "id": "def-common.AggParamsStdDeviation", "type": "Interface", - "label": "AggParamsGeoCentroid", + "label": "AggParamsStdDeviation", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsGeoCentroid", - "text": "AggParamsGeoCentroid" + "section": "def-common.AggParamsStdDeviation", + "text": "AggParamsStdDeviation" }, " extends ", "BaseAggParams" @@ -14447,35 +13571,33 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsGeoCentroid.field", + "id": "def-common.AggParamsStdDeviation.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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 19 } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsMax", + "id": "def-common.AggParamsSum", "type": "Interface", - "label": "AggParamsMax", + "label": "AggParamsSum", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsMax", - "text": "AggParamsMax" + "section": "def-common.AggParamsSum", + "text": "AggParamsSum" }, " extends ", "BaseAggParams" @@ -14485,35 +13607,33 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsMax.field", + "id": "def-common.AggParamsSum.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" + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 21 } } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/sum.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsMedian", + "id": "def-common.AggParamsTerms", "type": "Interface", - "label": "AggParamsMedian", + "label": "AggParamsTerms", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsMedian", - "text": "AggParamsMedian" + "section": "def-common.AggParamsTerms", + "text": "AggParamsTerms" }, " extends ", "BaseAggParams" @@ -14523,230 +13643,321 @@ "children": [ { "tags": [], - "id": "def-common.AggParamsMedian.field", + "id": "def-common.AggParamsTerms.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" + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 51 } - } - ], - "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": [], - "tags": [], - "children": [ + "tags": [], + "id": "def-common.AggParamsTerms.orderBy", + "type": "string", + "label": "orderBy", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 52 + } + }, { "tags": [], - "id": "def-common.IMetricAggConfig.type", + "id": "def-common.AggParamsTerms.orderAgg", "type": "Object", - "label": "type", + "label": "orderAgg", "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" + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 53 }, "signature": [ + "{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggType", - "text": "MetricAggType" - }, - "<", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" + "section": "def-common.SerializableState", + "text": "SerializableState" }, - ">" + " | undefined; schema?: string | undefined; } | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.order", + "type": "CompoundType", + "label": "order", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 54 + }, + "signature": [ + "\"asc\" | \"desc\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.size", + "type": "number", + "label": "size", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 55 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.missingBucket", + "type": "CompoundType", + "label": "missingBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 56 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.missingBucketLabel", + "type": "string", + "label": "missingBucketLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 57 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.otherBucket", + "type": "CompoundType", + "label": "otherBucket", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 58 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.otherBucketLabel", + "type": "string", + "label": "otherBucketLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 59 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.exclude", + "type": "string", + "label": "exclude", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 61 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTerms.include", + "type": "string", + "label": "include", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 62 + }, + "signature": [ + "string | undefined" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 50 }, "initialIsOpen": false }, { - "id": "def-common.MetricAggParam", + "id": "def-common.AggParamsTopHit", "type": "Interface", - "label": "MetricAggParam", + "label": "AggParamsTopHit", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MetricAggParam", - "text": "MetricAggParam" + "section": "def-common.AggParamsTopHit", + "text": "AggParamsTopHit" }, - " extends ", + " extends ", + "BaseAggParams" + ], + "description": [], + "tags": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamType", - "text": "AggParamType" + "tags": [], + "id": "def-common.AggParamsTopHit.field", + "type": "string", + "label": "field", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 18 + } + }, + { + "tags": [], + "id": "def-common.AggParamsTopHit.aggregate", + "type": "CompoundType", + "label": "aggregate", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 19 + }, + "signature": [ + "\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\"" + ] + }, + { + "tags": [], + "id": "def-common.AggParamsTopHit.sortField", + "type": "string", + "label": "sortField", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 20 + }, + "signature": [ + "string | undefined" + ] }, - "" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.MetricAggParam.filterFieldTypes", - "type": "CompoundType", - "label": "filterFieldTypes", + "id": "def-common.AggParamsTopHit.size", + "type": "number", + "label": "size", "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" + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 21 }, "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" + "number | undefined" ] }, { "tags": [], - "id": "def-common.MetricAggParam.onlyAggregatable", + "id": "def-common.AggParamsTopHit.sortOrder", "type": "CompoundType", - "label": "onlyAggregatable", + "label": "sortOrder", "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" + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 22 }, "signature": [ - "boolean | undefined" + "\"asc\" | \"desc\" | 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" + "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsMin", + "id": "def-common.AggTypeConfig", "type": "Interface", - "label": "AggParamsMin", + "label": "AggTypeConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsMin", - "text": "AggParamsMin" + "section": "def-common.AggTypeConfig", + "text": "AggTypeConfig" }, - " extends ", - "BaseAggParams" + "" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AggParamsMin.field", + "id": "def-common.AggTypeConfig.name", "type": "string", - "label": "field", + "label": "name", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 26 } - } - ], - "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" + "tags": [], + "id": "def-common.AggTypeConfig.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 27 + } }, - " extends ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsMovingAvg.buckets_path", + "id": "def-common.AggTypeConfig.createFilter", + "type": "Function", + "label": "createFilter", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 28 + }, + "signature": [ + "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.type", "type": "string", - "label": "buckets_path", + "label": "type", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 29 }, "signature": [ "string | undefined" @@ -14754,1412 +13965,1670 @@ }, { "tags": [], - "id": "def-common.AggParamsMovingAvg.window", - "type": "number", - "label": "window", + "id": "def-common.AggTypeConfig.dslName", + "type": "string", + "label": "dslName", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 30 }, "signature": [ - "number | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsMovingAvg.script", + "id": "def-common.AggTypeConfig.expressionName", "type": "string", - "label": "script", + "label": "expressionName", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 31 + } + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.makeLabel", + "type": "CompoundType", + "label": "makeLabel", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 32 }, "signature": [ - "string | undefined" + "((aggConfig: TAggConfig) => string) | (() => string) | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsMovingAvg.customMetric", - "type": "Object", - "label": "customMetric", + "id": "def-common.AggTypeConfig.ordered", + "type": "Any", + "label": "ordered", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 33 }, "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" + "any" ] }, { "tags": [], - "id": "def-common.AggParamsMovingAvg.metricAgg", - "type": "string", - "label": "metricAgg", + "id": "def-common.AggTypeConfig.hasNoDsl", + "type": "CompoundType", + "label": "hasNoDsl", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 34 }, "signature": [ - "string | undefined" + "boolean | 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" + "tags": [], + "id": "def-common.AggTypeConfig.params", + "type": "Array", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 35 + }, + "signature": [ + "Partial[] | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.valueType", + "type": "CompoundType", + "label": "valueType", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 36 + }, + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getRequestAggs", + "type": "CompoundType", + "label": "getRequestAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 37 + }, + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.getResponseAggs", + "type": "CompoundType", + "label": "getResponseAggs", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 38 + }, + "signature": [ + "((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.AggTypeConfig.customLabels", + "type": "CompoundType", + "label": "customLabels", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 39 + }, + "signature": [ + "boolean | undefined" + ] }, - " extends ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsPercentileRanks.field", - "type": "string", - "label": "field", + "id": "def-common.AggTypeConfig.json", + "type": "CompoundType", + "label": "json", "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" - } + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 40 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-common.AggParamsPercentileRanks.values", - "type": "Array", - "label": "values", + "id": "def-common.AggTypeConfig.decorateAggConfig", + "type": "Function", + "label": "decorateAggConfig", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 41 }, "signature": [ - "number[] | undefined" + "(() => any) | 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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart", + "id": "def-common.AggTypeConfig.postFlightRequest", "type": "Function", - "label": "getFieldFormatsStart", + "label": "postFlightRequest", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 42 }, "signature": [ - "() => Pick, \"deserialize\" | \"getDefaultInstance\">" + ", 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" ] - } - ], - "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 ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } }, { "tags": [], - "id": "def-common.AggParamsPercentiles.percents", - "type": "Array", - "label": "percents", + "id": "def-common.AggTypeConfig.getSerializedFormat", + "type": "Function", + "label": "getSerializedFormat", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 51 }, "signature": [ - "number[] | undefined" + "((agg: TAggConfig) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + ">) | 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 ", - "BaseAggParams" - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.AggParamsSerialDiff.buckets_path", - "type": "string", - "label": "buckets_path", + "id": "def-common.AggTypeConfig.getValue", + "type": "Function", + "label": "getValue", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 52 }, "signature": [ - "string | undefined" + "((agg: TAggConfig, bucket: any) => any) | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsSerialDiff.customMetric", - "type": "Object", - "label": "customMetric", + "id": "def-common.AggTypeConfig.getKey", + "type": "Function", + "label": "getKey", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 53 }, "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" + "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" ] }, { "tags": [], - "id": "def-common.AggParamsSerialDiff.metricAgg", - "type": "string", - "label": "metricAgg", + "id": "def-common.AggTypeConfig.getValueBucketPath", + "type": "Function", + "label": "getValueBucketPath", "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 54 }, "signature": [ - "string | undefined" + "((agg: TAggConfig) => 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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 22 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsStdDeviation", + "id": "def-common.AutoBounds", "type": "Interface", - "label": "AggParamsStdDeviation", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsStdDeviation", - "text": "AggParamsStdDeviation" - }, - " extends ", - "BaseAggParams" - ], + "label": "AutoBounds", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AggParamsStdDeviation.field", - "type": "string", - "label": "field", + "id": "def-common.AutoBounds.min", + "type": "number", + "label": "min", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 26 + } + }, + { + "tags": [], + "id": "def-common.AutoBounds.max", + "type": "number", + "label": "max", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 27 } } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-common.IStdDevAggConfig", + "id": "def-common.BucketAggParam", "type": "Interface", - "label": "IStdDevAggConfig", + "label": "BucketAggParam", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IStdDevAggConfig", - "text": "IStdDevAggConfig" + "section": "def-common.BucketAggParam", + "text": "BucketAggParam" }, - " extends ", - "IResponseAggConfig" + " extends ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" + }, + "" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.IStdDevAggConfig.keyedDetails", - "type": "Function", - "label": "keyedDetails", + "id": "def-common.BucketAggParam.scriptable", + "type": "CompoundType", + "label": "scriptable", "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" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 20 }, "signature": [ - "(customLabel: string, fieldDisplayName?: string | undefined) => Record" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.IStdDevAggConfig.valProp", - "type": "Function", - "label": "valProp", + "id": "def-common.BucketAggParam.filterFieldTypes", + "type": "CompoundType", + "label": "filterFieldTypes", "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" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 21 }, "signature": [ - "() => string[]" + { + "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/metrics/std_deviation.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L27" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsSum", + "id": "def-common.CidrMaskIpRangeAggKey", "type": "Interface", - "label": "AggParamsSum", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsSum", - "text": "AggParamsSum" - }, - " extends ", - "BaseAggParams" - ], + "label": "CidrMaskIpRangeAggKey", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AggParamsSum.field", + "id": "def-common.CidrMaskIpRangeAggKey.type", "type": "string", - "label": "field", + "label": "type", "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 10 + }, + "signature": [ + "\"mask\"" + ] + }, + { + "tags": [], + "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 } } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-common.AggParamsTopHit", + "id": "def-common.DateHistogramBucketAggDependencies", "type": "Interface", - "label": "AggParamsTopHit", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggParamsTopHit", - "text": "AggParamsTopHit" - }, - " extends ", - "BaseAggParams" - ], + "label": "DateHistogramBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "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\"" - ] - }, - { - "tags": [], - "id": "def-common.AggParamsTopHit.sortField", - "type": "string", - "label": "sortField", + "id": "def-common.DateHistogramBucketAggDependencies.calculateBounds", + "type": "Function", + "label": "calculateBounds", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 48 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.CalculateBoundsFn", + "text": "CalculateBoundsFn" + } ] }, { "tags": [], - "id": "def-common.AggParamsTopHit.size", - "type": "number", - "label": "size", + "id": "def-common.DateHistogramBucketAggDependencies.isDefaultTimezone", + "type": "Function", + "label": "isDefaultTimezone", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 49 }, "signature": [ - "number | undefined" + "() => boolean" ] }, { "tags": [], - "id": "def-common.AggParamsTopHit.sortOrder", - "type": "CompoundType", - "label": "sortOrder", + "id": "def-common.DateHistogramBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 50 }, "signature": [ - "\"asc\" | \"desc\" | undefined" + "(key: string) => T" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 47 }, "initialIsOpen": false }, { - "id": "def-common.OptionedValueProp", + "id": "def-common.DateRangeBucketAggDependencies", "type": "Interface", - "label": "OptionedValueProp", + "label": "DateRangeBucketAggDependencies", "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.OptionedValueProp.disabled", - "type": "CompoundType", - "label": "disabled", + "id": "def-common.DateRangeBucketAggDependencies.isDefaultTimezone", + "type": "Function", + "label": "isDefaultTimezone", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 27 }, "signature": [ - "boolean | undefined" + "() => boolean" ] }, { "tags": [], - "id": "def-common.OptionedValueProp.isCompatible", + "id": "def-common.DateRangeBucketAggDependencies.getConfig", "type": "Function", - "label": "isCompatible", + "label": "getConfig", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 28 }, "signature": [ - "(agg: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.AggConfig", - "text": "AggConfig" - }, - ") => boolean" + "(key: string) => T" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", + "lineNumber": 26 }, "initialIsOpen": false }, { - "id": "def-common.AggParamOption", + "id": "def-common.DateRangeKey", "type": "Interface", - "label": "AggParamOption", + "label": "DateRangeKey", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AggParamOption.val", - "type": "string", - "label": "val", + "id": "def-common.DateRangeKey.from", + "type": "CompoundType", + "label": "from", "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" - } + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 10 + }, + "signature": [ + "React.ReactText" + ] }, { "tags": [], - "id": "def-common.AggParamOption.display", - "type": "string", - "label": "display", + "id": "def-common.DateRangeKey.to", + "type": "CompoundType", + "label": "to", "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", + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 11 + }, "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" - } + "React.ReactText" + ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/date_range.ts", + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-common.AggFunctionsMapping", + "id": "def-common.FetchHandlers", "type": "Interface", - "label": "AggFunctionsMapping", - "description": [ - "\nA global list of the expression function definitions for each agg type function." - ], + "label": "FetchHandlers", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggFilter", - "type": "Object", - "label": "aggFilter", + "id": "def-common.FetchHandlers.getConfig", + "type": "Function", + "label": "getConfig", "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" + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 23 }, "signature": [ - "FunctionDefinition" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.GetConfigFn", + "text": "GetConfigFn" + } ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggFilters", - "type": "Object", - "label": "aggFilters", - "description": [], + "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/aggs/types.ts", - "lineNumber": 205, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205" + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 28 }, "signature": [ - "FunctionDefinition" + "(request: Record, response: ", + "SearchResponse", + ") => ", + "SearchResponse", + "" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggSignificantTerms", + "id": "def-common.FetchHandlers.legacy", "type": "Object", - "label": "aggSignificantTerms", + "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 + }, + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FiltersBucketAggDependencies", + "type": "Interface", + "label": "FiltersBucketAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.FiltersBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 33 }, "signature": [ - "FunctionDefinition" + "(key: string) => any" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", + "lineNumber": 32 + }, + "initialIsOpen": false + }, + { + "id": "def-common.HistogramBucketAggDependencies", + "type": "Interface", + "label": "HistogramBucketAggDependencies", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggIpRange", - "type": "Object", - "label": "aggIpRange", + "id": "def-common.HistogramBucketAggDependencies.getConfig", + "type": "Function", + "label": "getConfig", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 31 }, "signature": [ - "FunctionDefinition" + "(key: string) => T" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggDateRange", - "type": "Object", - "label": "aggDateRange", + "id": "def-common.HistogramBucketAggDependencies.getFieldFormatsStart", + "type": "Function", + "label": "getFieldFormatsStart", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 32 }, "signature": [ - "FunctionDefinition" + "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 30 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggRange", + "id": "def-common.IBucketAggConfig.type", "type": "Object", - "label": "aggRange", + "label": "type", "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" + "path": "src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts", + "lineNumber": 15 }, "signature": [ - "FunctionDefinition" + { + "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 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggGeoTile", + "id": "def-common.IBucketDateHistogramAggConfig.buckets", "type": "Object", - "label": "aggGeoTile", + "label": "buckets", "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" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", + "lineNumber": 54 }, "signature": [ - "FunctionDefinition" + { + "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 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggGeoHash", - "type": "Object", - "label": "aggGeoHash", + "id": "def-common.IBucketHistogramAggConfig.setAutoBounds", + "type": "Function", + "label": "setAutoBounds", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 36 }, "signature": [ - "FunctionDefinition" + "(bounds: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AutoBounds", + "text": "AutoBounds" + }, + ") => void" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggHistogram", - "type": "Object", - "label": "aggHistogram", + "id": "def-common.IBucketHistogramAggConfig.getAutoBounds", + "type": "Function", + "label": "getAutoBounds", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", + "lineNumber": 37 }, "signature": [ - "FunctionDefinition" + "() => ", + { + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IEsSearchRequest", + "type": "Interface", + "label": "IEsSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IEsSearchRequest", + "text": "IEsSearchRequest" }, + " extends ", { - "tags": [], - "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" - ] + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggTerms", - "type": "Object", - "label": "aggTerms", + "id": "def-common.IEsSearchRequest.indexType", + "type": "string", + "label": "indexType", "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 20 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 19 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IKibanaSearchRequest", + "type": "Interface", + "label": "IKibanaSearchRequest", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggAvg", - "type": "Object", - "label": "aggAvg", - "description": [], + "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/aggs/types.ts", - "lineNumber": 215, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 78 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggBucketAvg", - "type": "Object", - "label": "aggBucketAvg", + "id": "def-common.IKibanaSearchRequest.params", + "type": "Uncategorized", + "label": "params", "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 80 }, "signature": [ - "FunctionDefinition" + "Params | undefined" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 74 + }, + "initialIsOpen": false + }, + { + "id": "def-common.IKibanaSearchResponse", + "type": "Interface", + "label": "IKibanaSearchResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchResponse", + "text": "IKibanaSearchResponse" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggBucketMax", - "type": "Object", - "label": "aggBucketMax", - "description": [], + "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/aggs/types.ts", - "lineNumber": 217, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 44 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggBucketMin", - "type": "Object", - "label": "aggBucketMin", - "description": [], + "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/aggs/types.ts", - "lineNumber": 218, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 50 }, "signature": [ - "FunctionDefinition" + "number | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggBucketSum", - "type": "Object", - "label": "aggBucketSum", - "description": [], + "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/aggs/types.ts", - "lineNumber": 219, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 56 }, "signature": [ - "FunctionDefinition" + "number | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggCardinality", - "type": "Object", - "label": "aggCardinality", - "description": [], + "id": "def-common.IKibanaSearchResponse.isRunning", + "type": "CompoundType", + "label": "isRunning", + "description": [ + "\nIndicates whether search is still in flight" + ], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 61 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggCount", - "type": "Object", - "label": "aggCount", - "description": [], + "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/aggs/types.ts", - "lineNumber": 221, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 66 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggCumulativeSum", - "type": "Object", - "label": "aggCumulativeSum", - "description": [], + "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/aggs/types.ts", - "lineNumber": 222, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 71 }, "signature": [ - "FunctionDefinition" + "RawResponse" ] + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 40 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggDerivative", + "id": "def-common.IMetricAggConfig.type", "type": "Object", - "label": "aggDerivative", + "label": "type", "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 17 }, "signature": [ - "FunctionDefinition" + { + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ISearchClient", + "type": "Interface", + "label": "ISearchClient", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggGeoBounds", - "type": "Object", - "label": "aggGeoBounds", + "id": "def-common.ISearchClient.search", + "type": "Function", + "label": "search", "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 29 }, "signature": [ - "FunctionDefinition" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" + } ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggGeoCentroid", - "type": "Object", - "label": "aggGeoCentroid", - "description": [], + "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/aggs/types.ts", - "lineNumber": 225, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 33 }, "signature": [ - "FunctionDefinition" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchCancelGeneric", + "text": "ISearchCancelGeneric" + } ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggMax", - "type": "Object", - "label": "aggMax", - "description": [], + "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/aggs/types.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 37 }, "signature": [ - "FunctionDefinition" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchExtendGeneric", + "text": "ISearchExtendGeneric" + } ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 28 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ISearchOptions", + "type": "Interface", + "label": "ISearchOptions", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.AggFunctionsMapping.aggMedian", + "id": "def-common.ISearchOptions.abortSignal", "type": "Object", - "label": "aggMedian", - "description": [], + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 87 }, "signature": [ - "FunctionDefinition" + "AbortSignal | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggMin", - "type": "Object", - "label": "aggMin", - "description": [], + "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/aggs/types.ts", - "lineNumber": 228, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 92 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggMovingAvg", - "type": "Object", - "label": "aggMovingAvg", - "description": [], + "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/aggs/types.ts", - "lineNumber": 229, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 98 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggPercentileRanks", - "type": "Object", - "label": "aggPercentileRanks", - "description": [], + "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/aggs/types.ts", - "lineNumber": 230, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 103 }, "signature": [ - "FunctionDefinition" + "string | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggPercentiles", - "type": "Object", - "label": "aggPercentiles", - "description": [], + "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/aggs/types.ts", - "lineNumber": 231, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 108 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggSerialDiff", - "type": "Object", - "label": "aggSerialDiff", - "description": [], + "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/aggs/types.ts", - "lineNumber": 232, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 114 }, "signature": [ - "FunctionDefinition" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggStdDeviation", + "id": "def-common.ISearchOptions.indexPattern", "type": "Object", - "label": "aggStdDeviation", - "description": [], + "label": "indexPattern", + "description": [ + "\nIndex pattern reference is used for better error messages" + ], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 120 }, "signature": [ - "FunctionDefinition" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + " | undefined" ] - }, - { - "tags": [], - "id": "def-common.AggFunctionsMapping.aggSum", - "type": "Object", - "label": "aggSum", - "description": [], + } + ], + "source": { + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 83 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ISearchStartSearchSource", + "type": "Interface", + "label": "ISearchStartSearchSource", + "description": [ + "\nhigh level search service" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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/aggs/types.ts", - "lineNumber": 234, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 30 }, "signature": [ - "FunctionDefinition" + "(fields?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSourceFields", + "text": "SearchSourceFields" + }, + " | undefined) => Promise>" ] }, { "tags": [], - "id": "def-common.AggFunctionsMapping.aggTopHit", - "type": "Object", - "label": "aggTopHit", - "description": [], + "id": "def-common.ISearchStartSearchSource.createEmpty", + "type": "Function", + "label": "createEmpty", + "description": [ + "\ncreates empty {@link SearchSource}" + ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 34 }, "signature": [ - "FunctionDefinition" + "() => 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/aggs/types.ts", - "lineNumber": 203, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-common.IEsSearchRequest", + "id": "def-common.IStdDevAggConfig", "type": "Interface", - "label": "IEsSearchRequest", + "label": "IStdDevAggConfig", "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.IEsSearchRequest", - "text": "IEsSearchRequest" + "section": "def-common.IStdDevAggConfig", + "text": "IStdDevAggConfig" }, " 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" - }, - ">>" + "IResponseAggConfig" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.IEsSearchRequest.indexType", - "type": "string", - "label": "indexType", + "id": "def-common.IStdDevAggConfig.keyedDetails", + "type": "Function", + "label": "keyedDetails", "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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 28 }, "signature": [ - "string | undefined" + "(customLabel: string, fieldDisplayName?: string | undefined) => Record" + ] + }, + { + "tags": [], + "id": "def-common.IStdDevAggConfig.valProp", + "type": "Function", + "label": "valProp", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 29 + }, + "signature": [ + "() => string[]" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", + "lineNumber": 27 }, "initialIsOpen": false }, { - "id": "def-common.FetchHandlers", + "id": "def-common.LegacyFetchHandlers", "type": "Interface", - "label": "FetchHandlers", + "label": "LegacyFetchHandlers", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.FetchHandlers.getConfig", + "id": "def-common.LegacyFetchHandlers.callMsearch", "type": "Function", - "label": "getConfig", + "label": "callMsearch", "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 36 }, "signature": [ + "(params: { body: ", { "pluginId": "data", "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.GetConfigFn", - "text": "GetConfigFn" - } - ] - }, - { - "tags": [], - "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", - "" + "docId": "kibDataSearchPluginApi", + "section": "def-common.MsearchRequestBody", + "text": "MsearchRequestBody" + }, + "; signal: AbortSignal; }) => Promise<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MsearchResponse", + "text": "MsearchResponse" + }, + ">" ] }, { "tags": [], - "id": "def-common.FetchHandlers.legacy", + "id": "def-common.LegacyFetchHandlers.loadingCount$", "type": "Object", - "label": "legacy", - "description": [ - "\nThese handlers are only used by the legacy defaultSearchStrategy and can be removed\nonce that strategy has been deprecated." - ], + "label": "loadingCount$", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 40 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.LegacyFetchHandlers", - "text": "LegacyFetchHandlers" - } + "BehaviorSubject", + "" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 35 }, "initialIsOpen": false }, { - "id": "def-common.SearchError", + "id": "def-common.MetricAggParam", "type": "Interface", - "label": "SearchError", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, + "label": "MetricAggParam", + "signature": [ { - "tags": [], - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.MetricAggParam", + "text": "MetricAggParam" }, + " extends ", { - "tags": [], - "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" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.AggParamType", + "text": "AggParamType" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.SearchError.path", - "type": "string", - "label": "path", + "id": "def-common.MetricAggParam.filterFieldTypes", + "type": "CompoundType", + "label": "filterFieldTypes", "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" - } + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 22 + }, + "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" + ] }, { "tags": [], - "id": "def-common.SearchError.type", - "type": "string", - "label": "type", + "id": "def-common.MetricAggParam.onlyAggregatable", + "type": "CompoundType", + "label": "onlyAggregatable", "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" - } + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 23 + }, + "signature": [ + "boolean | undefined" + ] } ], "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 20 }, "initialIsOpen": false }, @@ -16178,8 +15647,7 @@ "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" + "lineNumber": 26 }, "signature": [ "MsearchRequest[]" @@ -16188,8 +15656,7 @@ ], "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" + "lineNumber": 25 }, "initialIsOpen": false }, @@ -16208,8 +15675,7 @@ "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" + "lineNumber": 31 }, "signature": [ "ApiResponse", @@ -16223,232 +15689,415 @@ ], "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" + "lineNumber": 30 }, "initialIsOpen": false }, { - "id": "def-common.LegacyFetchHandlers", + "id": "def-common.OptionedValueProp", "type": "Interface", - "label": "LegacyFetchHandlers", + "label": "OptionedValueProp", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.LegacyFetchHandlers.callMsearch", + "id": "def-common.OptionedValueProp.value", + "type": "string", + "label": "value", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 13 + } + }, + { + "tags": [], + "id": "def-common.OptionedValueProp.text", + "type": "string", + "label": "text", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 14 + } + }, + { + "tags": [], + "id": "def-common.OptionedValueProp.disabled", + "type": "CompoundType", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 15 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-common.OptionedValueProp.isCompatible", "type": "Function", - "label": "callMsearch", + "label": "isCompatible", "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" + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 16 }, "signature": [ - "(params: { body: ", + "(agg: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.MsearchRequestBody", - "text": "MsearchRequestBody" + "section": "def-common.AggConfig", + "text": "AggConfig" }, - "; signal: AbortSignal; }) => Promise<", + ") => boolean" + ] + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-common.PercentileRanksMetricAggDependencies", + "type": "Interface", + "label": "PercentileRanksMetricAggDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart", + "type": "Function", + "label": "getFieldFormatsStart", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 30 + }, + "signature": [ + "() => Pick" + ", \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\">, \"deserialize\" | \"getDefaultInstance\">" ] - }, + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 29 + }, + "initialIsOpen": false + }, + { + "id": "def-common.RangeBucketAggDependencies", + "type": "Interface", + "label": "RangeBucketAggDependencies", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.LegacyFetchHandlers.loadingCount$", - "type": "Object", - "label": "loadingCount$", + "id": "def-common.RangeBucketAggDependencies.getFieldFormatsStart", + "type": "Function", + "label": "getFieldFormatsStart", "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" + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 26 }, "signature": [ - "BehaviorSubject", - "" + "() => Pick, \"deserialize\" | \"getDefaultInstance\">" ] } ], "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" + "path": "src/plugins/data/common/search/aggs/buckets/range.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-common.SearchStrategySearchParams", + "id": "def-common.RangeIpRangeAggKey", "type": "Interface", - "label": "SearchStrategySearchParams", - "signature": [ + "label": "RangeIpRangeAggKey", + "description": [], + "tags": [], + "children": [ { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategySearchParams", - "text": "SearchStrategySearchParams" + "tags": [], + "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 + }, + "signature": [ + "\"range\"" + ] + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + } + ], + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-common.Request", + "type": "Interface", + "label": "Request", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.Request._source", + "type": "Unknown", + "label": "_source", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 124 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.Request.query", + "type": "Unknown", + "label": "query", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 125 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "id": "def-common.Request.sort", + "type": "Unknown", + "label": "sort", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 127 + }, + "signature": [ + "unknown" + ] }, - " extends ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.FetchHandlers", - "text": "FetchHandlers" - } - ], - "description": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.SearchStrategySearchParams.searchRequests", + "id": "def-common.Request.stored_fields", "type": "Array", - "label": "searchRequests", + "label": "stored_fields", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 128 }, "signature": [ - "Record[]" + "string[]" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 122 }, "initialIsOpen": false }, { - "id": "def-common.SearchStrategyProvider", + "id": "def-common.ResponseWithShardFailure", "type": "Interface", - "label": "SearchStrategyProvider", + "label": "ResponseWithShardFailure", "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.SearchStrategyProvider.search", - "type": "Function", - "label": "search", + "id": "def-common.ResponseWithShardFailure._shards", + "type": "Object", + "label": "_shards", "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 132 }, "signature": [ - "(params: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategySearchParams", - "text": "SearchStrategySearchParams" - }, - ") => ", + "{ failed: number; failures: ", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategyResponse", - "text": "SearchStrategyResponse" + "section": "def-common.ShardFailure", + "text": "ShardFailure" }, - "" + "[]; skipped: number; successful: number; total: number; }" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 131 }, "initialIsOpen": false }, { - "id": "def-common.SearchStrategyResponse", + "id": "def-common.SearchError", "type": "Interface", - "label": "SearchStrategyResponse", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.SearchStrategyResponse", - "text": "SearchStrategyResponse" - }, - "" - ], + "label": "SearchError", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.SearchStrategyResponse.searching", - "type": "Object", - "label": "searching", + "id": "def-common.SearchError.name", + "type": "string", + "label": "name", "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", - "[]>" - ] + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 37 + } }, { "tags": [], - "id": "def-common.SearchStrategyResponse.abort", - "type": "Function", - "label": "abort", + "id": "def-common.SearchError.status", + "type": "string", + "label": "status", "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" - ] + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 38 + } + }, + { + "tags": [], + "id": "def-common.SearchError.title", + "type": "string", + "label": "title", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 39 + } + }, + { + "tags": [], + "id": "def-common.SearchError.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 40 + } + }, + { + "tags": [], + "id": "def-common.SearchError.path", + "type": "string", + "label": "path", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 41 + } + }, + { + "tags": [], + "id": "def-common.SearchError.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 42 + } } ], "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" + "path": "src/plugins/data/common/search/search_source/fetch/types.ts", + "lineNumber": 36 }, "initialIsOpen": false }, @@ -16471,165 +16120,35 @@ "docId": "kibDataSearchPluginApi", "section": "def-common.FetchHandlers", "text": "FetchHandlers" - } - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.SearchSourceDependencies.search", - "type": "Function", - "label": "search", - "description": [], - "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" - }, - "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": 98, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L98" - }, - "initialIsOpen": false - }, - { - "id": "def-common.ISearchStartSearchSource", - "type": "Interface", - "label": "ISearchStartSearchSource", - "description": [ - "\nhigh level search service" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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>" - ] - }, - { - "tags": [], - "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": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.SortDirectionNumeric.order", - "type": "Enum", - "label": "order", + "id": "def-common.SearchSourceDependencies.search", + "type": "Function", + "label": "search", "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 99 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.SortDirection", - "text": "SortDirection" + "section": "def-common.ISearchGeneric", + "text": "ISearchGeneric" } ] - }, - { - "tags": [], - "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" + "path": "src/plugins/data/common/search/search_source/search_source.ts", + "lineNumber": 98 }, "initialIsOpen": false }, @@ -16650,8 +16169,7 @@ "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" + "lineNumber": 62 }, "signature": [ "string | undefined" @@ -16667,8 +16185,7 @@ ], "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" + "lineNumber": 66 }, "signature": [ { @@ -16691,8 +16208,7 @@ ], "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" + "lineNumber": 70 }, "signature": [ { @@ -16739,8 +16255,7 @@ ], "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" + "lineNumber": 74 }, "signature": [ "Record ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchStrategyResponse", + "text": "SearchStrategyResponse" + }, + "" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 48 }, "initialIsOpen": false }, { - "id": "def-common.Request", + "id": "def-common.SearchStrategyResponse", "type": "Interface", - "label": "Request", + "label": "SearchStrategyResponse", + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchStrategyResponse", + "text": "SearchStrategyResponse" + }, + "" + ], "description": [], "tags": [], "children": [ { "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.Request.sort", - "type": "Unknown", - "label": "sort", + "id": "def-common.SearchStrategyResponse.searching", + "type": "Object", + "label": "searching", "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 54 }, "signature": [ - "unknown" + "Promise<", + "SearchResponse", + "[]>" ] }, { "tags": [], - "id": "def-common.Request.stored_fields", - "type": "Array", - "label": "stored_fields", + "id": "def-common.SearchStrategyResponse.abort", + "type": "Function", + "label": "abort", "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 55 }, "signature": [ - "string[]" + "() => void" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 53 }, "initialIsOpen": false }, { - "id": "def-common.ResponseWithShardFailure", + "id": "def-common.SearchStrategySearchParams", "type": "Interface", - "label": "ResponseWithShardFailure", + "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": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ResponseWithShardFailure._shards", - "type": "Object", - "label": "_shards", + "id": "def-common.SearchStrategySearchParams.searchRequests", + "type": "Array", + "label": "searchRequests", "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 44 }, "signature": [ - "{ failed: number; failures: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ShardFailure", - "text": "ShardFailure" - }, - "[]; skipped: number; successful: number; total: number; }" + "Record[]" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/legacy/types.ts", + "lineNumber": 43 }, "initialIsOpen": false }, @@ -17372,8 +16745,7 @@ "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" + "lineNumber": 142 } }, { @@ -17384,8 +16756,7 @@ "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" + "lineNumber": 143 } }, { @@ -17396,8 +16767,7 @@ "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" + "lineNumber": 144 }, "signature": [ "{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }" @@ -17411,320 +16781,122 @@ "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" + "lineNumber": 155 } } ], "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" + "lineNumber": 141 }, "initialIsOpen": false }, { - "id": "def-common.ISearchClient", + "id": "def-common.SortDirectionNumeric", "type": "Interface", - "label": "ISearchClient", + "label": "SortDirectionNumeric", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ISearchClient.search", - "type": "Function", - "label": "search", + "id": "def-common.SortDirectionNumeric.order", + "type": "Enum", + "label": "order", "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" - } - ] - }, - { - "tags": [], - "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 45 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchCancelGeneric", - "text": "ISearchCancelGeneric" + "section": "def-common.SortDirection", + "text": "SortDirection" } ] }, { "tags": [], - "id": "def-common.ISearchClient.extend", - "type": "Function", - "label": "extend", - "description": [ - "\nUsed to extend the TTL of an in-progress search request." - ], + "id": "def-common.SortDirectionNumeric.numeric_type", + "type": "CompoundType", + "label": "numeric_type", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 46 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchExtendGeneric", - "text": "ISearchExtendGeneric" - } + "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" ] } ], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 44 }, "initialIsOpen": false }, { - "id": "def-common.IKibanaSearchResponse", + "id": "def-common.SortOptions", "type": "Interface", - "label": "IKibanaSearchResponse", - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.IKibanaSearchResponse", - "text": "IKibanaSearchResponse" - }, - "" - ], + "label": "SortOptions", "description": [], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.IKibanaSearchResponse.isRunning", + "id": "def-common.SortOptions.mode", "type": "CompoundType", - "label": "isRunning", - "description": [ - "\nIndicates whether search is still in flight" - ], + "label": "mode", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 112 }, "signature": [ - "boolean | undefined" + "\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined" ] }, { "tags": [], - "id": "def-common.IKibanaSearchResponse.isPartial", + "id": "def-common.SortOptions.type", "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" - ] - }, - { - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.IKibanaSearchRequest.id", - "type": "string", - "label": "id", - "description": [ - "\nAn id can be used to uniquely identify this request." - ], + "label": "type", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 113 }, "signature": [ - "string | undefined" + "\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined" ] }, { "tags": [], - "id": "def-common.IKibanaSearchRequest.params", + "id": "def-common.SortOptions.nested", "type": "Uncategorized", - "label": "params", + "label": "nested", "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 114 }, "signature": [ - "AbortSignal | undefined" + "object | undefined" ] }, { "tags": [], - "id": "def-common.ISearchOptions.strategy", + "id": "def-common.SortOptions.unmapped_type", "type": "string", - "label": "strategy", - "description": [ - "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." - ], + "label": "unmapped_type", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 115 }, "signature": [ "string | undefined" @@ -17732,33 +16904,27 @@ }, { "tags": [], - "id": "def-common.ISearchOptions.legacyHitsTotal", + "id": "def-common.SortOptions.distance_type", "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`." - ], + "label": "distance_type", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 116 }, "signature": [ - "boolean | undefined" + "\"arc\" | \"plane\" | undefined" ] }, { "tags": [], - "id": "def-common.ISearchOptions.sessionId", + "id": "def-common.SortOptions.unit", "type": "string", - "label": "sessionId", - "description": [ - "\nA session ID, grouping multiple search requests into a single session." - ], + "label": "unit", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 117 }, "signature": [ "string | undefined" @@ -17766,33 +16932,13 @@ }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.ISearchOptions.isRestore", + "id": "def-common.SortOptions.ignore_unmapped", "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)" - ], + "label": "ignore_unmapped", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 118 }, "signature": [ "boolean | undefined" @@ -17800,33 +16946,22 @@ }, { "tags": [], - "id": "def-common.ISearchOptions.indexPattern", - "type": "Object", - "label": "indexPattern", - "description": [ - "\nIndex pattern reference is used for better error messages" - ], + "id": "def-common.SortOptions._script", + "type": "Uncategorized", + "label": "_script", + "description": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 119 }, "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - " | undefined" + "object | 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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 111 }, "initialIsOpen": false } @@ -17840,8 +16975,7 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false }, @@ -17853,8 +16987,7 @@ "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" + "lineNumber": 24 }, "initialIsOpen": false }, @@ -17866,8 +16999,7 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false }, @@ -17879,151 +17011,144 @@ "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" + "lineNumber": 39 }, "initialIsOpen": false } ], "misc": [ { - "id": "def-common.AggConfigOptions", - "type": "Type", - "label": "AggConfigOptions", "tags": [], + "id": "def-common.aggAvgFnName", + "type": "string", + "label": "aggAvgFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/avg_fn.ts", + "lineNumber": 13 }, "signature": [ - "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" + "\"aggAvg\"" ], "initialIsOpen": false }, { - "id": "def-common.IAggConfig", - "type": "Type", - "label": "IAggConfig", - "tags": [ - "name", - "description" + "tags": [], + "id": "def-common.aggBucketAvgFnName", + "type": "string", + "label": "aggBucketAvgFnName", + "description": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts", + "lineNumber": 14 + }, + "signature": [ + "\"aggBucketAvg\"" ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.aggBucketMaxFnName", + "type": "string", + "label": "aggBucketMaxFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts", + "lineNumber": 14 }, "signature": [ - "AggConfig" + "\"aggBucketMax\"" ], "initialIsOpen": false }, { - "id": "def-common.CreateAggConfigParams", - "type": "Type", - "label": "CreateAggConfigParams", "tags": [], + "id": "def-common.aggBucketMinFnName", + "type": "string", + "label": "aggBucketMinFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts", + "lineNumber": 14 }, "signature": [ - "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", - "SerializableState", - " | undefined; }" + "\"aggBucketMin\"" ], "initialIsOpen": false }, { - "id": "def-common.AggGroupName", - "type": "Type", - "label": "AggGroupName", "tags": [], + "id": "def-common.aggBucketSumFnName", + "type": "string", + "label": "aggBucketSumFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts", + "lineNumber": 14 }, "signature": [ - "\"buckets\" | \"metrics\" | \"none\"" + "\"aggBucketSum\"" ], "initialIsOpen": false }, { - "id": "def-common.IAggType", - "type": "Type", - "label": "IAggType", "tags": [], + "id": "def-common.aggCardinalityFnName", + "type": "string", + "label": "aggCardinalityFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts", + "lineNumber": 13 }, "signature": [ - "AggType>" + "\"aggCardinality\"" ], "initialIsOpen": false }, { - "id": "def-common.AggTypesRegistrySetup", + "id": "def-common.AggConfigOptions", "type": "Type", - "label": "AggTypesRegistrySetup", + "label": "AggConfigOptions", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 43 }, "signature": [ - "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" + "{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.autoInterval", + "id": "def-common.aggCountFnName", "type": "string", - "label": "autoInterval", + "label": "aggCountFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/count_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"auto\"" + "\"aggCount\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.intervalOptions", - "type": "Array", - "label": "intervalOptions", + "id": "def-common.aggCumulativeSumFnName", + "type": "string", + "label": "aggCumulativeSumFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts", + "lineNumber": 14 }, "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; })[]" + "\"aggCumulativeSum\"" ], "initialIsOpen": false }, @@ -18035,8 +17160,7 @@ "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" + "lineNumber": 15 }, "signature": [ "\"aggDateHistogram\"" @@ -18051,8 +17175,7 @@ "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" + "lineNumber": 15 }, "signature": [ "\"aggDateRange\"" @@ -18061,617 +17184,634 @@ }, { "tags": [], - "id": "def-common.aggFilterFnName", + "id": "def-common.aggDerivativeFnName", "type": "string", - "label": "aggFilterFnName", + "label": "aggDerivativeFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/derivative_fn.ts", + "lineNumber": 14 }, "signature": [ - "\"aggFilter\"" + "\"aggDerivative\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggFiltersFnName", + "id": "def-common.aggFilterFnName", "type": "string", - "label": "aggFiltersFnName", + "label": "aggFilterFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filter_fn.ts", + "lineNumber": 15 }, "signature": [ - "\"aggFilters\"" + "\"aggFilter\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggGeoHashFnName", + "id": "def-common.aggFiltersFnName", "type": "string", - "label": "aggGeoHashFnName", + "label": "aggFiltersFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/filters_fn.ts", + "lineNumber": 15 }, "signature": [ - "\"aggGeoHash\"" + "\"aggFilters\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggGeoTileFnName", + "id": "def-common.aggGeoBoundsFnName", "type": "string", - "label": "aggGeoTileFnName", + "label": "aggGeoBoundsFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggGeoTile\"" + "\"aggGeoBounds\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggHistogramFnName", + "id": "def-common.aggGeoCentroidFnName", "type": "string", - "label": "aggHistogramFnName", + "label": "aggGeoCentroidFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggHistogram\"" + "\"aggGeoCentroid\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggIpRangeFnName", + "id": "def-common.aggGeoHashFnName", "type": "string", - "label": "aggIpRangeFnName", + "label": "aggGeoHashFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts", + "lineNumber": 15 }, "signature": [ - "\"aggIpRange\"" + "\"aggGeoHash\"" ], "initialIsOpen": false }, { - "id": "def-common.IpRangeKey", - "type": "Type", - "label": "IpRangeKey", "tags": [], + "id": "def-common.aggGeoTileFnName", + "type": "string", + "label": "aggGeoTileFnName", "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" - } + "source": { + "path": "src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts", + "lineNumber": 13 + }, + "signature": [ + "\"aggGeoTile\"" ], "initialIsOpen": false }, { + "id": "def-common.AggGroupName", + "type": "Type", + "label": "AggGroupName", "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 18 }, "signature": [ - "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" + "\"buckets\" | \"metrics\" | \"none\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggRangeFnName", + "id": "def-common.aggHistogramFnName", "type": "string", - "label": "aggRangeFnName", + "label": "aggHistogramFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/histogram_fn.ts", + "lineNumber": 15 }, "signature": [ - "\"aggRange\"" + "\"aggHistogram\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggSignificantTermsFnName", + "id": "def-common.aggIpRangeFnName", "type": "string", - "label": "aggSignificantTermsFnName", + "label": "aggIpRangeFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts", + "lineNumber": 15 }, "signature": [ - "\"aggSignificantTerms\"" + "\"aggIpRange\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggTermsFnName", + "id": "def-common.aggMaxFnName", "type": "string", - "label": "aggTermsFnName", + "label": "aggMaxFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/max_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggTerms\"" + "\"aggMax\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.termsAggFilter", - "type": "Array", - "label": "termsAggFilter", + "id": "def-common.aggMedianFnName", + "type": "string", + "label": "aggMedianFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/median_fn.ts", + "lineNumber": 13 }, "signature": [ - "string[]" + "\"aggMedian\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggAvgFnName", + "id": "def-common.aggMinFnName", "type": "string", - "label": "aggAvgFnName", + "label": "aggMinFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/min_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggAvg\"" + "\"aggMin\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggBucketAvgFnName", + "id": "def-common.aggMovingAvgFnName", "type": "string", - "label": "aggBucketAvgFnName", + "label": "aggMovingAvgFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts", + "lineNumber": 14 }, "signature": [ - "\"aggBucketAvg\"" + "\"aggMovingAvg\"" ], "initialIsOpen": false }, { + "id": "def-common.AggParam", + "type": "Type", + "label": "AggParam", "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/agg_params.ts", + "lineNumber": 28 }, "signature": [ - "\"aggBucketMax\"" + "BaseParamType" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggBucketMinFnName", + "id": "def-common.aggPercentileRanksFnName", "type": "string", - "label": "aggBucketMinFnName", + "label": "aggPercentileRanksFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggBucketMin\"" + "\"aggPercentileRanks\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggBucketSumFnName", + "id": "def-common.aggPercentilesFnName", "type": "string", - "label": "aggBucketSumFnName", + "label": "aggPercentilesFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggBucketSum\"" + "\"aggPercentiles\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggCardinalityFnName", + "id": "def-common.aggRangeFnName", "type": "string", - "label": "aggCardinalityFnName", + "label": "aggRangeFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/range_fn.ts", + "lineNumber": 15 }, "signature": [ - "\"aggCardinality\"" + "\"aggRange\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggCountFnName", + "id": "def-common.aggSerialDiffFnName", "type": "string", - "label": "aggCountFnName", + "label": "aggSerialDiffFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts", + "lineNumber": 14 }, "signature": [ - "\"aggCount\"" + "\"aggSerialDiff\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggCumulativeSumFnName", + "id": "def-common.aggSignificantTermsFnName", "type": "string", - "label": "aggCumulativeSumFnName", + "label": "aggSignificantTermsFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggCumulativeSum\"" + "\"aggSignificantTerms\"" ], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.aggDerivativeFnName", - "type": "string", - "label": "aggDerivativeFnName", - "description": [], + "id": "def-common.AggsStart", + "type": "Type", + "label": "AggsStart", + "tags": [ + "public" + ], + "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/metrics/derivative_fn.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L14" + "path": "src/plugins/data/common/search/aggs/types.ts", + "lineNumber": 139 }, "signature": [ - "\"aggDerivative\"" + "{ 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 }, { "tags": [], - "id": "def-common.aggGeoBoundsFnName", + "id": "def-common.aggStdDeviationFnName", "type": "string", - "label": "aggGeoBoundsFnName", + "label": "aggStdDeviationFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggGeoBounds\"" + "\"aggStdDeviation\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggGeoCentroidFnName", + "id": "def-common.aggSumFnName", "type": "string", - "label": "aggGeoCentroidFnName", + "label": "aggSumFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/sum_fn.ts", + "lineNumber": 13 }, "signature": [ - "\"aggGeoCentroid\"" + "\"aggSum\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.parentPipelineType", + "id": "def-common.aggTermsFnName", "type": "string", - "label": "parentPipelineType", + "label": "aggTermsFnName", "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" + "path": "src/plugins/data/common/search/aggs/buckets/terms_fn.ts", + "lineNumber": 14 }, + "signature": [ + "\"aggTerms\"" + ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.siblingPipelineType", + "id": "def-common.aggTopHitFnName", "type": "string", - "label": "siblingPipelineType", + "label": "aggTopHitFnName", "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" + "path": "src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts", + "lineNumber": 13 }, + "signature": [ + "\"aggTopHit\"" + ], "initialIsOpen": false }, { + "id": "def-common.AggTypesRegistrySetup", + "type": "Type", + "label": "AggTypesRegistrySetup", "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/agg_types_registry.ts", + "lineNumber": 13 }, "signature": [ - "\"aggMax\"" + "{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggMedianFnName", + "id": "def-common.autoInterval", "type": "string", - "label": "aggMedianFnName", + "label": "autoInterval", "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" + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 12 }, "signature": [ - "\"aggMedian\"" + "\"auto\"" ], "initialIsOpen": false }, { - "id": "def-common.IMetricAggType", - "type": "Type", - "label": "IMetricAggType", "tags": [], + "id": "def-common.boundsDescendingRaw", + "type": "Array", + "label": "boundsDescendingRaw", "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts", + "lineNumber": 12 }, "signature": [ - "MetricAggType" + "({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]" ], "initialIsOpen": false }, { + "id": "def-common.CreateAggConfigParams", + "type": "Type", + "label": "CreateAggConfigParams", "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/agg_configs.ts", + "lineNumber": 41 }, "signature": [ - "\"aggMin\"" + "{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ", + "SerializableState", + " | undefined; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.aggMovingAvgFnName", + "id": "def-common.ES_SEARCH_STRATEGY", "type": "string", - "label": "aggMovingAvgFnName", + "label": "ES_SEARCH_STRATEGY", "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 13 }, "signature": [ - "\"aggMovingAvg\"" + "\"es\"" ], "initialIsOpen": false }, { + "id": "def-common.EsaggsExpressionFunctionDefinition", + "type": "Type", + "label": "EsaggsExpressionFunctionDefinition", "tags": [], - "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" + "path": "src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts", + "lineNumber": 35 }, "signature": [ - "\"aggPercentileRanks\"" + "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" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-common.IPercentileRanksAggConfig", + "id": "def-common.EsQuerySearchAfter", "type": "Type", - "label": "IPercentileRanksAggConfig", - "tags": [], - "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 - }, - { + "label": "EsQuerySearchAfter", "tags": [], - "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 37 }, "signature": [ - "\"aggPercentiles\"" + "[", + "ReactText", + ", ", + "ReactText", + "]" ], "initialIsOpen": false }, { - "id": "def-common.IPercentileAggConfig", + "id": "def-common.EsQuerySortValue", "type": "Type", - "label": "IPercentileAggConfig", + "label": "EsQuerySortValue", "tags": [], "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 49 }, "signature": [ - "IResponseAggConfig" + "{ [x: string]: SortDirection | SortDirectionNumeric; }" ], "initialIsOpen": false }, { + "id": "def-common.ExecutionContextSearch", + "type": "Type", + "label": "ExecutionContextSearch", "tags": [], - "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 14 }, "signature": [ - "\"aggSerialDiff\"" + "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" ], "initialIsOpen": false }, { + "id": "def-common.ExpressionFunctionKibana", + "type": "Type", + "label": "ExpressionFunctionKibana", "tags": [], - "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" + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 17 }, "signature": [ - "\"aggStdDeviation\"" + "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", "tags": [], - "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" + "path": "src/plugins/data/common/search/expressions/kibana_context.ts", + "lineNumber": 23 }, "signature": [ - "\"aggSum\"" + "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.ExpressionValueSearchContext", + "type": "Type", + "label": "ExpressionValueSearchContext", "tags": [], - "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 20 }, "signature": [ - "\"aggTopHit\"" + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, @@ -18683,8 +17823,7 @@ "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" + "lineNumber": 19 }, "signature": [ { @@ -18730,298 +17869,265 @@ "initialIsOpen": false }, { - "id": "def-common.IFieldParamType", + "id": "def-common.IAggConfig", "type": "Type", - "label": "IFieldParamType", - "tags": [], + "label": "IAggConfig", + "tags": [ + "name", + "description" + ], "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" + "path": "src/plugins/data/common/search/aggs/agg_config.ts", + "lineNumber": 53 }, "signature": [ - "FieldParamType" + "AggConfig" ], "initialIsOpen": false }, { - "id": "def-common.AggParam", + "id": "def-common.IAggType", "type": "Type", - "label": "AggParam", + "label": "IAggType", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "lineNumber": 58 }, "signature": [ - "BaseParamType" + "AggType>" ], "initialIsOpen": false }, { - "id": "def-common.AggsStart", + "id": "def-common.IEsSearchResponse", "type": "Type", - "label": "AggsStart", - "tags": [ - "public" - ], - "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" - ], + "label": "IEsSearchResponse", + "tags": [], + "description": [], "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 23 }, "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; }" + "IKibanaSearchResponse>" ], "initialIsOpen": false }, { - "id": "def-common.ParsedInterval", + "id": "def-common.IFieldParamType", "type": "Type", - "label": "ParsedInterval", + "label": "IFieldParamType", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/param_types/field.ts", + "lineNumber": 21 }, "signature": [ - "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" + "FieldParamType" ], "initialIsOpen": false }, { + "id": "def-common.IMetricAggType", + "type": "Type", + "label": "IMetricAggType", "tags": [], - "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" + "path": "src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts", + "lineNumber": 35 }, "signature": [ - "\"es\"" + "MetricAggType" ], "initialIsOpen": false }, { - "id": "def-common.ISearchRequestParams", - "type": "Type", - "label": "ISearchRequestParams", "tags": [], + "id": "def-common.intervalOptions", + "type": "Array", + "label": "intervalOptions", "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" + "path": "src/plugins/data/common/search/aggs/buckets/_interval_options.ts", + "lineNumber": 15 }, "signature": [ - "{ trackTotalHits?: boolean | undefined; } & Search" + "({ 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.IEsSearchResponse", + "id": "def-common.IPercentileAggConfig", "type": "Type", - "label": "IEsSearchResponse", + "label": "IPercentileAggConfig", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentiles.ts", + "lineNumber": 24 }, "signature": [ - "IKibanaSearchResponse>" + "IResponseAggConfig" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionKibana", + "id": "def-common.IPercentileRanksAggConfig", "type": "Type", - "label": "ExpressionFunctionKibana", + "label": "IPercentileRanksAggConfig", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts", + "lineNumber": 27 }, "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>" + "IResponseAggConfig" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionKibanaContext", + "id": "def-common.IpRangeKey", "type": "Type", - "label": "ExpressionFunctionKibanaContext", + "label": "IpRangeKey", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts", + "lineNumber": 20 }, "signature": [ - "ExpressionFunctionDefinition<\"kibana_context\", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<", { - "pluginId": "expressions", + "pluginId": "data", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "docId": "kibDataSearchPluginApi", + "section": "def-common.CidrMaskIpRangeAggKey", + "text": "CidrMaskIpRangeAggKey" }, - "<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>" + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.RangeIpRangeAggKey", + "text": "RangeIpRangeAggKey" + } ], "initialIsOpen": false }, { - "id": "def-common.ExecutionContextSearch", + "id": "def-common.ISearchCancelGeneric", "type": "Type", - "label": "ExecutionContextSearch", + "label": "ISearchCancelGeneric", "tags": [], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 21 }, "signature": [ - "{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }" + "(id: string, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionValueSearchContext", + "id": "def-common.ISearchExtendGeneric", "type": "Type", - "label": "ExpressionValueSearchContext", + "label": "ISearchExtendGeneric", "tags": [], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 22 }, "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "(id: string, keepAlive: string, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => Promise" ], "initialIsOpen": false }, { - "id": "def-common.KIBANA_CONTEXT_NAME", + "id": "def-common.ISearchGeneric", "type": "Type", - "label": "KIBANA_CONTEXT_NAME", + "label": "ISearchGeneric", "tags": [], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 13 }, "signature": [ - "\"kibana_context\"" + "(request: SearchStrategyRequest, options: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined) => ", + "Observable", + "" ], "initialIsOpen": false }, { - "id": "def-common.KibanaContext", + "id": "def-common.ISearchOptionsSerializable", "type": "Type", - "label": "KibanaContext", + "label": "ISearchOptionsSerializable", "tags": [], - "description": [], + "description": [ + "\nSame as `ISearchOptions`, but contains only serializable fields, which can\nbe sent over the network." + ], "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" + "path": "src/plugins/data/common/search/types.ts", + "lineNumber": 127 }, "signature": [ - "{ type: \"kibana_context\"; } & ExecutionContextSearch" + "{ isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.EsaggsExpressionFunctionDefinition", + "id": "def-common.ISearchRequestParams", "type": "Type", - "label": "EsaggsExpressionFunctionDefinition", + "label": "ISearchRequestParams", "tags": [], "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" + "path": "src/plugins/data/common/search/es_search/types.ts", + "lineNumber": 15 }, "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" - }, - ", ", - "SerializableState", - ">>" + "{ trackTotalHits?: boolean | undefined; } & Search" ], "initialIsOpen": false }, @@ -19037,8 +18143,7 @@ ], "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" + "lineNumber": 19 }, "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?: ", @@ -19067,460 +18172,166 @@ "initialIsOpen": false }, { - "id": "def-common.EsQuerySearchAfter", - "type": "Type", - "label": "EsQuerySearchAfter", - "tags": [], - "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", - "tags": [], - "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", + "id": "def-common.KIBANA_CONTEXT_NAME", "type": "Type", - "label": "SearchFieldValue", + "label": "KIBANA_CONTEXT_NAME", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 26 }, "signature": [ - "string | SearchField" + "\"kibana_context\"" ], "initialIsOpen": false }, { - "id": "def-common.ISearchGeneric", + "id": "def-common.KibanaContext", "type": "Type", - "label": "ISearchGeneric", + "label": "KibanaContext", "tags": [], "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 27 }, "signature": [ - "(request: SearchStrategyRequest, options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => ", - "Observable", - "" + "{ type: \"kibana_context\"; } & ExecutionContextSearch" ], "initialIsOpen": false }, { - "id": "def-common.ISearchCancelGeneric", - "type": "Type", - "label": "ISearchCancelGeneric", "tags": [], + "id": "def-common.parentPipelineType", + "type": "string", + "label": "parentPipelineType", "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" + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 26 }, - "signature": [ - "(id: string, options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => Promise" - ], "initialIsOpen": false }, { - "id": "def-common.ISearchExtendGeneric", + "id": "def-common.ParsedInterval", "type": "Type", - "label": "ISearchExtendGeneric", + "label": "ParsedInterval", "tags": [], "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" + "path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts", + "lineNumber": 18 }, "signature": [ - "(id: string, keepAlive: string, options: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.ISearchOptions", - "text": "ISearchOptions" - }, - " | undefined) => Promise" + "{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }" ], "initialIsOpen": false }, { - "id": "def-common.ISearchOptionsSerializable", + "id": "def-common.SearchFieldValue", "type": "Type", - "label": "ISearchOptionsSerializable", - "tags": [], - "description": [ - "\nSame as `ISearchOptions`, but contains only serializable fields, which can\nbe sent over the network." - ], - "source": { - "path": "src/plugins/data/common/search/types.ts", - "lineNumber": 127, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L127" - }, - "signature": [ - "{ isStored?: boolean | undefined; isRestore?: boolean | undefined; sessionId?: string | undefined; strategy?: string | undefined; legacyHitsTotal?: boolean | undefined; }" - ], - "initialIsOpen": false - } - ], - "objects": [ - { + "label": "SearchFieldValue", "tags": [], - "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" + "path": "src/plugins/data/common/search/search_source/types.ts", + "lineNumber": 56 }, "signature": [ - "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + "string | SearchField" ], "initialIsOpen": false }, { - "id": "def-common.AggGroupLabels", - "type": "Object", "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - } - ], + "id": "def-common.siblingPipelineType", + "type": "string", + "label": "siblingPipelineType", "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" + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 33 }, "initialIsOpen": false }, { "tags": [], - "id": "def-common.migrateIncludeExcludeFormat", - "type": "Object", - "label": "migrateIncludeExcludeFormat", + "id": "def-common.termsAggFilter", + "type": "Array", + "label": "termsAggFilter", "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" + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "lineNumber": 32 }, "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" - }, - ">>" + "string[]" ], "initialIsOpen": false - }, + } + ], + "objects": [ { - "id": "def-common.parentPipelineAggHelper", + "id": "def-common.AggGroupLabels", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.parentPipelineAggHelper.subtype", + "id": "def-common.AggGroupLabels.[AggGroupNames.Buckets]", "type": "string", - "label": "subtype", + "label": "[AggGroupNames.Buckets]", "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 21 } }, { - "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": [], + "id": "def-common.AggGroupLabels.[AggGroupNames.Metrics]", + "type": "string", + "label": "[AggGroupNames.Metrics]", + "description": [], "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 24 } }, { - "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": [], + "id": "def-common.AggGroupLabels.[AggGroupNames.None]", + "type": "string", + "label": "[AggGroupNames.None]", + "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 27 } } ], "description": [], - "label": "parentPipelineAggHelper", + "label": "AggGroupLabels", "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.siblingPipelineAggHelper", - "type": "Object", "tags": [], - "children": [ - { - "tags": [], - "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" - } - } - ], + "id": "def-common.AggGroupNames", + "type": "Object", + "label": "AggGroupNames", "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" + "path": "src/plugins/data/common/search/aggs/agg_groups.ts", + "lineNumber": 12 }, + "signature": [ + "Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>" + ], "initialIsOpen": false }, { @@ -19536,8 +18347,7 @@ "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" + "lineNumber": 27 }, "signature": [ "\"kibana\"" @@ -19551,8 +18361,7 @@ "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" + "lineNumber": 28 }, "signature": [ "\"kibana_context\"" @@ -19566,8 +18375,7 @@ "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" + "lineNumber": 30 }, "signature": [ "(\"kibana_context\" | \"null\")[]" @@ -19581,8 +18389,7 @@ "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" + "lineNumber": 32 } }, { @@ -19594,8 +18401,7 @@ "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" + "lineNumber": 36 } }, { @@ -19656,8 +18462,7 @@ "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" + "lineNumber": 38 } }, { @@ -19670,8 +18475,7 @@ "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" + "lineNumber": 38 } }, { @@ -19706,27 +18510,107 @@ ], "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" - } + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 38 + } + } + ], + "description": [], + "label": "kibana", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana.ts", + "lineNumber": 26 + }, + "initialIsOpen": false + }, + { + "id": "def-common.kibanaContext", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.kibanaContext.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 30 + } + }, + { + "id": "def-common.kibanaContext.from", + "type": "Object", + "tags": [], + "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 + }, + "tags": [], + "returnComment": [] } ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 31 + } + }, + { + "id": "def-common.kibanaContext.to", + "type": "Object", "tags": [], - "returnComment": [], + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 38 } } ], "description": [], - "label": "kibana", + "label": "kibanaContext", "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" + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", + "lineNumber": 29 }, "initialIsOpen": false }, @@ -19743,8 +18627,7 @@ "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" + "lineNumber": 41 }, "signature": [ "\"kibana_context\"" @@ -19758,8 +18641,7 @@ "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" + "lineNumber": 42 }, "signature": [ "\"kibana_context\"" @@ -19773,8 +18655,7 @@ "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" + "lineNumber": 43 }, "signature": [ "(\"kibana_context\" | \"null\")[]" @@ -19788,8 +18669,7 @@ "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" + "lineNumber": 44 } }, { @@ -19810,8 +18690,7 @@ "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" + "lineNumber": 49 }, "signature": [ "(\"string\" | \"null\")[]" @@ -19825,8 +18704,7 @@ "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" + "lineNumber": 50 }, "signature": [ "string[]" @@ -19840,8 +18718,7 @@ "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" + "lineNumber": 51 }, "signature": [ "null" @@ -19855,8 +18732,7 @@ "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" + "lineNumber": 52 } } ], @@ -19864,8 +18740,7 @@ "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" + "lineNumber": 48 } }, { @@ -19881,8 +18756,7 @@ "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" + "lineNumber": 57 }, "signature": [ "(\"string\" | \"null\")[]" @@ -19896,8 +18770,7 @@ "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" + "lineNumber": 58 } }, { @@ -19908,8 +18781,7 @@ "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" + "lineNumber": 59 } } ], @@ -19917,8 +18789,7 @@ "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" + "lineNumber": 56 } }, { @@ -19934,8 +18805,7 @@ "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" + "lineNumber": 64 }, "signature": [ "(\"string\" | \"null\")[]" @@ -19949,8 +18819,7 @@ "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" + "lineNumber": 65 }, "signature": [ "null" @@ -19964,8 +18833,7 @@ "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" + "lineNumber": 66 } } ], @@ -19973,8 +18841,7 @@ "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" + "lineNumber": 63 } }, { @@ -19990,8 +18857,7 @@ "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" + "lineNumber": 71 }, "signature": [ "(\"string\" | \"null\")[]" @@ -20005,8 +18871,7 @@ "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" + "lineNumber": 72 }, "signature": [ "null" @@ -20020,8 +18885,7 @@ "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" + "lineNumber": 73 } } ], @@ -20029,8 +18893,7 @@ "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" + "lineNumber": 70 } } ], @@ -20038,8 +18901,7 @@ "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" + "lineNumber": 47 } }, { @@ -20100,8 +18962,7 @@ "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" + "lineNumber": 79 } }, { @@ -20114,8 +18975,7 @@ "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" + "lineNumber": 79 } }, { @@ -20151,8 +19011,7 @@ "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" + "lineNumber": 79 } } ], @@ -20160,8 +19019,7 @@ "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" + "lineNumber": 79 } } ], @@ -20169,97 +19027,240 @@ "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" + "lineNumber": 40 }, "initialIsOpen": false }, { - "id": "def-common.kibanaContext", + "tags": [], + "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 + }, + "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", "tags": [], "children": [ { "tags": [], - "id": "def-common.kibanaContext.name", + "id": "def-common.parentPipelineAggHelper.subtype", "type": "string", - "label": "name", + "label": "subtype", "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" + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 34 } }, { - "id": "def-common.kibanaContext.from", - "type": "Object", + "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 + } + }, + { + "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": [ { - "id": "def-common.kibanaContext.from.null", - "type": "Function", - "children": [], + "type": "Object", + "label": "agg", + "isRequired": true, "signature": [ - "() => { type: string; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + } ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 63 + } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 63 + } + } + ], + "description": [], + "label": "parentPipelineAggHelper", + "source": { + "path": "src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts", + "lineNumber": 33 + }, + "initialIsOpen": false + }, + { + "id": "def-common.siblingPipelineAggHelper", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.siblingPipelineAggHelper.subtype", + "type": "string", + "label": "subtype", "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" + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 41 } }, { - "id": "def-common.kibanaContext.to", - "type": "Object", + "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 + } + }, + { + "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": [ { - "id": "def-common.kibanaContext.to.null", - "type": "Function", - "children": [], + "type": "Object", + "label": "agg", + "isRequired": true, "signature": [ - "() => { type: string; }" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IMetricAggConfig", + "text": "IMetricAggConfig" + } ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 77 + } } ], - "description": [], - "label": "to", + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 77 } } ], "description": [], - "label": "kibanaContext", + "label": "siblingPipelineAggHelper", "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" + "path": "src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts", + "lineNumber": 40 }, "initialIsOpen": false } diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json index a1514015ac5bc..cf0528bc7faff 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -23,8 +23,7 @@ "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" + "lineNumber": 24 } } ], @@ -43,8 +42,7 @@ "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" + "lineNumber": 24 }, "tags": [], "returnComment": [], @@ -67,8 +65,7 @@ "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" + "lineNumber": 42 }, "signature": [ "(string | ", @@ -90,8 +87,7 @@ "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" + "lineNumber": 43 }, "signature": [ { @@ -111,8 +107,7 @@ "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" + "lineNumber": 44 }, "signature": [ "boolean | undefined" @@ -126,8 +121,7 @@ "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" + "lineNumber": 45 }, "signature": [ "string | undefined" @@ -141,8 +135,7 @@ "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" + "lineNumber": 46 }, "signature": [ "any" @@ -156,8 +149,7 @@ "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" + "lineNumber": 47 }, "signature": [ { @@ -178,8 +170,7 @@ "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" + "lineNumber": 48 }, "signature": [ "boolean | undefined" @@ -193,8 +184,7 @@ "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" + "lineNumber": 49 }, "signature": [ "string | undefined" @@ -208,8 +198,7 @@ "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" + "lineNumber": 50 }, "signature": [ "boolean | undefined" @@ -223,8 +212,7 @@ "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" + "lineNumber": 51 }, "signature": [ "\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined" @@ -238,8 +226,7 @@ "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" + "lineNumber": 52 }, "signature": [ "(() => void) | undefined" @@ -253,8 +240,7 @@ "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" + "lineNumber": 53 }, "signature": [ "((query: ", @@ -276,8 +262,7 @@ "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" + "lineNumber": 54 }, "signature": [ "((isFocused: boolean) => void) | undefined" @@ -291,8 +276,7 @@ "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" + "lineNumber": 55 }, "signature": [ "((query: ", @@ -314,8 +298,7 @@ "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" + "lineNumber": 56 }, "signature": [ "string | undefined" @@ -329,8 +312,7 @@ "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" + "lineNumber": 57 }, "signature": [ "\"s\" | \"l\" | undefined" @@ -344,8 +326,7 @@ "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" + "lineNumber": 58 }, "signature": [ "string | undefined" @@ -359,8 +340,7 @@ "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" + "lineNumber": 59 }, "signature": [ "boolean | undefined" @@ -374,8 +354,7 @@ "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" + "lineNumber": 60 }, "signature": [ "boolean | undefined" @@ -389,8 +368,7 @@ "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" + "lineNumber": 61 }, "signature": [ "string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined" @@ -404,8 +382,7 @@ "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" + "lineNumber": 67 }, "signature": [ "\"text\" | \"lucene\" | undefined" @@ -419,8 +396,7 @@ "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" + "lineNumber": 68 }, "signature": [ "string | undefined" @@ -429,14 +405,28 @@ ], "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" + "lineNumber": 41 }, "initialIsOpen": false } ], "enums": [], "misc": [ + { + "id": "def-public.IndexPatternSelectProps", + "type": "Type", + "label": "IndexPatternSelectProps", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx", + "lineNumber": 17 + }, + "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 + }, { "tags": [], "id": "def-public.SearchBar", @@ -445,8 +435,7 @@ "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" + "lineNumber": 23 }, "signature": [ "React.ComponentClass void) | undefined; }" ], "initialIsOpen": false - }, - { - "id": "def-public.IndexPatternSelectProps", - "type": "Type", - "label": "IndexPatternSelectProps", - "tags": [], - "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": [] diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json index 2db286ea4d6f9..39ddaf5d93b81 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -85,8 +85,7 @@ "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" + "lineNumber": 43 } }, { @@ -104,8 +103,7 @@ "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" + "lineNumber": 43 }, "signature": [ "{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }" @@ -114,8 +112,7 @@ ], "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" + "lineNumber": 43 } } ], @@ -123,8 +120,7 @@ "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" + "lineNumber": 43 } }, { @@ -140,8 +136,7 @@ "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" + "lineNumber": 84 } }, { @@ -157,15 +152,13 @@ "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" + "lineNumber": 90 } } ], "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" + "lineNumber": 35 }, "initialIsOpen": false } @@ -192,8 +185,7 @@ ], "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" + "lineNumber": 32 }, "signature": [ "(devTool: ", @@ -217,8 +209,7 @@ ], "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" + "lineNumber": 21 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/discover.json b/api_docs/discover.json index 75396858368b0..69e1d0366a712 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -29,8 +29,7 @@ "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" + "lineNumber": 18 } } ], @@ -38,13 +37,311 @@ "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" + "lineNumber": 18 }, "initialIsOpen": false } ], "interfaces": [ + { + "id": "def-public.DiscoverUrlGeneratorState", + "type": "Interface", + "label": "DiscoverUrlGeneratorState", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.DiscoverUrlGeneratorState.filters", + "type": "Array", + "label": "filters", + "description": [ + "\nOptionally apply filters." + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 46 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.Filter", + "text": "Filter" + }, + "[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[][] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 22 + }, + "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": [], + "tags": [], + "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 + } + } + ], + "source": { + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 34 + }, + "initialIsOpen": false + }, { "id": "def-public.SavedSearch", "type": "Interface", @@ -60,8 +357,7 @@ "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" + "lineNumber": 15 } }, { @@ -72,8 +368,7 @@ "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" + "lineNumber": 16 } }, { @@ -84,8 +379,7 @@ "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" + "lineNumber": 17 }, "signature": [ { @@ -105,8 +399,7 @@ "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" + "lineNumber": 18 }, "signature": [ "string | undefined" @@ -120,8 +413,7 @@ "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" + "lineNumber": 19 }, "signature": [ "string[]" @@ -135,8 +427,7 @@ "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" + "lineNumber": 20 }, "signature": [ { @@ -157,8 +448,7 @@ "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" + "lineNumber": 21 }, "signature": [ { @@ -178,8 +468,7 @@ "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" + "lineNumber": 22 }, "signature": [ "() => void" @@ -193,8 +482,7 @@ "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" + "lineNumber": 23 }, "signature": [ "(saveOptions: ", @@ -216,8 +504,7 @@ "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" + "lineNumber": 24 }, "signature": [ "string | undefined" @@ -231,8 +518,7 @@ "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" + "lineNumber": 25 }, "signature": [ "boolean | undefined" @@ -246,8 +532,7 @@ "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" + "lineNumber": 26 }, "signature": [ "boolean | undefined" @@ -256,8 +541,7 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -276,8 +560,7 @@ "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" + "lineNumber": 29 }, "signature": [ "(id: string) => Promise<", @@ -299,8 +582,7 @@ "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" + "lineNumber": 30 }, "signature": [ "(id: string) => string" @@ -309,75 +591,7 @@ ], "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": [], - "tags": [], - "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" + "lineNumber": 28 }, "initialIsOpen": false }, @@ -401,188 +615,19 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" } - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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": [], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.timeRange", + "id": "def-public.SearchInput.timeRange", "type": "Object", "label": "timeRange", - "description": [ - "\nOptionally set the time range in the time picker." - ], + "description": [], "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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 20 }, "signature": [ { @@ -591,46 +636,39 @@ "docId": "kibDataQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" - }, - " | undefined" + } ] }, { "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.refreshInterval", + "id": "def-public.SearchInput.query", "type": "Object", - "label": "refreshInterval", - "description": [ - "\nOptionally set the refresh interval." - ], + "label": "query", + "description": [], "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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 21 }, "signature": [ { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" + "section": "def-common.Query", + "text": "Query" }, " | undefined" ] }, { "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.filters", + "id": "def-public.SearchInput.filters", "type": "Array", "label": "filters", - "description": [ - "\nOptionally apply filters." - ], + "description": [], "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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 22 }, "signature": [ { @@ -645,40 +683,13 @@ }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.useHash", + "id": "def-public.SearchInput.hidePanelTitles", "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." - ], + "label": "hidePanelTitles", + "description": [], "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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 23 }, "signature": [ "boolean | undefined" @@ -686,33 +697,13 @@ }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.columns", + "id": "def-public.SearchInput.columns", "type": "Array", "label": "columns", - "description": [ - "\nColumns displayed in the table" - ], + "description": [], "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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 24 }, "signature": [ "string[] | undefined" @@ -720,60 +711,29 @@ }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.sort", + "id": "def-public.SearchInput.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" - ] - }, - { - "tags": [], - "id": "def-public.DiscoverUrlGeneratorState.savedQuery", - "type": "string", - "label": "savedQuery", - "description": [ - "\nid of the used saved query" - ], + "description": [], "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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 25 }, "signature": [ - "string | undefined" + { + "pluginId": "discover", + "scope": "public", + "docId": "kibDiscoverPluginApi", + "section": "def-public.SortOrder", + "text": "SortOrder" + }, + "[] | 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" + "path": "src/plugins/discover/public/application/embeddable/types.ts", + "lineNumber": 19 }, "initialIsOpen": false } @@ -782,33 +742,31 @@ "misc": [ { "tags": [], - "id": "def-public.SEARCH_EMBEDDABLE_TYPE", + "id": "def-public.DISCOVER_APP_URL_GENERATOR", "type": "string", - "label": "SEARCH_EMBEDDABLE_TYPE", + "label": "DISCOVER_APP_URL_GENERATOR", "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" + "path": "src/plugins/discover/public/url_generator.ts", + "lineNumber": 20 }, "signature": [ - "\"search\"" + "\"DISCOVER_APP_URL_GENERATOR\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.DISCOVER_APP_URL_GENERATOR", + "id": "def-public.SEARCH_EMBEDDABLE_TYPE", "type": "string", - "label": "DISCOVER_APP_URL_GENERATOR", + "label": "SEARCH_EMBEDDABLE_TYPE", "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" + "path": "src/plugins/discover/public/application/embeddable/constants.ts", + "lineNumber": 9 }, "signature": [ - "\"DISCOVER_APP_URL_GENERATOR\"" + "\"search\"" ], "initialIsOpen": false } @@ -831,8 +789,7 @@ "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" + "lineNumber": 75 }, "signature": [ "{ addDocView(docViewRaw: ", @@ -857,8 +814,7 @@ ], "source": { "path": "src/plugins/discover/public/plugin.ts", - "lineNumber": 74, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L74" + "lineNumber": 74 }, "lifecycle": "setup", "initialIsOpen": true @@ -878,8 +834,7 @@ "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" + "lineNumber": 86 }, "signature": [ { @@ -901,8 +856,7 @@ ], "source": { "path": "src/plugins/discover/public/plugin.ts", - "lineNumber": 104, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L104" + "lineNumber": 104 }, "signature": [ { @@ -918,8 +872,7 @@ ], "source": { "path": "src/plugins/discover/public/plugin.ts", - "lineNumber": 85, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L85" + "lineNumber": 85 }, "lifecycle": "start", "initialIsOpen": true @@ -941,81 +894,76 @@ "misc": [ { "tags": [], - "id": "def-common.DEFAULT_COLUMNS_SETTING", + "id": "def-common.AGGS_TERMS_SIZE_SETTING", "type": "string", - "label": "DEFAULT_COLUMNS_SETTING", + "label": "AGGS_TERMS_SIZE_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" + "lineNumber": 11 }, "signature": [ - "\"defaultColumns\"" + "\"discover:aggs:terms:size\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.SAMPLE_SIZE_SETTING", + "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", "type": "string", - "label": "SAMPLE_SIZE_SETTING", + "label": "CONTEXT_DEFAULT_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" + "lineNumber": 16 }, "signature": [ - "\"discover:sampleSize\"" + "\"context:defaultSize\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.AGGS_TERMS_SIZE_SETTING", + "id": "def-common.CONTEXT_STEP_SETTING", "type": "string", - "label": "AGGS_TERMS_SIZE_SETTING", + "label": "CONTEXT_STEP_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" + "lineNumber": 17 }, "signature": [ - "\"discover:aggs:terms:size\"" + "\"context:step\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.SORT_DEFAULT_ORDER_SETTING", + "id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING", "type": "string", - "label": "SORT_DEFAULT_ORDER_SETTING", + "label": "CONTEXT_TIE_BREAKER_FIELDS_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" + "lineNumber": 18 }, "signature": [ - "\"discover:sort:defaultOrder\"" + "\"context:tieBreakerFields\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING", + "id": "def-common.DEFAULT_COLUMNS_SETTING", "type": "string", - "label": "SEARCH_ON_PAGE_LOAD_SETTING", + "label": "DEFAULT_COLUMNS_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" + "lineNumber": 9 }, "signature": [ - "\"discover:searchOnPageLoad\"" + "\"defaultColumns\"" ], "initialIsOpen": false }, @@ -1027,8 +975,7 @@ "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" + "lineNumber": 14 }, "signature": [ "\"doc_table:hideTimeColumn\"" @@ -1037,113 +984,106 @@ }, { "tags": [], - "id": "def-common.FIELDS_LIMIT_SETTING", + "id": "def-common.DOC_TABLE_LEGACY", "type": "string", - "label": "FIELDS_LIMIT_SETTING", + "label": "DOC_TABLE_LEGACY", "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" + "lineNumber": 19 }, "signature": [ - "\"fields:popularLimit\"" + "\"doc_table:legacy\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", + "id": "def-common.FIELDS_LIMIT_SETTING", "type": "string", - "label": "CONTEXT_DEFAULT_SIZE_SETTING", + "label": "FIELDS_LIMIT_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" + "lineNumber": 15 }, "signature": [ - "\"context:defaultSize\"" + "\"fields:popularLimit\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.CONTEXT_STEP_SETTING", + "id": "def-common.MODIFY_COLUMNS_ON_SWITCH", "type": "string", - "label": "CONTEXT_STEP_SETTING", + "label": "MODIFY_COLUMNS_ON_SWITCH", "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" + "lineNumber": 20 }, "signature": [ - "\"context:step\"" + "\"discover:modifyColumnsOnSwitch\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING", + "id": "def-common.SAMPLE_SIZE_SETTING", "type": "string", - "label": "CONTEXT_TIE_BREAKER_FIELDS_SETTING", + "label": "SAMPLE_SIZE_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" + "lineNumber": 10 }, "signature": [ - "\"context:tieBreakerFields\"" + "\"discover:sampleSize\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.DOC_TABLE_LEGACY", + "id": "def-common.SEARCH_FIELDS_FROM_SOURCE", "type": "string", - "label": "DOC_TABLE_LEGACY", + "label": "SEARCH_FIELDS_FROM_SOURCE", "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" + "lineNumber": 21 }, "signature": [ - "\"doc_table:legacy\"" + "\"discover:searchFieldsFromSource\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.MODIFY_COLUMNS_ON_SWITCH", + "id": "def-common.SEARCH_ON_PAGE_LOAD_SETTING", "type": "string", - "label": "MODIFY_COLUMNS_ON_SWITCH", + "label": "SEARCH_ON_PAGE_LOAD_SETTING", "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" + "lineNumber": 13 }, "signature": [ - "\"discover:modifyColumnsOnSwitch\"" + "\"discover:searchOnPageLoad\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.SEARCH_FIELDS_FROM_SOURCE", + "id": "def-common.SORT_DEFAULT_ORDER_SETTING", "type": "string", - "label": "SEARCH_FIELDS_FROM_SOURCE", + "label": "SORT_DEFAULT_ORDER_SETTING", "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" + "lineNumber": 12 }, "signature": [ - "\"discover:searchFieldsFromSource\"" + "\"discover:sort:defaultOrder\"" ], "initialIsOpen": false } diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json index 7b4c21d670197..ffb733e0c656d 100644 --- a/api_docs/discover_enhanced.json +++ b/api_docs/discover_enhanced.json @@ -3,402 +3,181 @@ "client": { "classes": [ { - "id": "def-public.ExploreDataContextMenuAction", + "id": "def-public.DiscoverEnhancedPlugin", "type": "Class", "tags": [], - "label": "ExploreDataContextMenuAction", - "description": [ - "\nThis is \"Explore underlying data\" action which appears in the context\nmenu of a dashboard panel." - ], + "label": "DiscoverEnhancedPlugin", + "description": [], "signature": [ { "pluginId": "discoverEnhanced", "scope": "public", "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataContextMenuAction", - "text": "ExploreDataContextMenuAction" + "section": "def-public.DiscoverEnhancedPlugin", + "text": "DiscoverEnhancedPlugin" }, - " extends ", - "AbstractExploreDataAction", - " implements ", + " implements ", { - "pluginId": "uiActions", + "pluginId": "core", "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.Action", - "text": "Action" + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" }, - "" - ], - "children": [ + "" + ], + "children": [ { "tags": [], - "id": "def-public.ExploreDataContextMenuAction.order", - "type": "number", - "label": "order", + "id": "def-public.DiscoverEnhancedPlugin.config", + "type": "Object", + "label": "config", "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" + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 43 }, "signature": [ - "200" + { + "pluginId": "discoverEnhanced", + "scope": "common", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-common.Config", + "text": "Config" + } ] }, { - "id": "def-public.ExploreDataContextMenuAction.getUrl", + "id": "def-public.DiscoverEnhancedPlugin.Unnamed", "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { "type": "Object", "label": "context", "isRequired": true, "signature": [ - "EmbeddableQueryContext" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" ], "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" + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 45 } } ], - "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" - }, - "tags": [], - "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", - "tags": [], - "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": [ - { - "tags": [], - "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\"" - ] - }, - { - "tags": [], - "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\"" - ] - }, - { "tags": [], - "id": "def-public.ExploreDataChartAction.order", - "type": "number", - "label": "order", - "description": [], + "returnComment": [], "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" - ] + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 45 + } }, { - "id": "def-public.ExploreDataChartAction.isCompatible", + "id": "def-public.DiscoverEnhancedPlugin.setup", "type": "Function", - "label": "isCompatible", + "label": "setup", "signature": [ - "(context: ", + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "<", { "pluginId": "discoverEnhanced", "scope": "public", "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" }, - ") => Promise" + ", unknown>, { uiActions, share }: ", + { + "pluginId": "discoverEnhanced", + "scope": "public", + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.DiscoverEnhancedSetupDependencies", + "text": "DiscoverEnhancedSetupDependencies" + }, + ") => void" ], "description": [], "children": [ { "type": "Object", - "label": "context", + "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.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" - } + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" + }, + ", unknown>" ], "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" + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 50 } - } - ], - "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", + "label": "{ uiActions, share }", "isRequired": true, "signature": [ { "pluginId": "discoverEnhanced", "scope": "public", "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.ExploreDataChartActionContext", - "text": "ExploreDataChartActionContext" + "section": "def-public.DiscoverEnhancedSetupDependencies", + "text": "DiscoverEnhancedSetupDependencies" } ], "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" - }, - "tags": [], - "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", - "tags": [], - "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": [ - { - "tags": [], - "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" + "lineNumber": 51 } } ], @@ -406,24 +185,23 @@ "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" + "lineNumber": 49 } }, { - "id": "def-public.DiscoverEnhancedPlugin.setup", + "id": "def-public.DiscoverEnhancedPlugin.start", "type": "Function", - "label": "setup", + "label": "start", "signature": [ "(core: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" + "section": "def-public.CoreStart", + "text": "CoreStart" }, - "<", + ", plugins: ", { "pluginId": "discoverEnhanced", "scope": "public", @@ -431,14 +209,6 @@ "section": "def-public.DiscoverEnhancedStartDependencies", "text": "DiscoverEnhancedStartDependencies" }, - ", unknown>, { uiActions, share }: ", - { - "pluginId": "discoverEnhanced", - "scope": "public", - "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.DiscoverEnhancedSetupDependencies", - "text": "DiscoverEnhancedSetupDependencies" - }, ") => void" ], "description": [], @@ -452,44 +222,33 @@ "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>" + "section": "def-public.CoreStart", + "text": "CoreStart" + } ], "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" + "lineNumber": 69 } }, { "type": "Object", - "label": "{ uiActions, share }", + "label": "plugins", "isRequired": true, "signature": [ { "pluginId": "discoverEnhanced", "scope": "public", "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.DiscoverEnhancedSetupDependencies", - "text": "DiscoverEnhancedSetupDependencies" + "section": "def-public.DiscoverEnhancedStartDependencies", + "text": "DiscoverEnhancedStartDependencies" } ], "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" + "lineNumber": 69 } } ], @@ -497,106 +256,322 @@ "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" + "lineNumber": 69 } }, { - "id": "def-public.DiscoverEnhancedPlugin.start", + "id": "def-public.DiscoverEnhancedPlugin.stop", "type": "Function", - "label": "start", + "label": "stop", "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ", plugins: ", + "() => void" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 71 + } + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/plugin.ts", + "lineNumber": 40 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExploreDataChartAction", + "type": "Class", + "tags": [], + "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": [ + { + "tags": [], + "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 + }, + "signature": [ + "\"ACTION_EXPLORE_DATA_CHART\"" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"ACTION_EXPLORE_DATA_CHART\"" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "200" + ] + }, + { + "id": "def-public.ExploreDataChartAction.isCompatible", + "type": "Function", + "label": "isCompatible", + "signature": [ + "(context: ", { "pluginId": "discoverEnhanced", "scope": "public", "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.DiscoverEnhancedStartDependencies", - "text": "DiscoverEnhancedStartDependencies" + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" }, - ") => void" + ") => Promise" ], "description": [], "children": [ { "type": "Object", - "label": "core", + "label": "context", "isRequired": true, "signature": [ { - "pluginId": "core", + "pluginId": "discoverEnhanced", "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "docId": "kibDiscoverEnhancedPluginApi", + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" } ], "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" + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 41 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 41 + } + }, + { + "id": "def-public.ExploreDataChartAction.getUrl", + "type": "Function", + "children": [ { "type": "Object", - "label": "plugins", + "label": "context", "isRequired": true, "signature": [ { "pluginId": "discoverEnhanced", "scope": "public", "docId": "kibDiscoverEnhancedPluginApi", - "section": "def-public.DiscoverEnhancedStartDependencies", - "text": "DiscoverEnhancedStartDependencies" + "section": "def-public.ExploreDataChartActionContext", + "text": "ExploreDataChartActionContext" } ], "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" + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 47 } } ], + "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 + }, "tags": [], - "returnComment": [], + "returnComment": [] + } + ], + "source": { + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts", + "lineNumber": 32 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExploreDataContextMenuAction", + "type": "Class", + "tags": [], + "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": [ + { + "tags": [], + "id": "def-public.ExploreDataContextMenuAction.id", + "type": "string", + "label": "id", + "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" - } + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 37 + }, + "signature": [ + "\"ACTION_EXPLORE_DATA\"" + ] }, { - "id": "def-public.DiscoverEnhancedPlugin.stop", + "tags": [], + "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 + }, + "signature": [ + "\"ACTION_EXPLORE_DATA\"" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "200" + ] + }, + { + "id": "def-public.ExploreDataContextMenuAction.getUrl", "type": "Function", - "label": "stop", + "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 + } + } + ], "signature": [ - "() => void" + "(context: EmbeddableQueryContext) => Promise<", + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.KibanaURL", + "text": "KibanaURL" + }, + ">" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "getUrl", "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" - } + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 43 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts", + "lineNumber": 34 }, "initialIsOpen": false } @@ -618,8 +593,7 @@ "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" + "lineNumber": 25 }, "signature": [ { @@ -639,8 +613,7 @@ "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" + "lineNumber": 26 }, "signature": [ { @@ -660,8 +633,7 @@ "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" + "lineNumber": 27 }, "signature": [ "{} | undefined" @@ -675,8 +647,7 @@ "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" + "lineNumber": 28 }, "signature": [ { @@ -697,8 +668,7 @@ "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" + "lineNumber": 29 }, "signature": [ "Pick<", @@ -715,8 +685,7 @@ ], "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" + "lineNumber": 24 }, "initialIsOpen": false }, @@ -735,8 +704,7 @@ "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" + "lineNumber": 33 }, "signature": [ { @@ -756,8 +724,7 @@ "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" + "lineNumber": 34 }, "signature": [ { @@ -777,8 +744,7 @@ "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" + "lineNumber": 35 }, "signature": [ "{ dashboardConfig: ", @@ -800,8 +766,7 @@ "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" + "lineNumber": 36 }, "signature": [ { @@ -822,8 +787,7 @@ "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" + "lineNumber": 37 }, "signature": [ "Pick<", @@ -850,8 +814,7 @@ ], "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" + "lineNumber": 32 }, "initialIsOpen": false } @@ -887,8 +850,7 @@ "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" + "lineNumber": 9 }, "signature": [ "{ exploreDataInChart: { enabled: boolean; }; }" @@ -897,8 +859,7 @@ ], "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" + "lineNumber": 8 }, "initialIsOpen": false } diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json index 2b10b5ffa08cc..5b02c5e0c9cbd 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -35,8 +35,7 @@ "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" + "lineNumber": 24 }, "signature": [ "\"ACTION_ADD_PANEL\"" @@ -50,8 +49,7 @@ "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" + "lineNumber": 25 }, "signature": [ "\"ACTION_ADD_PANEL\"" @@ -115,8 +113,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L28" + "lineNumber": 28 } }, { @@ -168,8 +165,7 @@ "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" + "lineNumber": 29 } }, { @@ -188,8 +184,7 @@ "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" + "lineNumber": 30 } }, { @@ -208,8 +203,7 @@ "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" + "lineNumber": 31 } }, { @@ -222,8 +216,7 @@ "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" + "lineNumber": 32 } } ], @@ -231,8 +224,7 @@ "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" + "lineNumber": 27 } }, { @@ -248,8 +240,7 @@ "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" + "lineNumber": 35 } }, { @@ -265,8 +256,7 @@ "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" + "lineNumber": 41 } }, { @@ -303,8 +293,7 @@ "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" + "lineNumber": 45 } } ], @@ -312,8 +301,7 @@ "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" + "lineNumber": 45 } }, { @@ -350,8 +338,7 @@ "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" + "lineNumber": 50 } } ], @@ -359,78 +346,35 @@ "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" + "lineNumber": 50 } } ], "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" + "lineNumber": 23 }, "initialIsOpen": false }, { - "id": "def-public.Container", + "id": "def-public.AttributeService", "type": "Class", "tags": [], - "label": "Container", + "label": "AttributeService", "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" + "section": "def-public.AttributeService", + "text": "AttributeService" }, - "" + "" ], "children": [ { - "tags": [], - "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", - "tags": [], - "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", + "id": "def-public.AttributeService.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -439,47 +383,99 @@ "description": [], "children": [ { - "type": "Uncategorized", - "label": "input", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "TContainerInput" + "string" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 49 } }, { - "type": "Uncategorized", - "label": "output", + "type": "Function", + "label": "showSaveModal", "isRequired": true, "signature": [ - "TContainerOutput" + "(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/containers/container.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L43" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 50 } }, { "type": "Function", - "label": "getFactory", + "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 + } + }, + { + "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 + } + }, + { + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 56 + } + }, + { + "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", @@ -487,7 +483,7 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", O extends ", + ", ", { "pluginId": "embeddable", "scope": "public", @@ -495,169 +491,167 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - " = ", + ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, - ", E extends ", + "<", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" } ], "description": [], "source": { - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L44" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 57 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 48 + } + }, + { + "id": "def-public.AttributeService.unwrapAttributes", + "type": "Function", + "label": "unwrapAttributes", + "signature": [ + "(input: ValType | RefType) => Promise" + ], + "description": [], + "children": [ { - "type": "Object", - "label": "parent", - "isRequired": false, + "type": "CompoundType", + "label": "input", + "isRequired": true, "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" + "ValType | RefType" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 74 } } ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 74 } }, { - "id": "def-public.Container.updateInputForChild", + "id": "def-public.AttributeService.wrapAttributes", "type": "Function", - "label": "updateInputForChild", + "label": "wrapAttributes", "signature": [ - "(id: string, changes: Partial) => void" + "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>>" ], "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Uncategorized", + "label": "newAttributes", "isRequired": true, "signature": [ - "string" + "SavedObjectAttributes" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 84 } }, { - "type": "Object", - "label": "changes", + "type": "boolean", + "label": "useRefType", "isRequired": true, "signature": [ - "Partial" + "boolean" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 85 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 83 } }, { - "id": "def-public.Container.reload", + "id": "def-public.AttributeService.inputIsRefType", "type": "Function", - "label": "reload", - "signature": [ - "() => void" + "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 + } + } + ], + "signature": [ + "(input: ValType | RefType) => input is RefType" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "inputIsRefType", "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" - } + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 116 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.Container.addNewEmbeddable", + "id": "def-public.AttributeService.getExplicitInputFromEmbeddable", "type": "Function", - "label": "addNewEmbeddable", + "label": "getExplicitInputFromEmbeddable", "signature": [ - ") => ValType | RefType" ], "description": [], "children": [ - { - "type": "string", - "label": "type", - "isRequired": true, - "signature": [ - "string" - ], - "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" - } - }, { "type": "Object", - "label": "explicitInput", + "label": "embeddable", "isRequired": true, "signature": [ - "Partial" + { + "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/containers/container.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L86" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 120 } } ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 120 } }, { - "id": "def-public.Container.removeEmbeddable", + "id": "def-public.AttributeService.getInputAsValueType", "type": "Function", - "label": "removeEmbeddable", - "signature": [ - "(embeddableId: string) => void" - ], - "description": [], "children": [ { - "type": "string", - "label": "embeddableId", + "type": "CompoundType", + "label": "input", "isRequired": true, "signature": [ - "string" + "ValType | RefType" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 125 } } ], - "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[]" + "(input: ValType | RefType) => Promise" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "getInputAsValueType", "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" - } + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 125 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.Container.getChild", + "id": "def-public.AttributeService.getInputAsRefType", "type": "Function", - "label": "getChild", - "signature": [ - ">(id: string) => E" - ], - "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "CompoundType", + "label": "input", "isRequired": true, "signature": [ - "string" + "ValType | RefType" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 138 } - } - ], - "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, + "type": "CompoundType", + "label": "saveOptions", + "isRequired": false, "signature": [ - "string" + "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" ], "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" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 139 } } ], - "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" + "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "getInputAsRefType", "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>" + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 137 + }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "lineNumber": 41 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Container", + "type": "Class", + "tags": [], + "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": [ + { + "tags": [], + "id": "def-public.Container.isContainer", + "type": "boolean", + "label": "isContainer", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 34 + } + }, + { + "id": "def-public.Container.children", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "children", + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 35 + } + }, + { + "id": "def-public.Container.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Uncategorized", + "label": "input", "isRequired": true, "signature": [ - "string" + "TContainerInput" ], "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" + "lineNumber": 42 } - } - ], - "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", + "type": "Function", + "label": "getFactory", "isRequired": true, "signature": [ + "" + ", O extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", E extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + } ], "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" + "lineNumber": 44 } }, { "type": "Object", - "label": "partial", - "isRequired": true, + "label": "parent", + "isRequired": false, "signature": [ - "Partial" + { + "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/embeddable/public/lib/containers/container.ts", - "lineNumber": 185, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L185" + "lineNumber": 45 } } ], @@ -1059,16 +979,15 @@ "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" + "lineNumber": 41 } }, { - "id": "def-public.Container.getPanelState", + "id": "def-public.Container.updateInputForChild", "type": "Function", - "label": "getPanelState", + "label": "updateInputForChild", "signature": [ - "(embeddableId: string) => ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.PanelState", - "text": "PanelState" - }, - "" + ">(id: string, changes: Partial) => void" ], "description": [], "children": [ { "type": "string", - "label": "embeddableId", + "label": "id", "isRequired": true, "signature": [ "string" @@ -1106,42 +1017,20 @@ "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" + "lineNumber": 57 } - } - ], - "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", + "type": "Object", + "label": "changes", "isRequired": true, "signature": [ - "string" + "Partial" ], "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" + "lineNumber": 58 } } ], @@ -1149,588 +1038,601 @@ "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" + "lineNumber": 56 } - } - ], - "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", - "tags": [], - "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": [ { - "tags": [], - "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" - }, + "id": "def-public.Container.reload", + "type": "Function", + "label": "reload", "signature": [ - "\"editPanel\"" - ] - }, - { - "tags": [], - "id": "def-public.EditPanelAction.id", - "type": "string", - "label": "id", + "() => void" + ], "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\"" - ] - }, - { + "children": [], "tags": [], - "id": "def-public.EditPanelAction.order", - "type": "number", - "label": "order", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 78 } }, { - "tags": [], - "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", + "id": "def-public.Container.addNewEmbeddable", "type": "Function", - "label": "Constructor", + "label": "addNewEmbeddable", "signature": [ - "any" + "" ], "description": [], "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 46, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L46" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 86 } } ], "tags": [], "returnComment": [], "source": { - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L43" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 82 } }, { - "id": "def-public.EditPanelAction.getDisplayName", + "id": "def-public.Container.removeEmbeddable", "type": "Function", - "label": "getDisplayName", + "label": "removeEmbeddable", "signature": [ - "({ embeddable }: ActionContext) => string" + "(embeddableId: string) => void" ], "description": [], "children": [ { - "type": "Object", - "label": "{ embeddable }", + "type": "string", + "label": "embeddableId", "isRequired": true, "signature": [ - "ActionContext" + "string" ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 98 } } ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 98 } }, { - "id": "def-public.EditPanelAction.getIconType", + "id": "def-public.Container.getChildIds", "type": "Function", - "label": "getIconType", + "label": "getChildIds", "signature": [ - "() => string" + "() => 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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 106 } }, { - "id": "def-public.EditPanelAction.isCompatible", + "id": "def-public.Container.getChild", "type": "Function", - "label": "isCompatible", + "label": "getChild", "signature": [ - "({ embeddable }: ActionContext) => Promise" + ">(id: string) => E" ], "description": [], "children": [ { - "type": "Object", - "label": "{ embeddable }", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - "ActionContext" + "string" ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 110 } } ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 110 } }, { - "id": "def-public.EditPanelAction.execute", + "id": "def-public.Container.getInputForChild", "type": "Function", - "label": "execute", + "label": "getInputForChild", "signature": [ - "(context: ActionContext) => Promise" + "(embeddableId: string) => TEmbeddableInput" ], "description": [], "children": [ { - "type": "Object", - "label": "context", + "type": "string", + "label": "embeddableId", "isRequired": true, "signature": [ - "ActionContext" + "string" ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 115 } } ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 114 } }, { - "id": "def-public.EditPanelAction.getAppTarget", + "id": "def-public.Container.destroy", "type": "Function", - "label": "getAppTarget", + "label": "destroy", "signature": [ - "({ embeddable }: ActionContext) => NavigationContext | undefined" + "() => void" ], "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" - } - } - ], + "children": [], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 146 } }, { - "id": "def-public.EditPanelAction.getHref", + "id": "def-public.Container.untilEmbeddableLoaded", "type": "Function", - "label": "getHref", + "label": "untilEmbeddableLoaded", "signature": [ - "({ embeddable }: ActionContext) => Promise" + ">(id: string) => Promise<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable>" ], "description": [], "children": [ { - "type": "Object", - "label": "{ embeddable }", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - "ActionContext" + "string" ], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 153 } } ], "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", - "tags": [], - "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": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 152 } }, { - "tags": [], - "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" - }, + "id": "def-public.Container.createNewPanelState", + "type": "Function", + "label": "createNewPanelState", "signature": [ + ", ", + ">(factory: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" }, - "> | undefined" - ] - }, - { - "tags": [], - "id": "def-public.Embeddable.isContainer", - "type": "boolean", - "label": "isContainer", + ", partial?: Partial) => ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + } + ], "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" - } - }, - { - "tags": [], - "id": "def-public.Embeddable.type", - "type": "string", - "label": "type", + "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 + } + }, + { + "type": "Object", + "label": "partial", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 185 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 180 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 204 } }, { + "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 + } + } + ], "tags": [], - "id": "def-public.Embeddable.id", - "type": "string", - "label": "id", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 219 } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "lineNumber": 27 + }, + "initialIsOpen": false + }, + { + "id": "def-public.EditPanelAction", + "type": "Class", + "tags": [], + "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": [ { "tags": [], - "id": "def-public.Embeddable.fatalError", - "type": "Object", - "label": "fatalError", + "id": "def-public.EditPanelAction.type", + "type": "string", + "label": "type", "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 38 }, "signature": [ - "Error | undefined" + "\"editPanel\"" ] }, { "tags": [], - "id": "def-public.Embeddable.output", - "type": "Uncategorized", - "label": "output", + "id": "def-public.EditPanelAction.id", + "type": "string", + "label": "id", "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 39 }, "signature": [ - "TEmbeddableOutput" + "\"editPanel\"" ] }, { "tags": [], - "id": "def-public.Embeddable.input", - "type": "Uncategorized", - "label": "input", + "id": "def-public.EditPanelAction.order", + "type": "number", + "label": "order", "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" - ] + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 40 + } }, { "tags": [], - "id": "def-public.Embeddable.renderComplete", - "type": "Object", - "label": "renderComplete", + "id": "def-public.EditPanelAction.currentAppId", + "type": "string", + "label": "currentAppId", "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 41 }, "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.RenderCompleteDispatcher", - "text": "RenderCompleteDispatcher" - } + "string | undefined" ] }, { - "id": "def-public.Embeddable.Unnamed", + "id": "def-public.EditPanelAction.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -1739,491 +1641,565 @@ "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", + "type": "Function", + "label": "getEmbeddableFactory", "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": [ + ", ", + ", O extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - "> | undefined" + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", E extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + } ], "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 44 } - } - ], - "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" + "type": "Object", + "label": "application", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + } + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 45 + } }, - "<{}>, ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" + "type": "Object", + "label": "stateTransfer", + "isRequired": false, + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableStateTransfer", + "text": "EmbeddableStateTransfer" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 46 + } + } ], - "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 43 } }, { - "id": "def-public.Embeddable.reload", + "id": "def-public.EditPanelAction.getDisplayName", "type": "Function", - "label": "reload", + "label": "getDisplayName", "signature": [ - "() => void" + "({ embeddable }: ActionContext) => string" ], - "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$" + "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 + } + } ], - "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 55 } }, { - "id": "def-public.Embeddable.getUpdated$", + "id": "def-public.EditPanelAction.getIconType", "type": "Function", - "label": "getUpdated$", + "label": "getIconType", "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." + "() => string" ], + "description": [], "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 68 } }, { - "id": "def-public.Embeddable.getInput$", + "id": "def-public.EditPanelAction.isCompatible", "type": "Function", - "label": "getInput$", + "label": "isCompatible", "signature": [ - "() => Readonly<", - "Observable", - ">" + "({ embeddable }: ActionContext) => Promise" ], "description": [], - "children": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 72 + } + } + ], "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 72 } }, { - "id": "def-public.Embeddable.getOutput$", + "id": "def-public.EditPanelAction.execute", "type": "Function", - "label": "getOutput$", + "label": "execute", "signature": [ - "() => Readonly<", - "Observable", - ">" + "(context: ActionContext) => Promise" ], "description": [], - "children": [], + "children": [ + { + "type": "Object", + "label": "context", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 83 + } + } + ], "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 83 } }, { - "id": "def-public.Embeddable.getOutput", + "id": "def-public.EditPanelAction.getAppTarget", "type": "Function", - "label": "getOutput", + "label": "getAppTarget", "signature": [ - "() => Readonly" + "({ embeddable }: ActionContext) => NavigationContext | undefined" ], "description": [], - "children": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 104 + } + } + ], "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 104 } }, { - "id": "def-public.Embeddable.getInput", + "id": "def-public.EditPanelAction.getHref", "type": "Function", - "label": "getInput", + "label": "getHref", "signature": [ - "() => Readonly" + "({ embeddable }: ActionContext) => Promise" ], "description": [], - "children": [], + "children": [ + { + "type": "Object", + "label": "{ embeddable }", + "isRequired": true, + "signature": [ + "ActionContext" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 121 + } + } + ], "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" + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 121 } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "lineNumber": 37 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Embeddable", + "type": "Class", + "tags": [], + "label": "Embeddable", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" }, + " implements ", { - "id": "def-public.Embeddable.getTitle", - "type": "Function", - "label": "getTitle", - "signature": [ - "() => string" - ], + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "" + ], + "children": [ + { + "tags": [], + "id": "def-public.Embeddable.runtimeId", + "type": "number", + "label": "runtimeId", "description": [], - "children": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 27 + } + }, + { "tags": [], - "returnComment": [], + "id": "def-public.Embeddable.runtimeId", + "type": "number", + "label": "runtimeId", + "description": [], "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" + "lineNumber": 29 } }, { - "id": "def-public.Embeddable.getRoot", - "type": "Function", - "label": "getRoot", + "tags": [], + "id": "def-public.Embeddable.parent", + "type": "Object", + "label": "parent", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 31 + }, "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" + "section": "def-public.IContainer", + "text": "IContainer" }, - ", ", + "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.ContainerInput", + "text": "ContainerInput" }, - "> | ", + "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" }, - "<{}, ", - { - "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": [], + "> | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.Embeddable.isContainer", + "type": "boolean", + "label": "isContainer", + "description": [], "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" + "lineNumber": 32 } }, { - "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": [], + "id": "def-public.Embeddable.type", + "type": "string", + "label": "type", + "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" + "lineNumber": 33 } }, { - "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": [], + "id": "def-public.Embeddable.id", + "type": "string", + "label": "id", + "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" + "lineNumber": 34 } }, { - "id": "def-public.Embeddable.getInspectorAdapters", - "type": "Function", - "label": "getInspectorAdapters", + "tags": [], + "id": "def-public.Embeddable.fatalError", + "type": "Object", + "label": "fatalError", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 35 + }, "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." - ], + "Error | undefined" + ] + }, + { + "tags": [], + "id": "def-public.Embeddable.output", + "type": "Uncategorized", + "label": "output", + "description": [], "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" - } + "lineNumber": 37 + }, + "signature": [ + "TEmbeddableOutput" + ] }, { - "id": "def-public.Embeddable.destroy", - "type": "Function", - "label": "destroy", + "tags": [], + "id": "def-public.Embeddable.input", + "type": "Uncategorized", + "label": "input", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 38 + }, "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": [], + "TEmbeddableInput" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.Embeddable.renderComplete", + "type": "Object", + "label": "renderComplete", + "description": [], "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" - } + "lineNumber": 43 + }, + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.RenderCompleteDispatcher", + "text": "RenderCompleteDispatcher" + } + ] }, { - "id": "def-public.Embeddable.updateOutput", + "id": "def-public.Embeddable.Unnamed", "type": "Function", - "label": "updateOutput", + "label": "Constructor", "signature": [ - "(outputChanges: Partial) => void" + "any" ], "description": [], "children": [ { - "type": "Object", - "label": "outputChanges", + "type": "Uncategorized", + "label": "input", "isRequired": true, "signature": [ - "Partial" + "TEmbeddableInput" ], "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" + "lineNumber": 51 } - } - ], - "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", + "type": "Uncategorized", + "label": "output", "isRequired": true, "signature": [ - "Error" + "TEmbeddableOutput" ], "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" + "lineNumber": 51 } - } - ], - "tags": [], + }, + { + "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 + } + } + ], + "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" + "lineNumber": 51 } }, { - "id": "def-public.Embeddable.supportedTriggers", + "id": "def-public.Embeddable.getIsContainer", "type": "Function", - "label": "supportedTriggers", + "label": "getIsContainer", "signature": [ - "() => string[]" + "() => 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": [], @@ -2231,69 +2207,137 @@ "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" + "lineNumber": 89 } - } - ], - "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", - "tags": [], - "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" + "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 + } }, - " extends React.Component<", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanelProps", - "text": "EmbeddableChildPanelProps" + "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 + } }, - ", State, any>" - ], - "children": [ { + "id": "def-public.Embeddable.getInput$", + "type": "Function", + "label": "getInput$", + "signature": [ + "() => Readonly<", + "Observable", + ">" + ], + "description": [], + "children": [], "tags": [], - "id": "def-public.EmbeddableChildPanel.mounted", - "type": "boolean", - "label": "mounted", + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 121 + } + }, + { + "id": "def-public.Embeddable.getOutput$", + "type": "Function", + "label": "getOutput$", + "signature": [ + "() => Readonly<", + "Observable", + ">" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 125 } }, { + "id": "def-public.Embeddable.getOutput", + "type": "Function", + "label": "getOutput", + "signature": [ + "() => Readonly" + ], + "description": [], + "children": [], "tags": [], - "id": "def-public.EmbeddableChildPanel.embeddable", - "type": "CompoundType", - "label": "embeddable", + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 129 + } + }, + { + "id": "def-public.Embeddable.getInput", + "type": "Function", + "label": "getInput", + "signature": [ + "() => Readonly" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - }, + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 133 + } + }, + { + "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 + } + }, + { + "id": "def-public.Embeddable.getRoot", + "type": "Function", + "label": "getRoot", "signature": [ + "() => ", { "pluginId": "embeddable", "scope": "public", @@ -2322,196 +2366,304 @@ "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" + "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 + } }, { - "id": "def-public.EmbeddableChildPanel.Unnamed", + "id": "def-public.Embeddable.updateInput", "type": "Function", - "label": "Constructor", + "label": "updateInput", "signature": [ - "any" + "(changes: Partial) => void" ], "description": [], "children": [ { "type": "Object", - "label": "props", + "label": "changes", "isRequired": true, "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanelProps", - "text": "EmbeddableChildPanelProps" - } + "Partial" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 153 } } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 153 } }, { - "id": "def-public.EmbeddableChildPanel.componentDidMount", + "id": "def-public.Embeddable.render", "type": "Function", - "label": "componentDidMount", + "label": "render", "signature": [ - "() => Promise" + "(el: HTMLElement) => void" ], "description": [], - "children": [], + "children": [ + { + "type": "Object", + "label": "el", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 165 + } + } + ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 165 } }, { - "id": "def-public.EmbeddableChildPanel.componentWillUnmount", + "id": "def-public.Embeddable.getInspectorAdapters", "type": "Function", - "label": "componentWillUnmount", + "label": "getInspectorAdapters", "signature": [ - "() => void" + "() => ", + { + "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." ], - "description": [], "children": [], - "tags": [], - "returnComment": [], + "tags": [ + "return" + ], + "returnComment": [ + "Inspector adapters that will be used to open an inspector for." + ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 180 } }, { - "id": "def-public.EmbeddableChildPanel.render", + "id": "def-public.Embeddable.destroy", "type": "Function", - "label": "render", + "label": "destroy", "signature": [ - "() => JSX.Element" + "() => 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." ], - "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 188 } - } - ], - "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", - "tags": [], - "label": "EmbeddableFactoryNotFoundError", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryNotFoundError", - "text": "EmbeddableFactoryNotFoundError" }, - " extends Error" - ], - "children": [ { - "tags": [], - "id": "def-public.EmbeddableFactoryNotFoundError.code", - "type": "string", - "label": "code", + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 200 } }, { - "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", + "id": "def-public.Embeddable.onFatalError", "type": "Function", - "label": "Constructor", + "label": "onFatalError", "signature": [ - "any" + "(e: Error) => void" ], "description": [], "children": [ { - "type": "string", - "label": "type", + "type": "Object", + "label": "e", "isRequired": true, "signature": [ - "string" + "Error" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 211 } } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 211 + } + }, + { + "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 } } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "lineNumber": 23 }, "initialIsOpen": false }, { - "id": "def-public.EmbeddablePanel", + "id": "def-public.EmbeddableChildPanel", "type": "Class", "tags": [], - "label": "EmbeddablePanel", - "description": [], + "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.EmbeddablePanel", - "text": "EmbeddablePanel" + "section": "def-public.EmbeddableChildPanel", + "text": "EmbeddableChildPanel" }, - " extends React.Component" + " extends React.Component<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableChildPanelProps", + "text": "EmbeddableChildPanelProps" + }, + ", State, any>" ], "children": [ { - "id": "def-public.EmbeddablePanel.Unnamed", + "tags": [], + "id": "def-public.EmbeddableChildPanel.mounted", + "type": "boolean", + "label": "mounted", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 36 + } + }, + { + "tags": [], + "id": "def-public.EmbeddableChildPanel.embeddable", + "type": "CompoundType", + "label": "embeddable", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 37 + }, + "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": [ @@ -2524,43 +2676,46 @@ "label": "props", "isRequired": true, "signature": [ - "Props" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableChildPanelProps", + "text": "EmbeddableChildPanelProps" + } ], "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" + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 40 } } ], "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" + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 40 } }, { - "id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount", + "id": "def-public.EmbeddableChildPanel.componentDidMount", "type": "Function", - "label": "UNSAFE_componentWillMount", + "label": "componentDidMount", "signature": [ - "() => void" + "() => Promise" ], "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" + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 49 } }, { - "id": "def-public.EmbeddablePanel.componentWillUnmount", + "id": "def-public.EmbeddableChildPanel.componentWillUnmount", "type": "Function", "label": "componentWillUnmount", "signature": [ @@ -2571,27 +2726,192 @@ "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" + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 59 } }, { - "id": "def-public.EmbeddablePanel.onFocus", + "id": "def-public.EmbeddableChildPanel.render", "type": "Function", - "children": [ - { - "type": "string", - "label": "focusedPanelIndex", - "isRequired": true, + "label": "render", + "signature": [ + "() => JSX.Element" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 66 + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "lineNumber": 34 + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableFactoryNotFoundError", + "type": "Class", + "tags": [], + "label": "EmbeddableFactoryNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryNotFoundError", + "text": "EmbeddableFactoryNotFoundError" + }, + " extends Error" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableFactoryNotFoundError.code", + "type": "string", + "label": "code", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 25 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 27 + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 24 + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddablePanel", + "type": "Class", + "tags": [], + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "lineNumber": 96 + } + }, + { + "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 + } + }, + { + "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 + } + }, + { + "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" + "lineNumber": 199 } } ], @@ -2602,8 +2922,7 @@ "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" + "lineNumber": 199 }, "tags": [], "returnComment": [] @@ -2622,8 +2941,7 @@ "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" + "lineNumber": 203 } } ], @@ -2634,8 +2952,7 @@ "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" + "lineNumber": 203 }, "tags": [], "returnComment": [] @@ -2653,8 +2970,7 @@ "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" + "lineNumber": 209 } }, { @@ -2670,8 +2986,7 @@ "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" + "lineNumber": 251 } }, { @@ -2685,8 +3000,7 @@ "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" + "lineNumber": 274 }, "tags": [], "returnComment": [] @@ -2694,8 +3008,7 @@ ], "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" + "lineNumber": 89 }, "initialIsOpen": false }, @@ -2735,8 +3048,7 @@ "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" + "lineNumber": 25 } } ], @@ -2744,8 +3056,7 @@ "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" + "lineNumber": 25 } }, { @@ -2761,8 +3072,7 @@ "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" + "lineNumber": 31 } }, { @@ -2784,8 +3094,7 @@ "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" + "lineNumber": 38 } } ], @@ -2793,8 +3102,7 @@ "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" + "lineNumber": 38 } }, { @@ -2816,8 +3124,7 @@ "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" + "lineNumber": 59 } } ], @@ -2825,8 +3132,7 @@ "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" + "lineNumber": 59 } }, { @@ -2842,91 +3148,40 @@ "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" + "lineNumber": 69 } } ], "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" + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-public.ErrorEmbeddable", + "id": "def-public.EmbeddableStateTransfer", "type": "Class", - "tags": [], - "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" - }, - ">" + "tags": [ + "public" + ], + "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": [ { "tags": [], - "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\"" - ] - }, - { - "tags": [], - "id": "def-public.ErrorEmbeddable.error", - "type": "CompoundType", - "label": "error", + "id": "def-public.EmbeddableStateTransfer.isTransferInProgress", + "type": "boolean", + "label": "isTransferInProgress", "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" - ] + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 30 + } }, { - "id": "def-public.ErrorEmbeddable.Unnamed", + "id": "def-public.EmbeddableStateTransfer.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -2935,270 +3190,29 @@ "description": [], "children": [ { - "type": "CompoundType", - "label": "error", + "type": "Function", + "label": "navigateToApp", "isRequired": true, "signature": [ - "string | Error" + "(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/embeddables/error_embeddable.tsx", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30" + "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", + "lineNumber": 34 } }, { "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", - "tags": [], - "label": "PanelNotFoundError", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.PanelNotFoundError", - "text": "PanelNotFoundError" - }, - " extends Error" - ], - "children": [ - { - "tags": [], - "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", - "tags": [ - "public" - ], - "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": [ - { - "tags": [], - "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$", + "label": "currentAppId$", "isRequired": true, "signature": [ "Observable", @@ -3207,8 +3221,7 @@ "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" + "lineNumber": 35 } }, { @@ -3229,8 +3242,7 @@ "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" + "lineNumber": 36 } }, { @@ -3250,8 +3262,7 @@ "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" + "lineNumber": 37 } } ], @@ -3259,8 +3270,7 @@ "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" + "lineNumber": 33 } }, { @@ -3277,8 +3287,7 @@ "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" + "lineNumber": 50 } } ], @@ -3291,8 +3300,7 @@ "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" + "lineNumber": 50 }, "tags": [], "returnComment": [] @@ -3328,8 +3336,7 @@ ], "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" + "lineNumber": 59 } }, { @@ -3344,8 +3351,7 @@ ], "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" + "lineNumber": 60 } } ], @@ -3353,8 +3359,7 @@ "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" + "lineNumber": 58 } }, { @@ -3380,8 +3385,7 @@ ], "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" + "lineNumber": 78 } } ], @@ -3389,8 +3393,7 @@ "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" + "lineNumber": 78 } }, { @@ -3424,8 +3427,7 @@ ], "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" + "lineNumber": 97 } }, { @@ -3440,8 +3442,7 @@ ], "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" + "lineNumber": 98 } } ], @@ -3449,8 +3450,7 @@ "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" + "lineNumber": 96 } }, { @@ -3482,8 +3482,7 @@ "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" + "lineNumber": 115 } }, { @@ -3501,8 +3500,7 @@ "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" + "lineNumber": 117 }, "signature": [ "string | undefined" @@ -3516,8 +3514,7 @@ "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" + "lineNumber": 118 }, "signature": [ { @@ -3532,8 +3529,7 @@ ], "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" + "lineNumber": 116 } } ], @@ -3541,8 +3537,7 @@ "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" + "lineNumber": 114 } }, { @@ -3574,8 +3569,7 @@ "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" + "lineNumber": 132 } }, { @@ -3593,8 +3587,7 @@ "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" + "lineNumber": 133 }, "signature": [ "string | undefined" @@ -3608,8 +3601,7 @@ "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" + "lineNumber": 133 }, "signature": [ { @@ -3624,8 +3616,7 @@ ], "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" + "lineNumber": 133 } } ], @@ -3633,515 +3624,292 @@ "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" + "lineNumber": 131 } } ], "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" + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-public.AttributeService", + "id": "def-public.ErrorEmbeddable", "type": "Class", "tags": [], - "label": "AttributeService", + "label": "ErrorEmbeddable", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeService", - "text": "AttributeService" + "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.AttributeService.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ + "tags": [], + "id": "def-public.ErrorEmbeddable.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 26 + }, + "signature": [ + "\"error\"" + ] + }, + { + "tags": [], + "id": "def-public.ErrorEmbeddable.error", + "type": "CompoundType", + "label": "error", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 27 + }, + "signature": [ + "string | Error" + ] + }, + { + "id": "def-public.ErrorEmbeddable.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", + "type": "CompoundType", + "label": "error", "isRequired": true, "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastsApi", - "text": "ToastsApi" - }, - ", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">" + "string | Error" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30 } }, { "type": "Object", - "label": "options", + "label": "input", "isRequired": true, "signature": [ { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeServiceOptions", - "text": "AttributeServiceOptions" - }, - "" + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30 } }, { - "type": "Function", - "label": "getEmbeddableFactory", + "type": "Object", + "label": "parent", "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" + "section": "def-public.IContainer", + "text": "IContainer" }, - ", ", + "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.ContainerInput", + "text": "ContainerInput" }, - ", ", + "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - } + "> | undefined" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30 } } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 30 } }, { - "id": "def-public.AttributeService.unwrapAttributes", + "id": "def-public.ErrorEmbeddable.reload", "type": "Function", - "label": "unwrapAttributes", + "label": "reload", "signature": [ - "(input: ValType | RefType) => Promise" + "() => void" ], "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" - } - } - ], + "children": [], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 35 } }, { - "id": "def-public.AttributeService.wrapAttributes", + "id": "def-public.ErrorEmbeddable.render", "type": "Function", - "label": "wrapAttributes", + "label": "render", "signature": [ - "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>>" + "(dom: HTMLElement) => void" ], "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", + "type": "Object", + "label": "dom", "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" + "HTMLElement" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 37 } } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 37 } }, { - "id": "def-public.AttributeService.inputIsRefType", + "id": "def-public.ErrorEmbeddable.destroy", "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" - } - } - ], + "label": "destroy", "signature": [ - "(input: ValType | RefType) => input is RefType" + "() => void" ], "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" - }, + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 57 + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 25 + }, + "initialIsOpen": false + }, + { + "id": "def-public.PanelNotFoundError", + "type": "Class", + "tags": [], + "label": "PanelNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.PanelNotFoundError", + "text": "PanelNotFoundError" }, + " extends Error" + ], + "children": [ { - "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": [], + "id": "def-public.PanelNotFoundError.code", + "type": "string", + "label": "code", + "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" + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 13 } }, { - "id": "def-public.AttributeService.getInputAsValueType", + "id": "def-public.PanelNotFoundError.Unnamed", "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" - } - } - ], + "label": "Constructor", "signature": [ - "(input: ValType | RefType) => Promise" + "any" ], "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" - }, + "children": [], "tags": [], - "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", + "returnComment": [], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 15 + } } ], "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" + "path": "src/plugins/embeddable/public/lib/errors.ts", + "lineNumber": 12 }, "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", @@ -4163,8 +3931,7 @@ "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" + "lineNumber": 22 } } ], @@ -4214,414 +3981,106 @@ "label": "defaultEmbeddableFactoryProvider", "source": { "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#L16" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.isEmbeddable", - "type": "Function", - "children": [ - { - "type": "Unknown", - "label": "x", - "isRequired": true, - "signature": [ - "unknown" - ], - "description": [], - "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" - } - } - ], - "signature": [ - "(x: unknown) => 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" + "lineNumber": 16 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.isErrorEmbeddable", + "id": "def-public.EmbeddableRenderer", "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", + "label": "props", "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" - }, - ">" - ] - }, - { - "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" - ] - } + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" + }, + "" ], + "description": [], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "lineNumber": 83 } } ], - "tags": [], - "returnComment": [], + "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/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" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "lineNumber": 82 }, + "tags": [ + "public" + ], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.withEmbeddableSubscription", + "id": "def-public.isContextMenuTriggerContext", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "WrappedComponent", + "type": "Unknown", + "label": "context", "isRequired": true, "signature": [ - "React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>" + "unknown" ], "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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 115 } } ], "signature": [ - " 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", @@ -4629,7 +4088,7 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", O extends ", + ", ", { "pluginId": "embeddable", "scope": "public", @@ -4637,7 +4096,38 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", E extends ", + ">>" + ], + "description": [], + "label": "isContextMenuTriggerContext", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 115 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-public.isEmbeddable", + "type": "Function", + "children": [ + { + "type": "Unknown", + "label": "x", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "lineNumber": 11 + } + } + ], + "signature": [ + "(x: unknown) => x is ", { "pluginId": "embeddable", "scope": "public", @@ -4645,87 +4135,77 @@ "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.IEmbeddable", - "text": "IEmbeddable" + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" }, - ", ExtraProps = {}>(WrappedComponent: React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>) => React.ComponentType<{ embeddable: E; } & ExtraProps>" + ">" ], "description": [], - "label": "withEmbeddableSubscription", + "label": "isEmbeddable", "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" + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "lineNumber": 11 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.isSavedObjectEmbeddableInput", + "id": "def-public.isErrorEmbeddable", "type": "Function", - "label": "isSavedObjectEmbeddableInput", + "label": "isErrorEmbeddable", "signature": [ - "(input: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " | ", + "(embeddable: ", { "pluginId": "embeddable", - "scope": "common", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.SavedObjectEmbeddableInput", - "text": "SavedObjectEmbeddableInput" + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" }, - ") => boolean" + " | TEmbeddable) => boolean" ], "description": [], "children": [ { "type": "CompoundType", - "label": "input", + "label": "embeddable", "isRequired": true, "signature": [ { "pluginId": "embeddable", - "scope": "common", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" }, - " | ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.SavedObjectEmbeddableInput", - "text": "SavedObjectEmbeddableInput" - } + " | TEmbeddable" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 20 } } ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "lineNumber": 19 }, "initialIsOpen": false }, @@ -4774,8 +4254,7 @@ "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" + "lineNumber": 107 } } ], @@ -4825,15 +4304,45 @@ "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" + "lineNumber": 106 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.isValueClickTriggerContext", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 37 + }, + "initialIsOpen": false + }, + { + "id": "def-public.isRowClickTriggerContext", "type": "Function", "children": [ { @@ -4877,8 +4386,7 @@ "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" + "lineNumber": 110 } } ], @@ -4917,26 +4425,86 @@ }, ">>) => context is ", { - "pluginId": "embeddable", + "pluginId": "uiActions", "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ValueClickContext", - "text": "ValueClickContext" + "docId": "kibUiActionsPluginApi", + "section": "def-public.RowClickContext", + "text": "RowClickContext" } ], "description": [], - "label": "isValueClickTriggerContext", + "label": "isRowClickTriggerContext", "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" + "lineNumber": 110 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.isRowClickTriggerContext", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 15 + }, + "initialIsOpen": false + }, + { + "id": "def-public.isValueClickTriggerContext", "type": "Function", "children": [ { @@ -4980,8 +4548,7 @@ "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" + "lineNumber": 103 } } ], @@ -5020,61 +4587,310 @@ }, ">>) => context is ", { - "pluginId": "uiActions", + "pluginId": "embeddable", "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.RowClickContext", - "text": "RowClickContext" + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + } + ], + "description": [], + "label": "isValueClickTriggerContext", + "source": { + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 102 + }, + "tags": [], + "returnComment": [], + "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" + }, + ">" + ] + }, + { + "tags": [], + "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 + }, + "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" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayStart", + "text": "OverlayStart" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.NotificationsStart", + "text": "NotificationsStart" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "React.ComponentType" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16 + } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "lineNumber": 16 + }, "initialIsOpen": false }, { - "id": "def-public.isContextMenuTriggerContext", + "id": "def-public.withEmbeddableSubscription", "type": "Function", "children": [ { - "type": "Unknown", - "label": "context", + "type": "CompoundType", + "label": "WrappedComponent", "isRequired": true, "signature": [ - "unknown" + "React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>" ], "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" + "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", + "lineNumber": 19 } } ], "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" - }, - "<", + ">" - ], - "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" - }, - "tags": [], - "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" + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, - ") => 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" + ", ExtraProps = {}>(WrappedComponent: React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>) => React.ComponentType<{ embeddable: E; } & ExtraProps>" ], - "label": "EmbeddableRenderer", + "description": [], + "label": "withEmbeddableSubscription", "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" + "path": "src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx", + "lineNumber": 13 }, - "tags": [ - "remarks", - "public" - ], + "tags": [], "returnComment": [], "initialIsOpen": false } @@ -5183,8 +4953,7 @@ "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" + "lineNumber": 15 }, "signature": [ { @@ -5205,8 +4974,7 @@ "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" + "lineNumber": 16 }, "signature": [ "any" @@ -5215,88 +4983,7 @@ ], "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)." - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -5332,8 +5019,7 @@ "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" + "lineNumber": 25 }, "signature": [ "boolean | undefined" @@ -5347,8 +5033,7 @@ "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" + "lineNumber": 26 }, "signature": [ "{ [key: string]: ", @@ -5373,8 +5058,7 @@ ], "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" + "lineNumber": 24 }, "initialIsOpen": false }, @@ -5410,8 +5094,7 @@ "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" + "lineNumber": 21 }, "signature": [ "{ [key: string]: boolean; }" @@ -5420,8 +5103,7 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, @@ -5440,8 +5122,7 @@ "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" + "lineNumber": 19 } }, { @@ -5452,8 +5133,7 @@ "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" + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -5467,8 +5147,7 @@ "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" + "lineNumber": 21 }, "signature": [ { @@ -5505,8 +5184,7 @@ "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" + "lineNumber": 22 }, "signature": [ "React.FC<{ embeddable: ", @@ -5539,8 +5217,7 @@ ], "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" + "lineNumber": 18 }, "initialIsOpen": false }, @@ -5569,8 +5246,7 @@ "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" + "lineNumber": 15 }, "signature": [ "T" @@ -5579,8 +5255,71 @@ ], "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" + "lineNumber": 14 + }, + "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." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableEditorState.originatingApp", + "type": "string", + "label": "originatingApp", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-public.EmbeddableEditorState.embeddableId", + "type": "string", + "label": "embeddableId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 20 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.EmbeddableEditorState.valueInput", + "type": "Object", + "label": "valueInput", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 21 + }, + "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 }, "initialIsOpen": false }, @@ -5627,8 +5366,7 @@ "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" + "lineNumber": 41 } }, { @@ -5641,8 +5379,7 @@ ], "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" + "lineNumber": 47 }, "signature": [ "() => Promise" @@ -5656,8 +5393,7 @@ "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" + "lineNumber": 49 }, "signature": [ { @@ -5680,8 +5416,7 @@ ], "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" + "lineNumber": 57 } }, { @@ -5699,8 +5434,7 @@ "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" + "lineNumber": 63 } }, { @@ -5718,8 +5452,7 @@ "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" + "lineNumber": 69 } }, { @@ -5743,8 +5476,7 @@ "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" + "lineNumber": 77 } } ], @@ -5752,8 +5484,7 @@ "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" + "lineNumber": 77 } }, { @@ -5771,8 +5502,7 @@ "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" + "lineNumber": 84 } }, { @@ -5828,8 +5558,7 @@ "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" + "lineNumber": 94 } }, { @@ -5844,8 +5573,7 @@ ], "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" + "lineNumber": 95 } }, { @@ -5881,8 +5609,7 @@ "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" + "lineNumber": 96 } } ], @@ -5890,8 +5617,7 @@ "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" + "lineNumber": 93 } }, { @@ -5947,8 +5673,7 @@ "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" + "lineNumber": 106 } }, { @@ -5984,8 +5709,7 @@ "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" + "lineNumber": 107 } } ], @@ -5993,15 +5717,13 @@ "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" + "lineNumber": 105 } } ], "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" + "lineNumber": 30 }, "initialIsOpen": false }, @@ -6020,8 +5742,7 @@ "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" + "lineNumber": 19 } }, { @@ -6032,8 +5753,7 @@ "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" + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -6042,8 +5762,7 @@ ], "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" + "lineNumber": 18 }, "initialIsOpen": false }, @@ -6062,8 +5781,7 @@ "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" + "lineNumber": 23 }, "signature": [ "boolean | undefined" @@ -6077,8 +5795,7 @@ "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" + "lineNumber": 25 }, "signature": [ { @@ -6099,8 +5816,7 @@ "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" + "lineNumber": 26 }, "signature": [ "string | undefined" @@ -6114,8 +5830,7 @@ "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" + "lineNumber": 27 }, "signature": [ "string | undefined" @@ -6129,8 +5844,7 @@ "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" + "lineNumber": 28 }, "signature": [ "string | undefined" @@ -6144,8 +5858,7 @@ "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" + "lineNumber": 29 }, "signature": [ "string | undefined" @@ -6159,8 +5872,7 @@ "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" + "lineNumber": 30 }, "signature": [ "string | undefined" @@ -6174,8 +5886,7 @@ "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" + "lineNumber": 31 }, "signature": [ "boolean | undefined" @@ -6189,8 +5900,7 @@ "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" + "lineNumber": 32 }, "signature": [ "string | undefined" @@ -6199,134 +5909,228 @@ ], "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" + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-public.ValueClickContext", + "id": "def-public.EmbeddablePackageState", "type": "Interface", - "label": "ValueClickContext", - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ValueClickContext", - "text": "ValueClickContext" - }, - "" + "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." + ], + "tags": [ + "public" ], - "description": [], - "tags": [], "children": [ { "tags": [], - "id": "def-public.ValueClickContext.embeddable", - "type": "Uncategorized", - "label": "embeddable", + "id": "def-public.EmbeddablePackageState.type", + "type": "string", + "label": "type", "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" + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 35 + } + }, + { + "tags": [], + "id": "def-public.EmbeddablePackageState.input", + "type": "CompoundType", + "label": "input", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 36 }, "signature": [ - "T | undefined" + "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\">" ] }, { "tags": [], - "id": "def-public.ValueClickContext.data", + "id": "def-public.EmbeddablePackageState.embeddableId", + "type": "string", + "label": "embeddableId", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 37 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/embeddable/public/lib/state_transfer/types.ts", + "lineNumber": 34 + }, + "initialIsOpen": false + }, + { + "id": "def-public.EmbeddableSetupDependencies", + "type": "Interface", + "label": "EmbeddableSetupDependencies", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EmbeddableSetupDependencies.uiActions", "type": "Object", - "label": "data", + "label": "uiActions", "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" + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 54 }, "signature": [ - "{ data: { table: Pick<", + "Pick<", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.UiActionsService", + "text": "UiActionsService" }, - ", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }" + ", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">" ] } ], "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" + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 53 }, "initialIsOpen": false }, { - "id": "def-public.RangeSelectContext", + "id": "def-public.EmbeddableStartDependencies", "type": "Interface", - "label": "RangeSelectContext", - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.RangeSelectContext", - "text": "RangeSelectContext" - }, - "" - ], + "label": "EmbeddableStartDependencies", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.RangeSelectContext.embeddable", - "type": "Uncategorized", - "label": "embeddable", + "id": "def-public.EmbeddableStartDependencies.uiActions", + "type": "Object", + "label": "uiActions", "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" + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 58 }, "signature": [ - "T | undefined" + "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" + }, + ">>" ] }, { "tags": [], - "id": "def-public.RangeSelectContext.data", + "id": "def-public.EmbeddableStartDependencies.inspector", "type": "Object", - "label": "data", + "label": "inspector", "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" + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 59 }, "signature": [ - "{ table: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - "; column: number; range: number[]; timeFieldName?: string | undefined; }" + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.Start", + "text": "Start" + } ] } ], "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" + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 57 + }, + "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": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EnhancementRegistryDefinition.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/embeddable/public/types.ts", + "lineNumber": 28 + } + } + ], + "source": { + "path": "src/plugins/embeddable/public/types.ts", + "lineNumber": 26 }, "initialIsOpen": false }, @@ -6408,8 +6212,7 @@ "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" + "lineNumber": 40 } } ], @@ -6417,8 +6220,7 @@ "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" + "lineNumber": 39 } }, { @@ -6450,8 +6252,7 @@ "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" + "lineNumber": 49 } } ], @@ -6459,8 +6260,7 @@ "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" + "lineNumber": 49 } }, { @@ -6492,8 +6292,7 @@ "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" + "lineNumber": 57 } }, { @@ -6506,8 +6305,7 @@ "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" + "lineNumber": 57 } } ], @@ -6515,8 +6313,7 @@ "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" + "lineNumber": 57 } }, { @@ -6579,8 +6376,7 @@ "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" + "lineNumber": 63 } } ], @@ -6588,8 +6384,7 @@ "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" + "lineNumber": 63 } }, { @@ -6613,8 +6408,7 @@ "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" + "lineNumber": 69 } } ], @@ -6622,8 +6416,7 @@ "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" + "lineNumber": 69 } }, { @@ -6686,8 +6479,7 @@ "description": [], "source": { "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L80" + "lineNumber": 80 } }, { @@ -6700,8 +6492,7 @@ "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" + "lineNumber": 81 } } ], @@ -6709,15 +6500,13 @@ "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" + "lineNumber": 75 } } ], "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" + "lineNumber": 31 }, "initialIsOpen": false }, @@ -6748,8 +6537,7 @@ ], "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" + "lineNumber": 43 } }, { @@ -6762,8 +6550,7 @@ ], "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" + "lineNumber": 49 }, "signature": [ { @@ -6802,8 +6589,7 @@ ], "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" + "lineNumber": 55 } }, { @@ -6816,8 +6602,7 @@ ], "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" + "lineNumber": 61 } }, { @@ -6830,8 +6615,7 @@ ], "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" + "lineNumber": 69 }, "signature": [ "number | undefined" @@ -6847,8 +6631,7 @@ ], "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" + "lineNumber": 74 }, "signature": [ "object | undefined" @@ -6864,8 +6647,7 @@ ], "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" + "lineNumber": 79 }, "signature": [ "Error | undefined" @@ -6910,8 +6692,7 @@ "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" + "lineNumber": 85 } }, { @@ -6929,8 +6710,7 @@ "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" + "lineNumber": 96 } }, { @@ -6948,8 +6728,7 @@ "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" + "lineNumber": 108 } }, { @@ -6973,8 +6752,7 @@ "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" + "lineNumber": 114 } } ], @@ -6982,8 +6760,7 @@ "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" + "lineNumber": 114 } }, { @@ -7003,8 +6780,7 @@ "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" + "lineNumber": 119 } }, { @@ -7024,8 +6800,7 @@ "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" + "lineNumber": 124 } }, { @@ -7043,8 +6818,7 @@ "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" + "lineNumber": 129 } }, { @@ -7101,8 +6875,7 @@ "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" + "lineNumber": 135 } }, { @@ -7126,8 +6899,7 @@ "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" + "lineNumber": 141 } } ], @@ -7135,8 +6907,7 @@ "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" + "lineNumber": 141 } }, { @@ -7154,8 +6925,7 @@ "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" + "lineNumber": 147 } }, { @@ -7185,8 +6955,7 @@ ], "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" + "lineNumber": 154 } }, { @@ -7204,8 +6973,7 @@ "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" + "lineNumber": 159 } }, { @@ -7223,15 +6991,13 @@ "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" + "lineNumber": 164 } } ], "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" + "lineNumber": 35 }, "initialIsOpen": false }, @@ -7250,8 +7016,7 @@ "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" + "lineNumber": 24 }, "signature": [ "any" @@ -7260,8 +7025,7 @@ ], "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" + "lineNumber": 23 }, "initialIsOpen": false }, @@ -7290,8 +7054,7 @@ "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" + "lineNumber": 57 } }, { @@ -7302,8 +7065,7 @@ "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" + "lineNumber": 62 }, "signature": [ "Partial & { id: string; }" @@ -7312,8 +7074,7 @@ ], "source": { "path": "src/plugins/embeddable/common/types.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L54" + "lineNumber": 54 }, "initialIsOpen": false }, @@ -7332,8 +7093,7 @@ "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" + "lineNumber": 18 } }, { @@ -7344,8 +7104,7 @@ "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" + "lineNumber": 19 } }, { @@ -7356,8 +7115,7 @@ "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" + "lineNumber": 20 } }, { @@ -7368,151 +7126,106 @@ "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" + "lineNumber": 21 } }, { "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.SavedObjectEmbeddableInput.savedObjectId", + "id": "def-public.PropertySpec.value", "type": "string", - "label": "savedObjectId", + "label": "value", "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" - } + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 22 + }, + "signature": [ + "string | undefined" + ] } ], "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" + "path": "src/plugins/embeddable/public/lib/types.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-public.EmbeddableEditorState", + "id": "def-public.RangeSelectContext", "type": "Interface", - "label": "EmbeddableEditorState", - "description": [ - "\nA state package that contains information an editor will need to create or edit an embeddable then redirect back." - ], - "tags": [ - "public" - ], - "children": [ + "label": "RangeSelectContext", + "signature": [ { - "tags": [], - "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" - } + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.RangeSelectContext", + "text": "RangeSelectContext" }, + "" + ], + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.EmbeddableEditorState.embeddableId", - "type": "string", - "label": "embeddableId", + "id": "def-public.RangeSelectContext.embeddable", + "type": "Uncategorized", + "label": "embeddable", "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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 33 }, "signature": [ - "string | undefined" + "T | undefined" ] }, { "tags": [], - "id": "def-public.EmbeddableEditorState.valueInput", + "id": "def-public.RangeSelectContext.data", "type": "Object", - "label": "valueInput", + "label": "data", "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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 34 }, "signature": [ + "{ table: ", { - "pluginId": "embeddable", + "pluginId": "expressions", "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" }, - " | undefined" + "; column: number; range: number[]; timeFieldName?: string | 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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 32 }, "initialIsOpen": false }, { - "id": "def-public.EmbeddablePackageState", + "id": "def-public.ReferenceOrValueEmbeddable", "type": "Interface", - "label": "EmbeddablePackageState", + "label": "ReferenceOrValueEmbeddable", + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ReferenceOrValueEmbeddable", + "text": "ReferenceOrValueEmbeddable" + }, + "" + ], "description": [ - "\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container." + "\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)." ], "tags": [ "public" @@ -7520,222 +7233,158 @@ "children": [ { "tags": [], - "id": "def-public.EmbeddablePackageState.type", - "type": "string", - "label": "type", - "description": [], + "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/state_transfer/types.ts", - "lineNumber": 35, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L35" - } + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 24 + }, + "signature": [ + "(input: ValTypeInput | RefTypeInput) => input is RefTypeInput" + ] }, { "tags": [], - "id": "def-public.EmbeddablePackageState.input", - "type": "CompoundType", - "label": "input", - "description": [], + "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/state_transfer/types.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L36" + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 29 }, "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\">" + "() => Promise" ] }, { "tags": [], - "id": "def-public.EmbeddablePackageState.embeddableId", - "type": "string", - "label": "embeddableId", - "description": [], + "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/state_transfer/types.ts", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L37" + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 34 }, "signature": [ - "string | undefined" + "() => Promise" ] } ], "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" + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-public.EnhancementRegistryDefinition", + "id": "def-public.SavedObjectEmbeddableInput", "type": "Interface", - "label": "EnhancementRegistryDefinition", + "label": "SavedObjectEmbeddableInput", "signature": [ { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EnhancementRegistryDefinition", - "text": "EnhancementRegistryDefinition" + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" }, - "

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

>" + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + } ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.EnhancementRegistryDefinition.id", + "id": "def-public.SavedObjectEmbeddableInput.savedObjectId", "type": "string", - "label": "id", + "label": "savedObjectId", "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" + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 12 } } ], "source": { - "path": "src/plugins/embeddable/public/types.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/types.ts#L26" + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-public.EmbeddableSetupDependencies", + "id": "def-public.ValueClickContext", "type": "Interface", - "label": "EmbeddableSetupDependencies", - "description": [], - "tags": [], - "children": [ + "label": "ValueClickContext", + "signature": [ { - "tags": [], - "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\">" - ] - } + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + }, + "" ], - "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": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.EmbeddableStartDependencies.uiActions", - "type": "Object", - "label": "uiActions", + "id": "def-public.ValueClickContext.embeddable", + "type": "Uncategorized", + "label": "embeddable", "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" - }, - ">>" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 19 + }, + "signature": [ + "T | undefined" ] }, { "tags": [], - "id": "def-public.EmbeddableStartDependencies.inspector", + "id": "def-public.ValueClickContext.data", "type": "Object", - "label": "inspector", + "label": "data", "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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 20 }, "signature": [ + "{ data: { table: Pick<", { - "pluginId": "inspector", - "scope": "public", - "docId": "kibInspectorPluginApi", - "section": "def-public.Start", - "text": "Start" - } + "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/plugin.tsx", - "lineNumber": 57, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L57" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 18 }, "initialIsOpen": false } @@ -7749,8 +7398,7 @@ "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" + "lineNumber": 11 }, "initialIsOpen": false } @@ -7764,8 +7412,7 @@ "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" + "lineNumber": 17 }, "signature": [ "\"ACTION_ADD_PANEL\"" @@ -7780,14 +7427,30 @@ "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" + "lineNumber": 25 }, "signature": [ "\"editPanel\"" ], "initialIsOpen": false }, + { + "tags": [], + "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 + }, + "signature": [ + "\"attributes\"" + ], + "initialIsOpen": false + }, { "id": "def-public.ChartActionContext", "type": "Type", @@ -7796,8 +7459,7 @@ "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" + "lineNumber": 42 }, "signature": [ { @@ -7834,8 +7496,7 @@ "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" + "lineNumber": 47 }, "signature": [ "\"CONTEXT_MENU_TRIGGER\"" @@ -7850,8 +7511,7 @@ "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" + "lineNumber": 14 }, "signature": [ "Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>" @@ -7866,8 +7526,7 @@ "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" + "lineNumber": 16 }, "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; }" @@ -7875,142 +7534,118 @@ "initialIsOpen": false }, { + "id": "def-public.EmbeddablePanelHOC", + "type": "Type", + "label": "EmbeddablePanelHOC", "tags": [], - "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" + "path": "src/plugins/embeddable/public/plugin.tsx", + "lineNumber": 98 }, "signature": [ - "\"PANEL_BADGE_TRIGGER\"" + "(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 }, { + "id": "def-public.EmbeddableRendererProps", + "type": "Type", + "label": "EmbeddableRendererProps", "tags": [], - "id": "def-public.PANEL_NOTIFICATION_TRIGGER", - "type": "string", - "label": "PANEL_NOTIFICATION_TRIGGER", - "description": [], + "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/triggers/triggers.ts", - "lineNumber": 69, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L69" + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "lineNumber": 21 }, "signature": [ - "\"PANEL_NOTIFICATION_TRIGGER\"" + "EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.SELECT_RANGE_TRIGGER", + "id": "def-public.PANEL_BADGE_TRIGGER", "type": "string", - "label": "SELECT_RANGE_TRIGGER", + "label": "PANEL_BADGE_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" + "lineNumber": 58 }, "signature": [ - "\"SELECT_RANGE_TRIGGER\"" + "\"PANEL_BADGE_TRIGGER\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.VALUE_CLICK_TRIGGER", + "id": "def-public.PANEL_NOTIFICATION_TRIGGER", "type": "string", - "label": "VALUE_CLICK_TRIGGER", + "label": "PANEL_NOTIFICATION_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", - "tags": [], - "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" + "lineNumber": 69 }, "signature": [ - "EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory" + "\"PANEL_NOTIFICATION_TRIGGER\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.ATTRIBUTE_SERVICE_KEY", + "id": "def-public.SELECT_RANGE_TRIGGER", "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." - ], + "label": "SELECT_RANGE_TRIGGER", + "description": [], "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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 80 }, "signature": [ - "\"attributes\"" + "\"SELECT_RANGE_TRIGGER\"" ], "initialIsOpen": false }, { - "id": "def-public.EmbeddablePanelHOC", - "type": "Type", - "label": "EmbeddablePanelHOC", "tags": [], + "id": "def-public.VALUE_CLICK_TRIGGER", + "type": "string", + "label": "VALUE_CLICK_TRIGGER", "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" + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "lineNumber": 91 }, "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" + "\"VALUE_CLICK_TRIGGER\"" ], "initialIsOpen": false } @@ -8029,8 +7664,7 @@ "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" + "lineNumber": 49 } }, { @@ -8041,8 +7675,7 @@ "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" + "lineNumber": 50 } }, { @@ -8053,8 +7686,7 @@ "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" + "lineNumber": 53 } } ], @@ -8062,8 +7694,7 @@ "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" + "lineNumber": 48 }, "initialIsOpen": false }, @@ -8080,8 +7711,7 @@ "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" + "lineNumber": 60 } }, { @@ -8092,8 +7722,7 @@ "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" + "lineNumber": 61 } }, { @@ -8104,8 +7733,7 @@ "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" + "lineNumber": 64 } } ], @@ -8113,8 +7741,7 @@ "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" + "lineNumber": 59 }, "initialIsOpen": false }, @@ -8131,8 +7758,7 @@ "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" + "lineNumber": 71 } }, { @@ -8143,8 +7769,7 @@ "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" + "lineNumber": 72 } }, { @@ -8155,8 +7780,7 @@ "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" + "lineNumber": 75 } } ], @@ -8164,8 +7788,7 @@ "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" + "lineNumber": 70 }, "initialIsOpen": false } @@ -8185,8 +7808,7 @@ "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" + "lineNumber": 63 }, "signature": [ " IterableIterator<", @@ -8443,8 +8060,7 @@ "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" + "lineNumber": 84 }, "signature": [ "React.FC<{ embeddable: ", @@ -8482,8 +8098,7 @@ "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" + "lineNumber": 85 }, "signature": [ "(storage?: ", @@ -8512,8 +8127,7 @@ "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" + "lineNumber": 86 }, "signature": [ " extends Partial<", { @@ -8599,35 +8212,33 @@ "children": [ { "tags": [], - "id": "def-server.EnhancementRegistryDefinition.id", + "id": "def-server.EmbeddableRegistryDefinition.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" + "lineNumber": 32 } } ], "source": { "path": "src/plugins/embeddable/server/types.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L19" + "lineNumber": 29 }, "initialIsOpen": false }, { - "id": "def-server.EmbeddableRegistryDefinition", + "id": "def-server.EnhancementRegistryDefinition", "type": "Interface", - "label": "EmbeddableRegistryDefinition", + "label": "EnhancementRegistryDefinition", "signature": [ { "pluginId": "embeddable", "scope": "server", "docId": "kibEmbeddablePluginApi", - "section": "def-server.EmbeddableRegistryDefinition", - "text": "EmbeddableRegistryDefinition" + "section": "def-server.EnhancementRegistryDefinition", + "text": "EnhancementRegistryDefinition" }, "

extends Partial<", { @@ -8644,21 +8255,19 @@ "children": [ { "tags": [], - "id": "def-server.EmbeddableRegistryDefinition.id", + "id": "def-server.EnhancementRegistryDefinition.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" + "lineNumber": 21 } } ], "source": { "path": "src/plugins/embeddable/server/types.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L29" + "lineNumber": 19 }, "initialIsOpen": false } @@ -8707,8 +8316,7 @@ "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" + "lineNumber": 28 }, "signature": [ "(factory: ", @@ -8738,8 +8346,7 @@ "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" + "lineNumber": 29 }, "signature": [ "(enhancement: ", @@ -8764,8 +8371,7 @@ ], "source": { "path": "src/plugins/embeddable/server/plugin.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L27" + "lineNumber": 27 }, "lifecycle": "setup", "initialIsOpen": true @@ -8775,40 +8381,31 @@ "classes": [], "functions": [ { - "id": "def-common.getExtractFunction", + "id": "def-common.extractBaseEmbeddableInput", "type": "Function", "children": [ { - "type": "Object", - "label": "embeddables", + "type": "CompoundType", + "label": "state", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.CommonEmbeddableStartContract", - "text": "CommonEmbeddableStartContract" + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" } ], "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" + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 20 } } ], "signature": [ - "(embeddables: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.CommonEmbeddableStartContract", - "text": "CommonEmbeddableStartContract" - }, - ") => (state: ", + "(state: ", { "pluginId": "embeddable", "scope": "common", @@ -8829,18 +8426,17 @@ "[]; }" ], "description": [], - "label": "getExtractFunction", + "label": "extractBaseEmbeddableInput", "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" + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 20 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getInjectFunction", + "id": "def-common.getExtractFunction", "type": "Function", "children": [ { @@ -8858,9 +8454,8 @@ ], "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" + "path": "src/plugins/embeddable/common/lib/extract.ts", + "lineNumber": 13 } } ], @@ -8881,30 +8476,30 @@ "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, - ", references: ", - "SavedObjectReference", - "[]) => ", + ") => { state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" - } + }, + "; references: ", + "SavedObjectReference", + "[]; }" ], "description": [], - "label": "getInjectFunction", + "label": "getExtractFunction", "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" + "path": "src/plugins/embeddable/common/lib/extract.ts", + "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getMigrateFunction", + "id": "def-common.getInjectFunction", "type": "Function", "children": [ { @@ -8922,9 +8517,8 @@ ], "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" + "path": "src/plugins/embeddable/common/lib/inject.ts", + "lineNumber": 14 } } ], @@ -8939,128 +8533,127 @@ }, ") => (state: ", { - "pluginId": "kibanaUtils", + "pluginId": "embeddable", "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" }, - ", version: string) => ", + ", references: ", + "SavedObjectReference", + "[]) => ", { - "pluginId": "kibanaUtils", + "pluginId": "embeddable", "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableStateWithType", + "text": "EmbeddableStateWithType" } ], "description": [], - "label": "getMigrateFunction", + "label": "getInjectFunction", "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" + "path": "src/plugins/embeddable/common/lib/inject.ts", + "lineNumber": 14 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.telemetryBaseEmbeddableInput", + "id": "def-common.getMigrateFunction", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "state", + "type": "Object", + "label": "embeddables", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" } ], "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" + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "lineNumber": 13 } } ], "signature": [ - "(state: ", + "(embeddables: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" }, - ", telemetryData: Record) => Record" + ") => (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": "telemetryBaseEmbeddableInput", + "label": "getMigrateFunction", "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" + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "lineNumber": 13 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.extractBaseEmbeddableInput", + "id": "def-common.getTelemetryFunction", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "state", + "type": "Object", + "label": "embeddables", "isRequired": true, "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" } ], "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" + "path": "src/plugins/embeddable/common/lib/telemetry.ts", + "lineNumber": 12 } } ], "signature": [ - "(state: ", + "(embeddables: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableStateWithType", - "text": "EmbeddableStateWithType" + "section": "def-common.CommonEmbeddableStartContract", + "text": "CommonEmbeddableStartContract" }, - ") => { state: ", + ") => (state: ", { "pluginId": "embeddable", "scope": "common", @@ -9068,16 +8661,13 @@ "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, - "; references: ", - "SavedObjectReference", - "[]; }" + ", telemetryData?: Record) => Record" ], "description": [], - "label": "extractBaseEmbeddableInput", + "label": "getTelemetryFunction", "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" + "path": "src/plugins/embeddable/common/lib/telemetry.ts", + "lineNumber": 12 }, "tags": [], "returnComment": [], @@ -9103,8 +8693,7 @@ "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" + "lineNumber": 25 } }, { @@ -9124,8 +8713,7 @@ "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" + "lineNumber": 26 } } ], @@ -9153,63 +8741,7 @@ "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" - }, - "tags": [], - "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" + "lineNumber": 24 }, "tags": [], "returnComment": [], @@ -9264,8 +8796,7 @@ "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" + "lineNumber": 16 } } ], @@ -9273,107 +8804,158 @@ "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" + "lineNumber": 15 }, "initialIsOpen": false - } - ], - "interfaces": [ + }, { - "id": "def-common.PanelState", - "type": "Interface", - "label": "PanelState", + "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 + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/embeddable/common/lib/migrate_base_input.ts", + "lineNumber": 15 + } + } + ], "signature": [ + "(state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.PanelState", - "text": "PanelState" + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-common.CommonEmbeddableStartContract", + "type": "Interface", + "label": "CommonEmbeddableStartContract", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.PanelState.type", - "type": "string", - "label": "type", + "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory", + "type": "Function", + "label": "getEmbeddableFactory", "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" - } + "lineNumber": 70 + }, + "signature": [ + "(embeddableFactoryId: string) => any" + ] }, { "tags": [], - "id": "def-common.PanelState.explicitInput", - "type": "CompoundType", - "label": "explicitInput", + "id": "def-common.CommonEmbeddableStartContract.getEnhancement", + "type": "Function", + "label": "getEnhancement", "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" + "lineNumber": 71 }, "signature": [ - "Partial & { id: string; }" + "(enhancementId: string) => any" ] } ], "source": { "path": "src/plugins/embeddable/common/types.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L54" + "lineNumber": 69 }, "initialIsOpen": false }, { - "id": "def-common.CommonEmbeddableStartContract", + "id": "def-common.PanelState", "type": "Interface", - "label": "CommonEmbeddableStartContract", + "label": "PanelState", + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + "" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory", - "type": "Function", - "label": "getEmbeddableFactory", + "id": "def-common.PanelState.type", + "type": "string", + "label": "type", "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" - ] + "lineNumber": 57 + } }, { "tags": [], - "id": "def-common.CommonEmbeddableStartContract.getEnhancement", - "type": "Function", - "label": "getEnhancement", + "id": "def-common.PanelState.explicitInput", + "type": "CompoundType", + "label": "explicitInput", "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" + "lineNumber": 62 }, "signature": [ - "(enhancementId: string) => any" + "Partial & { id: string; }" ] } ], "source": { "path": "src/plugins/embeddable/common/types.ts", - "lineNumber": 69, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L69" + "lineNumber": 54 }, "initialIsOpen": false }, @@ -9409,15 +8991,13 @@ "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" + "lineNumber": 12 } } ], "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" + "lineNumber": 11 }, "initialIsOpen": false } @@ -9431,8 +9011,7 @@ "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" + "lineNumber": 11 }, "initialIsOpen": false } @@ -9446,8 +9025,7 @@ "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" + "lineNumber": 16 }, "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; }" @@ -9455,34 +9033,32 @@ "initialIsOpen": false }, { - "id": "def-common.EmbeddableStateWithType", + "id": "def-common.EmbeddablePersistableStateService", "type": "Type", - "label": "EmbeddableStateWithType", + "label": "EmbeddablePersistableStateService", "tags": [], "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" + "lineNumber": 67 }, "signature": [ - "EmbeddableInput & { type: string; }" + "PersistableStateService" ], "initialIsOpen": false }, { - "id": "def-common.EmbeddablePersistableStateService", + "id": "def-common.EmbeddableStateWithType", "type": "Type", - "label": "EmbeddablePersistableStateService", + "label": "EmbeddableStateWithType", "tags": [], "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" + "lineNumber": 65 }, "signature": [ - "PersistableStateService" + "EmbeddableInput & { type: string; }" ], "initialIsOpen": false } @@ -9497,8 +9073,7 @@ "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" + "lineNumber": 31 }, "initialIsOpen": false } diff --git a/api_docs/embeddable_enhanced.json b/api_docs/embeddable_enhanced.json index 63b9eed7c3c41..8c5d5a1de4ca2 100644 --- a/api_docs/embeddable_enhanced.json +++ b/api_docs/embeddable_enhanced.json @@ -17,8 +17,7 @@ "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" + "lineNumber": 12 } } ], @@ -61,8 +60,7 @@ "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" + "lineNumber": 11 }, "tags": [], "returnComment": [], @@ -70,6 +68,65 @@ } ], "interfaces": [ + { + "id": "def-public.EnhancedEmbeddableContext", + "type": "Interface", + "label": "EnhancedEmbeddableContext", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.EnhancedEmbeddableContext.embeddable", + "type": "CompoundType", + "label": "embeddable", + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 21 + }, + "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 + }, + "initialIsOpen": false + }, { "id": "def-public.SetupDependencies", "type": "Interface", @@ -85,8 +142,7 @@ "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" + "lineNumber": 36 }, "signature": [ { @@ -106,8 +162,7 @@ "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" + "lineNumber": 37 }, "signature": [ { @@ -122,8 +177,7 @@ ], "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" + "lineNumber": 35 }, "initialIsOpen": false }, @@ -142,8 +196,7 @@ "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" + "lineNumber": 41 }, "signature": [ { @@ -163,8 +216,7 @@ "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" + "lineNumber": 42 }, "signature": [ { @@ -179,91 +231,13 @@ ], "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" + "lineNumber": 40 }, "initialIsOpen": false } ], "enums": [], "misc": [ - { - "id": "def-public.EnhancedEmbeddable", - "type": "Type", - "label": "EnhancedEmbeddable", - "tags": [], - "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 - }, { "tags": [], "id": "def-public.drilldownGrouping", @@ -272,8 +246,7 @@ "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" + "lineNumber": 12 }, "signature": [ { @@ -310,6 +283,21 @@ "> | undefined; }>" ], "initialIsOpen": false + }, + { + "id": "def-public.EnhancedEmbeddable", + "type": "Type", + "label": "EnhancedEmbeddable", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/embeddable_enhanced/public/types.ts", + "lineNumber": 11 + }, + "signature": [ + "E & { enhancements: { dynamicActions: DynamicActionManager;}; }" + ], + "initialIsOpen": false } ], "objects": [], @@ -322,8 +310,7 @@ "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" + "lineNumber": 46 }, "lifecycle": "setup", "initialIsOpen": true @@ -337,8 +324,7 @@ "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" + "lineNumber": 49 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json index c4583698f6ff0..6de5870d05230 100644 --- a/api_docs/encrypted_saved_objects.json +++ b/api_docs/encrypted_saved_objects.json @@ -46,8 +46,7 @@ "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" + "lineNumber": 18 } }, { @@ -60,8 +59,7 @@ "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" + "lineNumber": 19 } }, { @@ -80,8 +78,7 @@ "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" + "lineNumber": 20 } }, { @@ -94,8 +91,7 @@ "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" + "lineNumber": 21 } } ], @@ -103,8 +99,7 @@ "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" + "lineNumber": 17 } }, { @@ -120,21 +115,63 @@ "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" + "lineNumber": 30 } } ], "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" + "lineNumber": 16 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ + { + "id": "def-server.EncryptedSavedObjectsClient", + "type": "Interface", + "label": "EncryptedSavedObjectsClient", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser", + "type": "Function", + "label": "getDecryptedAsInternalUser", + "description": [], + "source": { + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "lineNumber": 41 + }, + "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": 40 + }, + "initialIsOpen": false + }, { "id": "def-server.EncryptedSavedObjectTypeRegistration", "type": "Interface", @@ -152,8 +189,7 @@ "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" + "lineNumber": 34 } }, { @@ -164,8 +200,7 @@ "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", - "lineNumber": 35, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L35" + "lineNumber": 35 }, "signature": [ "ReadonlySet | undefined" @@ -197,54 +231,7 @@ ], "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" - }, - "initialIsOpen": false - }, - { - "id": "def-server.EncryptedSavedObjectsClient", - "type": "Interface", - "label": "EncryptedSavedObjectsClient", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser", - "type": "Function", - "label": "getDecryptedAsInternalUser", - "description": [], - "source": { - "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", - "lineNumber": 41, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L41" - }, - "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": 40, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L40" + "lineNumber": 33 }, "initialIsOpen": false } @@ -269,8 +256,7 @@ ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 35, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L35" + "lineNumber": 35 } }, { @@ -281,8 +267,7 @@ "description": [], "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" + "lineNumber": 36 }, "signature": [ "(typeRegistration: ", @@ -304,8 +289,7 @@ "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" + "lineNumber": 37 }, "signature": [ { @@ -320,8 +304,7 @@ ], "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" + "lineNumber": 31 }, "lifecycle": "setup", "initialIsOpen": true @@ -341,8 +324,7 @@ "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 41, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L41" + "lineNumber": 41 }, "signature": [ "(error: Error) => boolean" @@ -356,8 +338,7 @@ "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 42, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L42" + "lineNumber": 42 }, "signature": [ { @@ -372,8 +353,7 @@ ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "lineNumber": 40, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L40" + "lineNumber": 40 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/enterprise_search.json b/api_docs/enterprise_search.json index dab40f56f6d69..83b5fc5c1bc1e 100644 --- a/api_docs/enterprise_search.json +++ b/api_docs/enterprise_search.json @@ -22,8 +22,7 @@ "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" + "lineNumber": 24 }, "signature": [ "{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" @@ -40,8 +39,7 @@ "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" + "lineNumber": 17 }, "signature": [ "ObjectType", diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json index 406f95613fa35..c3b2b042f9875 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -48,8 +48,7 @@ "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" + "lineNumber": 65 } } ], @@ -57,8 +56,7 @@ "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" + "lineNumber": 65 } }, { @@ -80,8 +78,7 @@ "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" + "lineNumber": 70 } } ], @@ -89,8 +86,7 @@ "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" + "lineNumber": 70 } }, { @@ -113,8 +109,7 @@ "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" + "lineNumber": 80 } } ], @@ -133,8 +128,7 @@ "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" + "lineNumber": 80 }, "tags": [], "returnComment": [] @@ -159,8 +153,7 @@ "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" + "lineNumber": 104 } } ], @@ -179,8 +172,7 @@ "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" + "lineNumber": 104 }, "tags": [], "returnComment": [] @@ -198,8 +190,7 @@ "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" + "lineNumber": 140 } }, { @@ -215,20 +206,113 @@ "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" + "lineNumber": 215 } } ], "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" + "lineNumber": 64 }, "initialIsOpen": false } ], "functions": [ + { + "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/public/url/extract_query_params.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, { "tags": [], "id": "def-public.JsonEditor", @@ -237,14 +321,75 @@ "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" + "lineNumber": 102 }, "signature": [ "typeof JsonEditorComp" ], "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, { "id": "def-public.SectionLoading", "type": "Function", @@ -259,8 +404,7 @@ "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" + "lineNumber": 26 } } ], @@ -271,8 +415,7 @@ "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" + "lineNumber": 26 }, "tags": [], "returnComment": [], @@ -298,8 +441,7 @@ "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" + "lineNumber": 29 } }, { @@ -318,8 +460,7 @@ "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" + "lineNumber": 30 } } ], @@ -354,8 +495,24 @@ "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" + "lineNumber": 28 + }, + "tags": [], + "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 }, "tags": [], "returnComment": [], @@ -381,8 +538,7 @@ "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" + "lineNumber": 29 } }, { @@ -401,8 +557,7 @@ "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" + "lineNumber": 30 } } ], @@ -437,226 +592,38 @@ "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" + "lineNumber": 28 }, "tags": [], "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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", + "id": "def-public.WithPrivileges", "type": "Function", "children": [ { - "type": "string", - "label": "value", - "isRequired": false, + "type": "Object", + "label": "{ privileges: requiredPrivileges, children }", + "isRequired": true, "signature": [ - "string | undefined" + "Props" ], "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" + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", + "lineNumber": 32 } } ], "signature": [ - "(value?: string | undefined) => string | undefined" + "({ privileges: requiredPrivileges, children }: Props) => JSX.Element" ], "description": [], - "label": "attemptToURIDecode", + "label": "WithPrivileges", "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" + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx", + "lineNumber": 32 }, "tags": [], "returnComment": [], @@ -664,6 +631,59 @@ } ], "interfaces": [ + { + "id": "def-public.Error", + "type": "Interface", + "label": "Error", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx", + "lineNumber": 12 + }, + "initialIsOpen": false + }, { "id": "def-public.JsonEditorState", "type": "Interface", @@ -689,8 +709,7 @@ "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" + "lineNumber": 15 }, "signature": [ "{ raw: string; format(): T; }" @@ -709,8 +728,7 @@ "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" + "lineNumber": 19 } }, { @@ -721,8 +739,7 @@ "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" + "lineNumber": 20 }, "signature": [ "boolean | undefined" @@ -731,8 +748,80 @@ ], "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" + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-public.MissingPrivileges", + "type": "Interface", + "label": "MissingPrivileges", + "description": [], + "tags": [], + "children": [ + { + "id": "def-public.MissingPrivileges.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 10 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Privileges", + "type": "Interface", + "label": "Privileges", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "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 }, "initialIsOpen": false }, @@ -751,8 +840,7 @@ "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" + "lineNumber": 12 } }, { @@ -763,8 +851,7 @@ "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" + "lineNumber": 13 }, "signature": [ "\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\"" @@ -778,8 +865,7 @@ "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" + "lineNumber": 14 }, "signature": [ { @@ -800,8 +886,7 @@ "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" + "lineNumber": 15 }, "signature": [ "any" @@ -817,8 +902,7 @@ ], "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" + "lineNumber": 20 }, "signature": [ "boolean | undefined" @@ -827,8 +911,7 @@ ], "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" + "lineNumber": 11 }, "initialIsOpen": false }, @@ -857,8 +940,7 @@ "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" + "lineNumber": 24 }, "signature": [ "D | null" @@ -872,8 +954,7 @@ "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" + "lineNumber": 25 }, "signature": [ "E | null" @@ -882,8 +963,7 @@ ], "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" + "lineNumber": 23 }, "initialIsOpen": false }, @@ -919,8 +999,7 @@ "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" + "lineNumber": 15 }, "signature": [ "number | undefined" @@ -934,8 +1013,7 @@ "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" + "lineNumber": 16 }, "signature": [ "any" @@ -943,259 +1021,131 @@ }, { "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-public.Privileges.missingPrivileges", - "type": "Object", - "label": "missingPrivileges", + "id": "def-public.UseRequestConfig.deserializer", + "type": "Function", + "label": "deserializer", "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" + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 17 }, "signature": [ - { - "pluginId": "esUiShared", - "scope": "common", - "docId": "kibEsUiSharedPluginApi", - "section": "def-common.MissingPrivileges", - "text": "MissingPrivileges" - } + "((data: any) => any) | undefined" ] } ], "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" + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-public.MissingPrivileges", + "id": "def-public.UseRequestResponse", "type": "Interface", - "label": "MissingPrivileges", + "label": "UseRequestResponse", + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.UseRequestResponse", + "text": "UseRequestResponse" + }, + "" + ], "description": [], "tags": [], "children": [ { - "id": "def-public.MissingPrivileges.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-public.UseRequestResponse.isInitialRequest", + "type": "boolean", + "label": "isInitialRequest", "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": [], - "tags": [], - "children": [ + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 21 + } + }, { "tags": [], - "id": "def-public.Error.error", - "type": "string", - "label": "error", + "id": "def-public.UseRequestResponse.isLoading", + "type": "boolean", + "label": "isLoading", "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" + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 22 } }, { "tags": [], - "id": "def-public.Error.cause", - "type": "Array", - "label": "cause", + "id": "def-public.UseRequestResponse.error", + "type": "CompoundType", + "label": "error", "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" + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 23 }, "signature": [ - "string[] | undefined" + "E | null" ] }, { "tags": [], - "id": "def-public.Error.message", - "type": "string", - "label": "message", + "id": "def-public.UseRequestResponse.data", + "type": "CompoundType", + "label": "data", "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" + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 24 }, "signature": [ - "string | undefined" + "D | null | undefined" + ] + }, + { + "tags": [], + "id": "def-public.UseRequestResponse.resendRequest", + "type": "Function", + "label": "resendRequest", + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 25 + }, + "signature": [ + "() => void" ] } ], "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" + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "lineNumber": 20 }, "initialIsOpen": false } ], "enums": [], "misc": [ + { + "id": "def-public.Frequency", + "type": "Type", + "label": "Frequency", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/public/components/cron_editor/types.ts", + "lineNumber": 9 + }, + "signature": [ + "\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\"" + ], + "initialIsOpen": false + }, { "id": "def-public.OnJsonEditorUpdateHandler", "type": "Type", @@ -1204,8 +1154,7 @@ "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" + "lineNumber": 23 }, "signature": [ "(arg: ", @@ -1219,25 +1168,24 @@ ") => void" ], "initialIsOpen": false - }, + } + ], + "objects": [ { - "id": "def-public.Frequency", - "type": "Type", - "label": "Frequency", "tags": [], + "id": "def-public.AuthorizationContext", + "type": "Object", + "label": "AuthorizationContext", "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" + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx", + "lineNumber": 33 }, "signature": [ - "\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\"" + "React.Context" ], "initialIsOpen": false - } - ], - "objects": [ + }, { "id": "def-public.indices", "type": "Object", @@ -1251,8 +1199,7 @@ "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" + "lineNumber": 18 }, "signature": [ "string[]" @@ -1266,8 +1213,7 @@ "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" + "lineNumber": 19 }, "signature": [ "typeof ", @@ -1288,8 +1234,7 @@ "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" + "lineNumber": 20 }, "signature": [ "typeof ", @@ -1310,8 +1255,7 @@ "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" + "lineNumber": 21 }, "signature": [ "typeof ", @@ -1329,25 +1273,8 @@ "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 - }, - { - "tags": [], - "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" + "lineNumber": 17 }, - "signature": [ - "React.Context" - ], "initialIsOpen": false } ] @@ -1355,39 +1282,6 @@ "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", @@ -1402,8 +1296,7 @@ "description": [], "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L23" + "lineNumber": 23 } } ], @@ -1422,13 +1315,43 @@ "label": "handleEsError", "source": { "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L23" + "lineNumber": 23 }, "tags": [], "returnComment": [], "initialIsOpen": false }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", + "lineNumber": 21 + }, + "initialIsOpen": false + }, { "id": "def-server.parseEsError", "type": "Function", @@ -1443,8 +1366,7 @@ "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" + "lineNumber": 27 } } ], @@ -1455,8 +1377,7 @@ "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" + "lineNumber": 27 }, "tags": [], "returnComment": [], @@ -1472,6 +1393,34 @@ "classes": [], "functions": [], "interfaces": [ + { + "id": "def-common.MissingPrivileges", + "type": "Interface", + "label": "MissingPrivileges", + "description": [], + "tags": [], + "children": [ + { + "id": "def-common.MissingPrivileges.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 10 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, { "id": "def-common.Privileges", "type": "Interface", @@ -1487,8 +1436,7 @@ "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" + "lineNumber": 14 } }, { @@ -1499,8 +1447,7 @@ "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" + "lineNumber": 15 }, "signature": [ { @@ -1515,38 +1462,7 @@ ], "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": [], - "tags": [], - "children": [ - { - "id": "def-common.MissingPrivileges.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "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" + "lineNumber": 13 }, "initialIsOpen": false } diff --git a/api_docs/event_log.json b/api_docs/event_log.json index 08bd555f1ea80..64266b0563556 100644 --- a/api_docs/event_log.json +++ b/api_docs/event_log.json @@ -13,33 +13,82 @@ "functions": [], "interfaces": [ { - "id": "def-server.IEventLogger", + "id": "def-server.IEventLogClient", "type": "Interface", - "label": "IEventLogger", + "label": "IEventLogClient", "description": [], "tags": [], "children": [ { - "id": "def-server.IEventLogger.logEvent", + "id": "def-server.IEventLogClient.findEventsBySavedObjectIds", "type": "Function", - "label": "logEvent", + "label": "findEventsBySavedObjectIds", "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" + "(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 + } + }, + { + "type": "Array", + "label": "ids", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 47 + } + }, { "type": "Object", - "label": "properties", + "label": "options", "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" + "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": 53, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53" + "lineNumber": 48 } } ], @@ -47,22 +96,35 @@ "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" + "lineNumber": 45 } - }, + } + ], + "source": { + "path": "x-pack/plugins/event_log/server/types.ts", + "lineNumber": 44 + }, + "initialIsOpen": false + }, + { + "id": "def-server.IEventLogger", + "type": "Interface", + "label": "IEventLogger", + "description": [], + "tags": [], + "children": [ { - "id": "def-server.IEventLogger.startTiming", + "id": "def-server.IEventLogger.logEvent", "type": "Function", - "label": "startTiming", + "label": "logEvent", "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" + "(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": "event", + "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" @@ -70,8 +132,7 @@ "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" + "lineNumber": 53 } } ], @@ -79,14 +140,13 @@ "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" + "lineNumber": 53 } }, { - "id": "def-server.IEventLogger.stopTiming", + "id": "def-server.IEventLogger.startTiming", "type": "Function", - "label": "stopTiming", + "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" ], @@ -102,8 +162,7 @@ "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" + "lineNumber": 54 } } ], @@ -111,98 +170,29 @@ "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" + "lineNumber": 54 } - } - ], - "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": [], - "tags": [], - "children": [ + }, { - "id": "def-server.IEventLogClient.findEventsBySavedObjectIds", + "id": "def-server.IEventLogger.stopTiming", "type": "Function", - "label": "findEventsBySavedObjectIds", + "label": "stopTiming", "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" - }, - ">" + "(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": "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", + "label": "event", "isRequired": false, "signature": [ - "Partial<", - { - "pluginId": "eventLog", - "scope": "server", - "docId": "kibEventLogPluginApi", - "section": "def-server.FindOptionsType", - "text": "FindOptionsType" - }, - "> | 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; } & {}>>> | 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" + "lineNumber": 55 } } ], @@ -210,15 +200,13 @@ "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" + "lineNumber": 55 } } ], "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" + "lineNumber": 52 }, "initialIsOpen": false }, @@ -237,8 +225,7 @@ "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" + "lineNumber": 35 } }, { @@ -249,8 +236,7 @@ "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" + "lineNumber": 36 } }, { @@ -261,8 +247,7 @@ "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" + "lineNumber": 37 } }, { @@ -273,8 +258,7 @@ "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" + "lineNumber": 38 }, "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)[]" @@ -283,8 +267,7 @@ ], "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" + "lineNumber": 34 }, "initialIsOpen": false } @@ -299,8 +282,7 @@ "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" + "lineNumber": 26 }, "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; } & {}>>>" @@ -315,8 +297,7 @@ "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" + "lineNumber": 25 }, "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; } & {}>" @@ -331,8 +312,7 @@ "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" + "lineNumber": 18 }, "signature": [ "\"primary\"" @@ -361,8 +341,7 @@ "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" + "lineNumber": 30 } }, { @@ -378,8 +357,7 @@ "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" + "lineNumber": 31 } }, { @@ -395,8 +373,7 @@ "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" + "lineNumber": 32 } }, { @@ -418,8 +395,7 @@ "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" + "lineNumber": 33 } }, { @@ -432,8 +408,7 @@ "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" + "lineNumber": 33 } } ], @@ -441,8 +416,7 @@ "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" + "lineNumber": 33 } }, { @@ -464,8 +438,7 @@ "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" + "lineNumber": 34 } }, { @@ -478,8 +451,7 @@ "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" + "lineNumber": 34 } } ], @@ -487,8 +459,7 @@ "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" + "lineNumber": 34 } }, { @@ -504,8 +475,7 @@ "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" + "lineNumber": 35 } }, { @@ -535,8 +505,7 @@ "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" + "lineNumber": 36 } }, { @@ -555,8 +524,7 @@ "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" + "lineNumber": 36 } } ], @@ -564,8 +532,7 @@ "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" + "lineNumber": 36 } }, { @@ -594,8 +561,7 @@ "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" + "lineNumber": 37 } } ], @@ -603,15 +569,13 @@ "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" + "lineNumber": 37 } } ], "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" + "lineNumber": 29 }, "lifecycle": "setup", "initialIsOpen": true @@ -664,8 +628,7 @@ "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" + "lineNumber": 41 } } ], @@ -673,15 +636,13 @@ "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" + "lineNumber": 41 } } ], "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" + "lineNumber": 40 }, "lifecycle": "start", "initialIsOpen": true @@ -701,8 +662,7 @@ "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" + "lineNumber": 8 }, "signature": [ "\"/api/event_log\"" diff --git a/api_docs/expressions.json b/api_docs/expressions.json index 9d50f8609f921..ff04fcd03f046 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -3,336 +3,424 @@ "client": { "classes": [ { - "id": "def-public.ExpressionsPublicPlugin", + "id": "def-public.Execution", "type": "Class", "tags": [], - "label": "ExpressionsPublicPlugin", + "label": "Execution", "description": [], "signature": [ { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionsPublicPlugin", - "text": "ExpressionsPublicPlugin" + "section": "def-common.Execution", + "text": "Execution" }, - " implements ", + "" + ], + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Plugin", - "text": "Plugin" + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContainer", + "text": "ExecutionContainer" + }, + ">" + ] }, - ", ", { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionsStart", - "text": "ExpressionsStart" + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "" + ] }, - ", object, object>" - ], - "children": [ { - "id": "def-public.ExpressionsPublicPlugin.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + "tags": [], + "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." ], - "description": [], - "children": [ + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 134 + }, + "signature": [ { - "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" - } - } - ], + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" + }, + "" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.Execution.expression", + "type": "string", + "label": "expression", + "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 } }, { - "id": "def-public.ExpressionsPublicPlugin.setup", - "type": "Function", - "label": "setup", + "id": "def-public.Execution.result", + "type": "Object", + "label": "result", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 142 + }, "signature": [ - "(core: ", + "Promise) => Pick<", + "<\"error\", { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" + "section": "def-common.ErrorLike", + "text": "ErrorLike" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + "; info?: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }>>" + ] + }, + { + "id": "def-public.Execution.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 146 + }, + "signature": [ + "InspectorAdapters" + ] + }, + { + "id": "def-public.Execution.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], "description": [], "children": [ { "type": "Object", - "label": "core", + "label": "execution", "isRequired": true, "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - "" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionParams", + "text": "ExecutionParams" + } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150 } }, { - "id": "def-public.ExpressionsPublicPlugin.start", + "id": "def-public.Execution.cancel", "type": "Function", - "label": "start", + "label": "cancel", "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" - } + "() => void" + ], + "description": [ + "\nStop execution of expression." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 192 + } + }, + { + "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." ], - "description": [], "children": [ { - "type": "Object", - "label": "core", + "type": "Uncategorized", + "label": "input", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - } + "Input" ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202 } }, { - "id": "def-public.ExpressionsPublicPlugin.stop", + "id": "def-public.Execution.invokeChain", "type": "Function", - "label": "stop", + "label": "invokeChain", "signature": [ - "() => void" + "(chainArr: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[], input: unknown) => Promise" ], "description": [], - "children": [], + "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 + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236 + } + } + ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236 } - } - ], - "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", - "tags": [], - "label": "ExpressionRenderHandler", - "description": [], - "children": [ - { - "tags": [], - "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", - "" - ] - }, - { - "tags": [], - "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", - "" - ] }, { - "tags": [], - "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" - }, + "id": "def-public.Execution.invokeFunction", + "type": "Function", + "label": "invokeFunction", "signature": [ - "Observable", - "<", + "(fn: ", { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRendererEvent", - "text": "ExpressionRendererEvent" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - ">" - ] - }, - { - "id": "def-public.ExpressionRenderHandler.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + ", input: unknown, args: Record) => Promise" ], "description": [], "children": [ { "type": "Object", - "label": "element", + "label": "fn", "isRequired": true, "signature": [ - "HTMLElement" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 317 + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 318 } }, { "type": "Object", - "label": "{\n onRenderError,\n renderMode,\n syncColors,\n hasCompatibleActions = async () => false,\n }", + "label": "args", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderHandlerParams", - "text": "ExpressionRenderHandlerParams" - } + "Record" ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 319 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 316 } }, { - "id": "def-public.ExpressionRenderHandler.render", + "id": "def-public.Execution.cast", "type": "Function", + "label": "cast", + "signature": [ + "(value: any, toTypeNames?: string[] | undefined) => any" + ], + "description": [], "children": [ { "type": "Any", @@ -343,166 +431,256 @@ ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348 } }, { - "type": "Any", - "label": "uiState", - "isRequired": true, + "type": "Array", + "label": "toTypeNames", + "isRequired": false, "signature": [ - "any" + "string[] | undefined" ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348 + } }, { - "id": "def-public.ExpressionRenderHandler.destroy", + "id": "def-public.Execution.resolveArgs", "type": "Function", - "children": [], + "label": "resolveArgs", "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionRenderHandler.getElement", - "type": "Function", - "children": [], - "signature": [ - "() => HTMLElement" + "(fnDef: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + ", input: unknown, argAsts: any) => Promise" ], "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionRenderHandler.handleRenderError", - "type": "Function", "children": [ { "type": "Object", - "label": "error", + "label": "fnDef", "isRequired": true, "signature": [ { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderError", - "text": "ExpressionRenderError" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + } + }, + { + "type": "Any", + "label": "argAsts", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + } + }, + { + "id": "def-public.Execution.interpret", + "type": "Function", + "label": "interpret", "signature": [ - "(error: ", + "(ast: ", { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderError", - "text": "ExpressionRenderError" + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" }, - ") => void" + ", input: T) => Promise" ], "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" - }, + "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 + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465 + } + } + ], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465 + } } ], "source": { - "path": "src/plugins/expressions/public/render.ts", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L37" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 70 }, "initialIsOpen": false }, { - "id": "def-public.Execution", + "id": "def-public.ExecutionContract", "type": "Class", "tags": [], - "label": "Execution", - "description": [], + "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.Execution", - "text": "Execution" + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" }, "" ], "children": [ { + "id": "def-public.ExecutionContract.isPending", + "type": "boolean", + "label": "isPending", "tags": [], - "id": "def-public.Execution.state", - "type": "Object", - "label": "state", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 18 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24 + } + }, + { + "id": "def-public.ExecutionContract.cancel", + "type": "Function", + "children": [], + "signature": [ + "() => void" + ], "description": [ - "\nDynamic state of the execution." + "\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.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 31 }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExecutionContract.getData", + "type": "Function", + "children": [], "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContainer", - "text": "ExecutionContainer" - }, - " Promise<", { "pluginId": "expressions", "scope": "common", @@ -526,150 +704,232 @@ "section": "def-common.SerializableState", "text": "SerializableState" }, - " | undefined; }>>" - ] - }, - { - "tags": [], - "id": "def-public.Execution.input", - "type": "Uncategorized", - "label": "input", + " | undefined; }> | Output>" + ], "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." + "\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.ts", - "lineNumber": 88, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 40 }, - "signature": [ - "Input" - ] + "tags": [], + "returnComment": [] }, { - "tags": [], - "id": "def-public.Execution.context", - "type": "Object", - "label": "context", + "id": "def-public.ExecutionContract.getExpression", + "type": "Function", + "children": [], + "signature": [ + "() => string" + ], "description": [ - "\nExecution context - object that allows to do side-effects. Context is passed\nto every function." + "\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.ts", - "lineNumber": 94, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 60 }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExecutionContract.getAst", + "type": "Function", + "children": [], "signature": [ + "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "" - ] + "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 + }, + "tags": [], + "returnComment": [] }, { - "tags": [], - "id": "def-public.Execution.contract", - "type": "Object", - "label": "contract", + "id": "def-public.ExecutionContract.inspect", + "type": "Function", + "children": [], + "signature": [ + "() => InspectorAdapters" + ], "description": [ - "\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption." + "\nGet Inspector adapters provided to all functions of expression through\nexecution context." ], + "label": "inspect", "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" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 73 }, + "tags": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Executor", + "type": "Class", + "tags": [], + "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.ExecutionContract", - "text": "ExecutionContract" + "section": "def-common.Executor", + "text": "Executor" }, - "" - ] - }, - { - "tags": [], - "id": "def-public.Execution.expression", - "type": "string", - "label": "expression", + ".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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 82 } }, { - "id": "def-public.Execution.result", - "type": "Object", - "label": "result", "tags": [], + "id": "def-public.Executor.state", + "type": "Object", + "label": "state", "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 91 }, "signature": [ - "Promise" + ] + }, + { + "tags": [ + "deprecated" + ], + "id": "def-public.Executor.functions", + "type": "Object", + "label": "functions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 96 + }, + "signature": [ { "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; }>>" + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + } ] }, { - "id": "def-public.Execution.inspectorAdapters", - "type": "Uncategorized", - "label": "inspectorAdapters", - "tags": [], + "tags": [ + "deprecated" + ], + "id": "def-public.Executor.types", + "type": "Object", + "label": "types", "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 101 }, "signature": [ - "InspectorAdapters" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + } ] }, { - "id": "def-public.Execution.Unnamed", + "id": "def-public.Executor.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -679,153 +939,137 @@ "children": [ { "type": "Object", - "label": "execution", - "isRequired": true, + "label": "state", + "isRequired": false, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionParams", - "text": "ExecutionParams" - } + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + " | undefined" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 103 } }, { - "id": "def-public.Execution.start", + "id": "def-public.Executor.registerFunction", "type": "Function", - "label": "start", + "label": "registerFunction", "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." + "(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": "Uncategorized", - "label": "input", + "type": "CompoundType", + "label": "functionDefinition", "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" + { + "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 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 109 } }, { - "id": "def-public.Execution.invokeChain", + "id": "def-public.Executor.getFunction", "type": "Function", - "label": "invokeChain", + "label": "getFunction", "signature": [ - "(chainArr: ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - "[], input: unknown) => Promise" + " | undefined" ], "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", + "type": "string", + "label": "name", "isRequired": true, "signature": [ - "unknown" + "string" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 118 } }, { - "id": "def-public.Execution.invokeFunction", + "id": "def-public.Executor.getFunctions", "type": "Function", - "label": "invokeFunction", + "label": "getFunctions", "signature": [ - "(fn: ", + "() => Record) => Promise" + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 122 + } + }, + { + "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": "Object", - "label": "fn", + "type": "CompoundType", + "label": "typeDefinition", "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" + "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/execution/execution.ts", - "lineNumber": 319, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 127 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 126 } }, { - "id": "def-public.Execution.cast", + "id": "def-public.Executor.getType", "type": "Function", - "label": "cast", + "label": "getType", "signature": [ - "(value: any, toTypeNames?: string[] | undefined) => any" + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" ], "description": [], "children": [ { - "type": "Any", - "label": "value", + "type": "string", + "label": "name", "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" + "string" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 135 } }, { - "id": "def-public.Execution.resolveArgs", + "id": "def-public.Executor.getTypes", "type": "Function", - "label": "resolveArgs", + "label": "getTypes", "signature": [ - "(fnDef: ", + "() => Record Promise" + ">" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 139 + } + }, + { + "id": "def-public.Executor.extendContext", + "type": "Function", + "label": "extendContext", + "signature": [ + "(extraContext: Record) => void" ], "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", + "label": "extraContext", "isRequired": true, "signature": [ - "any" + "Record" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143 } }, { - "id": "def-public.Execution.interpret", - "type": "Function", - "label": "interpret", - "signature": [ - "(ast: ", + "id": "def-public.Executor.context", + "type": "Object", + "label": "context", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 147 + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-public.Executor.run", + "type": "Function", + "label": "run", + "signature": [ + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstNode", - "text": "ExpressionAstNode" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ", input: T) => Promise" + ", input: Input, params?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + }, + ") => Promise" + ], + "description": [ + "\nExecute expression and return result.\n" ], - "description": [], "children": [ { "type": "CompoundType", "label": "ast", "isRequired": true, "signature": [ + "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstNode", - "text": "ExpressionAstNode" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" } ], - "description": [], + "description": [ + "Expression AST or a string representing expression." + ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 160 } }, { @@ -1056,305 +1309,200 @@ "label": "input", "isRequired": true, "signature": [ - "T" + "Input" + ], + "description": [ + "Initial input to the first expression function." ], - "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 161 } - } - ], - "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", - "tags": [], - "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", - "tags": [], - "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", + "label": "params", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Execution", - "text": "Execution" - }, - "" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 162 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 159 } }, { - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExecutionContract.getData", + "id": "def-public.Executor.createExecution", "type": "Function", - "children": [], + "label": "createExecution", "signature": [ - "() => Promise<", + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - "<\"error\", { error: ", + ", params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ErrorLike", - "text": "ErrorLike" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" }, - "; info?: ", + ") => ", { - "pluginId": "kibanaUtils", + "pluginId": "expressions", "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" }, - " | 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." + "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 + } + }, + { + "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 + } + } ], - "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" - }, "tags": [], - "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", + "returnComment": [], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 169 + } }, { - "id": "def-public.ExecutionContract.getAst", + "id": "def-public.Executor.inject", "type": "Function", - "children": [], + "label": "inject", "signature": [ - "() => ", + "(ast: ", { "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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", - "tags": [], - "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 ", + }, + ", references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - ".createWithDefaults" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "description": [], "children": [ { "type": "Object", - "label": "state", - "isRequired": false, + "label": "ast", + "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 217 + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" }, - " | 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" + "lineNumber": 217 } } ], @@ -1362,106 +1510,59 @@ "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" + "lineNumber": 217 } }, { - "tags": [], - "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" - }, + "id": "def-public.Executor.extract", + "type": "Function", + "label": "extract", "signature": [ + "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorContainer", - "text": "ExecutorContainer" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - "" - ] - }, - { - "tags": [ - "deprecated" - ], - "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": [ + ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.FunctionsRegistry", - "text": "FunctionsRegistry" - } - ] - }, - { - "tags": [ - "deprecated" - ], - "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": [ + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "; references: ", { - "pluginId": "expressions", + "pluginId": "core", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.TypesRegistry", - "text": "TypesRegistry" - } - ] - }, - { - "id": "def-public.Executor.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" ], "description": [], "children": [ { "type": "Object", - "label": "state", - "isRequired": false, + "label": "ast", + "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - " | undefined" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "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" + "lineNumber": 223 } } ], @@ -1469,62 +1570,56 @@ "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" + "lineNumber": 223 } }, { - "id": "def-public.Executor.registerFunction", + "id": "def-public.Executor.telemetry", "type": "Function", - "label": "registerFunction", + "label": "telemetry", "signature": [ - "(functionDefinition: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - }, - " | (() => ", + "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ")) => void" + ", telemetryData: Record) => Record" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "functionDefinition", + "type": "Object", + "label": "ast", "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" - }, - ")" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233 + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" ], "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" + "lineNumber": 233 } } ], @@ -1532,158 +1627,55 @@ "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" + "lineNumber": 233 } }, { - "id": "def-public.Executor.getFunction", + "id": "def-public.Executor.migrate", "type": "Function", - "label": "getFunction", + "label": "migrate", "signature": [ - "(name: string) => ", + "(ast: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ", version: 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" - } + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" } ], - "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", + "type": "Object", + "label": "ast", "isRequired": true, "signature": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" - }, - " | (() => ", - { - "pluginId": "expressions", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" - }, - ")" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + } ], "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" + "lineNumber": 241 } - } - ], - "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", + "label": "version", "isRequired": true, "signature": [ "string" @@ -1691,8 +1683,7 @@ "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" + "lineNumber": 241 } } ], @@ -1700,24 +1691,23 @@ "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" + "lineNumber": 241 } }, { - "id": "def-public.Executor.getTypes", + "id": "def-public.Executor.fork", "type": "Function", - "label": "getTypes", + "label": "fork", "signature": [ - "() => Record ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.Executor", + "text": "Executor" }, - ">" + "" ], "description": [], "children": [], @@ -1725,257 +1715,241 @@ "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" + "lineNumber": 250 } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 80 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionFunction", + "type": "Class", + "tags": [], + "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.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": [], + "id": "def-public.ExpressionFunction.name", + "type": "string", + "label": "name", + "description": [ + "\nName of function" + ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 22 } }, { - "id": "def-public.Executor.context", - "type": "Object", - "label": "context", "tags": [], - "description": [], + "id": "def-public.ExpressionFunction.aliases", + "type": "Array", + "label": "aliases", + "description": [ + "\nAliases that can be used instead of `name`." + ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 27 }, "signature": [ - "Record" + "string[]" ] }, { - "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" + "tags": [], + "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 + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.fn", + "type": "Function", + "label": "fn", "description": [ - "\nExecute expression and return result.\n" + "\nFunction to run function (context, args)" ], - "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" - } - } + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 39 + }, + "signature": [ + "(input: any, params: Record, handlers: object) => any" + ] + }, + { + "tags": [], + "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 + } + }, + { + "id": "def-public.ExpressionFunction.args", + "type": "Object", "tags": [], - "returnComment": [], + "children": [], + "description": [ + "\nSpecification of expression function parameters." + ], + "label": "args", "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 49 } }, { - "id": "def-public.Executor.createExecution", + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.disabled", + "type": "boolean", + "label": "disabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56 + } + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.telemetry", "type": "Function", - "label": "createExecution", + "label": "telemetry", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57 + }, "signature": [ - "(ast: string | ", + "(state: Record, telemetryData: Record) => Record" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.extract", + "type": "Function", + "label": "extract", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61 + }, + "signature": [ + "(state: Record ", + "[]>) => { state: Record; references: ", { - "pluginId": "expressions", + "pluginId": "core", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DefaultInspectorAdapters", - "text": "DefaultInspectorAdapters" - }, - ">" - ], - "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" - } + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" }, - { - "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", + "tags": [], + "id": "def-public.ExpressionFunction.inject", "type": "Function", "label": "inject", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64 + }, "signature": [ - "(ast: ", + "(state: Record, references: ", { "pluginId": "core", "scope": "common", @@ -1983,576 +1957,240 @@ "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, - "[]) => ", + "[]) => Record" + ] + }, + { + "tags": [], + "id": "def-public.ExpressionFunction.migrations", + "type": "Object", + "label": "migrations", "description": [], - "children": [ + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 68 + }, + "signature": [ + "{ [key: string]: (state: ", { - "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", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - "; references: ", + ") => ", { - "pluginId": "core", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - "[]; }" - ], - "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", + "id": "def-public.ExpressionFunction.Unnamed", "type": "Function", - "label": "telemetry", + "label": "Constructor", "signature": [ - "(ast: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - ", telemetryData: Record) => Record" + "any" ], "description": [], "children": [ { "type": "Object", - "label": "ast", + "label": "functionDefinition", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72 } } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72 } }, { - "id": "def-public.Executor.migrate", + "id": "def-public.ExpressionFunction.accepts", "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", + "label": "type", "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107 } } ], - "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" - }, - "" + "(type: string) => boolean" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "accepts", "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" - } + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 18 }, "initialIsOpen": false }, { - "id": "def-public.ExpressionFunction", + "id": "def-public.ExpressionFunctionParameter", "type": "Class", "tags": [], - "label": "ExpressionFunction", + "label": "ExpressionFunctionParameter", "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": [ { "tags": [], - "id": "def-public.ExpressionFunction.name", + "id": "def-public.ExpressionFunctionParameter.name", "type": "string", "label": "name", - "description": [ - "\nName of function" - ], + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 12 } }, { "tags": [], - "id": "def-public.ExpressionFunction.aliases", - "type": "Array", - "label": "aliases", - "description": [ - "\nAliases that can be used instead of `name`." - ], + "id": "def-public.ExpressionFunctionParameter.required", + "type": "boolean", + "label": "required", + "description": [], "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[]" - ] - }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 13 } }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-public.ExpressionFunction.help", + "id": "def-public.ExpressionFunctionParameter.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", - "tags": [], - "children": [], - "description": [ - "\nSpecification of expression function parameters." - ], - "label": "args", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 14 } }, { "tags": [], - "id": "def-public.ExpressionFunction.inputTypes", + "id": "def-public.ExpressionFunctionParameter.types", "type": "Array", - "label": "inputTypes", - "description": [ - "\nType of inputs that this function supports." - ], + "label": "types", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 15 }, "signature": [ - "string[] | undefined" + "string[]" ] }, { "tags": [], - "id": "def-public.ExpressionFunction.disabled", - "type": "boolean", - "label": "disabled", + "id": "def-public.ExpressionFunctionParameter.default", + "type": "Any", + "label": "default", "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" - } + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 16 + }, + "signature": [ + "any" + ] }, { "tags": [], - "id": "def-public.ExpressionFunction.telemetry", - "type": "Function", - "label": "telemetry", + "id": "def-public.ExpressionFunctionParameter.aliases", + "type": "Array", + "label": "aliases", "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 17 }, "signature": [ - "(state: Record, telemetryData: Record) => Record" + "string[]" ] }, { "tags": [], - "id": "def-public.ExpressionFunction.extract", - "type": "Function", - "label": "extract", + "id": "def-public.ExpressionFunctionParameter.multi", + "type": "boolean", + "label": "multi", "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" - }, - "[]; }" - ] + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 18 + } }, { "tags": [], - "id": "def-public.ExpressionFunction.inject", - "type": "Function", - "label": "inject", + "id": "def-public.ExpressionFunctionParameter.resolve", + "type": "boolean", + "label": "resolve", "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" - ] + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 19 + } }, { "tags": [], - "id": "def-public.ExpressionFunction.migrations", - "type": "Object", - "label": "migrations", + "id": "def-public.ExpressionFunctionParameter.options", + "type": "Array", + "label": "options", "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 20 }, "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" - }, - "; }" + "any[]" ] }, { - "id": "def-public.ExpressionFunction.Unnamed", + "id": "def-public.ExpressionFunctionParameter.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -2561,37 +2199,54 @@ "description": [], "children": [ { - "type": "Object", - "label": "functionDefinition", + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 + } + }, + { + "type": "CompoundType", + "label": "arg", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - } + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "" ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 } } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 } }, { - "id": "def-public.ExpressionFunction.accepts", + "id": "def-public.ExpressionFunctionParameter.accepts", "type": "Function", + "label": "accepts", + "signature": [ + "(type: string) => boolean" + ], + "description": [], "children": [ { "type": "string", @@ -2602,260 +2257,32 @@ ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 + } } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-public.ExpressionFunctionParameter", + "id": "def-public.ExpressionRenderer", "type": "Class", "tags": [], - "label": "ExpressionFunctionParameter", + "label": "ExpressionRenderer", "description": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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", - "tags": [], - "label": "ExpressionRenderer", - "description": [], - "signature": [ + "signature": [ { "pluginId": "expressions", "scope": "common", @@ -2874,8 +2301,7 @@ "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" + "lineNumber": 12 } }, { @@ -2886,8 +2312,7 @@ "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" + "lineNumber": 13 } }, { @@ -2898,8 +2323,7 @@ "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" + "lineNumber": 14 } }, { @@ -2910,8 +2334,7 @@ "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" + "lineNumber": 15 }, "signature": [ "() => void | Error" @@ -2925,8 +2348,7 @@ "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" + "lineNumber": 16 } }, { @@ -2937,8 +2359,7 @@ "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" + "lineNumber": 17 }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", @@ -2978,8 +2399,7 @@ "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" + "lineNumber": 19 } } ], @@ -2987,15 +2407,13 @@ "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" + "lineNumber": 19 } } ], "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" + "lineNumber": 11 }, "initialIsOpen": false }, @@ -3082,8 +2500,7 @@ "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" + "lineNumber": 19 } } ], @@ -3091,8 +2508,7 @@ "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" + "lineNumber": 19 } }, { @@ -3122,8 +2538,7 @@ "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" + "lineNumber": 25 } } ], @@ -3131,8 +2546,7 @@ "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" + "lineNumber": 25 } }, { @@ -3156,8 +2570,7 @@ "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" + "lineNumber": 29 } }, { @@ -3181,117 +2594,78 @@ "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" + "lineNumber": 39 } } ], "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" + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-public.ExpressionType", + "id": "def-public.ExpressionRenderHandler", "type": "Class", "tags": [], - "label": "ExpressionType", + "label": "ExpressionRenderHandler", "description": [], "children": [ { "tags": [], - "id": "def-public.ExpressionType.name", - "type": "string", - "label": "name", + "id": "def-public.ExpressionRenderHandler.render$", + "type": "Object", + "label": "render$", "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" - } - }, - { - "tags": [], - "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" - } + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 38 + }, + "signature": [ + "Observable", + "" + ] }, { "tags": [], - "id": "def-public.ExpressionType.validate", - "type": "Function", - "label": "validate", - "description": [ - "\nType validation, useful for checking function output." - ], + "id": "def-public.ExpressionRenderHandler.update$", + "type": "Object", + "label": "update$", + "description": [], "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 39 }, "signature": [ - "(type: any) => void | Error" + "Observable", + "" ] }, { "tags": [], - "id": "def-public.ExpressionType.create", - "type": "Unknown", - "label": "create", + "id": "def-public.ExpressionRenderHandler.events$", + "type": "Object", + "label": "events$", "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 40 }, "signature": [ - "unknown" + "Observable", + "<", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ">" ] }, { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", + "id": "def-public.ExpressionRenderHandler.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -3301,358 +2675,282 @@ "children": [ { "type": "Object", - "label": "definition", + "label": "element", + "isRequired": true, + "signature": [ + "HTMLElement" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 52 + } + }, + { + "type": "Object", + "label": "{\n onRenderError,\n renderMode,\n syncColors,\n hasCompatibleActions = async () => false,\n }", "isRequired": true, "signature": [ { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-public.ExpressionRenderHandlerParams", + "text": "ExpressionRenderHandlerParams" } ], "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 53 } } ], "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 51 } }, { - "id": "def-public.ExpressionType.getToFn", + "id": "def-public.ExpressionRenderHandler.render", "type": "Function", "children": [ { - "type": "string", - "label": "typeName", + "type": "Any", + "label": "value", "isRequired": true, "signature": [ - "string" + "any" ], "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-public.ExpressionType.getFromFn", - "type": "Function", - "children": [ { - "type": "string", - "label": "typeName", + "type": "Any", + "label": "uiState", "isRequired": true, "signature": [ - "string" + "any" ], "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102 } } ], "signature": [ - "(typeName: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueConverter", - "text": "ExpressionValueConverter" - }, - " | undefined" + "(value: any, uiState?: any) => Promise" ], "description": [], - "label": "getFromFn", + "label": "render", "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 102 }, "tags": [], "returnComment": [] }, { - "id": "def-public.ExpressionType.castsTo", + "id": "def-public.ExpressionRenderHandler.destroy", "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" - } - } - ], + "children": [], "signature": [ - "(value: any) => boolean" + "() => void" ], "description": [], - "label": "castsTo", + "label": "destroy", "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 134 }, "tags": [], "returnComment": [] }, { - "id": "def-public.ExpressionType.castsFrom", + "id": "def-public.ExpressionRenderHandler.getElement", "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" - } - } - ], + "children": [], "signature": [ - "(value: any) => boolean" + "() => HTMLElement" ], "description": [], - "label": "castsFrom", + "label": "getElement", "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 143 }, "tags": [], "returnComment": [] }, { - "id": "def-public.ExpressionType.to", + "id": "def-public.ExpressionRenderHandler.handleRenderError", "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", + "label": "error", "isRequired": true, "signature": [ - "Record" + "section": "def-public.ExpressionRenderError", + "text": "ExpressionRenderError" + } ], "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 147 } } ], "signature": [ - "(value: any, toTypeName: string, types: Record) => any" + ") => void" ], "description": [], - "label": "to", + "label": "handleRenderError", "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 147 }, "tags": [], "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 37 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionsInspectorAdapter", + "type": "Class", + "tags": [], + "label": "ExpressionsInspectorAdapter", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsInspectorAdapter", + "text": "ExpressionsInspectorAdapter" }, + " extends ", + "EventEmitter" + ], + "children": [ { - "id": "def-public.ExpressionType.from", + "id": "def-public.ExpressionsInspectorAdapter.logAST", "type": "Function", + "label": "logAST", + "signature": [ + "(ast: any) => void" + ], + "description": [], "children": [ { "type": "Any", - "label": "value", + "label": "ast", "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" + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14 } } ], - "signature": [ - "(value: any, types: Record) => any" - ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14 + } + }, + { + "id": "def-public.ExpressionsInspectorAdapter.ast", + "type": "Any", + "label": "ast", + "tags": [], "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" + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 19 }, - "tags": [], - "returnComment": [] + "signature": [ + "any" + ] } ], "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" + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-public.FunctionsRegistry", + "id": "def-public.ExpressionsPublicPlugin", "type": "Class", "tags": [], - "label": "FunctionsRegistry", + "label": "ExpressionsPublicPlugin", "description": [], "signature": [ { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.FunctionsRegistry", - "text": "FunctionsRegistry" + "section": "def-public.ExpressionsPublicPlugin", + "text": "ExpressionsPublicPlugin" }, " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + ", ", { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" }, - ">" + ", object, object>" ], "children": [ { - "id": "def-public.FunctionsRegistry.Unnamed", + "id": "def-public.ExpressionsPublicPlugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -3662,230 +2960,202 @@ "children": [ { "type": "Object", - "label": "executor", + "label": "initializerContext", "isRequired": true, "signature": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" }, - "" + "" ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40 } }, { - "id": "def-public.FunctionsRegistry.register", + "id": "def-public.ExpressionsPublicPlugin.setup", "type": "Function", - "label": "register", + "label": "setup", "signature": [ - "(functionDefinition: ", + "(core: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" }, - " | (() => ", + ") => Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" }, - ")) => void" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "functionDefinition", + "type": "Object", + "label": "core", "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" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" }, - ")" + "" ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56 } }, { - "id": "def-public.FunctionsRegistry.get", + "id": "def-public.ExpressionsPublicPlugin.start", "type": "Function", - "label": "get", + "label": "start", "signature": [ - "(id: string) => ", + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ") => ", { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - " | null" + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" + } ], "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70 } }, { - "id": "def-public.FunctionsRegistry.toArray", + "id": "def-public.ExpressionsPublicPlugin.stop", "type": "Function", - "label": "toArray", + "label": "stop", "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - "[]" + "() => void" ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 86 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 37 }, "initialIsOpen": false }, { - "id": "def-public.TypesRegistry", + "id": "def-public.ExpressionsPublicPlugin", "type": "Class", "tags": [], - "label": "TypesRegistry", + "label": "ExpressionsPublicPlugin", "description": [], "signature": [ { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.TypesRegistry", - "text": "TypesRegistry" + "section": "def-public.ExpressionsPublicPlugin", + "text": "ExpressionsPublicPlugin" }, " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + ", ", { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" }, - ">" + ", object, object>" ], "children": [ { - "id": "def-public.TypesRegistry.Unnamed", + "id": "def-public.ExpressionsPublicPlugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -3895,192 +3165,156 @@ "children": [ { "type": "Object", - "label": "executor", + "label": "initializerContext", "isRequired": true, "signature": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" }, - "" + "" ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 40 } }, { - "id": "def-public.TypesRegistry.register", + "id": "def-public.ExpressionsPublicPlugin.setup", "type": "Function", - "label": "register", + "label": "setup", "signature": [ - "(typeDefinition: ", + "(core: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" }, - " | (() => ", + ") => Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" }, - ")) => void" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "typeDefinition", + "type": "Object", + "label": "core", "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" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" }, - ")" + "" ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 56 } }, { - "id": "def-public.TypesRegistry.get", + "id": "def-public.ExpressionsPublicPlugin.start", "type": "Function", - "label": "get", + "label": "start", "signature": [ - "(id: string) => ", + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ") => ", { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" - }, - " | null" + "section": "def-public.ExpressionsStart", + "text": "ExpressionsStart" + } ], "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 70 } }, { - "id": "def-public.TypesRegistry.toArray", + "id": "def-public.ExpressionsPublicPlugin.stop", "type": "Function", - "label": "toArray", + "label": "stop", "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" - }, - "[]" + "() => void" ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 86 } } ], "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" + "path": "src/plugins/expressions/public/plugin.ts", + "lineNumber": 37 }, "initialIsOpen": false }, @@ -4127,8 +3361,7 @@ "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" + "lineNumber": 175 }, "signature": [ { @@ -4149,8 +3382,7 @@ "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" + "lineNumber": 176 }, "signature": [ { @@ -4187,8 +3419,7 @@ "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" + "lineNumber": 178 } } ], @@ -4196,8 +3427,7 @@ "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" + "lineNumber": 178 } }, { @@ -4229,8 +3459,7 @@ "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" + "lineNumber": 219 } } ], @@ -4259,8 +3488,7 @@ "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" + "lineNumber": 218 }, "tags": [], "returnComment": [] @@ -4294,8 +3522,7 @@ "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" + "lineNumber": 223 } } ], @@ -4322,8 +3549,7 @@ "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" + "lineNumber": 222 }, "tags": [], "returnComment": [] @@ -4357,8 +3583,7 @@ "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" + "lineNumber": 227 } } ], @@ -4385,8 +3610,7 @@ "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" + "lineNumber": 226 }, "tags": [], "returnComment": [] @@ -4412,8 +3636,7 @@ "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" + "lineNumber": 230 } }, { @@ -4426,8 +3649,7 @@ "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" + "lineNumber": 230 } }, { @@ -4447,8 +3669,7 @@ "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" + "lineNumber": 230 } } ], @@ -4475,8 +3696,7 @@ "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" + "lineNumber": 230 }, "tags": [], "returnComment": [] @@ -4495,8 +3715,7 @@ "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" + "lineNumber": 233 } } ], @@ -4515,8 +3734,7 @@ "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" + "lineNumber": 233 }, "tags": [], "returnComment": [] @@ -4542,8 +3760,7 @@ "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" + "lineNumber": 240 }, "tags": [], "returnComment": [] @@ -4562,8 +3779,7 @@ "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" + "lineNumber": 243 } } ], @@ -4582,8 +3798,7 @@ "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" + "lineNumber": 243 }, "tags": [], "returnComment": [] @@ -4609,8 +3824,7 @@ "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" + "lineNumber": 250 }, "tags": [], "returnComment": [] @@ -4629,8 +3843,7 @@ "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" + "lineNumber": 253 } } ], @@ -4649,8 +3862,7 @@ "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" + "lineNumber": 253 }, "tags": [], "returnComment": [] @@ -4676,8 +3888,7 @@ "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" + "lineNumber": 260 }, "tags": [], "returnComment": [] @@ -4690,8 +3901,7 @@ "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" + "lineNumber": 262 }, "signature": [ "(ast: string | ", @@ -4739,8 +3949,7 @@ "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" + "lineNumber": 268 }, "tags": [], "returnComment": [] @@ -4765,8 +3974,7 @@ "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" + "lineNumber": 281 } }, { @@ -4779,8 +3987,7 @@ "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" + "lineNumber": 282 } } ], @@ -4801,8 +4008,7 @@ "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" + "lineNumber": 280 }, "tags": [], "returnComment": [] @@ -4827,8 +4033,7 @@ "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" + "lineNumber": 292 } } ], @@ -4865,8 +4070,7 @@ "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" + "lineNumber": 292 }, "tags": [], "returnComment": [ @@ -4893,8 +4097,7 @@ "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" + "lineNumber": 302 } }, { @@ -4914,8 +4117,7 @@ "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" + "lineNumber": 302 } } ], @@ -4951,8 +4153,7 @@ "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" + "lineNumber": 302 }, "tags": [], "returnComment": [ @@ -4979,8 +4180,7 @@ "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" + "lineNumber": 312 } }, { @@ -4993,8 +4193,7 @@ "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" + "lineNumber": 312 } } ], @@ -5022,8 +4221,7 @@ "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" + "lineNumber": 312 }, "tags": [], "returnComment": [ @@ -5053,8 +4251,7 @@ "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" + "lineNumber": 320 } }, { @@ -5079,8 +4276,7 @@ "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" + "lineNumber": 328 } }, { @@ -5096,243 +4292,109 @@ "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" + "lineNumber": 332 } } ], "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" + "lineNumber": 174 }, "initialIsOpen": false }, { - "id": "def-public.TablesAdapter", + "id": "def-public.ExpressionType", "type": "Class", "tags": [], - "label": "TablesAdapter", + "label": "ExpressionType", "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" - ], + "tags": [], + "id": "def-public.ExpressionType.name", + "type": "string", + "label": "name", "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" - } - } - ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 13 + } + }, + { "tags": [], - "returnComment": [], + "id": "def-public.ExpressionType.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 18 } }, { - "id": "def-public.TablesAdapter.tables", - "type": "Object", - "label": "tables", "tags": [], - "description": [], + "id": "def-public.ExpressionType.validate", + "type": "Function", + "label": "validate", + "description": [ + "\nType validation, useful for checking function output." + ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 23 }, "signature": [ - "{ [key: string]: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - "; }" + "(type: any) => void | Error" ] - } - ], - "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", - "tags": [], - "label": "ExpressionsInspectorAdapter", - "description": [], - "signature": [ + }, { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsInspectorAdapter", - "text": "ExpressionsInspectorAdapter" + "tags": [], + "id": "def-public.ExpressionType.create", + "type": "Unknown", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 25 + }, + "signature": [ + "unknown" + ] }, - " extends ", - "EventEmitter" - ], - "children": [ { - "id": "def-public.ExpressionsInspectorAdapter.logAST", + "tags": [], + "id": "def-public.ExpressionType.serialize", "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" - } - } + "label": "serialize", + "description": [ + "\nOptional serialization (used when passing context around client/server)." ], - "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" - } + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 30 + }, + "signature": [ + "((value: any) => any) | undefined" + ] }, { - "id": "def-public.ExpressionsInspectorAdapter.ast", - "type": "Any", - "label": "ast", "tags": [], + "id": "def-public.ExpressionType.deserialize", + "type": "Function", + "label": "deserialize", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 31 }, "signature": [ - "any" + "((serialized: any) => any) | undefined" ] - } - ], - "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", - "tags": [], - "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", + "id": "def-public.ExpressionType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -5342,1040 +4404,1337 @@ "children": [ { "type": "Object", - "label": "initializerContext", + "label": "definition", "isRequired": true, "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + } ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 } } ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 } }, { - "id": "def-public.ExpressionsPublicPlugin.setup", + "id": "def-public.ExpressionType.getToFn", "type": "Function", - "label": "setup", - "signature": [ - "(core: ", + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - ") => Pick<", + "type": "string", + "label": "typeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 48 + } + } + ], + "signature": [ + "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + " | undefined" ], "description": [], + "label": "getToFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 47 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.getFromFn", + "type": "Function", "children": [ { - "type": "Object", - "label": "core", + "type": "string", + "label": "typeName", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - "" + "string" ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53 } } ], - "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" - }, - ") => ", + "(typeName: string) => ", { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionsStart", - "text": "ExpressionsStart" - } + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + " | undefined" ], "description": [], + "label": "getFromFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 52 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-public.ExpressionType.castsTo", + "type": "Function", "children": [ { - "type": "Object", - "label": "core", + "type": "Any", + "label": "value", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - } + "any" ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsTo", "source": { - "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 70, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70" - } + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-public.ExpressionsPublicPlugin.stop", + "id": "def-public.ExpressionType.castsFrom", "type": "Function", - "label": "stop", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59 + } + } + ], "signature": [ - "() => void" + "(value: any) => boolean" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "castsFrom", "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": [ + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59 + }, + "tags": [], + "returnComment": [] + }, { - "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, + "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 + } + }, + { + "type": "string", + "label": "toTypeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + } + } + ], "signature": [ + "(value: any, toTypeName: string, types: Record) => any" + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + }, + "tags": [], + "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 + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 + } } ], + "signature": [ + "(value: any, types: Record) => any" + ], "description": [], + "label": "from", "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" - } + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 + }, + "tags": [], + "returnComment": [] } ], - "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.buildExpression", - "type": "Function", - "label": "buildExpression", + "id": "def-public.FunctionsRegistry", + "type": "Class", + "tags": [], + "label": "FunctionsRegistry", + "description": [], "signature": [ - "(initialState: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" }, - " | ", + " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionBuilder", - "text": "ExpressionAstFunctionBuilder" + "section": "def-common.IRegistry", + "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - ">[] | 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, + "id": "def-public.FunctionsRegistry.Unnamed", + "type": "Function", + "label": "Constructor", "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" + "any" ], - "description": [ - "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." + "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 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 } - } - ], - "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, + "id": "def-public.FunctionsRegistry.register", + "type": "Function", + "label": "register", "signature": [ + "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.InferFunctionDefinition", - "text": "InferFunctionDefinition" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" }, - "[\"name\"]" + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void" ], - "description": [ - "String representing the name of this expression function." + "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 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 61 } }, { - "type": "Object", - "label": "initialArgs", - "isRequired": true, + "id": "def-public.FunctionsRegistry.get", + "type": "Function", + "label": "get", "signature": [ - "{ [K in keyof FunctionArgs]: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" - }, - " | FunctionArgs[K] | ", + "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - "[]; }" + " | null" ], - "description": [ - "Object containing the arguments to this function." + "description": [], + "children": [ + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67 + } + } ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67 } - } - ], - "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, + "id": "def-public.FunctionsRegistry.toJS", + "type": "Function", + "label": "toJS", "signature": [ - "T" + "() => Record" ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 71 } }, { - "type": "Uncategorized", - "label": "type", - "isRequired": true, + "id": "def-public.FunctionsRegistry.toArray", + "type": "Function", + "label": "toArray", "signature": [ - "T extends ", + "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - " ? \"expression\" : \"argument\"" + "[]" ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 75 } } ], - "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 58 }, "initialIsOpen": false }, { - "id": "def-public.formatExpression", - "type": "Function", - "label": "formatExpression", - "signature": [ - "(ast: ", + "id": "def-public.TablesAdapter", + "type": "Class", + "tags": [], + "label": "TablesAdapter", + "description": [], + "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.TablesAdapter", + "text": "TablesAdapter" }, - ") => string" - ], - "description": [ - "\nGiven expression pipeline AST, returns formatted string.\n" + " extends ", + "EventEmitter" ], "children": [ { - "type": "Object", - "label": "ast", - "isRequired": true, + "id": "def-public.TablesAdapter.logDatatable", + "type": "Function", + "label": "logDatatable", "signature": [ + "(name: string, datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "section": "def-common.Datatable", + "text": "Datatable" + }, + ") => void" ], - "description": [ - "Expression pipeline AST." + "description": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15 + } + }, + { + "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 + } + } ], + "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" + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 15 } - } - ], - "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." - ], + "id": "def-public.TablesAdapter.tables", + "type": "Object", + "label": "tables", + "tags": [], + "description": [], "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" - } + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 20 + }, + "signature": [ + "{ [key: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; }" + ] } ], - "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" + "path": "src/plugins/expressions/common/util/tables_adapter.ts", + "lineNumber": 12 }, "initialIsOpen": false }, { - "id": "def-public.parse", - "type": "Function", - "label": "parse", + "id": "def-public.TypesRegistry", + "type": "Class", + "tags": [], + "label": "TypesRegistry", + "description": [], "signature": [ - "(expression: E, startRule: S) => S extends \"expression\" ? ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" }, - " : ", + " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstArgument", - "text": "ExpressionAstArgument" - } + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + ">" ], - "description": [], "children": [ { - "type": "Uncategorized", - "label": "expression", - "isRequired": true, + "id": "def-public.TypesRegistry.Unnamed", + "type": "Function", + "label": "Constructor", "signature": [ - "E" + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 } }, { - "type": "Uncategorized", - "label": "startRule", - "isRequired": true, + "id": "def-public.TypesRegistry.register", + "type": "Function", + "label": "register", "signature": [ - "S" + "(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 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 39 } - } - ], - "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.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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 36 + }, + "initialIsOpen": false + } + ], + "functions": [ { - "id": "def-public.parseExpression", + "id": "def-public.buildExpression", "type": "Function", - "label": "parseExpression", + "label": "buildExpression", "signature": [ - "(expression: string) => ", + "(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": [ - "\nGiven expression pipeline string, returns parsed AST.\n" + "\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": "string", - "label": "expression", - "isRequired": true, + "type": "CompoundType", + "label": "initialState", + "isRequired": false, "signature": [ - "string" + "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": [ - "Expression pipeline string." + "Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`." ], "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 98 } } ], - "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": [], "tags": [ - "deprecated" + "return" ], - "children": [ - { - "tags": [], - "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" - } - ] - } + "returnComment": [ + "`this`" ], "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 97 }, "initialIsOpen": false }, { - "id": "def-public.IExpressionLoaderParams", - "type": "Interface", - "label": "IExpressionLoaderParams", - "description": [], - "tags": [], - "children": [ + "id": "def-public.buildExpressionFunction", + "type": "Function", + "label": "buildExpressionFunction", + "signature": [ + "(fnName: ", { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" }, + "[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ", { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, + " | FunctionArgs[K] | ", { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, + "[]; }) => ", { - "tags": [], - "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" - ] + "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": [ { - "tags": [], - "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" - }, + "type": "Uncategorized", + "label": "fnName", + "isRequired": true, "signature": [ - "[] | undefined" - ] - }, - { - "tags": [], - "id": "def-public.IExpressionLoaderParams.uiState", - "type": "Unknown", - "label": "uiState", - "description": [], + { + "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/public/types/index.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L44" - }, - "signature": [ - "unknown" - ] + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 155 + } }, { - "tags": [], - "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" - }, + "label": "initialArgs", + "isRequired": true, "signature": [ + "{ [K in keyof FunctionArgs]: ", { - "pluginId": "inspector", + "pluginId": "expressions", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - " | undefined" - ] - }, - { - "tags": [], - "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": [ + " | FunctionArgs[K] | ", { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.RenderErrorHandlerFnType", - "text": "RenderErrorHandlerFnType" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-public.IExpressionLoaderParams.searchSessionId", - "type": "string", - "label": "searchSessionId", - "description": [], + "[]; }" + ], + "description": [ + "Object containing the arguments to this function." + ], "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" - ] - }, + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 163 + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "`this`" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152 + }, + "initialIsOpen": false + }, + { + "id": "def-public.format", + "type": "Function", + "label": "format", + "signature": [ + "(ast: T, type: T extends ", { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, + " ? \"expression\" : \"argument\") => string" + ], + "description": [], + "children": [ { - "tags": [], - "id": "def-public.IExpressionLoaderParams.syncColors", - "type": "CompoundType", - "label": "syncColors", + "type": "Uncategorized", + "label": "ast", + "isRequired": true, + "signature": [ + "T" + ], "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" - ] + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 15 + } }, { - "tags": [], - "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" - }, + "type": "Uncategorized", + "label": "type", + "isRequired": true, "signature": [ - "((event: ", + "T extends ", { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRendererEvent", - "text": "ExpressionRendererEvent" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ") => Promise) | undefined" - ] + " ? \"expression\" : \"argument\"" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 16 + } } ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-public.ExpressionRenderError", - "type": "Interface", - "label": "ExpressionRenderError", + "id": "def-public.formatExpression", + "type": "Function", + "label": "formatExpression", "signature": [ + "(ast: ", { "pluginId": "expressions", - "scope": "public", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-public.ExpressionRenderError", - "text": "ExpressionRenderError" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " extends Error" + ") => 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 + } + } ], - "description": [], "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17 + }, + "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": [ { - "tags": [], - "id": "def-public.ExpressionRenderError.type", - "type": "string", - "label": "type", - "description": [], + "type": "Any", + "label": "val", + "isRequired": true, + "signature": [ + "any" + ], + "description": [ + "Value you want to check." + ], "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" - }, + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 + } + } + ], + "tags": [ + "return" + ], + "returnComment": [ + "boolean" + ], + "source": { + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 + }, + "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": [ - "string | undefined" - ] + "E" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 15 + } }, { - "tags": [], - "id": "def-public.ExpressionRenderError.original", - "type": "Object", - "label": "original", + "type": "Uncategorized", + "label": "startRule", + "isRequired": true, + "signature": [ + "S" + ], "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" - }, + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 16 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14 + }, + "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": [ - "Error | undefined" - ] + "string" + ], + "description": [ + "Expression pipeline string." + ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 + } } ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-public.ReactExpressionRendererProps", - "type": "Interface", - "label": "ReactExpressionRendererProps", + "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 + } + } + ], "signature": [ + "({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ", { "pluginId": "expressions", "scope": "public", @@ -6383,285 +5742,73 @@ "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, - " extends ", - { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.IExpressionLoaderParams", - "text": "IExpressionLoaderParams" - } + ") => JSX.Element" ], "description": [], + "label": "ReactExpressionRenderer", + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 57 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "id": "def-public.Datatable", + "type": "Interface", + "label": "Datatable", + "description": [ + "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." + ], "tags": [], "children": [ { "tags": [], - "id": "def-public.ReactExpressionRendererProps.className", + "id": "def-public.Datatable.type", "type": "string", - "label": "className", + "label": "type", "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 99 }, "signature": [ - "string | undefined" + "\"datatable\"" ] }, { "tags": [], - "id": "def-public.ReactExpressionRendererProps.dataAttrs", + "id": "def-public.Datatable.columns", "type": "Array", - "label": "dataAttrs", + "label": "columns", "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100 }, "signature": [ - "string[] | undefined" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" + }, + "[]" ] }, { "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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\"" - ] - }, - { - "tags": [], - "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" - }, - "[]" - ] - }, - { - "tags": [], - "id": "def-public.Datatable.rows", - "type": "Array", - "label": "rows", + "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" + "lineNumber": 101 }, "signature": [ "Record[]" @@ -6670,8 +5817,7 @@ ], "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" + "lineNumber": 98 }, "initialIsOpen": false }, @@ -6692,8 +5838,7 @@ "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" + "lineNumber": 90 } }, { @@ -6704,8 +5849,7 @@ "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" + "lineNumber": 91 } }, { @@ -6716,8 +5860,7 @@ "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" + "lineNumber": 92 }, "signature": [ { @@ -6732,8 +5875,7 @@ ], "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" + "lineNumber": 89 }, "initialIsOpen": false }, @@ -6766,8 +5908,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "() => ExecutionContextSearch" @@ -6783,8 +5924,7 @@ ], "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" + "lineNumber": 33 }, "signature": [ "Record" @@ -6800,8 +5940,7 @@ ], "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" + "lineNumber": 38 }, "signature": [ "Record string | undefined" @@ -6876,8 +6012,7 @@ ], "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" + "lineNumber": 60 }, "signature": [ "(() => ", @@ -6901,8 +6036,7 @@ ], "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" + "lineNumber": 71 }, "signature": [ "( boolean) | undefined" @@ -6952,8 +6085,7 @@ ], "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" + "lineNumber": 21 }, "initialIsOpen": false }, @@ -6972,8 +6104,7 @@ "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" + "lineNumber": 58 }, "signature": [ { @@ -6994,8 +6125,7 @@ "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" + "lineNumber": 59 }, "signature": [ { @@ -7016,8 +6146,7 @@ "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" + "lineNumber": 60 }, "signature": [ "string | undefined" @@ -7031,8 +6160,7 @@ "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" + "lineNumber": 61 }, "signature": [ { @@ -7047,8 +6175,7 @@ ], "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" + "lineNumber": 57 }, "initialIsOpen": false }, @@ -7085,8 +6212,7 @@ "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" + "lineNumber": 18 }, "signature": [ { @@ -7108,8 +6234,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "\"result\" | \"error\" | \"not-started\" | \"pending\"" @@ -7125,8 +6250,7 @@ ], "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" + "lineNumber": 33 }, "signature": [ "Output | undefined" @@ -7142,8 +6266,7 @@ ], "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" + "lineNumber": 38 }, "signature": [ "Error | undefined" @@ -7152,8 +6275,7 @@ ], "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" + "lineNumber": 17 }, "initialIsOpen": false }, @@ -7182,8 +6304,7 @@ "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" + "lineNumber": 17 }, "signature": [ "Record ", @@ -7388,8 +6502,7 @@ ], "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" + "lineNumber": 80 }, "signature": [ "() => string" @@ -7398,8 +6511,7 @@ ], "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" + "lineNumber": 44 }, "initialIsOpen": false }, @@ -7430,8 +6542,7 @@ ], "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" + "lineNumber": 63 }, "signature": [ "\"expression_function_builder\"" @@ -7447,8 +6558,7 @@ ], "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" + "lineNumber": 67 }, "signature": [ { @@ -7471,8 +6581,7 @@ ], "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" + "lineNumber": 74 }, "signature": [ "FunctionBuilderArguments" @@ -7490,8 +6599,7 @@ ], "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" + "lineNumber": 86 }, "signature": [ ">(name: A, value: ", @@ -7517,8 +6625,7 @@ ], "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" + "lineNumber": 99 }, "signature": [ ">(name: A) => (", @@ -7544,8 +6651,7 @@ ], "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" + "lineNumber": 111 }, "signature": [ ">(name: A, value: (", @@ -7571,8 +6677,7 @@ ], "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" + "lineNumber": 124 }, "signature": [ ">>(name: A) => this" @@ -7590,8 +6695,7 @@ ], "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" + "lineNumber": 130 }, "signature": [ "() => ", @@ -7616,8 +6720,7 @@ ], "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" + "lineNumber": 136 }, "signature": [ "() => string" @@ -7626,8 +6729,43 @@ ], "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" + "lineNumber": 57 + }, + "initialIsOpen": false + }, + { + "id": "def-public.ExpressionExecutor", + "type": "Interface", + "label": "ExpressionExecutor", + "description": [], + "tags": [ + "deprecated" + ], + "children": [ + { + "tags": [], + "id": "def-public.ExpressionExecutor.interpreter", + "type": "Object", + "label": "interpreter", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 25 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionInterpreter", + "text": "ExpressionInterpreter" + } + ] + } + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 24 }, "initialIsOpen": false }, @@ -7676,8 +6814,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ "Name" @@ -7693,8 +6830,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ "boolean | undefined" @@ -7710,8 +6846,7 @@ ], "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" + "lineNumber": 50 }, "signature": [ "\"date\" | \"filter\" | ", @@ -7737,8 +6872,7 @@ ], "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" + "lineNumber": 58 }, "signature": [ { @@ -7761,8 +6895,7 @@ ], "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" + "lineNumber": 64 }, "signature": [ "{ [key in keyof Arguments]: ", @@ -7786,8 +6919,7 @@ "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" + "lineNumber": 69 }, "signature": [ "string[] | undefined" @@ -7803,8 +6935,7 @@ ], "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" + "lineNumber": 75 } }, { @@ -7830,8 +6961,7 @@ ], "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" + "lineNumber": 86 } }, { @@ -7846,8 +6976,7 @@ ], "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" + "lineNumber": 86 } }, { @@ -7862,8 +6991,7 @@ ], "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" + "lineNumber": 86 } } ], @@ -7871,8 +6999,7 @@ "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" + "lineNumber": 86 } }, { @@ -7885,8 +7012,7 @@ "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" + "lineNumber": 91 }, "signature": [ "{ types: any[] | undefined; } | undefined" @@ -7895,8 +7021,7 @@ ], "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" + "lineNumber": 30 }, "initialIsOpen": false }, @@ -7919,8 +7044,7 @@ "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" + "lineNumber": 117 }, "signature": [ { @@ -7940,8 +7064,7 @@ "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" + "lineNumber": 118 }, "signature": [ { @@ -7961,8 +7084,7 @@ "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" + "lineNumber": 119 }, "signature": [ { @@ -7982,8 +7104,7 @@ "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" + "lineNumber": 120 }, "signature": [ { @@ -8003,8 +7124,7 @@ "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" + "lineNumber": 121 }, "signature": [ { @@ -8024,8 +7144,7 @@ "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" + "lineNumber": 122 }, "signature": [ { @@ -8045,8 +7164,7 @@ "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" + "lineNumber": 123 }, "signature": [ { @@ -8066,8 +7184,7 @@ "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" + "lineNumber": 124 }, "signature": [ { @@ -8082,8 +7199,7 @@ ], "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" + "lineNumber": 116 }, "initialIsOpen": false }, @@ -8102,8 +7218,7 @@ "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" + "lineNumber": 15 }, "signature": [ "\"image\"" @@ -8117,8 +7232,7 @@ "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" + "lineNumber": 16 } }, { @@ -8129,15 +7243,13 @@ "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" + "lineNumber": 17 } } ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -8168,8 +7280,7 @@ ], "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" + "lineNumber": 15 } }, { @@ -8182,8 +7293,7 @@ ], "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" + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -8199,8 +7309,7 @@ ], "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" + "lineNumber": 26 }, "signature": [ "string | undefined" @@ -8216,8 +7325,7 @@ ], "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" + "lineNumber": 31 }, "signature": [ "(() => Error | undefined) | undefined" @@ -8233,8 +7341,7 @@ ], "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" + "lineNumber": 37 } }, { @@ -8247,8 +7354,7 @@ ], "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" + "lineNumber": 42 }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", @@ -8265,925 +7371,870 @@ ], "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" + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-public.ExpressionTypeDefinition", + "id": "def-public.ExpressionRendererEvent", "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." - ], + "label": "ExpressionRendererEvent", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.ExpressionTypeDefinition.name", - "type": "Uncategorized", + "id": "def-public.ExpressionRendererEvent.name", + "type": "string", "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" - ] + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 28 + } }, { "tags": [], - "id": "def-public.ExpressionTypeDefinition.validate", - "type": "Function", - "label": "validate", + "id": "def-public.ExpressionRendererEvent.data", + "type": "Any", + "label": "data", "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" + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 29 }, "signature": [ - "((type: any) => void | Error) | undefined" + "any" ] + } + ], + "source": { + "path": "src/plugins/expressions/public/render.ts", + "lineNumber": 27 + }, + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.ExpressionTypeDefinition.serialize", - "type": "Function", - "label": "serialize", + "id": "def-public.ExpressionRenderError.type", + "type": "string", + "label": "type", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 54 }, "signature": [ - "((type: Value) => SerializedType) | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.ExpressionTypeDefinition.deserialize", - "type": "Function", - "label": "deserialize", + "id": "def-public.ExpressionRenderError.original", + "type": "Object", + "label": "original", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 55 }, "signature": [ - "((type: SerializedType) => Value) | undefined" + "Error | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 53 + }, + "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." + ], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.ExpressionTypeDefinition.from", - "type": "Object", - "label": "from", - "description": [], + "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/expression_types/types.ts", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 78 }, "signature": [ - "{ [type: string]: ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueConverter", - "text": "ExpressionValueConverter" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - "; } | undefined" + " | undefined" ] }, { "tags": [], - "id": "def-public.ExpressionTypeDefinition.to", - "type": "Object", - "label": "to", - "description": [], + "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/expression_types/types.ts", - "lineNumber": 40, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 86 }, "signature": [ - "{ [type: string]: ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueConverter", - "text": "ExpressionValueConverter" + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" }, - "; } | undefined" + " | null" ] }, { "tags": [], - "id": "def-public.ExpressionTypeDefinition.help", - "type": "string", - "label": "help", - "description": [], + "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/expression_types/types.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 94 }, "signature": [ - "string | undefined" + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | 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." - ], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.ExpressionTypeStyle.type", - "type": "string", - "label": "type", - "description": [], + "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/types/style.ts", - "lineNumber": 121, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 120 }, "signature": [ - "\"style\"" + "(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" ] }, { "tags": [], - "id": "def-public.ExpressionTypeStyle.spec", - "type": "Object", - "label": "spec", - "description": [], + "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/types/style.ts", - "lineNumber": 122, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 131 }, "signature": [ + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.CSSStyle", - "text": "CSSStyle" - } + "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" + }, + "" ] }, { "tags": [], - "id": "def-public.ExpressionTypeStyle.css", - "type": "string", - "label": "css", - "description": [], + "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/types/style.ts", - "lineNumber": 123, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123" - } + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 147 + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ] } ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 71 }, "initialIsOpen": false }, { - "id": "def-public.Font", + "id": "def-public.ExpressionTypeDefinition", "type": "Interface", - "label": "Font", - "description": [ - "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." - ], - "tags": [], - "children": [ + "label": "ExpressionTypeDefinition", + "signature": [ { - "tags": [], - "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\"" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" }, - { - "tags": [], - "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\"" - ] - } + "" + ], + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." ], - "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": [], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-public.IInterpreterRenderHandlers.onDestroy", - "type": "Function", - "label": "onDestroy", + "id": "def-public.ExpressionTypeDefinition.name", + "type": "Uncategorized", + "label": "name", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 31 }, "signature": [ - "(fn: () => void) => void" + "Name" ] }, { "tags": [], - "id": "def-public.IInterpreterRenderHandlers.reload", + "id": "def-public.ExpressionTypeDefinition.validate", "type": "Function", - "label": "reload", + "label": "validate", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 32 }, "signature": [ - "() => void" + "((type: any) => void | Error) | undefined" ] }, { "tags": [], - "id": "def-public.IInterpreterRenderHandlers.update", + "id": "def-public.ExpressionTypeDefinition.serialize", "type": "Function", - "label": "update", + "label": "serialize", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 33 }, "signature": [ - "(params: any) => void" + "((type: Value) => SerializedType) | undefined" ] }, { "tags": [], - "id": "def-public.IInterpreterRenderHandlers.event", + "id": "def-public.ExpressionTypeDefinition.deserialize", "type": "Function", - "label": "event", + "label": "deserialize", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 34 }, "signature": [ - "(event: any) => void" + "((type: SerializedType) => Value) | undefined" ] }, { "tags": [], - "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions", - "type": "Function", - "label": "hasCompatibleActions", + "id": "def-public.ExpressionTypeDefinition.from", + "type": "Object", + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37 }, "signature": [ - "((event: any) => Promise) | undefined" + "{ [type: string]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" ] }, { "tags": [], - "id": "def-public.IInterpreterRenderHandlers.getRenderMode", - "type": "Function", - "label": "getRenderMode", + "id": "def-public.ExpressionTypeDefinition.to", + "type": "Object", + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40 }, "signature": [ - "() => ", + "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.RenderMode", - "text": "RenderMode" - } + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" + }, + "; } | undefined" ] }, { "tags": [], - "id": "def-public.IInterpreterRenderHandlers.isSyncColorsEnabled", - "type": "Function", - "label": "isSyncColorsEnabled", + "id": "def-public.ExpressionTypeDefinition.help", + "type": "string", + "label": "help", "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" - ] - }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 43 }, "signature": [ - "unknown" + "string | undefined" ] } ], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26 }, "initialIsOpen": false }, { - "id": "def-public.IRegistry", + "id": "def-public.ExpressionTypeStyle", "type": "Interface", - "label": "IRegistry", - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.IRegistry", - "text": "IRegistry" - }, - "" + "label": "ExpressionTypeStyle", + "description": [ + "\nAn object that represents style information, typically CSS." ], - "description": [], "tags": [], "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": [], + "id": "def-public.ExpressionTypeStyle.type", + "type": "string", + "label": "type", + "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" - } + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 121 + }, + "signature": [ + "\"style\"" + ] }, { - "id": "def-public.IRegistry.toJS", - "type": "Function", - "label": "toJS", - "signature": [ - "() => Record" - ], - "description": [], - "children": [], "tags": [], - "returnComment": [], + "id": "def-public.ExpressionTypeStyle.spec", + "type": "Object", + "label": "spec", + "description": [], "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" - } + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.CSSStyle", + "text": "CSSStyle" + } + ] }, { - "id": "def-public.IRegistry.toArray", - "type": "Function", - "label": "toArray", - "signature": [ - "() => T[]" - ], - "description": [], - "children": [], "tags": [], - "returnComment": [], + "id": "def-public.ExpressionTypeStyle.css", + "type": "string", + "label": "css", + "description": [], "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 123 } } ], "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120 }, "initialIsOpen": false }, { - "id": "def-public.PointSeriesColumn", + "id": "def-public.Font", "type": "Interface", - "label": "PointSeriesColumn", + "label": "Font", "description": [ - "\nColumn in a PointSeries" + "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." ], "tags": [], "children": [ { "tags": [], - "id": "def-public.PointSeriesColumn.type", + "id": "def-public.Font.label", "type": "CompoundType", - "label": "type", + "label": "label", "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" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 26 }, "signature": [ - "\"string\" | \"number\"" + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" ] }, { "tags": [], - "id": "def-public.PointSeriesColumn.role", + "id": "def-public.Font.value", "type": "CompoundType", - "label": "role", + "label": "value", "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" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 27 }, "signature": [ - "\"measure\" | \"dimension\"" + "\"'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\"" ] - }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-public.Range", + "id": "def-public.IExpressionLoaderParams", "type": "Interface", - "label": "Range", + "label": "IExpressionLoaderParams", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.Range.type", - "type": "string", - "label": "type", + "id": "def-public.IExpressionLoaderParams.searchContext", + "type": "Object", + "label": "searchContext", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 36 }, "signature": [ - "\"range\"" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined" ] }, { "tags": [], - "id": "def-public.Range.from", - "type": "number", - "label": "from", + "id": "def-public.IExpressionLoaderParams.context", + "type": "Any", + "label": "context", "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" - } + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 37 + }, + "signature": [ + "any" + ] }, { "tags": [], - "id": "def-public.Range.to", - "type": "number", - "label": "to", + "id": "def-public.IExpressionLoaderParams.variables", + "type": "Object", + "label": "variables", "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" - } + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 38 + }, + "signature": [ + "Record | undefined" + ] }, { "tags": [], - "id": "def-public.Range.label", - "type": "string", - "label": "label", + "id": "def-public.IExpressionLoaderParams.debug", + "type": "CompoundType", + "label": "debug", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 40 }, "signature": [ - "string | undefined" + "boolean | 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": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-public.SerializedDatatable.rows", - "type": "Array", - "label": "rows", + "id": "def-public.IExpressionLoaderParams.disableCaching", + "type": "CompoundType", + "label": "disableCaching", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 41 }, "signature": [ - "string[][]" + "boolean | undefined" ] - } - ], - "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." - ], - "tags": [], - "children": [ { "tags": [], - "id": "def-public.SerializedFieldFormat.id", - "type": "string", - "label": "id", + "id": "def-public.IExpressionLoaderParams.customFunctions", + "type": "Object", + "label": "customFunctions", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 42 }, "signature": [ - "string | undefined" + "[] | undefined" ] }, { "tags": [], - "id": "def-public.SerializedFieldFormat.params", - "type": "Uncategorized", - "label": "params", + "id": "def-public.IExpressionLoaderParams.customRenderers", + "type": "Object", + "label": "customRenderers", "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 43 }, "signature": [ - "TParams | undefined" + "[] | 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." - ], - "tags": [], - "children": [ + }, { "tags": [], - "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." - ], + "id": "def-public.IExpressionLoaderParams.uiState", + "type": "Unknown", + "label": "uiState", + "description": [], "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 44 }, "signature": [ - "(name: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - " | undefined" + "unknown" ] }, { "tags": [], - "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." - ], + "id": "def-public.IExpressionLoaderParams.inspectorAdapters", + "type": "Object", + "label": "inspectorAdapters", + "description": [], "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 45 }, "signature": [ - "(name: string) => ", { - "pluginId": "expressions", + "pluginId": "inspector", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderer", - "text": "ExpressionRenderer" + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" }, - " | null" + " | undefined" ] }, { "tags": [], - "id": "def-public.ExpressionsServiceStart.getType", + "id": "def-public.IExpressionLoaderParams.onRenderError", "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." - ], + "label": "onRenderError", + "description": [], "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 46 }, "signature": [ - "(name: string) => ", { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-public.RenderErrorHandlerFnType", + "text": "RenderErrorHandlerFnType" }, " | undefined" ] }, { "tags": [], - "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" - }, + "id": "def-public.IExpressionLoaderParams.searchSessionId", + "type": "string", + "label": "searchSessionId", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 47 + }, "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" + "string | undefined" ] }, { "tags": [], - "id": "def-public.ExpressionsServiceStart.execute", + "id": "def-public.IExpressionLoaderParams.renderMode", + "type": "CompoundType", + "label": "renderMode", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 48 + }, + "signature": [ + "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.syncColors", + "type": "CompoundType", + "label": "syncColors", + "description": [], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 49 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IExpressionLoaderParams.hasCompatibleActions", "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." - ], + "label": "hasCompatibleActions", + "description": [], "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" + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 50 }, "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) => ", + "((event: ", { "pluginId": "expressions", - "scope": "common", + "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContract", - "text": "ExecutionContract" + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" }, - "" + ") => Promise) | undefined" ] - }, + } + ], + "source": { + "path": "src/plugins/expressions/public/types/index.ts", + "lineNumber": 35 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IInterpreterRenderHandlers", + "type": "Interface", + "label": "IInterpreterRenderHandlers", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.ExpressionsServiceStart.fork", + "id": "def-public.IInterpreterRenderHandlers.done", "type": "Function", - "label": "fork", + "label": "done", "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." + "\nDone increments the number of rendering successes" ], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 67 + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.onDestroy", + "type": "Function", + "label": "onDestroy", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68 + }, + "signature": [ + "(fn: () => void) => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.reload", + "type": "Function", + "label": "reload", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 69 + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.update", + "type": "Function", + "label": "update", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70 + }, + "signature": [ + "(params: any) => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.event", + "type": "Function", + "label": "event", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71 + }, + "signature": [ + "(event: any) => void" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions", + "type": "Function", + "label": "hasCompatibleActions", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 72 + }, + "signature": [ + "((event: any) => Promise) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.getRenderMode", + "type": "Function", + "label": "getRenderMode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73 }, "signature": [ "() => ", @@ -9191,135 +8242,258 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" + "section": "def-common.RenderMode", + "text": "RenderMode" } ] + }, + { + "tags": [], + "id": "def-public.IInterpreterRenderHandlers.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 74 + }, + "signature": [ + "() => boolean" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "unknown" + ] } ], "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", - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63 }, "initialIsOpen": false }, { - "id": "def-public.FontWeight", - "type": "Enum", - "label": "FontWeight", - "tags": [], - "description": [ - "\nEnum of supported CSS `font-weight` properties." + "id": "def-public.IRegistry", + "type": "Interface", + "label": "IRegistry", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "" ], - "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": [], "tags": [], - "description": [ - "\nEnum of supported CSS `overflow` properties." + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10 + } + }, + { + "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 + } + }, + { + "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 + } + } ], "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" + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-public.TextAlignment", - "type": "Enum", - "label": "TextAlignment", - "tags": [], + "id": "def-public.PointSeriesColumn", + "type": "Interface", + "label": "PointSeriesColumn", "description": [ - "\nEnum of supported CSS `text-align` properties." + "\nColumn in a PointSeries" ], - "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", "tags": [], - "description": [ - "\nEnum of supported CSS `text-decoration` properties." + "children": [ + { + "tags": [], + "id": "def-public.PointSeriesColumn.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 24 + }, + "signature": [ + "\"string\" | \"number\"" + ] + }, + { + "tags": [], + "id": "def-public.PointSeriesColumn.role", + "type": "CompoundType", + "label": "role", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 25 + }, + "signature": [ + "\"measure\" | \"dimension\"" + ] + }, + { + "tags": [], + "id": "def-public.PointSeriesColumn.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 26 + } + } ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23 }, "initialIsOpen": false - } - ], - "misc": [ + }, { - "id": "def-public.ExpressionRendererComponent", - "type": "Type", - "label": "ExpressionRendererComponent", - "tags": [], + "id": "def-public.Range", + "type": "Interface", + "label": "Range", "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<", + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "public", - "docId": "kibExpressionsPluginApi", - "section": "def-public.ReactExpressionRendererProps", - "text": "ReactExpressionRendererProps" + "tags": [], + "id": "def-public.Range.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 15 + }, + "signature": [ + "\"range\"" + ] }, - ">, context: any) => React.ReactElement | null" + { + "tags": [], + "id": "def-public.Range.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-public.Range.to", + "type": "number", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-public.Range.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 18 + }, + "signature": [ + "string | undefined" + ] + } ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14 + }, "initialIsOpen": false }, { - "id": "def-public.ReactExpressionRendererType", - "type": "Type", - "label": "ReactExpressionRendererType", - "tags": [], - "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" - }, + "id": "def-public.ReactExpressionRendererProps", + "type": "Interface", + "label": "ReactExpressionRendererProps", "signature": [ - "React.ComponentClass<", { "pluginId": "expressions", "scope": "public", @@ -9327,110 +8501,437 @@ "section": "def-public.ReactExpressionRendererProps", "text": "ReactExpressionRendererProps" }, - ", any> | React.FunctionComponent<", + " extends ", { "pluginId": "expressions", "scope": "public", "docId": "kibExpressionsPluginApi", - "section": "def-public.ReactExpressionRendererProps", - "text": "ReactExpressionRendererProps" - }, - ">" + "section": "def-public.IExpressionLoaderParams", + "text": "IExpressionLoaderParams" + } ], - "initialIsOpen": false - }, - { - "id": "def-public.AnyExpressionFunctionDefinition", - "type": "Type", - "label": "AnyExpressionFunctionDefinition", + "description": [], "tags": [], - "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<", + "children": [ { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "tags": [], + "id": "def-public.ReactExpressionRendererProps.className", + "type": "string", + "label": "className", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 24 + }, + "signature": [ + "string | undefined" + ] }, - ", ", - "SerializableState", - ">>" + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.dataAttrs", + "type": "Array", + "label": "dataAttrs", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 25 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.expression", + "type": "CompoundType", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 26 + }, + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.renderError", + "type": "Function", + "label": "renderError", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 27 + }, + "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" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.padding", + "type": "CompoundType", + "label": "padding", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 31 + }, + "signature": [ + "\"m\" | \"s\" | \"l\" | \"xs\" | \"xl\" | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.onEvent", + "type": "Function", + "label": "onEvent", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 32 + }, + "signature": [ + "((event: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ") => void) | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.onData$", + "type": "Function", + "label": "onData$", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 33 + }, + "signature": [ + "((data: TData, adapters?: TInspectorAdapters | undefined) => void) | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "Observable", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ReactExpressionRendererProps.debounce", + "type": "number", + "label": "debounce", + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 38 + }, + "signature": [ + "number | undefined" + ] + } ], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 23 + }, "initialIsOpen": false }, { - "id": "def-public.AnyExpressionTypeDefinition", - "type": "Type", - "label": "AnyExpressionTypeDefinition", - "tags": [], + "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": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SerializedDatatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 105 + }, + "signature": [ + "string[][]" + ] + } + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104 }, - "signature": [ - "ExpressionTypeDefinition" - ], "initialIsOpen": false }, { - "id": "def-public.ArgumentType", - "type": "Type", - "label": "ArgumentType", - "tags": [], + "id": "def-public.SerializedFieldFormat", + "type": "Interface", + "label": "SerializedFieldFormat", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "" + ], "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." + "\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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.SerializedFieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 54 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SerializedFieldFormat.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55 + }, + "signature": [ + "TParams | undefined" + ] + } ], "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" + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 53 }, - "signature": [ - "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" - ], "initialIsOpen": false - }, + } + ], + "enums": [ { - "id": "def-public.DatatableColumnType", - "type": "Type", - "label": "DatatableColumnType", + "id": "def-public.FontStyle", + "type": "Enum", + "label": "FontStyle", "tags": [], "description": [ - "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" + "\nEnum of supported CSS `font-style` properties." ], "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 35 }, - "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", + "id": "def-public.FontWeight", + "type": "Enum", + "label": "FontWeight", + "tags": [], + "description": [ + "\nEnum of supported CSS `font-weight` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 43 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Overflow", + "type": "Enum", + "label": "Overflow", + "tags": [], + "description": [ + "\nEnum of supported CSS `overflow` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 62 + }, + "initialIsOpen": false + }, + { + "id": "def-public.TextAlignment", + "type": "Enum", + "label": "TextAlignment", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-align` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 72 + }, + "initialIsOpen": false + }, + { + "id": "def-public.TextDecoration", + "type": "Enum", + "label": "TextDecoration", + "tags": [], + "description": [ + "\nEnum of supported CSS `text-decoration` properties." + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 82 + }, + "initialIsOpen": false + } + ], + "misc": [ + { + "id": "def-public.AnyExpressionFunctionDefinition", + "type": "Type", + "label": "AnyExpressionFunctionDefinition", + "tags": [], + "description": [ + "\nType to capture every possible expression function definition." + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102 + }, + "signature": [ + "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-public.AnyExpressionTypeDefinition", + "type": "Type", + "label": "AnyExpressionTypeDefinition", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 46 + }, + "signature": [ + "ExpressionTypeDefinition" + ], + "initialIsOpen": false + }, + { + "id": "def-public.ArgumentType", + "type": "Type", + "label": "ArgumentType", + "tags": [], + "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 + }, + "signature": [ + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + ], + "initialIsOpen": false + }, + { + "id": "def-public.DatatableColumnType", + "type": "Type", + "label": "DatatableColumnType", + "tags": [], + "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 + }, + "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", "tags": [], "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" + "lineNumber": 57 }, "signature": [ "{ [x: string]: any; }" @@ -9445,8 +8946,7 @@ "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" + "lineNumber": 73 }, "signature": [ "StateContainer, ExecutionPureTransitions, {}>" @@ -9461,8 +8961,7 @@ "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" + "lineNumber": 55 }, "signature": [ "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" @@ -9477,8 +8976,7 @@ "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" + "lineNumber": 77 }, "signature": [ "string | number | false | true | ", @@ -9500,8 +8998,7 @@ "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" + "lineNumber": 16 }, "signature": [ "{ type: 'expression'; chain: ExpressionAstFunction[]; }" @@ -9516,8 +9013,7 @@ "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" + "lineNumber": 21 }, "signature": [ "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" @@ -9532,8 +9028,7 @@ "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" + "lineNumber": 11 }, "signature": [ "string | number | false | true | ", @@ -9555,6 +9050,29 @@ ], "initialIsOpen": false }, + { + "id": "def-public.ExpressionRendererComponent", + "type": "Type", + "label": "ExpressionRendererComponent", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 49 + }, + "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.ExpressionValue", "type": "Type", @@ -9563,8 +9081,7 @@ "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" + "lineNumber": 15 }, "signature": [ "any" @@ -9579,8 +9096,7 @@ "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" + "lineNumber": 11 }, "signature": [ "{ type: Type; } & Value" @@ -9595,8 +9111,7 @@ "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" + "lineNumber": 17 }, "signature": [ "(input: I, availableTypes: Record) => O" @@ -9611,14 +9126,30 @@ "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" + "lineNumber": 17 }, "signature": [ "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "initialIsOpen": false }, + { + "id": "def-public.ExpressionValueFilter", + "type": "Type", + "label": "ExpressionValueFilter", + "tags": [], + "description": [ + "\nRepresents an object that is a Filter." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 14 + }, + "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.ExpressionValueNum", "type": "Type", @@ -9627,8 +9158,7 @@ "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" + "lineNumber": 14 }, "signature": [ "{ type: \"num\"; } & { value: number; }" @@ -9645,8 +9175,7 @@ ], "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" + "lineNumber": 16 }, "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" @@ -9654,36 +9183,34 @@ "initialIsOpen": false }, { - "id": "def-public.ExpressionValueUnboxed", + "id": "def-public.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueUnboxed", + "label": "ExpressionValueRender", "tags": [], - "description": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16 }, "signature": [ - "any" + "{ type: \"render\"; } & { as: string; value: T; }" ], "initialIsOpen": false }, { - "id": "def-public.ExpressionValueFilter", + "id": "def-public.ExpressionValueUnboxed", "type": "Type", - "label": "ExpressionValueFilter", + "label": "ExpressionValueUnboxed", "tags": [], - "description": [ - "\nRepresents an object that is a Filter." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 9 }, "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + "any" ], "initialIsOpen": false }, @@ -9697,8 +9224,7 @@ ], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13" + "lineNumber": 13 }, "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\"" @@ -9715,8 +9241,7 @@ ], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19" + "lineNumber": 19 }, "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\"" @@ -9733,8 +9258,7 @@ "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" + "lineNumber": 33 }, "signature": [ "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" @@ -9751,8 +9275,7 @@ ], "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" + "lineNumber": 26 }, "signature": [ "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" @@ -9769,8 +9292,7 @@ ], "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" + "lineNumber": 39 }, "signature": [ "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" @@ -9787,8 +9309,7 @@ ], "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" + "lineNumber": 18 }, "signature": [ "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" @@ -9805,8 +9326,7 @@ ], "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" + "lineNumber": 32 }, "signature": [ "{} | Record<", @@ -9837,14 +9357,44 @@ "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" + "lineNumber": 34 }, "signature": [ "{ [x: string]: any; }" ], "initialIsOpen": false }, + { + "id": "def-public.ReactExpressionRendererType", + "type": "Type", + "label": "ReactExpressionRendererType", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "lineNumber": 41 + }, + "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.Style", "type": "Type", @@ -9853,8 +9403,7 @@ "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" + "lineNumber": 126 }, "signature": [ "ExpressionTypeStyle" @@ -9871,8 +9420,7 @@ ], "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" + "lineNumber": 39 }, "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" @@ -9889,8 +9437,7 @@ ], "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" + "lineNumber": 17 }, "signature": [ "\"date\" | \"filter\" | ", @@ -9915,31 +9462,12 @@ ], "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" + "lineNumber": 46 }, "signature": [ "\"date\" | \"filter\"" ], "initialIsOpen": false - }, - { - "id": "def-public.ExpressionValueRender", - "type": "Type", - "label": "ExpressionValueRender", - "tags": [], - "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": [], @@ -9953,8 +9481,7 @@ ], "source": { "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L24" + "lineNumber": 24 }, "signature": [ "{ readonly getType: (name: string) => ", @@ -10035,8 +9562,7 @@ "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L30" + "lineNumber": 30 }, "signature": [ "typeof ", @@ -10057,8 +9583,7 @@ "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L31" + "lineNumber": 31 }, "signature": [ "typeof ", @@ -10079,8 +9604,7 @@ "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L32" + "lineNumber": 32 }, "signature": [ { @@ -10100,8 +9624,7 @@ "description": [], "source": { "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L33" + "lineNumber": 33 }, "signature": [ "({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ", @@ -10123,8 +9646,7 @@ "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" + "lineNumber": 34 }, "signature": [ "typeof ", @@ -10140,8 +9662,7 @@ ], "source": { "path": "src/plugins/expressions/public/plugin.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L29" + "lineNumber": 29 }, "lifecycle": "start", "initialIsOpen": true @@ -10150,256 +9671,22 @@ "server": { "classes": [ { - "id": "def-server.ExpressionsServerPlugin", + "id": "def-server.Execution", "type": "Class", "tags": [], - "label": "ExpressionsServerPlugin", + "label": "Execution", "description": [], "signature": [ { "pluginId": "expressions", - "scope": "server", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-server.ExpressionsServerPlugin", - "text": "ExpressionsServerPlugin" - }, - " implements ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" + "section": "def-common.Execution", + "text": "Execution" }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsServiceStart", - "text": "ExpressionsServiceStart" - }, - ", object, object>" - ], - "children": [ - { - "tags": [], - "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", - "tags": [], - "label": "Execution", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Execution", - "text": "Execution" - }, - "" - ], - "children": [ + "" + ], + "children": [ { "tags": [], "id": "def-server.Execution.state", @@ -10410,8 +9697,7 @@ ], "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" + "lineNumber": 80 }, "signature": [ { @@ -10458,8 +9744,7 @@ ], "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" + "lineNumber": 88 }, "signature": [ "Input" @@ -10475,8 +9760,7 @@ ], "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" + "lineNumber": 94 }, "signature": [ { @@ -10507,8 +9791,7 @@ ], "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" + "lineNumber": 134 }, "signature": [ { @@ -10529,8 +9812,7 @@ "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" + "lineNumber": 140 } }, { @@ -10541,8 +9823,7 @@ "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" + "lineNumber": 142 }, "signature": [ "Promise" @@ -11537,8 +10774,7 @@ ], "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" + "lineNumber": 160 } }, { @@ -11553,8 +10789,7 @@ ], "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" + "lineNumber": 161 } }, { @@ -11573,8 +10808,7 @@ "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" + "lineNumber": 162 } } ], @@ -11582,8 +10816,7 @@ "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" + "lineNumber": 159 } }, { @@ -11644,8 +10877,7 @@ "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" + "lineNumber": 170 } }, { @@ -11664,8 +10896,7 @@ "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" + "lineNumber": 171 } } ], @@ -11673,8 +10904,7 @@ "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" + "lineNumber": 169 } }, { @@ -11725,8 +10955,7 @@ "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" + "lineNumber": 217 } }, { @@ -11746,8 +10975,7 @@ "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" + "lineNumber": 217 } } ], @@ -11755,8 +10983,7 @@ "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" + "lineNumber": 217 } }, { @@ -11808,8 +11035,7 @@ "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" + "lineNumber": 223 } } ], @@ -11817,8 +11043,7 @@ "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" + "lineNumber": 223 } }, { @@ -11854,8 +11079,7 @@ "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" + "lineNumber": 233 } }, { @@ -11868,8 +11092,7 @@ "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" + "lineNumber": 233 } } ], @@ -11877,8 +11100,7 @@ "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" + "lineNumber": 233 } }, { @@ -11921,8 +11143,7 @@ "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" + "lineNumber": 241 } }, { @@ -11935,8 +11156,7 @@ "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" + "lineNumber": 241 } } ], @@ -11944,8 +11164,7 @@ "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" + "lineNumber": 241 } }, { @@ -11969,15 +11188,13 @@ "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" + "lineNumber": 250 } } ], "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" + "lineNumber": 80 }, "initialIsOpen": false }, @@ -12024,8 +11241,7 @@ ], "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" + "lineNumber": 22 } }, { @@ -12038,8 +11254,7 @@ ], "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" + "lineNumber": 27 }, "signature": [ "string[]" @@ -12055,8 +11270,7 @@ ], "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" + "lineNumber": 34 } }, { @@ -12069,8 +11283,7 @@ ], "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" + "lineNumber": 39 }, "signature": [ "(input: any, params: Record, handlers: object) => any" @@ -12086,8 +11299,7 @@ ], "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" + "lineNumber": 44 } }, { @@ -12101,8 +11313,7 @@ "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" + "lineNumber": 49 } }, { @@ -12115,8 +11326,7 @@ ], "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" + "lineNumber": 54 }, "signature": [ "string[] | undefined" @@ -12130,8 +11340,7 @@ "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" + "lineNumber": 56 } }, { @@ -12142,8 +11351,7 @@ "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" + "lineNumber": 57 }, "signature": [ "(state: Record void | Error" @@ -12640,8 +11821,7 @@ "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" + "lineNumber": 16 } }, { @@ -12652,8 +11832,7 @@ "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" + "lineNumber": 17 }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", @@ -12693,8 +11872,7 @@ "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" + "lineNumber": 19 } } ], @@ -12702,15 +11880,13 @@ "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" + "lineNumber": 19 } } ], "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" + "lineNumber": 11 }, "initialIsOpen": false }, @@ -12797,8 +11973,7 @@ "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" + "lineNumber": 19 } } ], @@ -12806,8 +11981,7 @@ "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" + "lineNumber": 19 } }, { @@ -12837,8 +12011,7 @@ "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" + "lineNumber": 25 } } ], @@ -12846,8 +12019,7 @@ "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" + "lineNumber": 25 } }, { @@ -12871,8 +12043,7 @@ "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" + "lineNumber": 29 } }, { @@ -12896,117 +12067,79 @@ "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" + "lineNumber": 39 } } ], "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" + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-server.ExpressionType", + "id": "def-server.ExpressionsServerPlugin", "type": "Class", "tags": [], - "label": "ExpressionType", + "label": "ExpressionsServerPlugin", "description": [], - "children": [ + "signature": [ { - "tags": [], - "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" - } + "pluginId": "expressions", + "scope": "server", + "docId": "kibExpressionsPluginApi", + "section": "def-server.ExpressionsServerPlugin", + "text": "ExpressionsServerPlugin" }, + " implements ", { - "tags": [], - "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" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, + " void | Error" - ] - }, - { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" }, + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">, ", { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" }, + ", object, object>" + ], + "children": [ { "tags": [], - "id": "def-server.ExpressionType.deserialize", - "type": "Function", - "label": "deserialize", + "id": "def-server.ExpressionsServerPlugin.expressions", + "type": "Object", + "label": "expressions", "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 18 }, "signature": [ - "((serialized: any) => any) | undefined" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } ] }, { - "id": "def-server.ExpressionType.Unnamed", + "id": "def-server.ExpressionsServerPlugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -13016,358 +12149,222 @@ "children": [ { "type": "Object", - "label": "definition", + "label": "initializerContext", "isRequired": true, "signature": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20 } } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20 } }, { - "id": "def-server.ExpressionType.getToFn", + "id": "def-server.ExpressionsServerPlugin.setup", "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" - } - } - ], + "label": "setup", "signature": [ - "(typeName: string) => ", + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ") => Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueConverter", - "text": "ExpressionValueConverter" + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" }, - " | undefined" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.ExpressionType.getFromFn", - "type": "Function", "children": [ { - "type": "string", - "label": "typeName", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22 + } + }, + { + "id": "def-server.ExpressionsServerPlugin.start", + "type": "Function", + "label": "start", "signature": [ - "(typeName: string) => ", + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueConverter", - "text": "ExpressionValueConverter" - }, - " | undefined" + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } ], "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.ExpressionType.castsTo", - "type": "Function", "children": [ { - "type": "Any", - "label": "value", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32 + } }, { - "id": "def-server.ExpressionType.castsFrom", + "id": "def-server.ExpressionsServerPlugin.stop", "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" - } - } - ], + "label": "stop", "signature": [ - "(value: any) => boolean" + "() => void" ], "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" - }, + "children": [], "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 38 + } + } + ], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-server.ExpressionsServerPlugin", + "type": "Class", + "tags": [], + "label": "ExpressionsServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "server", + "docId": "kibExpressionsPluginApi", + "section": "def-server.ExpressionsServerPlugin", + "text": "ExpressionsServerPlugin" }, + " implements ", { - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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", - "tags": [], - "label": "FunctionsRegistry", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.FunctionsRegistry", - "text": "FunctionsRegistry" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, - " implements ", + ", ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" }, - ">" + ", object, object>" ], "children": [ { - "id": "def-server.FunctionsRegistry.Unnamed", + "tags": [], + "id": "def-server.ExpressionsServerPlugin.expressions", + "type": "Object", + "label": "expressions", + "description": [], + "source": { + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 18 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" + } + ] + }, + { + "id": "def-server.ExpressionsServerPlugin.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -13377,230 +12374,252 @@ "children": [ { "type": "Object", - "label": "executor", + "label": "initializerContext", "isRequired": true, "signature": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" }, - "" + "" ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20 } } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 20 } }, { - "id": "def-server.FunctionsRegistry.register", + "id": "def-server.ExpressionsServerPlugin.setup", "type": "Function", - "label": "register", + "label": "setup", "signature": [ - "(functionDefinition: ", + "(core: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" }, - " | (() => ", + ") => Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" }, - ")) => void" + ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "functionDefinition", + "type": "Object", + "label": "core", "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" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" }, - ")" + "" ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22 } } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 22 } }, { - "id": "def-server.FunctionsRegistry.get", + "id": "def-server.ExpressionsServerPlugin.start", "type": "Function", - "label": "get", + "label": "start", "signature": [ - "(id: string) => ", + "(core: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" }, - " | null" + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionsServiceStart", + "text": "ExpressionsServiceStart" + } ], "description": [], "children": [ { - "type": "string", - "label": "id", + "type": "Object", + "label": "core", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32 } } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 32 } }, { - "id": "def-server.FunctionsRegistry.toArray", + "id": "def-server.ExpressionsServerPlugin.stop", "type": "Function", - "label": "toArray", + "label": "stop", "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - "[]" + "() => void" ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 38 } } ], "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" + "path": "src/plugins/expressions/server/plugin.ts", + "lineNumber": 16 }, "initialIsOpen": false }, { - "id": "def-server.TypesRegistry", + "id": "def-server.ExpressionType", "type": "Class", "tags": [], - "label": "TypesRegistry", + "label": "ExpressionType", "description": [], - "signature": [ + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.TypesRegistry", - "text": "TypesRegistry" + "tags": [], + "id": "def-server.ExpressionType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 13 + } }, - " implements ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.IRegistry", - "text": "IRegistry" + "tags": [], + "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 + } }, - "<", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "tags": [], + "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 + }, + "signature": [ + "(type: any) => void | Error" + ] }, - ">" - ], - "children": [ { - "id": "def-server.TypesRegistry.Unnamed", + "tags": [], + "id": "def-server.ExpressionType.create", + "type": "Unknown", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 25 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "((value: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ExpressionType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 31 + }, + "signature": [ + "((serialized: any) => any) | undefined" + ] + }, + { + "id": "def-server.ExpressionType.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -13610,143 +12629,221 @@ "children": [ { "type": "Object", - "label": "executor", + "label": "definition", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + } ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 } } ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 } }, { - "id": "def-server.TypesRegistry.register", + "id": "def-server.ExpressionType.getToFn", "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", + "type": "string", + "label": "typeName", "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" - }, - ")" + "string" ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 48 } } ], - "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) => ", + "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" }, - " | null" + " | undefined" ], "description": [], - "children": [ - { - "type": "string", - "label": "id", - "isRequired": true, + "label": "getToFn", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 47 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.ExpressionType.getFromFn", + "type": "Function", + "children": [ + { + "type": "string", + "label": "typeName", + "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53 } } ], + "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 + }, "tags": [], - "returnComment": [], + "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 + } + } + ], + "signature": [ + "(value: any) => boolean" + ], + "description": [], + "label": "castsTo", "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" - } + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-server.TypesRegistry.toJS", + "id": "def-server.ExpressionType.castsFrom", "type": "Function", - "label": "toJS", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59 + } + } + ], "signature": [ - "() => Record boolean" + ], + "description": [], + "label": "castsFrom", + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59 + }, + "tags": [], + "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 + } + }, + { + "type": "string", + "label": "toTypeName", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + } + } + ], + "signature": [ + "(value: any, toTypeName: string, types: Record" + ">) => any" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "to", "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" - } + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-server.TypesRegistry.toArray", + "id": "def-server.ExpressionType.from", "type": "Function", - "label": "toArray", + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 + } + }, + { + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 + } + } + ], "signature": [ - "() => ", + "(value: any, types: Record) => any" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "from", "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" - } + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12 }, "initialIsOpen": false }, { - "id": "def-server.ExpressionsServerPlugin", + "id": "def-server.FunctionsRegistry", "type": "Class", "tags": [], - "label": "ExpressionsServerPlugin", + "label": "FunctionsRegistry", "description": [], "signature": [ { "pluginId": "expressions", - "scope": "server", + "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-server.ExpressionsServerPlugin", - "text": "ExpressionsServerPlugin" + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" }, " 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" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - ", object, object>" + ">" ], "children": [ { - "tags": [], - "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" - }, + "id": "def-server.FunctionsRegistry.Unnamed", + "type": "Function", + "label": "Constructor", "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": [ + "any" + ], + "description": [], + "children": [ { "type": "Object", - "label": "initializerContext", + "label": "executor", "isRequired": true, "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" }, - "" + "" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 } }, { - "id": "def-server.ExpressionsServerPlugin.setup", + "id": "def-server.FunctionsRegistry.register", "type": "Function", - "label": "setup", + "label": "register", "signature": [ - "(core: ", + "(functionDefinition: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" }, - ") => Pick<", + " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" }, - ", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">" + ")) => void" ], "description": [], "children": [ { - "type": "Object", - "label": "core", + "type": "CompoundType", + "label": "functionDefinition", "isRequired": true, "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" + "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/server/plugin.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 61 } }, { - "id": "def-server.ExpressionsServerPlugin.start", + "id": "def-server.FunctionsRegistry.get", "type": "Function", - "label": "start", + "label": "get", "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ") => ", + "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsServiceStart", - "text": "ExpressionsServiceStart" - } + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | null" ], "description": [], "children": [ { - "type": "Object", - "label": "core", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } + "string" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67 } }, { - "id": "def-server.ExpressionsServerPlugin.stop", + "id": "def-server.FunctionsRegistry.toJS", "type": "Function", - "label": "stop", + "label": "toJS", "signature": [ - "() => void" + "() => Record" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 71 + } + }, + { + "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 } } ], "source": { - "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L16" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 58 }, "initialIsOpen": false - } - ], - "functions": [ + }, { - "id": "def-server.buildExpression", - "type": "Function", - "label": "buildExpression", + "id": "def-server.TypesRegistry", + "type": "Class", + "tags": [], + "label": "TypesRegistry", + "description": [], "signature": [ - "(initialState: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" }, - " | ", + " implements ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionBuilder", - "text": "ExpressionAstFunctionBuilder" + "section": "def-common.IRegistry", + "text": "IRegistry" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionType", + "text": "ExpressionType" }, - ">[] | 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, + "id": "def-server.TypesRegistry.Unnamed", + "type": "Function", + "label": "Constructor", "signature": [ - "string | ", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 + } + }, + { + "id": "def-server.TypesRegistry.register", + "type": "Function", + "label": "register", + "signature": [ + "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, - " | ", + " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionBuilder", - "text": "ExpressionAstFunctionBuilder" + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 39 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 36 + }, + "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", @@ -14113,8 +13456,7 @@ ], "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" + "lineNumber": 98 } } ], @@ -14126,8 +13468,7 @@ ], "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" + "lineNumber": 97 }, "initialIsOpen": false }, @@ -14193,8 +13534,7 @@ ], "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" + "lineNumber": 155 } }, { @@ -14225,8 +13565,7 @@ ], "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" + "lineNumber": 163 } } ], @@ -14238,8 +13577,7 @@ ], "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" + "lineNumber": 152 }, "initialIsOpen": false }, @@ -14270,8 +13608,7 @@ "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" + "lineNumber": 15 } }, { @@ -14292,8 +13629,7 @@ "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" + "lineNumber": 16 } } ], @@ -14301,8 +13637,7 @@ "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -14343,8 +13678,7 @@ ], "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" + "lineNumber": 17 } } ], @@ -14352,8 +13686,7 @@ "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" + "lineNumber": 17 }, "initialIsOpen": false }, @@ -14380,13 +13713,11 @@ ], "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" + "lineNumber": 35 } } ], "tags": [ - "example", "return" ], "returnComment": [ @@ -14394,8 +13725,7 @@ ], "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" + "lineNumber": 35 }, "initialIsOpen": false }, @@ -14433,8 +13763,7 @@ "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" + "lineNumber": 15 } }, { @@ -14447,8 +13776,7 @@ "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" + "lineNumber": 16 } } ], @@ -14456,8 +13784,7 @@ "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -14491,8 +13818,7 @@ ], "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" + "lineNumber": 17 } } ], @@ -14500,8 +13826,7 @@ "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" + "lineNumber": 17 }, "initialIsOpen": false } @@ -14524,8 +13849,7 @@ "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" + "lineNumber": 99 }, "signature": [ "\"datatable\"" @@ -14539,8 +13863,7 @@ "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" + "lineNumber": 100 }, "signature": [ { @@ -14561,8 +13884,7 @@ "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" + "lineNumber": 101 }, "signature": [ "Record[]" @@ -14571,8 +13893,7 @@ ], "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" + "lineNumber": 98 }, "initialIsOpen": false }, @@ -14593,8 +13914,7 @@ "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" + "lineNumber": 90 } }, { @@ -14605,8 +13925,7 @@ "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" + "lineNumber": 91 } }, { @@ -14617,8 +13936,7 @@ "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" + "lineNumber": 92 }, "signature": [ { @@ -14633,8 +13951,7 @@ ], "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" + "lineNumber": 89 }, "initialIsOpen": false }, @@ -14667,8 +13984,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "() => ExecutionContextSearch" @@ -14684,8 +14000,7 @@ ], "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" + "lineNumber": 33 }, "signature": [ "Record" @@ -14701,8 +14016,7 @@ ], "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" + "lineNumber": 38 }, "signature": [ "Record string | undefined" @@ -14777,8 +14088,7 @@ ], "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" + "lineNumber": 60 }, "signature": [ "(() => ", @@ -14802,8 +14112,7 @@ ], "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" + "lineNumber": 71 }, "signature": [ "( boolean) | undefined" @@ -14853,8 +14161,7 @@ ], "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" + "lineNumber": 21 }, "initialIsOpen": false }, @@ -14873,8 +14180,7 @@ "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" + "lineNumber": 58 }, "signature": [ { @@ -14895,8 +14201,7 @@ "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" + "lineNumber": 59 }, "signature": [ { @@ -14917,8 +14222,7 @@ "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" + "lineNumber": 60 }, "signature": [ "string | undefined" @@ -14932,8 +14236,7 @@ "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" + "lineNumber": 61 }, "signature": [ { @@ -14948,8 +14251,7 @@ ], "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" + "lineNumber": 57 }, "initialIsOpen": false }, @@ -14986,8 +14288,7 @@ "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" + "lineNumber": 18 }, "signature": [ { @@ -15009,8 +14310,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "\"result\" | \"error\" | \"not-started\" | \"pending\"" @@ -15026,8 +14326,7 @@ ], "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" + "lineNumber": 33 }, "signature": [ "Output | undefined" @@ -15043,8 +14342,7 @@ ], "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" + "lineNumber": 38 }, "signature": [ "Error | undefined" @@ -15053,8 +14351,7 @@ ], "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" + "lineNumber": 17 }, "initialIsOpen": false }, @@ -15083,8 +14380,7 @@ "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" + "lineNumber": 17 }, "signature": [ "Record ", @@ -15289,8 +14578,7 @@ ], "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" + "lineNumber": 80 }, "signature": [ "() => string" @@ -15299,8 +14587,7 @@ ], "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" + "lineNumber": 44 }, "initialIsOpen": false }, @@ -15331,8 +14618,7 @@ ], "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" + "lineNumber": 63 }, "signature": [ "\"expression_function_builder\"" @@ -15348,8 +14634,7 @@ ], "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" + "lineNumber": 67 }, "signature": [ { @@ -15372,8 +14657,7 @@ ], "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" + "lineNumber": 74 }, "signature": [ "FunctionBuilderArguments" @@ -15391,8 +14675,7 @@ ], "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" + "lineNumber": 86 }, "signature": [ ">(name: A, value: ", @@ -15418,8 +14701,7 @@ ], "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" + "lineNumber": 99 }, "signature": [ ">(name: A) => (", @@ -15445,8 +14727,7 @@ ], "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" + "lineNumber": 111 }, "signature": [ ">(name: A, value: (", @@ -15472,8 +14753,7 @@ ], "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" + "lineNumber": 124 }, "signature": [ ">>(name: A) => this" @@ -15491,8 +14771,7 @@ ], "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" + "lineNumber": 130 }, "signature": [ "() => ", @@ -15517,8 +14796,7 @@ ], "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" + "lineNumber": 136 }, "signature": [ "() => string" @@ -15527,8 +14805,7 @@ ], "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" + "lineNumber": 57 }, "initialIsOpen": false }, @@ -15577,8 +14854,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ "Name" @@ -15594,8 +14870,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ "boolean | undefined" @@ -15611,8 +14886,7 @@ ], "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" + "lineNumber": 50 }, "signature": [ "\"date\" | \"filter\" | ", @@ -15638,8 +14912,7 @@ ], "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" + "lineNumber": 58 }, "signature": [ { @@ -15662,8 +14935,7 @@ ], "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" + "lineNumber": 64 }, "signature": [ "{ [key in keyof Arguments]: ", @@ -15687,8 +14959,7 @@ "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" + "lineNumber": 69 }, "signature": [ "string[] | undefined" @@ -15704,8 +14975,7 @@ ], "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" + "lineNumber": 75 } }, { @@ -15731,8 +15001,7 @@ ], "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" + "lineNumber": 86 } }, { @@ -15747,8 +15016,7 @@ ], "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" + "lineNumber": 86 } }, { @@ -15763,8 +15031,7 @@ ], "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" + "lineNumber": 86 } } ], @@ -15772,8 +15039,7 @@ "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" + "lineNumber": 86 } }, { @@ -15786,8 +15052,7 @@ "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" + "lineNumber": 91 }, "signature": [ "{ types: any[] | undefined; } | undefined" @@ -15796,8 +15061,7 @@ ], "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" + "lineNumber": 30 }, "initialIsOpen": false }, @@ -15820,8 +15084,7 @@ "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" + "lineNumber": 117 }, "signature": [ { @@ -15841,8 +15104,7 @@ "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" + "lineNumber": 118 }, "signature": [ { @@ -15862,8 +15124,7 @@ "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" + "lineNumber": 119 }, "signature": [ { @@ -15883,8 +15144,7 @@ "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" + "lineNumber": 120 }, "signature": [ { @@ -15904,8 +15164,7 @@ "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" + "lineNumber": 121 }, "signature": [ { @@ -15925,8 +15184,7 @@ "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" + "lineNumber": 122 }, "signature": [ { @@ -15946,8 +15204,7 @@ "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" + "lineNumber": 123 }, "signature": [ { @@ -15967,8 +15224,7 @@ "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" + "lineNumber": 124 }, "signature": [ { @@ -15983,8 +15239,7 @@ ], "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" + "lineNumber": 116 }, "initialIsOpen": false }, @@ -16003,8 +15258,7 @@ "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" + "lineNumber": 15 }, "signature": [ "\"image\"" @@ -16018,8 +15272,7 @@ "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" + "lineNumber": 16 } }, { @@ -16030,15 +15283,13 @@ "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" + "lineNumber": 17 } } ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -16069,8 +15320,7 @@ ], "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" + "lineNumber": 15 } }, { @@ -16083,8 +15333,7 @@ ], "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" + "lineNumber": 20 }, "signature": [ "string | undefined" @@ -16100,8 +15349,7 @@ ], "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" + "lineNumber": 26 }, "signature": [ "string | undefined" @@ -16117,8 +15365,7 @@ ], "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" + "lineNumber": 31 }, "signature": [ "(() => Error | undefined) | undefined" @@ -16134,8 +15381,7 @@ ], "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" + "lineNumber": 37 } }, { @@ -16148,8 +15394,7 @@ ], "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" + "lineNumber": 42 }, "signature": [ "(domNode: HTMLElement, config: Config, handlers: ", @@ -16166,8 +15411,7 @@ ], "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" + "lineNumber": 9 }, "initialIsOpen": false }, @@ -16198,8 +15442,7 @@ "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" + "lineNumber": 31 }, "signature": [ "Name" @@ -16213,8 +15456,7 @@ "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" + "lineNumber": 32 }, "signature": [ "((type: any) => void | Error) | undefined" @@ -16228,8 +15470,7 @@ "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" + "lineNumber": 33 }, "signature": [ "((type: Value) => SerializedType) | undefined" @@ -16243,8 +15484,7 @@ "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" + "lineNumber": 34 }, "signature": [ "((type: SerializedType) => Value) | undefined" @@ -16258,8 +15498,7 @@ "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" + "lineNumber": 37 }, "signature": [ "{ [type: string]: ", @@ -16281,8 +15520,7 @@ "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" + "lineNumber": 40 }, "signature": [ "{ [type: string]: ", @@ -16304,8 +15542,7 @@ "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" + "lineNumber": 43 }, "signature": [ "string | undefined" @@ -16314,8 +15551,7 @@ ], "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" + "lineNumber": 26 }, "initialIsOpen": false }, @@ -16336,8 +15572,7 @@ "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" + "lineNumber": 121 }, "signature": [ "\"style\"" @@ -16351,8 +15586,7 @@ "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" + "lineNumber": 122 }, "signature": [ { @@ -16372,15 +15606,13 @@ "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" + "lineNumber": 123 } } ], "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" + "lineNumber": 120 }, "initialIsOpen": false }, @@ -16401,8 +15633,7 @@ "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" + "lineNumber": 26 }, "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\"" @@ -16416,8 +15647,7 @@ "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" + "lineNumber": 27 }, "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\"" @@ -16426,8 +15656,7 @@ ], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25" + "lineNumber": 25 }, "initialIsOpen": false }, @@ -16448,8 +15677,7 @@ ], "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" + "lineNumber": 67 }, "signature": [ "() => void" @@ -16463,8 +15691,7 @@ "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" + "lineNumber": 68 }, "signature": [ "(fn: () => void) => void" @@ -16478,8 +15705,7 @@ "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" + "lineNumber": 69 }, "signature": [ "() => void" @@ -16493,8 +15719,7 @@ "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" + "lineNumber": 70 }, "signature": [ "(params: any) => void" @@ -16508,8 +15733,7 @@ "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" + "lineNumber": 71 }, "signature": [ "(event: any) => void" @@ -16523,8 +15747,7 @@ "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" + "lineNumber": 72 }, "signature": [ "((event: any) => Promise) | undefined" @@ -16538,8 +15761,7 @@ "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" + "lineNumber": 73 }, "signature": [ "() => ", @@ -16560,8 +15782,7 @@ "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" + "lineNumber": 74 }, "signature": [ "() => boolean" @@ -16577,8 +15798,7 @@ ], "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" + "lineNumber": 80 }, "signature": [ "unknown" @@ -16587,8 +15807,7 @@ ], "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" + "lineNumber": 63 }, "initialIsOpen": false }, @@ -16628,8 +15847,7 @@ "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" + "lineNumber": 10 } } ], @@ -16637,8 +15855,7 @@ "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" + "lineNumber": 10 } }, { @@ -16654,8 +15871,7 @@ "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" + "lineNumber": 12 } }, { @@ -16671,15 +15887,13 @@ "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" + "lineNumber": 14 } } ], "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" + "lineNumber": 9 }, "initialIsOpen": false }, @@ -16700,8 +15914,7 @@ "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" + "lineNumber": 24 }, "signature": [ "\"string\" | \"number\"" @@ -16715,8 +15928,7 @@ "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" + "lineNumber": 25 }, "signature": [ "\"measure\" | \"dimension\"" @@ -16730,15 +15942,13 @@ "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" + "lineNumber": 26 } } ], "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" + "lineNumber": 23 }, "initialIsOpen": false }, @@ -16757,8 +15967,7 @@ "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" + "lineNumber": 15 }, "signature": [ "\"range\"" @@ -16772,8 +15981,7 @@ "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" + "lineNumber": 16 } }, { @@ -16784,8 +15992,7 @@ "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" + "lineNumber": 17 } }, { @@ -16796,8 +16003,7 @@ "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" + "lineNumber": 18 }, "signature": [ "string | undefined" @@ -16806,8 +16012,7 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -16843,8 +16048,7 @@ "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" + "lineNumber": 105 }, "signature": [ "string[][]" @@ -16853,8 +16057,7 @@ ], "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" + "lineNumber": 104 }, "initialIsOpen": false }, @@ -16885,8 +16088,7 @@ "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" + "lineNumber": 54 }, "signature": [ "string | undefined" @@ -16900,8 +16102,7 @@ "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" + "lineNumber": 55 }, "signature": [ "TParams | undefined" @@ -16910,8 +16111,7 @@ ], "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" + "lineNumber": 53 }, "initialIsOpen": false } @@ -16927,8 +16127,7 @@ ], "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" + "lineNumber": 35 }, "initialIsOpen": false }, @@ -16942,8 +16141,7 @@ ], "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" + "lineNumber": 43 }, "initialIsOpen": false }, @@ -16957,8 +16155,7 @@ ], "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" + "lineNumber": 62 }, "initialIsOpen": false }, @@ -16972,8 +16169,7 @@ ], "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" + "lineNumber": 72 }, "initialIsOpen": false }, @@ -16987,8 +16183,7 @@ ], "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" + "lineNumber": 82 }, "initialIsOpen": false } @@ -17004,8 +16199,7 @@ ], "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" + "lineNumber": 102 }, "signature": [ "ExpressionFunctionDefinition, any, ExecutionContext<", @@ -17030,8 +16224,7 @@ "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" + "lineNumber": 46 }, "signature": [ "ExpressionTypeDefinition" @@ -17048,8 +16241,7 @@ ], "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" + "lineNumber": 16 }, "signature": [ "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" @@ -17066,8 +16258,7 @@ ], "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" + "lineNumber": 36 }, "signature": [ "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" @@ -17084,8 +16275,7 @@ ], "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" + "lineNumber": 57 }, "signature": [ "{ [x: string]: any; }" @@ -17100,8 +16290,7 @@ "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" + "lineNumber": 73 }, "signature": [ "StateContainer, ExecutionPureTransitions, {}>" @@ -17116,8 +16305,7 @@ "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" + "lineNumber": 55 }, "signature": [ "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" @@ -17132,8 +16320,7 @@ "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" + "lineNumber": 77 }, "signature": [ "string | number | false | true | ", @@ -17155,8 +16342,7 @@ "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" + "lineNumber": 16 }, "signature": [ "{ type: 'expression'; chain: ExpressionAstFunction[]; }" @@ -17171,8 +16357,7 @@ "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" + "lineNumber": 21 }, "signature": [ "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" @@ -17187,8 +16372,7 @@ "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" + "lineNumber": 11 }, "signature": [ "string | number | false | true | ", @@ -17218,8 +16402,7 @@ "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" + "lineNumber": 15 }, "signature": [ "any" @@ -17234,8 +16417,7 @@ "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" + "lineNumber": 11 }, "signature": [ "{ type: Type; } & Value" @@ -17250,8 +16432,7 @@ "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" + "lineNumber": 17 }, "signature": [ "(input: I, availableTypes: Record) => O" @@ -17266,14 +16447,30 @@ "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" + "lineNumber": 17 }, "signature": [ "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "initialIsOpen": false }, + { + "id": "def-server.ExpressionValueFilter", + "type": "Type", + "label": "ExpressionValueFilter", + "tags": [], + "description": [ + "\nRepresents an object that is a Filter." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 14 + }, + "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.ExpressionValueNum", "type": "Type", @@ -17282,8 +16479,7 @@ "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" + "lineNumber": 14 }, "signature": [ "{ type: \"num\"; } & { value: number; }" @@ -17300,8 +16496,7 @@ ], "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" + "lineNumber": 16 }, "signature": [ "{ type: \"render\"; } & { as: string; value: T; }" @@ -17309,36 +16504,34 @@ "initialIsOpen": false }, { - "id": "def-server.ExpressionValueUnboxed", + "id": "def-server.ExpressionValueRender", "type": "Type", - "label": "ExpressionValueUnboxed", + "label": "ExpressionValueRender", "tags": [], - "description": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16 }, "signature": [ - "any" + "{ type: \"render\"; } & { as: string; value: T; }" ], "initialIsOpen": false }, { - "id": "def-server.ExpressionValueFilter", + "id": "def-server.ExpressionValueUnboxed", "type": "Type", - "label": "ExpressionValueFilter", + "label": "ExpressionValueUnboxed", "tags": [], - "description": [ - "\nRepresents an object that is a Filter." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 9 }, "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + "any" ], "initialIsOpen": false }, @@ -17352,8 +16545,7 @@ ], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13" + "lineNumber": 13 }, "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\"" @@ -17370,8 +16562,7 @@ ], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19" + "lineNumber": 19 }, "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\"" @@ -17388,8 +16579,7 @@ "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" + "lineNumber": 33 }, "signature": [ "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" @@ -17406,8 +16596,7 @@ ], "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" + "lineNumber": 26 }, "signature": [ "T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never" @@ -17424,8 +16613,7 @@ ], "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" + "lineNumber": 39 }, "signature": [ "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" @@ -17442,8 +16630,7 @@ ], "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" + "lineNumber": 18 }, "signature": [ "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" @@ -17460,8 +16647,7 @@ ], "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" + "lineNumber": 32 }, "signature": [ "{} | Record<", @@ -17492,8 +16678,7 @@ "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" + "lineNumber": 34 }, "signature": [ "{ [x: string]: any; }" @@ -17508,8 +16693,7 @@ "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" + "lineNumber": 126 }, "signature": [ "ExpressionTypeStyle" @@ -17526,8 +16710,7 @@ ], "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" + "lineNumber": 39 }, "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" @@ -17544,8 +16727,7 @@ ], "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" + "lineNumber": 17 }, "signature": [ "\"date\" | \"filter\" | ", @@ -17570,31 +16752,12 @@ ], "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" + "lineNumber": 46 }, "signature": [ "\"date\" | \"filter\"" ], "initialIsOpen": false - }, - { - "id": "def-server.ExpressionValueRender", - "type": "Type", - "label": "ExpressionValueRender", - "tags": [], - "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": [], @@ -17606,8 +16769,7 @@ "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" + "lineNumber": 12 }, "signature": [ "{ readonly getType: (name: string) => ", @@ -17662,8 +16824,7 @@ "description": [], "source": { "path": "src/plugins/expressions/server/plugin.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L14" + "lineNumber": 14 }, "signature": [ "ExpressionsServiceStart" @@ -17675,925 +16836,178 @@ "common": { "classes": [ { - "id": "def-common.ExpressionType", + "id": "def-common.Execution", "type": "Class", "tags": [], - "label": "ExpressionType", + "label": "Execution", "description": [], - "children": [ - { - "tags": [], - "id": "def-common.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" - } - }, - { - "tags": [], - "id": "def-common.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" - } - }, - { - "tags": [], - "id": "def-common.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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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", - "tags": [], - "label": "ExpressionFunctionParameter", - "description": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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", - "tags": [], - "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": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" }, + "" + ], + "children": [ { "tags": [], - "id": "def-common.ExpressionFunction.telemetry", - "type": "Function", - "label": "telemetry", - "description": [], + "id": "def-common.Execution.state", + "type": "Object", + "label": "state", + "description": [ + "\nDynamic state of the execution." + ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 80 }, "signature": [ - "(state: Record, telemetryData: Record) => Record" - ] - }, - { - "tags": [], - "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: ", + "; info?: ", { - "pluginId": "core", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - "[]; }" + " | undefined; }>>" ] }, { "tags": [], - "id": "def-common.ExpressionFunction.inject", - "type": "Function", - "label": "inject", - "description": [], + "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/expression_functions/expression_function.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 88 + }, + "signature": [ + "Input" + ] + }, + { + "tags": [], + "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 }, "signature": [ - "(state: Record, references: ", + " Record" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstArgument", - "text": "ExpressionAstArgument" + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" }, - "[]>" + "" ] }, { "tags": [], - "id": "def-common.ExpressionFunction.migrations", + "id": "def-common.Execution.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 140 + } + }, + { + "id": "def-common.Execution.result", "type": "Object", - "label": "migrations", + "label": "result", + "tags": [], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 142 }, "signature": [ - "{ [key: string]: (state: ", + "Promise ", + "<\"error\", { error: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + "; info?: ", { "pluginId": "kibanaUtils", "scope": "common", @@ -18601,555 +17015,677 @@ "section": "def-common.SerializableState", "text": "SerializableState" }, - "; }" + " | undefined; }>>" + ] + }, + { + "id": "def-common.Execution.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 146 + }, + "signature": [ + "InspectorAdapters" ] }, { - "id": "def-common.ExpressionFunction.Unnamed", + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 150 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 202 + } + }, + { + "id": "def-common.Execution.invokeChain", "type": "Function", - "label": "Constructor", + "label": "invokeChain", "signature": [ - "any" + "(chainArr: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[], input: unknown) => Promise" ], "description": [], "children": [ { - "type": "Object", - "label": "functionDefinition", + "type": "Array", + "label": "chainArr", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - } + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + }, + "[]" ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236 + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 236 } }, { - "id": "def-common.ExpressionFunction.accepts", + "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": "string", - "label": "type", + "type": "Object", + "label": "fn", "isRequired": true, "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 317 + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 318 + } + }, + { + "type": "Object", + "label": "args", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 319 } } ], - "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" - }, - "tags": [], - "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", - "tags": [], - "label": "ExpressionRenderer", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderer", - "text": "ExpressionRenderer" - }, - "" - ], - "children": [ - { "tags": [], - "id": "def-common.ExpressionRenderer.name", - "type": "string", - "label": "name", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 316 } }, { - "tags": [], - "id": "def-common.ExpressionRenderer.displayName", - "type": "string", - "label": "displayName", + "id": "def-common.Execution.cast", + "type": "Function", + "label": "cast", + "signature": [ + "(value: any, toTypeNames?: string[] | undefined) => any" + ], "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" - } - }, - { + "children": [ + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348 + } + }, + { + "type": "Array", + "label": "toTypeNames", + "isRequired": false, + "signature": [ + "string[] | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348 + } + } + ], "tags": [], - "id": "def-common.ExpressionRenderer.help", - "type": "string", - "label": "help", - "description": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 348 } }, { - "tags": [], - "id": "def-common.ExpressionRenderer.validate", + "id": "def-common.Execution.resolveArgs", "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" - }, + "label": "resolveArgs", "signature": [ - "() => void | Error" - ] - }, - { - "tags": [], - "id": "def-common.ExpressionRenderer.reuseDomNode", - "type": "boolean", - "label": "reuseDomNode", + "(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 + } + }, + { + "type": "Unknown", + "label": "input", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + } + }, + { + "type": "Any", + "label": "argAsts", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 374 } }, { - "tags": [], - "id": "def-common.ExpressionRenderer.render", + "id": "def-common.Execution.interpret", "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" - }, + "label": "interpret", "signature": [ - "(domNode: HTMLElement, config: Config, handlers: ", + "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.IInterpreterRenderHandlers", - "text": "IInterpreterRenderHandlers" + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" }, - ") => void | Promise" - ] - }, - { - "id": "def-common.ExpressionRenderer.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" + ", input: T) => Promise" ], "description": [], "children": [ { - "type": "Object", - "label": "config", + "type": "CompoundType", + "label": "ast", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderDefinition", - "text": "ExpressionRenderDefinition" - }, - "" + "section": "def-common.ExpressionAstNode", + "text": "ExpressionAstNode" + } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465 + } + }, + { + "type": "Uncategorized", + "label": "input", + "isRequired": true, + "signature": [ + "T" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 465 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 70 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionRendererRegistry", + "id": "def-common.ExecutionContract", "type": "Class", "tags": [], - "label": "ExpressionRendererRegistry", - "description": [], + "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.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" + "section": "def-common.ExecutionContract", + "text": "ExecutionContract" }, - ">" + "" ], "children": [ { - "id": "def-common.ExpressionRendererRegistry.register", + "id": "def-common.ExecutionContract.isPending", + "type": "boolean", + "label": "isPending", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 18 + } + }, + { + "id": "def-common.ExecutionContract.Unnamed", "type": "Function", - "label": "register", + "label": "Constructor", "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" + "any" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "definition", + "type": "Object", + "label": "execution", "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" + "section": "def-common.Execution", + "text": "Execution" }, - ")" + "" ], "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" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24 } } ], "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" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 24 } }, { - "id": "def-common.ExpressionRendererRegistry.get", + "id": "def-common.ExecutionContract.cancel", "type": "Function", - "label": "get", + "children": [], "signature": [ - "(id: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderer", - "text": "ExpressionRenderer" - }, - " | null" + "() => void" ], - "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" - } - } + "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." ], - "tags": [], - "returnComment": [], + "label": "cancel", "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" - } + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 31 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.ExpressionRendererRegistry.toJS", + "id": "def-common.ExecutionContract.getData", "type": "Function", - "label": "toJS", + "children": [], "signature": [ - "() => Record Promise<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderer", - "text": "ExpressionRenderer" + "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": [], - "children": [], + "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 + }, "tags": [], - "returnComment": [], + "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/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" - } + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 60 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.ExpressionRendererRegistry.toArray", + "id": "def-common.ExecutionContract.getAst", "type": "Function", - "label": "toArray", + "children": [], "signature": [ "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderer", - "text": "ExpressionRenderer" - }, - "[]" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], - "description": [], - "children": [], + "description": [ + "\nGet AST used to execute the expression." + ], + "label": "getAst", + "source": { + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 67 + }, "tags": [], - "returnComment": [], + "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/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" - } + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 73 + }, + "tags": [], + "returnComment": [] } ], "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" + "path": "src/plugins/expressions/common/execution/execution_contract.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.TypesRegistry", + "id": "def-common.Executor", "type": "Class", "tags": [], - "label": "TypesRegistry", + "label": "Executor", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.TypesRegistry", - "text": "TypesRegistry" + "section": "def-common.Executor", + "text": "Executor" }, - " implements ", + " implements ", { - "pluginId": "expressions", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.IRegistry", - "text": "IRegistry" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" }, "<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, ">" ], "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", + "id": "def-common.Executor.createWithDefaults", "type": "Function", - "label": "register", + "label": "createWithDefaults", "signature": [ - "(typeDefinition: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" - }, - " | (() => ", + "typeof ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.Executor", + "text": "Executor" }, - ")) => void" + ".createWithDefaults" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "typeDefinition", - "isRequired": true, + "type": "Object", + "label": "state", + "isRequired": false, "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" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - ")" + " | undefined" ], "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" + "lineNumber": 83 } } ], @@ -19157,143 +17693,76 @@ "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" + "lineNumber": 82 } }, { - "id": "def-common.TypesRegistry.get", - "type": "Function", - "label": "get", + "tags": [], + "id": "def-common.Executor.state", + "type": "Object", + "label": "state", + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 91 + }, "signature": [ - "(id: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" }, - " | null" + "" + ] + }, + { + "tags": [ + "deprecated" ], + "id": "def-common.Executor.functions", + "type": "Object", + "label": "functions", "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", + "lineNumber": 96 + }, "signature": [ - "() => Record" + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" + } + ] + }, + { + "tags": [ + "deprecated" ], + "id": "def-common.Executor.types", + "type": "Object", + "label": "types", "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", + "lineNumber": 101 + }, "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", - "tags": [], - "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" + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" + } + ] }, - ">" - ], - "children": [ { - "id": "def-common.FunctionsRegistry.Unnamed", + "id": "def-common.Executor.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -19303,23 +17772,22 @@ "children": [ { "type": "Object", - "label": "executor", - "isRequired": true, + "label": "state", + "isRequired": false, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - "" + " | undefined" ], "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" + "lineNumber": 103 } } ], @@ -19327,14 +17795,13 @@ "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" + "lineNumber": 103 } }, { - "id": "def-common.FunctionsRegistry.register", + "id": "def-common.Executor.registerFunction", "type": "Function", - "label": "register", + "label": "registerFunction", "signature": [ "(functionDefinition: ", { @@ -19381,8 +17848,7 @@ "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" + "lineNumber": 110 } } ], @@ -19390,16 +17856,15 @@ "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" + "lineNumber": 109 } }, { - "id": "def-common.FunctionsRegistry.get", + "id": "def-common.Executor.getFunction", "type": "Function", - "label": "get", + "label": "getFunction", "signature": [ - "(id: string) => ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", @@ -19407,13 +17872,13 @@ "section": "def-common.ExpressionFunction", "text": "ExpressionFunction" }, - " | null" + " | undefined" ], "description": [], "children": [ { "type": "string", - "label": "id", + "label": "name", "isRequired": true, "signature": [ "string" @@ -19421,8 +17886,7 @@ "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" + "lineNumber": 118 } } ], @@ -19430,14 +17894,13 @@ "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" + "lineNumber": 118 } }, { - "id": "def-common.FunctionsRegistry.toJS", + "id": "def-common.Executor.getFunctions", "type": "Function", - "label": "toJS", + "label": "getFunctions", "signature": [ "() => Record ", + "(typeDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, - "[]" + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + ")) => void" ], "description": [], - "children": [], + "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 + } + } + ], "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" + "lineNumber": 126 } - } - ], - "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", - "tags": [], - "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", + "id": "def-common.Executor.getType", "type": "Function", - "label": "createWithDefaults", + "label": "getType", "signature": [ - "typeof ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" + "section": "def-common.ExpressionType", + "text": "ExpressionType" }, - ".createWithDefaults" + " | undefined" ], "description": [], "children": [ { - "type": "Object", - "label": "state", - "isRequired": false, + "type": "string", + "label": "name", + "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - " | undefined" + "string" ], "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" + "lineNumber": 135 } } ], @@ -19568,106 +18017,158 @@ "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" + "lineNumber": 135 } }, { - "tags": [], - "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" - }, + "id": "def-common.Executor.getTypes", + "type": "Function", + "label": "getTypes", "signature": [ + "() => Record" - ] - }, - { - "tags": [ - "deprecated" + ">" ], - "id": "def-common.Executor.functions", - "type": "Object", - "label": "functions", "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - }, + "lineNumber": 139 + } + }, + { + "id": "def-common.Executor.extendContext", + "type": "Function", + "label": "extendContext", "signature": [ + "(extraContext: Record) => void" + ], + "description": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.FunctionsRegistry", - "text": "FunctionsRegistry" + "type": "Object", + "label": "extraContext", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143 + } } - ] + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 143 + } }, { - "tags": [ - "deprecated" - ], - "id": "def-common.Executor.types", + "id": "def-common.Executor.context", "type": "Object", - "label": "types", + "label": "context", + "tags": [], "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" + "lineNumber": 147 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.TypesRegistry", - "text": "TypesRegistry" - } + "Record" ] }, { - "id": "def-common.Executor.Unnamed", + "id": "def-common.Executor.run", "type": "Function", - "label": "Constructor", + "label": "run", "signature": [ - "any" + "(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" ], - "description": [], "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 + } + }, + { + "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 + } + }, { "type": "Object", - "label": "state", - "isRequired": false, + "label": "params", + "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - " | undefined" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } ], "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" + "lineNumber": 162 } } ], @@ -19675,62 +18176,87 @@ "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" + "lineNumber": 159 } }, { - "id": "def-common.Executor.registerFunction", + "id": "def-common.Executor.createExecution", "type": "Function", - "label": "registerFunction", + "label": "createExecution", "signature": [ - "(functionDefinition: ", + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | (() => ", + ", params?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" }, - ")) => void" + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Execution", + "text": "Execution" + }, + "" ], "description": [], "children": [ { "type": "CompoundType", - "label": "functionDefinition", + "label": "ast", "isRequired": true, "signature": [ + "string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - }, - " | (() => ", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 170 + } + }, + { + "type": "Object", + "label": "params", + "isRequired": true, + "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - }, - ")" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } ], "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" + "lineNumber": 171 } } ], @@ -19738,39 +18264,78 @@ "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" + "lineNumber": 169 } }, { - "id": "def-common.Executor.getFunction", + "id": "def-common.Executor.inject", "type": "Function", - "label": "getFunction", + "label": "inject", "signature": [ - "(name: string) => ", + "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | undefined" + ", 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": "string", - "label": "name", + "type": "Object", + "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": 217 + } + }, + { + "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": 118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118" + "lineNumber": 217 } } ], @@ -19778,87 +18343,116 @@ "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" + "lineNumber": 217 } }, { - "id": "def-common.Executor.getFunctions", + "id": "def-common.Executor.extract", "type": "Function", - "label": "getFunctions", + "label": "extract", "signature": [ - "() => Record" + ") => { 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": [], + "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 + } + } + ], "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" + "lineNumber": 223 } }, { - "id": "def-common.Executor.registerType", + "id": "def-common.Executor.telemetry", "type": "Function", - "label": "registerType", + "label": "telemetry", "signature": [ - "(typeDefinition: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" - }, - " | (() => ", + "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ")) => void" + ", telemetryData: Record) => Record" ], "description": [], "children": [ { - "type": "CompoundType", - "label": "typeDefinition", + "type": "Object", + "label": "ast", "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" - }, - ")" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 233 + } + }, + { + "type": "Object", + "label": "telemetryData", + "isRequired": true, + "signature": [ + "Record" ], "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" + "lineNumber": 233 } } ], @@ -19866,30 +18460,55 @@ "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" + "lineNumber": 233 } }, { - "id": "def-common.Executor.getType", + "id": "def-common.Executor.migrate", "type": "Function", - "label": "getType", + "label": "migrate", "signature": [ - "(name: string) => ", + "(ast: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ", version: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" - }, - " | undefined" + "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 + } + }, { "type": "string", - "label": "name", + "label": "version", "isRequired": true, "signature": [ "string" @@ -19897,8 +18516,7 @@ "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" + "lineNumber": 241 } } ], @@ -19906,24 +18524,23 @@ "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" + "lineNumber": 241 } }, { - "id": "def-common.Executor.getTypes", + "id": "def-common.Executor.fork", "type": "Function", - "label": "getTypes", + "label": "fork", "signature": [ - "() => Record ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.Executor", + "text": "Executor" }, - ">" + "" ], "description": [], "children": [], @@ -19931,257 +18548,241 @@ "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" + "lineNumber": 250 } + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 80 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunction", + "type": "Class", + "tags": [], + "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.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": [], + "id": "def-common.ExpressionFunction.name", + "type": "string", + "label": "name", + "description": [ + "\nName of function" + ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 22 } }, { - "id": "def-common.Executor.context", - "type": "Object", - "label": "context", "tags": [], - "description": [], + "id": "def-common.ExpressionFunction.aliases", + "type": "Array", + "label": "aliases", + "description": [ + "\nAliases that can be used instead of `name`." + ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 27 }, "signature": [ - "Record" + "string[]" ] }, { - "id": "def-common.Executor.run", + "tags": [], + "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 + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.fn", "type": "Function", - "label": "run", + "label": "fn", + "description": [ + "\nFunction to run function (context, args)" + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 39 + }, "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" + "(input: any, params: Record, handlers: object) => any" + ] + }, + { + "tags": [], + "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 + } + }, + { + "id": "def-common.ExpressionFunction.args", + "type": "Object", + "tags": [], + "children": [], "description": [ - "\nExecute expression and return result.\n" + "\nSpecification of expression function parameters." ], - "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" - } - } + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 49 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-common.ExpressionFunction.disabled", + "type": "boolean", + "label": "disabled", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 56 } }, { - "id": "def-common.Executor.createExecution", + "tags": [], + "id": "def-common.ExpressionFunction.telemetry", "type": "Function", - "label": "createExecution", + "label": "telemetry", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 57 + }, "signature": [ - "(ast: string | ", + "(state: Record, telemetryData: Record) => Record" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunction.extract", + "type": "Function", + "label": "extract", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 61 + }, + "signature": [ + "(state: Record ", + "[]>) => { state: Record; references: ", { - "pluginId": "expressions", + "pluginId": "core", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DefaultInspectorAdapters", - "text": "DefaultInspectorAdapters" - }, - ">" - ], - "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" - } + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" }, - { - "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", + "tags": [], + "id": "def-common.ExpressionFunction.inject", "type": "Function", "label": "inject", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 64 + }, "signature": [ - "(ast: ", + "(state: Record, references: ", { "pluginId": "core", "scope": "common", @@ -20189,874 +18790,1041 @@ "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, - "[]) => ", + "[]) => Record" + ] }, { - "id": "def-common.Executor.extract", - "type": "Function", - "label": "extract", + "tags": [], + "id": "def-common.ExpressionFunction.migrations", + "type": "Object", + "label": "migrations", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 68 + }, "signature": [ - "(ast: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - ") => { state: ", + "{ [key: string]: (state: ", { - "pluginId": "expressions", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" }, - "; references: ", + ") => ", { - "pluginId": "core", + "pluginId": "kibanaUtils", "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" - } + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + "; }" + ] }, { - "id": "def-common.Executor.telemetry", + "id": "def-common.ExpressionFunction.Unnamed", "type": "Function", - "label": "telemetry", + "label": "Constructor", "signature": [ - "(ast: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - ", telemetryData: Record) => Record" + "any" ], "description": [], "children": [ { "type": "Object", - "label": "ast", + "label": "functionDefinition", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 72 + } + }, + { + "id": "def-common.ExpressionFunction.accepts", + "type": "Function", + "children": [ { - "type": "Object", - "label": "telemetryData", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - "Record" + "string" ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107 } } ], + "signature": [ + "(type: string) => boolean" + ], + "description": [], + "label": "accepts", + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 107 + }, "tags": [], - "returnComment": [], + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "lineNumber": 18 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionParameter", + "type": "Class", + "tags": [], + "label": "ExpressionFunctionParameter", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.name", + "type": "string", + "label": "name", + "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 12 } }, { - "id": "def-common.Executor.migrate", + "tags": [], + "id": "def-common.ExpressionFunctionParameter.required", + "type": "boolean", + "label": "required", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 13 + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 14 + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.types", + "type": "Array", + "label": "types", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 15 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.default", + "type": "Any", + "label": "default", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 16 + }, + "signature": [ + "any" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 17 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.multi", + "type": "boolean", + "label": "multi", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 18 + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.resolve", + "type": "boolean", + "label": "resolve", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 19 + } + }, + { + "tags": [], + "id": "def-common.ExpressionFunctionParameter.options", + "type": "Array", + "label": "options", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 20 + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-common.ExpressionFunctionParameter.Unnamed", "type": "Function", - "label": "migrate", + "label": "Constructor", "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" - } + "any" ], "description": [], "children": [ { - "type": "Object", - "label": "ast", + "type": "string", + "label": "name", "isRequired": true, "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - } + "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 } }, { - "type": "string", - "label": "version", + "type": "CompoundType", + "label": "arg", "isRequired": true, "signature": [ - "string" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "" ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 } } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 22 } }, { - "id": "def-common.Executor.fork", + "id": "def-common.ExpressionFunctionParameter.accepts", "type": "Function", - "label": "fork", + "label": "accepts", "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "" + "(type: string) => boolean" ], "description": [], - "children": [], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 + } + } + ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 40 } } ], "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" + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-common.Execution", + "id": "def-common.ExpressionRenderer", "type": "Class", "tags": [], - "label": "Execution", + "label": "ExpressionRenderer", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Execution", - "text": "Execution" + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" }, - "" + "" ], "children": [ { "tags": [], - "id": "def-common.Execution.state", - "type": "Object", - "label": "state", - "description": [ - "\nDynamic state of the execution." - ], + "id": "def-common.ExpressionRenderer.name", + "type": "string", + "label": "name", + "description": [], "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" - }, - ">" - ] + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 12 + } }, { "tags": [], - "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." - ], + "id": "def-common.ExpressionRenderer.displayName", + "type": "string", + "label": "displayName", + "description": [], "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" - ] + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 13 + } }, { "tags": [], - "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." - ], + "id": "def-common.ExpressionRenderer.help", + "type": "string", + "label": "help", + "description": [], "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" - }, - "" - ] + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 14 + } }, { "tags": [], - "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." - ], + "id": "def-common.ExpressionRenderer.validate", + "type": "Function", + "label": "validate", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 15 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContract", - "text": "ExecutionContract" - }, - "" + "() => void | Error" ] }, { "tags": [], - "id": "def-common.Execution.expression", - "type": "string", - "label": "expression", + "id": "def-common.ExpressionRenderer.reuseDomNode", + "type": "boolean", + "label": "reuseDomNode", "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" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 16 } }, { - "id": "def-common.Execution.result", - "type": "Object", - "label": "result", "tags": [], + "id": "def-common.ExpressionRenderer.render", + "type": "Function", + "label": "render", "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" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 17 }, "signature": [ - "Promise>" + ") => void | Promise" ] }, { - "id": "def-common.Execution.inspectorAdapters", - "type": "Uncategorized", - "label": "inspectorAdapters", - "tags": [], + "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 + } + } + ], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 19 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionRendererRegistry", + "type": "Class", + "tags": [], + "label": "ExpressionRendererRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" }, + " implements ", { - "id": "def-common.Execution.Unnamed", + "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": "Constructor", + "label": "register", "signature": [ - "any" + "(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": "Object", - "label": "execution", + "type": "CompoundType", + "label": "definition", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionParams", - "text": "ExecutionParams" - } + "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/execution/execution.ts", - "lineNumber": 150, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19 } } ], "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" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 19 } }, { - "id": "def-common.Execution.start", + "id": "def-common.ExpressionRendererRegistry.get", "type": "Function", - "label": "start", + "label": "get", "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." + "(id: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" ], + "description": [], "children": [ { - "type": "Uncategorized", - "label": "input", + "type": "string", + "label": "id", "isRequired": true, "signature": [ - "Input" + "string" ], "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" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25 } } ], "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" + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 25 } }, { - "id": "def-common.Execution.invokeChain", + "id": "def-common.ExpressionRendererRegistry.toJS", "type": "Function", - "label": "invokeChain", + "label": "toJS", "signature": [ - "(chainArr: ", + "() => Record Promise" + ">" ], "description": [], - "children": [ + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 29 + } + }, + { + "id": "def-common.ExpressionRendererRegistry.toArray", + "type": "Function", + "label": "toArray", + "signature": [ + "() => ", { - "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" - } + "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 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionsInspectorAdapter", + "type": "Class", + "tags": [], + "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": "Unknown", - "label": "input", + "type": "Any", + "label": "ast", "isRequired": true, "signature": [ - "unknown" + "any" ], "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" + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14 } } ], "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" + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 14 } }, { - "id": "def-common.Execution.invokeFunction", - "type": "Function", - "label": "invokeFunction", + "id": "def-common.ExpressionsInspectorAdapter.ast", + "type": "Any", + "label": "ast", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 19 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/expressions/common/util/expressions_inspector_adapter.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionsService", + "type": "Class", + "tags": [], + "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": [ + { + "tags": [], + "id": "def-common.ExpressionsService.executor", + "type": "Object", + "label": "executor", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 175 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + ">" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionsService.renderers", + "type": "Object", + "label": "renderers", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 176 + }, "signature": [ - "(fn: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - ", input: unknown, args: Record) => Promise" + "section": "def-common.ExpressionRendererRegistry", + "text": "ExpressionRendererRegistry" + } + ] + }, + { + "id": "def-common.ExpressionsService.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" ], "description": [], "children": [ { "type": "Object", - "label": "fn", + "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-common.ExpressionServiceParams", + "text": "ExpressionServiceParams" } ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 178 } } ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 178 } }, { - "id": "def-common.Execution.cast", + "id": "def-common.ExpressionsService.registerFunction", "type": "Function", - "label": "cast", - "signature": [ - "(value: any, toTypeNames?: string[] | undefined) => any" - ], - "description": [], "children": [ { - "type": "Any", - "label": "value", + "type": "CompoundType", + "label": "functionDefinition", "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" + { + "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/execution/execution.ts", - "lineNumber": 348, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 219 } } ], - "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: ", + "(functionDefinition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" }, - ", input: unknown, argAsts: any) => Promise" + " | (() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void" ], - "description": [], + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.registerType", + "type": "Function", "children": [ { - "type": "Object", - "label": "fnDef", + "type": "CompoundType", + "label": "typeDefinition", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - } + "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/execution/execution.ts", - "lineNumber": 374, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 223 } + } + ], + "signature": [ + "(typeDefinition: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" }, + " | (() => ", { - "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" - } + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.ExpressionsService.registerRenderer", + "type": "Function", + "children": [ { - "type": "Any", - "label": "argAsts", + "type": "CompoundType", + "label": "definition", "isRequired": true, "signature": [ - "any" + { + "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/execution/execution.ts", - "lineNumber": 374, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 227 } } ], - "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: ", + "(definition: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstNode", - "text": "ExpressionAstNode" + "section": "def-common.AnyExpressionRenderDefinition", + "text": "AnyExpressionRenderDefinition" }, - ", input: T) => Promise" + " | (() => ", + { + "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 + }, + "tags": [], + "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.ExpressionAstNode", - "text": "ExpressionAstNode" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" } ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230 } }, { @@ -21064,1257 +19832,1286 @@ "label": "input", "isRequired": true, "signature": [ - "T" + "Input" ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230 } - } - ], - "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", - "tags": [], - "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", - "tags": [], - "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, + "label": "params", + "isRequired": false, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Execution", - "text": "Execution" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" }, - "" + " | undefined" ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230 } } ], - "tags": [], - "returnComment": [], + "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/execution/execution_contract.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24" - } + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 230 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.ExecutionContract.cancel", + "id": "def-common.ExpressionsService.getFunction", "type": "Function", - "children": [], - "signature": [ - "() => void" + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 233 + } + } ], - "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." + "signature": [ + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" ], - "label": "cancel", + "description": [], + "label": "getFunction", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 233 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExecutionContract.getData", + "id": "def-common.ExpressionsService.getFunctions", "type": "Function", "children": [], "signature": [ - "() => Promise<", + "() => 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 + }, + "tags": [], + "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 + } + } + ], + "signature": [ + "(name: string) => ", { "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" + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" }, - " | 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." + " | null" ], - "label": "getData", + "description": [], + "label": "getRenderer", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 243 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExecutionContract.getExpression", + "id": "def-common.ExpressionsService.getRenderers", "type": "Function", "children": [], "signature": [ - "() => string" + "() => Record>" ], "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." + "\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances." ], - "label": "getExpression", + "label": "getRenderers", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 250 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExecutionContract.getAst", + "id": "def-common.ExpressionsService.getType", "type": "Function", - "children": [], + "children": [ + { + "type": "string", + "label": "name", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 253 + } + } + ], "signature": [ - "() => ", + "(name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } - ], - "description": [ - "\nGet AST used to execute the expression." + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + " | undefined" ], - "label": "getAst", + "description": [], + "label": "getType", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 253 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExecutionContract.inspect", + "id": "def-common.ExpressionsService.getTypes", "type": "Function", "children": [], "signature": [ - "() => InspectorAdapters" + "() => Record" ], "description": [ - "\nGet Inspector adapters provided to all functions of expression through\nexecution context." + "\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances." ], - "label": "inspect", + "label": "getTypes", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 260 }, "tags": [], "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", - "tags": [], - "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": [ { "tags": [], - "id": "def-common.ExpressionsService.executor", - "type": "Object", - "label": "executor", + "id": "def-common.ExpressionsService.execute", + "type": "Function", + "label": "execute", "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" + "lineNumber": 262 }, "signature": [ + "(ast: string | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" + "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" + }, + "" ] }, { - "tags": [], - "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" - }, + "id": "def-common.ExpressionsService.fork", + "type": "Function", + "children": [], "signature": [ + "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRendererRegistry", - "text": "ExpressionRendererRegistry" + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" } - ] + ], + "description": [], + "label": "fork", + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 268 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.ExpressionsService.Unnamed", + "id": "def-common.ExpressionsService.telemetry", "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], "children": [ { "type": "Object", - "label": "{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }", + "label": "state", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionServiceParams", - "text": "ExpressionServiceParams" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" } ], "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" + "lineNumber": 281 } - } - ], - "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", + "type": "Object", + "label": "telemetryData", "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" - }, - ")" + "Record" ], "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" + "lineNumber": 282 } } ], "signature": [ - "(functionDefinition: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" - }, - " | (() => ", + "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ")) => void" + ", telemetryData?: Record) => Record" ], "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." + "\nExtracts telemetry from expression AST" ], - "label": "registerFunction", + "label": "telemetry", "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" + "lineNumber": 280 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExpressionsService.registerType", + "id": "def-common.ExpressionsService.extract", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "typeDefinition", + "type": "Object", + "label": "state", "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" - }, - ")" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "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" + "lineNumber": 292 } } ], "signature": [ - "(typeDefinition: ", + "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | (() => ", + ") => { state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ")) => void" + "; references: ", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]; }" ], - "description": [], - "label": "registerType", + "description": [ + "\nExtracts saved object references from expression AST" + ], + "label": "extract", "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" + "lineNumber": 292 }, "tags": [], - "returnComment": [] + "returnComment": [ + "new expression AST with references removed and array of references" + ] }, { - "id": "def-common.ExpressionsService.registerRenderer", + "id": "def-common.ExpressionsService.inject", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "definition", + "type": "Object", + "label": "state", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" - }, - " | (() => ", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 302 + } + }, + { + "type": "Array", + "label": "references", + "isRequired": true, + "signature": [ { - "pluginId": "expressions", + "pluginId": "core", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" }, - ")" + "[]" ], "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" + "lineNumber": 302 } } ], "signature": [ - "(definition: ", + "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" + "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.AnyExpressionRenderDefinition", - "text": "AnyExpressionRenderDefinition" - }, - ")) => void" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], - "description": [], - "label": "registerRenderer", + "description": [ + "\nInjects saved object references into expression AST" + ], + "label": "inject", "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" + "lineNumber": 302 }, "tags": [], - "returnComment": [] + "returnComment": [ + "new expression AST with references injected" + ] }, { - "id": "def-common.ExpressionsService.run", + "id": "def-common.ExpressionsService.migrate", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "ast", + "type": "Object", + "label": "state", "isRequired": true, "signature": [ - "string | ", { - "pluginId": "expressions", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" } ], "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" + "lineNumber": 312 } }, { - "type": "Uncategorized", - "label": "input", + "type": "string", + "label": "version", "isRequired": true, "signature": [ - "Input" + "string" ], "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" + "lineNumber": 312 } + } + ], + "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 + }, + "tags": [], + "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 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 174 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionType", + "type": "Class", + "tags": [], + "label": "ExpressionType", + "description": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 13 + } + }, + { + "tags": [], + "id": "def-common.ExpressionType.help", + "type": "string", + "label": "help", + "description": [ + "\nA short help text." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 18 + } + }, + { + "tags": [], + "id": "def-common.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 + }, + "signature": [ + "(type: any) => void | Error" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionType.create", + "type": "Unknown", + "label": "create", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 25 + }, + "signature": [ + "unknown" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "((value: any) => any) | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ExpressionType.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 31 + }, + "signature": [ + "((serialized: any) => any) | undefined" + ] + }, + { + "id": "def-common.ExpressionType.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ { "type": "Object", - "label": "params", - "isRequired": false, + "label": "definition", + "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionExecutionParams", - "text": "ExpressionExecutionParams" - }, - " | undefined" + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + } ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 33 + } }, { - "id": "def-common.ExpressionsService.getFunction", + "id": "def-common.ExpressionType.getToFn", "type": "Function", "children": [ { "type": "string", - "label": "name", + "label": "typeName", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 48 } } ], "signature": [ - "(name: string) => ", + "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" }, - " | undefined" + " | 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" - }, - "tags": [], - "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", + "label": "getToFn", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 47 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExpressionsService.getRenderer", + "id": "def-common.ExpressionType.getFromFn", "type": "Function", "children": [ { "type": "string", - "label": "name", + "label": "typeName", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 53 } } ], "signature": [ - "(name: string) => ", + "(typeName: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRenderer", - "text": "ExpressionRenderer" + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" }, - " | null" + " | undefined" ], "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" - }, - "tags": [], - "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", + "label": "getFromFn", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 52 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExpressionsService.getType", + "id": "def-common.ExpressionType.castsTo", "type": "Function", "children": [ { - "type": "string", - "label": "name", + "type": "Any", + "label": "value", "isRequired": true, "signature": [ - "string" + "any" ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 } } ], "signature": [ - "(name: string) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" - }, - " | undefined" + "(value: any) => boolean" ], "description": [], - "label": "getType", + "label": "castsTo", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 57 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExpressionsService.getTypes", + "id": "def-common.ExpressionType.castsFrom", "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." + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59 + } + } ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "tags": [], - "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" - } + "(value: any) => boolean" ], "description": [], - "label": "fork", + "label": "castsFrom", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 59 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExpressionsService.telemetry", + "id": "def-common.ExpressionType.to", "type": "Function", "children": [ { - "type": "Object", - "label": "state", + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 + } + }, + { + "type": "string", + "label": "toTypeName", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "string" ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 } }, { "type": "Object", - "label": "telemetryData", + "label": "types", "isRequired": true, "signature": [ - "Record" + "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 } } ], "signature": [ - "(state: ", + "(value: any, toTypeName: string, types: Record) => Record" - ], - "description": [ - "\nExtracts telemetry from expression AST" + ">) => any" ], - "label": "telemetry", + "description": [], + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 61 }, "tags": [], "returnComment": [] }, { - "id": "def-common.ExpressionsService.extract", + "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 + } + }, { "type": "Object", - "label": "state", + "label": "types", "isRequired": true, "signature": [ + "Record" ], "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 } } ], "signature": [ - "(state: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - ") => { state: ", + "(value: any, types: Record) => any" ], - "label": "extract", + "description": [], + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 73 }, "tags": [], - "returnComment": [ - "new expression AST with references removed and array of references" - ] + "returnComment": [] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/expression_type.ts", + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "id": "def-common.FunctionsRegistry", + "type": "Class", + "tags": [], + "label": "FunctionsRegistry", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.FunctionsRegistry", + "text": "FunctionsRegistry" }, + " implements ", { - "id": "def-common.ExpressionsService.inject", + "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": "state", + "label": "executor", "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" + "section": "def-common.Executor", + "text": "Executor" }, - "[]" + "" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 59 + } + }, + { + "id": "def-common.FunctionsRegistry.register", + "type": "Function", + "label": "register", "signature": [ - "(state: ", + "(functionDefinition: ", { "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" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" }, - "[]) => ", + " | (() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } - ], - "description": [ - "\nInjects saved object references into expression AST" + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ")) => void" ], - "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" - }, - "tags": [], - "returnComment": [ - "new expression AST with references injected" - ] - }, - { - "id": "def-common.ExpressionsService.migrate", - "type": "Function", + "description": [], "children": [ { - "type": "Object", - "label": "state", + "type": "CompoundType", + "label": "functionDefinition", "isRequired": true, "signature": [ { - "pluginId": "kibanaUtils", + "pluginId": "expressions", "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - } + "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": 312, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 62 } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 61 + } + }, + { + "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": "version", + "label": "id", "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67 } } ], - "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" - }, "tags": [], - "returnComment": [ - "new migrated expression AST" - ] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 67 + } }, { - "id": "def-common.ExpressionsService.setup", + "id": "def-common.FunctionsRegistry.toJS", "type": "Function", - "label": "setup", + "label": "toJS", "signature": [ - "() => Pick<", + "() => Record" - ], - "description": [ - "\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side." + ">" ], + "description": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 71 } }, { - "id": "def-common.ExpressionsService.start", + "id": "def-common.FunctionsRegistry.toArray", "type": "Function", - "label": "start", + "label": "toArray", "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" + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + "[]" ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 75 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 58 }, "initialIsOpen": false }, @@ -22363,8 +21160,7 @@ "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" + "lineNumber": 15 } }, { @@ -22383,8 +21179,7 @@ "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" + "lineNumber": 15 } } ], @@ -22392,8 +21187,7 @@ "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" + "lineNumber": 15 } }, { @@ -22404,8 +21198,7 @@ "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" + "lineNumber": 20 }, "signature": [ "{ [key: string]: ", @@ -22422,128 +21215,236 @@ ], "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" + "lineNumber": 12 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionsInspectorAdapter", + "id": "def-common.TypesRegistry", "type": "Class", "tags": [], - "label": "ExpressionsInspectorAdapter", + "label": "TypesRegistry", "description": [], "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsInspectorAdapter", - "text": "ExpressionsInspectorAdapter" + "section": "def-common.TypesRegistry", + "text": "TypesRegistry" }, - " extends ", - "EventEmitter" + " 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.ExpressionsInspectorAdapter.logAST", + "id": "def-common.TypesRegistry.Unnamed", "type": "Function", - "label": "logAST", + "label": "Constructor", "signature": [ - "(ast: any) => void" + "any" ], "description": [], "children": [ { - "type": "Any", - "label": "ast", + "type": "Object", + "label": "executor", "isRequired": true, "signature": [ - "any" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 37 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 39 + } + }, + { + "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/util/expressions_inspector_adapter.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45 } } ], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 45 } }, { - "id": "def-common.ExpressionsInspectorAdapter.ast", - "type": "Any", - "label": "ast", - "tags": [], + "id": "def-common.TypesRegistry.toJS", + "type": "Function", + "label": "toJS", + "signature": [ + "() => Record" + ], "description": [], + "children": [], + "tags": [], + "returnComment": [], "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": [ + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 49 + } + }, { - "type": "Any", - "label": "val", - "isRequired": true, + "id": "def-common.TypesRegistry.toArray", + "type": "Function", + "label": "toArray", "signature": [ - "any" - ], - "description": [ - "Value you want to check." + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" + }, + "[]" ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 53 } } ], - "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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 36 }, "initialIsOpen": false - }, + } + ], + "functions": [ { "id": "def-common.buildExpression", "type": "Function", @@ -22622,8 +21523,7 @@ ], "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" + "lineNumber": 98 } } ], @@ -22635,8 +21535,7 @@ ], "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" + "lineNumber": 97 }, "initialIsOpen": false }, @@ -22702,8 +21601,7 @@ ], "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" + "lineNumber": 155 } }, { @@ -22734,8 +21632,7 @@ ], "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" + "lineNumber": 163 } } ], @@ -22746,176 +21643,321 @@ "`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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 152 + }, + "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 + } + }, + { + "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 + } + }, + { + "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 + } + }, + { + "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 + } + }, + { + "id": "def-common.buildResultColumns.options", + "type": "Object", + "label": "options", + "tags": [], + "description": [], + "children": [ + { + "tags": [], + "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 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 38 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts", + "lineNumber": 33 + }, + "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 + } + } + ], + "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 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.formatExpression", + "id": "def-common.createExecutionContainer", "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", + "label": "state", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } - ], - "description": [ - "Expression pipeline AST." + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" ], + "description": [], "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" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 81 } } ], - "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 ", + "(state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExecutionState", + "text": "ExecutionState" }, - " ? \"expression\" : \"argument\") => string" + ") => ", + { + "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 + }, + "tags": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "id": "def-common.createExecutorContainer", + "type": "Function", "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", + "type": "Object", + "label": "state", "isRequired": true, "signature": [ - "T extends ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - " ? \"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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 62 } } ], - "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) => ", + " = Record>(state?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } - ], - "description": [ - "\nGiven expression pipeline string, returns parsed AST.\n" - ], - "children": [ + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ") => ", { - "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" - } - } + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorContainer", + "text": "ExecutorContainer" + }, + "" ], - "tags": [], - "returnComment": [], + "description": [], + "label": "createExecutorContainer", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 59 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.parse", + "id": "def-common.format", "type": "Function", - "label": "parse", + "label": "format", "signature": [ - "(expression: E, startRule: S) => S extends \"expression\" ? ", + "(ast: T, type: T extends ", { "pluginId": "expressions", "scope": "common", @@ -22923,234 +21965,100 @@ "section": "def-common.ExpressionAstExpression", "text": "ExpressionAstExpression" }, - " : ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstArgument", - "text": "ExpressionAstArgument" - } + " ? \"expression\" : \"argument\") => string" ], "description": [], "children": [ { "type": "Uncategorized", - "label": "expression", + "label": "ast", "isRequired": true, "signature": [ - "E" + "T" ], "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" + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 15 } }, { "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", + "label": "type", "isRequired": true, "signature": [ - "Record" + " ? \"expression\" : \"argument\"" ], "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" + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 16 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format.ts", + "lineNumber": 14 + }, "initialIsOpen": false }, { - "id": "def-common.isDatatable", + "id": "def-common.formatExpression", "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" - } - } - ], + "label": "formatExpression", "signature": [ - "(datatable: unknown) => datatable is ", + "(ast: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + ") => string" ], "description": [ - "\nA Utility function that Typescript can use to determine if an object is a Datatable." + "\nGiven expression pipeline AST, returns formatted string.\n" ], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-common.isExpressionValueError", - "type": "Function", "children": [ { - "type": "Any", - "label": "value", + "type": "Object", + "label": "ast", "isRequired": true, "signature": [ - "any" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "description": [ + "Expression pipeline AST." ], - "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" + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/format_expression.ts", + "lineNumber": 17 + }, "initialIsOpen": false }, { @@ -23174,8 +22082,7 @@ "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" + "lineNumber": 15 } }, { @@ -23188,8 +22095,7 @@ "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" + "lineNumber": 15 } } ], @@ -23197,292 +22103,186 @@ "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" + "lineNumber": 15 }, "initialIsOpen": false }, { - "id": "def-common.buildResultColumns", + "id": "def-common.getByAlias", "type": "Function", - "label": "buildResultColumns", + "label": "getByAlias", "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" + "(node: T[] | Record, nodeName: string) => T | 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." + "\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": "Object", - "label": "input", + "type": "CompoundType", + "label": "node", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } - ], - "description": [ - "Input datatable" + "T[] | Record" ], + "description": [], "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" + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 15 } }, { "type": "string", - "label": "outputColumnId", + "label": "nodeName", "isRequired": true, "signature": [ "string" ], - "description": [ - "Id of the output column" - ], + "description": [], "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" + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 16 } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/util/get_by_alias.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-common.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(node: any) => any" + ], + "description": [], + "children": [ { - "type": "string", - "label": "inputColumnId", + "type": "Any", + "label": "node", "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" + "any" ], - "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", - "tags": [], "description": [], - "children": [ - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_types/get_type.ts", + "lineNumber": 9 } } ], "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" + "path": "src/plugins/expressions/common/expression_types/get_type.ts", + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-common.createExecutorContainer", + "id": "def-common.isDatatable", "type": "Function", "children": [ { - "type": "Object", - "label": "state", + "type": "Unknown", + "label": "datatable", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - "" + "unknown" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 29 } } ], "signature": [ - " = Record>(state?: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ") => ", + "(datatable: unknown) => datatable is ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorContainer", - "text": "ExecutorContainer" - }, - "" + "section": "def-common.Datatable", + "text": "Datatable" + } ], - "description": [], - "label": "createExecutorContainer", + "description": [ + "\nA Utility function that Typescript can use to determine if an object is a Datatable." + ], + "label": "isDatatable", "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 29 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.createExecutionContainer", + "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": "Object", - "label": "state", + "type": "Any", + "label": "val", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - "" + "any" + ], + "description": [ + "Value you want to check." ], - "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 } } ], - "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" - }, - "" + "tags": [ + "return" + ], + "returnComment": [ + "boolean" ], - "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 35 }, - "tags": [], - "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.createError", + "id": "def-common.isExpressionValueError", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "err", + "type": "Any", + "label": "value", "isRequired": true, "signature": [ - "string | ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ErrorLike", - "text": "ErrorLike" - } + "any" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 25 } } ], "signature": [ - "(err: string | ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ErrorLike", - "text": "ErrorLike" - }, - ") => ", + "(value: any) => value is ", { "pluginId": "expressions", "scope": "common", @@ -23509,2525 +22309,2253 @@ " | undefined; }>" ], "description": [], - "label": "createError", + "label": "isExpressionValueError", "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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 25 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-common.getByAlias", + "id": "def-common.parse", "type": "Function", - "label": "getByAlias", + "label": "parse", "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." + "(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": "CompoundType", - "label": "node", + "type": "Uncategorized", + "label": "expression", "isRequired": true, "signature": [ - "T[] | Record" + "E" ], "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" + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 15 } }, { - "type": "string", - "label": "nodeName", + "type": "Uncategorized", + "label": "startRule", "isRequired": true, "signature": [ - "string" + "S" ], "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" + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 16 } } ], "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" + "path": "src/plugins/expressions/common/ast/parse.ts", + "lineNumber": 14 }, "initialIsOpen": false - } - ], - "interfaces": [ + }, { - "id": "def-common.SerializedFieldFormat", - "type": "Interface", - "label": "SerializedFieldFormat", + "id": "def-common.parseExpression", + "type": "Function", + "label": "parseExpression", "signature": [ + "(expression: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "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." + "\nGiven expression pipeline string, returns parsed AST.\n" ], - "tags": [], "children": [ { - "tags": [], - "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" - }, + "label": "expression", + "isRequired": true, "signature": [ - "string | undefined" - ] - }, + "string" + ], + "description": [ + "Expression pipeline string." + ], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/ast/parse_expression.ts", + "lineNumber": 17 + }, + "initialIsOpen": false + }, + { + "id": "def-common.serializeProvider", + "type": "Function", + "children": [ { - "tags": [], - "id": "def-common.SerializedFieldFormat.params", - "type": "Uncategorized", - "label": "params", + "type": "Object", + "label": "types", + "isRequired": true, + "signature": [ + "Record" + ], "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" - ] + "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", + "lineNumber": 15 + } } ], + "signature": [ + "(types: Record) => { serialize: (value: any) => any; deserialize: (value: any) => any; }" + ], + "description": [], + "label": "serializeProvider", "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" + "path": "src/plugins/expressions/common/expression_types/serialize_provider.ts", + "lineNumber": 15 }, + "tags": [], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { - "id": "def-common.CSSStyle", + "id": "def-common.ContainerStyle", "type": "Interface", - "label": "CSSStyle", + "label": "ContainerStyle", "description": [ - "\nRepresents the various style properties that can be applied to an element." + "\nRepresents an object containing style information for a Container." ], "tags": [], "children": [ { "tags": [], - "id": "def-common.CSSStyle.color", - "type": "string", - "label": "color", + "id": "def-common.ContainerStyle.border", + "type": "CompoundType", + "label": "border", "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" + "lineNumber": 106 }, "signature": [ - "string | undefined" + "string | null" ] }, { "tags": [], - "id": "def-common.CSSStyle.fill", - "type": "string", - "label": "fill", + "id": "def-common.ContainerStyle.borderRadius", + "type": "CompoundType", + "label": "borderRadius", "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" + "lineNumber": 107 }, "signature": [ - "string | undefined" + "string | null" ] }, { "tags": [], - "id": "def-common.CSSStyle.fontFamily", + "id": "def-common.ContainerStyle.padding", "type": "CompoundType", - "label": "fontFamily", + "label": "padding", "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" + "lineNumber": 108 }, "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" + "string | null" ] }, { "tags": [], - "id": "def-common.CSSStyle.fontSize", - "type": "string", - "label": "fontSize", + "id": "def-common.ContainerStyle.backgroundColor", + "type": "CompoundType", + "label": "backgroundColor", "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" + "lineNumber": 109 }, "signature": [ - "string | undefined" + "string | null" ] }, { "tags": [], - "id": "def-common.CSSStyle.fontStyle", + "id": "def-common.ContainerStyle.backgroundImage", "type": "CompoundType", - "label": "fontStyle", + "label": "backgroundImage", "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" + "lineNumber": 110 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.FontStyle", - "text": "FontStyle" - }, - " | undefined" + "string | null" ] }, { "tags": [], - "id": "def-common.CSSStyle.fontWeight", - "type": "CompoundType", - "label": "fontWeight", + "id": "def-common.ContainerStyle.backgroundSize", + "type": "Enum", + "label": "backgroundSize", "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" + "lineNumber": 111 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.FontWeight", - "text": "FontWeight" - }, - " | undefined" + "section": "def-common.BackgroundSize", + "text": "BackgroundSize" + } ] }, { "tags": [], - "id": "def-common.CSSStyle.lineHeight", - "type": "CompoundType", - "label": "lineHeight", + "id": "def-common.ContainerStyle.backgroundRepeat", + "type": "Enum", + "label": "backgroundRepeat", "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" + "lineNumber": 112 }, "signature": [ - "string | number | undefined" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.BackgroundRepeat", + "text": "BackgroundRepeat" + } ] }, { "tags": [], - "id": "def-common.CSSStyle.textAlign", + "id": "def-common.ContainerStyle.opacity", "type": "CompoundType", - "label": "textAlign", + "label": "opacity", "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" + "lineNumber": 113 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.TextAlignment", - "text": "TextAlignment" - }, - " | undefined" + "number | null" ] }, { "tags": [], - "id": "def-common.CSSStyle.textDecoration", - "type": "CompoundType", - "label": "textDecoration", + "id": "def-common.ContainerStyle.overflow", + "type": "Enum", + "label": "overflow", "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" + "lineNumber": 114 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.TextDecoration", - "text": "TextDecoration" - }, - " | undefined" + "section": "def-common.Overflow", + "text": "Overflow" + } ] } ], "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" + "lineNumber": 105 }, "initialIsOpen": false }, { - "id": "def-common.ContainerStyle", + "id": "def-common.CSSStyle", "type": "Interface", - "label": "ContainerStyle", + "label": "CSSStyle", "description": [ - "\nRepresents an object containing style information for a Container." + "\nRepresents the various style properties that can be applied to an element." ], "tags": [], "children": [ { "tags": [], - "id": "def-common.ContainerStyle.border", - "type": "CompoundType", - "label": "border", + "id": "def-common.CSSStyle.color", + "type": "string", + "label": "color", "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" + "lineNumber": 91 }, "signature": [ - "string | null" + "string | undefined" ] }, { "tags": [], - "id": "def-common.ContainerStyle.borderRadius", - "type": "CompoundType", - "label": "borderRadius", + "id": "def-common.CSSStyle.fill", + "type": "string", + "label": "fill", "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" + "lineNumber": 92 }, "signature": [ - "string | null" + "string | undefined" ] }, { "tags": [], - "id": "def-common.ContainerStyle.padding", + "id": "def-common.CSSStyle.fontFamily", "type": "CompoundType", - "label": "padding", + "label": "fontFamily", "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" + "lineNumber": 93 }, "signature": [ - "string | null" + "\"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" ] }, { "tags": [], - "id": "def-common.ContainerStyle.backgroundColor", - "type": "CompoundType", - "label": "backgroundColor", + "id": "def-common.CSSStyle.fontSize", + "type": "string", + "label": "fontSize", "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" + "lineNumber": 94 }, "signature": [ - "string | null" + "string | undefined" ] }, { "tags": [], - "id": "def-common.ContainerStyle.backgroundImage", + "id": "def-common.CSSStyle.fontStyle", "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" - ] - }, - { - "tags": [], - "id": "def-common.ContainerStyle.backgroundSize", - "type": "Enum", - "label": "backgroundSize", + "label": "fontStyle", "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" + "lineNumber": 95 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.BackgroundSize", - "text": "BackgroundSize" - } + "section": "def-common.FontStyle", + "text": "FontStyle" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.ContainerStyle.backgroundRepeat", - "type": "Enum", - "label": "backgroundRepeat", + "id": "def-common.CSSStyle.fontWeight", + "type": "CompoundType", + "label": "fontWeight", "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" + "lineNumber": 96 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.BackgroundRepeat", - "text": "BackgroundRepeat" - } + "section": "def-common.FontWeight", + "text": "FontWeight" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.ContainerStyle.opacity", + "id": "def-common.CSSStyle.lineHeight", "type": "CompoundType", - "label": "opacity", + "label": "lineHeight", "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" + "lineNumber": 97 }, "signature": [ - "number | null" + "string | number | undefined" ] }, { "tags": [], - "id": "def-common.ContainerStyle.overflow", - "type": "Enum", - "label": "overflow", + "id": "def-common.CSSStyle.textAlign", + "type": "CompoundType", + "label": "textAlign", "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" + "lineNumber": 98 }, "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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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\"" + "section": "def-common.TextAlignment", + "text": "TextAlignment" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.ExpressionTypeStyle.spec", - "type": "Object", - "label": "spec", + "id": "def-common.CSSStyle.textDecoration", + "type": "CompoundType", + "label": "textDecoration", "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" + "lineNumber": 99 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.CSSStyle", - "text": "CSSStyle" - } + "section": "def-common.TextDecoration", + "text": "TextDecoration" + }, + " | undefined" ] - }, - { - "tags": [], - "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" + "lineNumber": 90 }, "initialIsOpen": false }, { - "id": "def-common.IRegistry", + "id": "def-common.CumulativeSumArgs", "type": "Interface", - "label": "IRegistry", - "signature": [ + "label": "CumulativeSumArgs", + "description": [], + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.IRegistry", - "text": "IRegistry" + "tags": [], + "id": "def-common.CumulativeSumArgs.by", + "type": "Array", + "label": "by", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 15 + }, + "signature": [ + "string[] | undefined" + ] }, - "" - ], - "description": [], - "tags": [], - "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": [], + "id": "def-common.CumulativeSumArgs.inputColumnId", + "type": "string", + "label": "inputColumnId", + "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 16 } }, { - "id": "def-common.IRegistry.toJS", - "type": "Function", - "label": "toJS", - "signature": [ - "() => Record" - ], - "description": [], - "children": [], "tags": [], - "returnComment": [], + "id": "def-common.CumulativeSumArgs.outputColumnId", + "type": "string", + "label": "outputColumnId", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 17 } }, { - "id": "def-common.IRegistry.toArray", - "type": "Function", - "label": "toArray", - "signature": [ - "() => T[]" - ], - "description": [], - "children": [], "tags": [], - "returnComment": [], + "id": "def-common.CumulativeSumArgs.outputColumnName", + "type": "string", + "label": "outputColumnName", + "description": [], "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" - } + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 18 + }, + "signature": [ + "string | undefined" + ] } ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionAstExpressionBuilder", + "id": "def-common.Datatable", "type": "Interface", - "label": "ExpressionAstExpressionBuilder", - "description": [], + "label": "Datatable", + "description": [ + "\nA `Datatable` in Canvas is a unique structure that represents tabulated data." + ], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExpressionAstExpressionBuilder.type", + "id": "def-common.Datatable.type", "type": "string", "label": "type", - "description": [ - "\nUsed to identify expression builder objects." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 99 }, "signature": [ - "\"expression_builder\"" + "\"datatable\"" ] }, { "tags": [], - "id": "def-common.ExpressionAstExpressionBuilder.functions", + "id": "def-common.Datatable.columns", "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." - ], + "label": "columns", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 100 }, "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" + "section": "def-common.DatatableColumn", + "text": "DatatableColumn" }, - ">[]" + "[]" ] }, { - "tags": [ - "return" - ], - "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" - ], + "tags": [], + "id": "def-common.Datatable.rows", + "type": "Array", + "label": "rows", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 101 }, "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" - }, - "[]" + "Record[]" ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 98 + }, + "initialIsOpen": false + }, + { + "id": "def-common.DatatableColumn", + "type": "Interface", + "label": "DatatableColumn", + "description": [ + "\nThis type represents the shape of a column in a `Datatable`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DatatableColumn.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 90 + } }, { - "tags": [ - "return" - ], - "id": "def-common.ExpressionAstExpressionBuilder.toAst", - "type": "Function", - "label": "toAst", - "description": [ - "\nConverts expression to an AST.\n" - ], + "tags": [], + "id": "def-common.DatatableColumn.name", + "type": "string", + "label": "name", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 91 + } + }, + { + "tags": [], + "id": "def-common.DatatableColumn.meta", + "type": "Object", + "label": "meta", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 92 }, "signature": [ - "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.DatatableColumnMeta", + "text": "DatatableColumnMeta" } ] - }, - { - "tags": [ - "return" - ], - "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 89 }, - "initialIsOpen": false - }, - { - "id": "def-common.ExpressionAstFunctionBuilder", - "type": "Interface", - "label": "ExpressionAstFunctionBuilder", - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunctionBuilder", - "text": "ExpressionAstFunctionBuilder" - }, - "" + "initialIsOpen": false + }, + { + "id": "def-common.DatatableColumnMeta", + "type": "Interface", + "label": "DatatableColumnMeta", + "description": [ + "\nDatatable column meta information" ], - "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExpressionAstFunctionBuilder.type", - "type": "string", + "id": "def-common.DatatableColumnMeta.type", + "type": "CompoundType", "label": "type", - "description": [ - "\nUsed to identify expression function builder objects." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 63 }, "signature": [ - "\"expression_function_builder\"" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableColumnType", + "text": "DatatableColumnType" + } ] }, { "tags": [], - "id": "def-common.ExpressionAstFunctionBuilder.name", - "type": "Uncategorized", - "label": "name", + "id": "def-common.DatatableColumnMeta.field", + "type": "string", + "label": "field", "description": [ - "\nName of this expression function." + "\nfield this column is based on" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 67 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.InferFunctionDefinition", - "text": "InferFunctionDefinition" - }, - "[\"name\"]" + "string | undefined" ] }, { "tags": [], - "id": "def-common.ExpressionAstFunctionBuilder.arguments", - "type": "Object", - "label": "arguments", + "id": "def-common.DatatableColumnMeta.index", + "type": "string", + "label": "index", "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." + "\nindex/table this column is based on" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 71 }, "signature": [ - "FunctionBuilderArguments" + "string | undefined" ] }, { - "tags": [ - "return" - ], - "id": "def-common.ExpressionAstFunctionBuilder.addArgument", - "type": "Function", - "label": "addArgument", + "tags": [], + "id": "def-common.DatatableColumnMeta.params", + "type": "Object", + "label": "params", "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" + "\nserialized field format" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 75 }, "signature": [ - ">(name: A, value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" }, - " | FunctionArgs[A]) => this" + "> | undefined" ] }, { - "tags": [ - "return" - ], - "id": "def-common.ExpressionAstFunctionBuilder.getArgument", - "type": "Function", - "label": "getArgument", + "tags": [], + "id": "def-common.DatatableColumnMeta.source", + "type": "string", + "label": "source", "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" + "\nsource function that produced this column" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 79 }, "signature": [ - ">(name: A) => (", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" - }, - " | FunctionArgs[A])[] | undefined" + "string | undefined" ] }, { - "tags": [ - "return" - ], - "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument", - "type": "Function", - "label": "replaceArgument", + "tags": [], + "id": "def-common.DatatableColumnMeta.sourceParams", + "type": "Object", + "label": "sourceParams", "description": [ - "\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n" + "\nany extra parameters for the source that produced this column" ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 83 }, "signature": [ - ">(name: A, value: (", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.SerializableState", + "text": "SerializableState" }, - " | FunctionArgs[A])[]) => this" + " | undefined" ] + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 62 + }, + "initialIsOpen": false + }, + { + "id": "def-common.DefaultInspectorAdapters", + "type": "Interface", + "label": "DefaultInspectorAdapters", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DefaultInspectorAdapters", + "text": "DefaultInspectorAdapters" }, + " extends ", { - "tags": [ - "return" - ], - "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" - ], + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "description": [ + "\nDefault inspector adapters created if inspector adapters are not set explicitly." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DefaultInspectorAdapters.requests", + "type": "Object", + "label": "requests", + "description": [], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 86 }, "signature": [ - ">>(name: A) => this" + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + } ] }, { - "tags": [ - "return" - ], - "id": "def-common.ExpressionAstFunctionBuilder.toAst", - "type": "Function", - "label": "toAst", - "description": [ - "\nConverts function to an AST.\n" - ], + "tags": [], + "id": "def-common.DefaultInspectorAdapters.tables", + "type": "Object", + "label": "tables", + "description": [], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 87 }, "signature": [ - "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" + "section": "def-common.TablesAdapter", + "text": "TablesAdapter" } ] - }, - { - "tags": [ - "return" - ], - "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 85 }, "initialIsOpen": false }, { - "id": "def-common.Font", + "id": "def-common.DerivativeArgs", "type": "Interface", - "label": "Font", - "description": [ - "\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`." - ], + "label": "DerivativeArgs", + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.Font.label", - "type": "CompoundType", - "label": "label", + "id": "def-common.DerivativeArgs.by", + "type": "Array", + "label": "by", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 15 }, "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\"" + "string[] | undefined" ] }, { "tags": [], - "id": "def-common.Font.value", - "type": "CompoundType", - "label": "value", + "id": "def-common.DerivativeArgs.inputColumnId", + "type": "string", + "label": "inputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-common.DerivativeArgs.outputColumnId", + "type": "string", + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-common.DerivativeArgs.outputColumnName", + "type": "string", + "label": "outputColumnName", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 18 }, "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\"" + "string | undefined" ] } ], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionTypeDefinition", + "id": "def-common.ExecutionContext", "type": "Interface", - "label": "ExpressionTypeDefinition", + "label": "ExecutionContext", "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionTypeDefinition", - "text": "ExpressionTypeDefinition" + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, - "" + "" ], "description": [ - "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." + "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." ], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.ExpressionTypeDefinition.deserialize", + "id": "def-common.ExecutionContext.getSearchContext", "type": "Function", - "label": "deserialize", - "description": [], + "label": "getSearchContext", + "description": [ + "\nGet search context of the expression." + ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 28 }, "signature": [ - "((type: SerializedType) => Value) | undefined" + "() => ExecutionContextSearch" ] }, { "tags": [], - "id": "def-common.ExpressionTypeDefinition.from", + "id": "def-common.ExecutionContext.variables", "type": "Object", - "label": "from", - "description": [], + "label": "variables", + "description": [ + "\nContext variables that can be consumed using `var` and `var_set` functions." + ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 33 }, "signature": [ - "{ [type: string]: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueConverter", - "text": "ExpressionValueConverter" - }, - "; } | undefined" + "Record" ] }, { "tags": [], - "id": "def-common.ExpressionTypeDefinition.to", + "id": "def-common.ExecutionContext.types", "type": "Object", - "label": "to", - "description": [], + "label": "types", + "description": [ + "\nA map of available expression types." + ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 38 }, "signature": [ - "{ [type: string]: ", + "Record; } | undefined" + ">" ] }, { "tags": [], - "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.DatatableColumnMeta", - "type": "Interface", - "label": "DatatableColumnMeta", - "description": [ - "\nDatatable column meta information" - ], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.DatatableColumnMeta.type", - "type": "CompoundType", - "label": "type", - "description": [], + "id": "def-common.ExecutionContext.abortSignal", + "type": "Object", + "label": "abortSignal", + "description": [ + "\nAdds ability to abort current execution." + ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 43 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumnType", - "text": "DatatableColumnType" - } + "AbortSignal" ] }, { "tags": [], - "id": "def-common.DatatableColumnMeta.field", - "type": "string", - "label": "field", + "id": "def-common.ExecutionContext.inspectorAdapters", + "type": "Uncategorized", + "label": "inspectorAdapters", "description": [ - "\nfield this column is based on" + "\nAdapters for `inspector` plugin." ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 48 }, "signature": [ - "string | undefined" + "InspectorAdapters" ] }, { "tags": [], - "id": "def-common.DatatableColumnMeta.index", - "type": "string", - "label": "index", + "id": "def-common.ExecutionContext.getSearchSessionId", + "type": "Function", + "label": "getSearchSessionId", "description": [ - "\nindex/table this column is based on" + "\nSearch context in which expression should operate." ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 53 }, "signature": [ - "string | undefined" + "() => string | undefined" ] }, { "tags": [], - "id": "def-common.DatatableColumnMeta.params", - "type": "Object", - "label": "params", + "id": "def-common.ExecutionContext.getKibanaRequest", + "type": "Function", + "label": "getKibanaRequest", "description": [ - "\nserialized field format" + "\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/expression_types/specs/datatable.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L75" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 60 }, "signature": [ + "(() => ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" }, - "> | undefined" + ") | undefined" ] }, { "tags": [], - "id": "def-common.DatatableColumnMeta.source", - "type": "string", - "label": "source", + "id": "def-common.ExecutionContext.getSavedObject", + "type": "Function", + "label": "getSavedObject", "description": [ - "\nsource function that produced this column" + "\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/expression_types/specs/datatable.ts", - "lineNumber": 79, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L79" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 71 }, "signature": [ - "string | undefined" + "((type: string, id: string) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">) | undefined" ] }, { "tags": [], - "id": "def-common.DatatableColumnMeta.sourceParams", - "type": "Object", - "label": "sourceParams", + "id": "def-common.ExecutionContext.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", "description": [ - "\nany extra parameters for the source that produced this column" + "\nReturns the state (true|false) of the sync colors across panels switch." ], "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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 79 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, - " | undefined" + "(() => boolean) | 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" + "path": "src/plugins/expressions/common/execution/types.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-common.DatatableColumn", + "id": "def-common.ExecutionParams", "type": "Interface", - "label": "DatatableColumn", - "description": [ - "\nThis type represents the shape of a column in a `Datatable`." - ], + "label": "ExecutionParams", + "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.DatatableColumn.name", - "type": "string", - "label": "name", + "id": "def-common.ExecutionParams.executor", + "type": "Object", + "label": "executor", "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" - } + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 58 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "" + ] }, { "tags": [], - "id": "def-common.DatatableColumn.meta", + "id": "def-common.ExecutionParams.ast", "type": "Object", - "label": "meta", + "label": "ast", "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 59 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumnMeta", - "text": "DatatableColumnMeta" - } + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + " | undefined" ] - } - ], - "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." - ], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.Datatable.type", + "id": "def-common.ExecutionParams.expression", "type": "string", - "label": "type", + "label": "expression", "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 60 }, "signature": [ - "\"datatable\"" + "string | undefined" ] }, { "tags": [], - "id": "def-common.Datatable.columns", - "type": "Array", - "label": "columns", + "id": "def-common.ExecutionParams.params", + "type": "Object", + "label": "params", "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 61 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.DatatableColumn", - "text": "DatatableColumn" - }, - "[]" - ] - }, - { - "tags": [], - "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[]" + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" + } ] } ], "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" + "path": "src/plugins/expressions/common/execution/execution.ts", + "lineNumber": 57 }, "initialIsOpen": false }, { - "id": "def-common.SerializedDatatable", + "id": "def-common.ExecutionPureTransitions", "type": "Interface", - "label": "SerializedDatatable", + "label": "ExecutionPureTransitions", "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializedDatatable", - "text": "SerializedDatatable" + "section": "def-common.ExecutionPureTransitions", + "text": "ExecutionPureTransitions" }, - " extends ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.SerializedDatatable.rows", - "type": "Array", - "label": "rows", + "id": "def-common.ExecutionPureTransitions.start", + "type": "Function", + "label": "start", "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" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 51 }, "signature": [ - "string[][]" + "(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" + }, + "" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.ExpressionImage.type", - "type": "string", - "label": "type", + "id": "def-common.ExecutionPureTransitions.setResult", + "type": "Function", + "label": "setResult", "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" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 52 }, "signature": [ - "\"image\"" + "(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" + }, + "" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.ExpressionImage.dataurl", - "type": "string", - "label": "dataurl", + "id": "def-common.ExecutionPureTransitions.setError", + "type": "Function", + "label": "setError", "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" - } + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 53 + }, + "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/expression_types/specs/image.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 50 }, "initialIsOpen": false }, { - "id": "def-common.PointSeriesColumn", + "id": "def-common.ExecutionState", "type": "Interface", - "label": "PointSeriesColumn", - "description": [ - "\nColumn in a PointSeries" + "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": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.PointSeriesColumn.type", - "type": "CompoundType", - "label": "type", + "id": "def-common.ExecutionState.ast", + "type": "Object", + "label": "ast", "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" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 18 }, "signature": [ - "\"string\" | \"number\"" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ] }, { "tags": [], - "id": "def-common.PointSeriesColumn.role", + "id": "def-common.ExecutionState.state", "type": "CompoundType", - "label": "role", - "description": [], + "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/expression_types/specs/pointseries.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 28 }, "signature": [ - "\"measure\" | \"dimension\"" + "\"result\" | \"error\" | \"not-started\" | \"pending\"" ] }, { "tags": [], - "id": "def-common.PointSeriesColumn.expression", - "type": "string", - "label": "expression", - "description": [], + "id": "def-common.ExecutionState.result", + "type": "Uncategorized", + "label": "result", + "description": [ + "\nResult of the expression execution." + ], "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" - } + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 33 + }, + "signature": [ + "Output | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "Error | undefined" + ] } ], "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" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-common.Range", + "id": "def-common.ExecutorPureSelectors", "type": "Interface", - "label": "Range", + "label": "ExecutorPureSelectors", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.Range.type", - "type": "string", - "label": "type", + "id": "def-common.ExecutorPureSelectors.getFunction", + "type": "Function", + "label": "getFunction", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 44 }, "signature": [ - "\"range\"" + "(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" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.Range.to", - "type": "number", - "label": "to", + "id": "def-common.ExecutorPureSelectors.getType", + "type": "Function", + "label": "getType", "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" - } + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 45 + }, + "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" + ] }, { "tags": [], - "id": "def-common.Range.label", - "type": "string", - "label": "label", + "id": "def-common.ExecutorPureSelectors.getContext", + "type": "Function", + "label": "getContext", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 46 }, "signature": [ - "string | undefined" + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">) => () => Record" ] } ], "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 43 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionDefinition", + "id": "def-common.ExecutorPureTransitions", "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." - ], + "label": "ExecutorPureTransitions", + "description": [], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.ExpressionFunctionDefinition.type", - "type": "CompoundType", - "label": "type", - "description": [ - "\nName of type of value this function outputs." - ], + "id": "def-common.ExecutorPureTransitions.addFunction", + "type": "Function", + "label": "addFunction", + "description": [], "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 29 }, "signature": [ - "\"date\" | \"filter\" | ", + "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.KnownTypeToString", - "text": "KnownTypeToString" + "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" }, - "<", - "UnwrapPromiseOrReturn", - "> | undefined" + ">" ] }, { "tags": [], - "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." - ], + "id": "def-common.ExecutorPureTransitions.addType", + "type": "Function", + "label": "addType", + "description": [], "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 30 }, "signature": [ + "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.TypeToString", - "text": "TypeToString" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - "[] | undefined" - ] - }, - { - "tags": [], - "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]: ", + ">) => (type: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ArgumentType", - "text": "ArgumentType" + "section": "def-common.ExpressionType", + "text": "ExpressionType" }, - "; }" + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" ] }, { - "tags": [ - "todo" - ], - "id": "def-common.ExpressionFunctionDefinition.aliases", - "type": "Array", - "label": "aliases", + "tags": [], + "id": "def-common.ExecutorPureTransitions.extendContext", + "type": "Function", + "label": "extendContext", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 31 }, "signature": [ - "string[] | undefined" - ] - }, - { - "tags": [], - "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": [ + "(state: ", { - "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" - } + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, + ">) => (extraContext: Record) => ", { - "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" - } + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - { - "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" - } - }, - { - "tags": [ - "deprecated" - ], - "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 28 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionDefinitions", + "id": "def-common.ExecutorState", "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" - ], - "tags": [ - "public" + "label": "ExecutorState", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + "" ], + "description": [], + "tags": [], "children": [ { "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.clog", + "id": "def-common.ExecutorState.functions", "type": "Object", - "label": "clog", + "label": "functions", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 17 }, "signature": [ + "Record" ] }, { "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.font", + "id": "def-common.ExecutorState.types", "type": "Object", - "label": "font", + "label": "types", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 18 }, "signature": [ + "Record" ] }, { "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.var_set", - "type": "Object", - "label": "var_set", + "id": "def-common.ExecutorState.context", + "type": "Uncategorized", + "label": "context", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 19 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVarSet", - "text": "ExpressionFunctionVarSet" - } + "Context" ] - }, + } + ], + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionAstExpressionBuilder", + "type": "Interface", + "label": "ExpressionAstExpressionBuilder", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.var", - "type": "Object", - "label": "var", - "description": [], + "id": "def-common.ExpressionAstExpressionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression builder objects." + ], "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 48 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionVar", - "text": "ExpressionFunctionVar" - } + "\"expression_builder\"" ] }, { "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.theme", - "type": "Object", - "label": "theme", - "description": [], + "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/expression_functions/types.ts", - "lineNumber": 121, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 54 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionTheme", - "text": "ExpressionFunctionTheme" - } + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "<", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" + }, + ">[]" ] }, { - "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.cumulative_sum", - "type": "Object", - "label": "cumulative_sum", - "description": [], + "tags": [ + "return" + ], + "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/expression_functions/types.ts", - "lineNumber": 122, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 66 }, "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" + }, + "[]" ] }, { - "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.derivative", - "type": "Object", - "label": "derivative", - "description": [], + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstExpressionBuilder.toAst", + "type": "Function", + "label": "toAst", + "description": [ + "\nConverts expression to an AST.\n" + ], "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 74 }, "signature": [ + "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDerivative", - "text": "ExpressionFunctionDerivative" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" } ] }, { - "tags": [], - "id": "def-common.ExpressionFunctionDefinitions.moving_average", - "type": "Object", - "label": "moving_average", - "description": [], + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstExpressionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts expression to an expression string.\n" + ], "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 80 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionMovingAverage", - "text": "ExpressionFunctionMovingAverage" - } + "() => string" ] } ], "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" + "path": "src/plugins/expressions/common/ast/build_expression.ts", + "lineNumber": 44 }, "initialIsOpen": false }, { - "id": "def-common.MapColumnArguments", + "id": "def-common.ExpressionAstFunctionBuilder", "type": "Interface", - "label": "MapColumnArguments", + "label": "ExpressionAstFunctionBuilder", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunctionBuilder", + "text": "ExpressionAstFunctionBuilder" + }, + "" + ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.MapColumnArguments.id", - "type": "CompoundType", - "label": "id", - "description": [], + "id": "def-common.ExpressionAstFunctionBuilder.type", + "type": "string", + "label": "type", + "description": [ + "\nUsed to identify expression function builder objects." + ], "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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 63 }, "signature": [ - "string | null | undefined" + "\"expression_function_builder\"" ] }, { "tags": [], - "id": "def-common.MapColumnArguments.name", - "type": "string", + "id": "def-common.ExpressionAstFunctionBuilder.name", + "type": "Uncategorized", "label": "name", - "description": [], + "description": [ + "\nName of this expression function." + ], "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" - } + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 67 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.InferFunctionDefinition", + "text": "InferFunctionDefinition" + }, + "[\"name\"]" + ] }, { "tags": [], - "id": "def-common.MapColumnArguments.expression", + "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 + }, + "signature": [ + "FunctionBuilderArguments" + ] + }, + { + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstFunctionBuilder.addArgument", "type": "Function", - "label": "expression", - "description": [], + "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/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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 86 }, "signature": [ - "((datatable: ", + ">(name: A, value: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - ") => Promise) | undefined" + " | FunctionArgs[A]) => this" ] }, { - "tags": [], - "id": "def-common.MapColumnArguments.copyMetaFrom", - "type": "CompoundType", - "label": "copyMetaFrom", - "description": [], + "tags": [ + "return" + ], + "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/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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 99 }, "signature": [ - "string | null | undefined" + ">(name: A) => (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[] | 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": [], - "tags": [], - "children": [ + }, { - "tags": [], - "id": "def-common.CumulativeSumArgs.by", - "type": "Array", - "label": "by", - "description": [], + "tags": [ + "return" + ], + "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/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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 111 }, "signature": [ - "string[] | undefined" + ">(name: A, value: (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + }, + " | FunctionArgs[A])[]) => this" ] }, { - "tags": [], - "id": "def-common.CumulativeSumArgs.inputColumnId", - "type": "string", - "label": "inputColumnId", - "description": [], + "tags": [ + "return" + ], + "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/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" - } + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 124 + }, + "signature": [ + ">>(name: A) => this" + ] }, { - "tags": [], - "id": "def-common.CumulativeSumArgs.outputColumnId", - "type": "string", - "label": "outputColumnId", - "description": [], + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstFunctionBuilder.toAst", + "type": "Function", + "label": "toAst", + "description": [ + "\nConverts function to an AST.\n" + ], "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" - } + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 130 + }, + "signature": [ + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" + } + ] }, { - "tags": [], - "id": "def-common.CumulativeSumArgs.outputColumnName", - "type": "string", - "label": "outputColumnName", - "description": [], + "tags": [ + "return" + ], + "id": "def-common.ExpressionAstFunctionBuilder.toString", + "type": "Function", + "label": "toString", + "description": [ + "\nConverts function to an expression string.\n" + ], "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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 136 }, "signature": [ - "string | undefined" + "() => string" ] } ], "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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 57 }, "initialIsOpen": false }, { - "id": "def-common.DerivativeArgs", + "id": "def-common.ExpressionExecOptions", "type": "Interface", - "label": "DerivativeArgs", + "label": "ExpressionExecOptions", "description": [], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.DerivativeArgs.outputColumnName", - "type": "string", - "label": "outputColumnName", - "description": [], + "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/expression_functions/specs/derivative.ts", - "lineNumber": 18, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L18" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 33 }, "signature": [ - "string | undefined" + "boolean | 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" + "path": "src/plugins/expressions/common/executor/executor.ts", + "lineNumber": 27 }, "initialIsOpen": false }, { - "id": "def-common.MovingAverageArgs", + "id": "def-common.ExpressionExecutionParams", "type": "Interface", - "label": "MovingAverageArgs", + "label": "ExpressionExecutionParams", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.MovingAverageArgs.by", - "type": "Array", - "label": "by", + "id": "def-common.ExpressionExecutionParams.searchContext", + "type": "Object", + "label": "searchContext", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 42 }, "signature": [ - "string[] | undefined" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.MovingAverageArgs.outputColumnName", - "type": "string", - "label": "outputColumnName", + "id": "def-common.ExpressionExecutionParams.variables", + "type": "Object", + "label": "variables", "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 44 }, "signature": [ - "string | undefined" + "Record | undefined" ] }, { "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.ExpressionRenderDefinition.name", - "type": "string", - "label": "name", + "id": "def-common.ExpressionExecutionParams.debug", + "type": "CompoundType", + "label": "debug", "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." + "\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/expression_renderers/types.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15" - } + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 51 + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-common.ExpressionRenderDefinition.displayName", - "type": "string", - "label": "displayName", + "id": "def-common.ExpressionExecutionParams.kibanaRequest", + "type": "Object", + "label": "kibanaRequest", "description": [ - "\nA user friendly name of the renderer as will be displayed to user in UI." + "\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/expression_renderers/types.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 58 }, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.ExpressionRenderDefinition.help", + "id": "def-common.ExpressionExecutionParams.searchSessionId", "type": "string", - "label": "help", - "description": [ - "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." - ], + "label": "searchSessionId", + "description": [], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 60 }, "signature": [ "string | undefined" @@ -26035,2430 +24563,2195 @@ }, { "tags": [], - "id": "def-common.ExpressionRenderDefinition.validate", - "type": "Function", - "label": "validate", - "description": [ - "\nUsed to validate the data before calling the render function." - ], + "id": "def-common.ExpressionExecutionParams.syncColors", + "type": "CompoundType", + "label": "syncColors", + "description": [], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 62 }, "signature": [ - "(() => Error | undefined) | undefined" + "boolean | undefined" ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.ExpressionRenderDefinition.render", - "type": "Function", - "label": "render", - "description": [ - "\nThe function called to render the output data of an expression." - ], + "id": "def-common.ExpressionExecutionParams.inspectorAdapters", + "type": "Object", + "label": "inspectorAdapters", + "description": [], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 64 }, "signature": [ - "(domNode: HTMLElement, config: Config, handlers: ", { - "pluginId": "expressions", + "pluginId": "inspector", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.IInterpreterRenderHandlers", - "text": "IInterpreterRenderHandlers" + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" }, - ") => void | Promise" + " | undefined" ] } ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 41 }, "initialIsOpen": false }, { - "id": "def-common.IInterpreterRenderHandlers", + "id": "def-common.ExpressionFunctionDefinition", "type": "Interface", - "label": "IInterpreterRenderHandlers", - "description": [], + "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." + ], "tags": [], "children": [ { "tags": [], - "id": "def-common.IInterpreterRenderHandlers.done", - "type": "Function", - "label": "done", + "id": "def-common.ExpressionFunctionDefinition.name", + "type": "Uncategorized", + "label": "name", "description": [ - "\nDone increments the number of rendering successes" + "\nThe name of the function, as will be used in expression." ], "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 40 }, "signature": [ - "() => void" + "Name" ] }, { "tags": [], - "id": "def-common.IInterpreterRenderHandlers.onDestroy", - "type": "Function", - "label": "onDestroy", - "description": [], + "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_renderers/types.ts", - "lineNumber": 68, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 45 }, "signature": [ - "(fn: () => void) => void" + "boolean | undefined" ] }, { "tags": [], - "id": "def-common.IInterpreterRenderHandlers.reload", - "type": "Function", - "label": "reload", - "description": [], + "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_renderers/types.ts", - "lineNumber": 69, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 50 }, "signature": [ - "() => void" + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "<", + "UnwrapPromiseOrReturn", + "> | undefined" ] }, { "tags": [], - "id": "def-common.IInterpreterRenderHandlers.update", - "type": "Function", - "label": "update", - "description": [], + "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_renderers/types.ts", - "lineNumber": 70, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 58 }, "signature": [ - "(params: any) => void" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TypeToString", + "text": "TypeToString" + }, + "[] | undefined" ] }, { "tags": [], - "id": "def-common.IInterpreterRenderHandlers.event", - "type": "Function", - "label": "event", - "description": [], + "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_renderers/types.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 64 }, "signature": [ - "(event: any) => void" + "{ [key in keyof Arguments]: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ArgumentType", + "text": "ArgumentType" + }, + "; }" ] }, { - "tags": [], - "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions", - "type": "Function", - "label": "hasCompatibleActions", + "tags": [ + "todo" + ], + "id": "def-common.ExpressionFunctionDefinition.aliases", + "type": "Array", + "label": "aliases", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 69 }, "signature": [ - "((event: any) => Promise) | undefined" + "string[] | undefined" ] }, { "tags": [], - "id": "def-common.IInterpreterRenderHandlers.getRenderMode", - "type": "Function", - "label": "getRenderMode", - "description": [], + "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_renderers/types.ts", - "lineNumber": 73, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73" - }, + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 75 + } + }, + { + "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 + } + }, + { + "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 + } + }, { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.RenderMode", - "text": "RenderMode" + "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 + } } - ] - }, - { + ], "tags": [], - "id": "def-common.IInterpreterRenderHandlers.isSyncColorsEnabled", - "type": "Function", - "label": "isSyncColorsEnabled", - "description": [], + "returnComment": [], "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" - ] + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 86 + } }, { - "tags": [], - "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." + "tags": [ + "deprecated" ], + "id": "def-common.ExpressionFunctionDefinition.context", + "type": "Object", + "label": "context", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 91 }, "signature": [ - "unknown" + "{ types: any[] | undefined; } | undefined" ] } ], "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 30 }, "initialIsOpen": false }, { - "id": "def-common.ExecutorState", + "id": "def-common.ExpressionFunctionDefinitions", "type": "Interface", - "label": "ExecutorState", - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - "" + "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" + ], + "tags": [ + "public" ], - "description": [], - "tags": [], "children": [ { "tags": [], - "id": "def-common.ExecutorState.functions", + "id": "def-common.ExpressionFunctionDefinitions.clog", "type": "Object", - "label": "functions", + "label": "clog", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 117 }, "signature": [ - "Record" + "section": "def-common.ExpressionFunctionClog", + "text": "ExpressionFunctionClog" + } ] }, { "tags": [], - "id": "def-common.ExecutorState.types", + "id": "def-common.ExpressionFunctionDefinitions.font", "type": "Object", - "label": "types", + "label": "font", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 118 }, "signature": [ - "Record" + "section": "def-common.ExpressionFunctionFont", + "text": "ExpressionFunctionFont" + } ] }, { "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.ExecutorPureTransitions.addFunction", - "type": "Function", - "label": "addFunction", + "id": "def-common.ExpressionFunctionDefinitions.var_set", + "type": "Object", + "label": "var_set", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 119 }, "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" - }, - ">" + "section": "def-common.ExpressionFunctionVarSet", + "text": "ExpressionFunctionVarSet" + } ] }, { "tags": [], - "id": "def-common.ExecutorPureTransitions.addType", - "type": "Function", - "label": "addType", + "id": "def-common.ExpressionFunctionDefinitions.var", + "type": "Object", + "label": "var", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 120 }, "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" - }, - ">" + "section": "def-common.ExpressionFunctionVar", + "text": "ExpressionFunctionVar" + } ] }, { "tags": [], - "id": "def-common.ExecutorPureTransitions.extendContext", - "type": "Function", - "label": "extendContext", + "id": "def-common.ExpressionFunctionDefinitions.theme", + "type": "Object", + "label": "theme", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 121 }, "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" - }, - ">" + "section": "def-common.ExpressionFunctionTheme", + "text": "ExpressionFunctionTheme" + } ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.ExecutorPureSelectors.getFunction", - "type": "Function", - "label": "getFunction", + "id": "def-common.ExpressionFunctionDefinitions.cumulative_sum", + "type": "Object", + "label": "cumulative_sum", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 122 }, "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" + "section": "def-common.ExpressionFunctionCumulativeSum", + "text": "ExpressionFunctionCumulativeSum" + } ] }, { "tags": [], - "id": "def-common.ExecutorPureSelectors.getType", - "type": "Function", - "label": "getType", + "id": "def-common.ExpressionFunctionDefinitions.derivative", + "type": "Object", + "label": "derivative", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 123 }, "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" + "section": "def-common.ExpressionFunctionDerivative", + "text": "ExpressionFunctionDerivative" + } ] }, { "tags": [], - "id": "def-common.ExecutorPureSelectors.getContext", - "type": "Function", - "label": "getContext", + "id": "def-common.ExpressionFunctionDefinitions.moving_average", + "type": "Object", + "label": "moving_average", "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 124 }, "signature": [ - "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ">) => () => Record" + "section": "def-common.ExpressionFunctionMovingAverage", + "text": "ExpressionFunctionMovingAverage" + } ] } ], "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 116 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionExecOptions", + "id": "def-common.ExpressionImage", "type": "Interface", - "label": "ExpressionExecOptions", + "label": "ExpressionImage", "description": [], "tags": [], "children": [ { "tags": [], - "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." - ], + "id": "def-common.ExpressionImage.type", + "type": "string", + "label": "type", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 15 }, "signature": [ - "boolean | undefined" + "\"image\"" ] + }, + { + "tags": [], + "id": "def-common.ExpressionImage.mode", + "type": "string", + "label": "mode", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-common.ExpressionImage.dataurl", + "type": "string", + "label": "dataurl", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 17 + } } ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-common.ExecutionContext", + "id": "def-common.ExpressionRenderDefinition", "type": "Interface", - "label": "ExecutionContext", + "label": "ExpressionRenderDefinition", "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "section": "def-common.ExpressionRenderDefinition", + "text": "ExpressionRenderDefinition" }, - "" - ], - "description": [ - "\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects." + "" ], + "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExecutionContext.getSearchContext", - "type": "Function", - "label": "getSearchContext", + "id": "def-common.ExpressionRenderDefinition.name", + "type": "string", + "label": "name", "description": [ - "\nGet search context of the expression." + "\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/execution/types.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "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 }, "signature": [ - "() => ExecutionContextSearch" + "string | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionContext.variables", - "type": "Object", - "label": "variables", + "id": "def-common.ExpressionRenderDefinition.help", + "type": "string", + "label": "help", "description": [ - "\nContext variables that can be consumed using `var` and `var_set` functions." + "\nHelp text as will be displayed to user. A sentence or few about what this\nelement does." ], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 26 }, "signature": [ - "Record" + "string | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionContext.types", - "type": "Object", - "label": "types", + "id": "def-common.ExpressionRenderDefinition.validate", + "type": "Function", + "label": "validate", "description": [ - "\nA map of available expression types." + "\nUsed to validate the data before calling the render function." ], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 31 }, "signature": [ - "Record Error | undefined) | undefined" + ] + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "(domNode: HTMLElement, config: Config, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.IInterpreterRenderHandlers", + "text": "IInterpreterRenderHandlers" }, - ">" + ") => void | Promise" ] - }, + } + ], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionServiceParams", + "type": "Interface", + "label": "ExpressionServiceParams", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.ExecutionContext.abortSignal", + "id": "def-common.ExpressionServiceParams.executor", "type": "Object", - "label": "abortSignal", - "description": [ - "\nAdds ability to abort current execution." - ], + "label": "executor", + "description": [], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 151 }, "signature": [ - "AbortSignal" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Executor", + "text": "Executor" + }, + "> | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionContext.inspectorAdapters", - "type": "Uncategorized", - "label": "inspectorAdapters", + "id": "def-common.ExpressionServiceParams.renderers", + "type": "Object", + "label": "renderers", + "description": [], + "source": { + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 152 + }, + "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 + }, + "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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ExpressionsServiceStart.getFunction", + "type": "Function", + "label": "getFunction", "description": [ - "\nAdapters for `inspector` plugin." + "\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/execution/types.ts", - "lineNumber": 48, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 78 }, "signature": [ - "InspectorAdapters" + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionContext.getSearchSessionId", + "id": "def-common.ExpressionsServiceStart.getRenderer", "type": "Function", - "label": "getSearchSessionId", + "label": "getRenderer", "description": [ - "\nSearch context in which expression should operate." + "\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/execution/types.ts", - "lineNumber": 53, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 86 }, "signature": [ - "() => string | undefined" + "(name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null" ] }, { "tags": [], - "id": "def-common.ExecutionContext.getKibanaRequest", + "id": "def-common.ExpressionsServiceStart.getType", "type": "Function", - "label": "getKibanaRequest", + "label": "getType", "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." + "\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/execution/types.ts", - "lineNumber": 60, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 94 }, "signature": [ - "(() => ", + "(name: string) => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionType", + "text": "ExpressionType" }, - ") | undefined" + " | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionContext.getSavedObject", + "id": "def-common.ExpressionsServiceStart.run", "type": "Function", - "label": "getSavedObject", + "label": "run", "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." + "\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/execution/types.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 120 }, "signature": [ - "((ast: string | ", { - "pluginId": "core", + "pluginId": "expressions", "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - ">(type: string, id: string) => Promise<", + ", input: Input, params?: ", { - "pluginId": "core", + "pluginId": "expressions", "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionExecutionParams", + "text": "ExpressionExecutionParams" }, - ">) | undefined" + " | undefined) => Promise" ] }, { "tags": [], - "id": "def-common.ExecutionContext.isSyncColorsEnabled", + "id": "def-common.ExpressionsServiceStart.execute", "type": "Function", - "label": "isSyncColorsEnabled", + "label": "execute", "description": [ - "\nReturns the state (true|false) of the sync colors across panels switch." + "\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/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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 131 }, "signature": [ + "(ast: string | ", { - "pluginId": "inspector", + "pluginId": "expressions", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestAdapter", - "text": "RequestAdapter" - } + "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" + }, + "" ] }, { "tags": [], - "id": "def-common.DefaultInspectorAdapters.tables", - "type": "Object", - "label": "tables", - "description": [], + "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/execution/types.ts", - "lineNumber": 87, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L87" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 147 }, "signature": [ + "() => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.TablesAdapter", - "text": "TablesAdapter" + "section": "def-common.ExpressionsService", + "text": "ExpressionsService" } ] } ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 71 }, "initialIsOpen": false }, { - "id": "def-common.ExecutionState", + "id": "def-common.ExpressionTypeDefinition", "type": "Interface", - "label": "ExecutionState", + "label": "ExpressionTypeDefinition", "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" + "section": "def-common.ExpressionTypeDefinition", + "text": "ExpressionTypeDefinition" }, - ">" + "" + ], + "description": [ + "\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter." ], - "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExecutionState.ast", - "type": "Object", - "label": "ast", + "id": "def-common.ExpressionTypeDefinition.name", + "type": "Uncategorized", + "label": "name", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 31 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "Name" ] }, { "tags": [], - "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." - ], + "id": "def-common.ExpressionTypeDefinition.validate", + "type": "Function", + "label": "validate", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 32 }, "signature": [ - "\"result\" | \"error\" | \"not-started\" | \"pending\"" + "((type: any) => void | Error) | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionState.result", - "type": "Uncategorized", - "label": "result", - "description": [ - "\nResult of the expression execution." - ], + "id": "def-common.ExpressionTypeDefinition.serialize", + "type": "Function", + "label": "serialize", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 33 }, "signature": [ - "Output | undefined" + "((type: Value) => SerializedType) | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionState.error", - "type": "Object", - "label": "error", - "description": [ - "\nError happened during the execution." - ], + "id": "def-common.ExpressionTypeDefinition.deserialize", + "type": "Function", + "label": "deserialize", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 34 }, "signature": [ - "Error | undefined" + "((type: SerializedType) => Value) | 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": [], - "tags": [], - "children": [ { "tags": [], - "id": "def-common.ExecutionPureTransitions.start", - "type": "Function", - "label": "start", + "id": "def-common.ExpressionTypeDefinition.from", + "type": "Object", + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 37 }, "signature": [ - "(state: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - ") => () => ", + "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" }, - "" + "; } | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionPureTransitions.setResult", - "type": "Function", - "label": "setResult", + "id": "def-common.ExpressionTypeDefinition.to", + "type": "Object", + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 40 }, "signature": [ - "(state: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - ") => (result: Output) => ", + "{ [type: string]: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" + "section": "def-common.ExpressionValueConverter", + "text": "ExpressionValueConverter" }, - "" + "; } | undefined" ] }, { "tags": [], - "id": "def-common.ExecutionPureTransitions.setError", - "type": "Function", - "label": "setError", + "id": "def-common.ExpressionTypeDefinition.help", + "type": "string", + "label": "help", "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 43 }, "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" - }, - "" + "string | undefined" ] } ], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 26 }, "initialIsOpen": false }, { - "id": "def-common.ExecutionParams", + "id": "def-common.ExpressionTypeStyle", "type": "Interface", - "label": "ExecutionParams", - "description": [], + "label": "ExpressionTypeStyle", + "description": [ + "\nAn object that represents style information, typically CSS." + ], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExecutionParams.executor", - "type": "Object", - "label": "executor", + "id": "def-common.ExpressionTypeStyle.type", + "type": "string", + "label": "type", "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 121 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "" + "\"style\"" ] }, { "tags": [], - "id": "def-common.ExecutionParams.ast", + "id": "def-common.ExpressionTypeStyle.spec", "type": "Object", - "label": "ast", + "label": "spec", "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 122 }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - }, - " | undefined" + "section": "def-common.CSSStyle", + "text": "CSSStyle" + } ] }, { "tags": [], - "id": "def-common.ExecutionParams.expression", + "id": "def-common.ExpressionTypeStyle.css", "type": "string", - "label": "expression", + "label": "css", "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 123 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 120 + }, + "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`." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Font.label", + "type": "CompoundType", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 26 }, "signature": [ - "string | undefined" + "\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\"" ] }, { "tags": [], - "id": "def-common.ExecutionParams.params", - "type": "Object", - "label": "params", + "id": "def-common.Font.value", + "type": "CompoundType", + "label": "value", "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" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 27 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionExecutionParams", - "text": "ExpressionExecutionParams" - } + "\"'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/execution/execution.ts", - "lineNumber": 57, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 25 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionExecutionParams", + "id": "def-common.IInterpreterRenderHandlers", "type": "Interface", - "label": "ExpressionExecutionParams", + "label": "IInterpreterRenderHandlers", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExpressionExecutionParams.searchContext", - "type": "Object", - "label": "searchContext", + "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 + }, + "signature": [ + "() => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.onDestroy", + "type": "Function", + "label": "onDestroy", "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 68 }, "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, - " | undefined" + "(fn: () => void) => void" + ] + }, + { + "tags": [], + "id": "def-common.IInterpreterRenderHandlers.reload", + "type": "Function", + "label": "reload", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 69 + }, + "signature": [ + "() => void" ] }, { "tags": [], - "id": "def-common.ExpressionExecutionParams.variables", - "type": "Object", - "label": "variables", + "id": "def-common.IInterpreterRenderHandlers.update", + "type": "Function", + "label": "update", "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 70 }, "signature": [ - "Record | undefined" + "(params: any) => void" ] }, { "tags": [], - "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." - ], + "id": "def-common.IInterpreterRenderHandlers.event", + "type": "Function", + "label": "event", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 71 }, "signature": [ - "boolean | undefined" + "(event: any) => void" ] }, { "tags": [], - "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." - ], + "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions", + "type": "Function", + "label": "hasCompatibleActions", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 72 }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | undefined" + "((event: any) => Promise) | undefined" ] }, { "tags": [], - "id": "def-common.ExpressionExecutionParams.searchSessionId", - "type": "string", - "label": "searchSessionId", + "id": "def-common.IInterpreterRenderHandlers.getRenderMode", + "type": "Function", + "label": "getRenderMode", "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 73 }, "signature": [ - "string | undefined" + "() => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.RenderMode", + "text": "RenderMode" + } ] }, { "tags": [], - "id": "def-common.ExpressionExecutionParams.syncColors", - "type": "CompoundType", - "label": "syncColors", + "id": "def-common.IInterpreterRenderHandlers.isSyncColorsEnabled", + "type": "Function", + "label": "isSyncColorsEnabled", "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 74 }, "signature": [ - "boolean | undefined" + "() => boolean" ] }, { "tags": [], - "id": "def-common.ExpressionExecutionParams.inspectorAdapters", - "type": "Object", - "label": "inspectorAdapters", - "description": [], + "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/service/expressions_services.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L64" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 80 }, "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - " | undefined" + "unknown" ] } ], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 63 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionsServiceStart", + "id": "def-common.IRegistry", "type": "Interface", - "label": "ExpressionsServiceStart", - "description": [ - "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle." + "label": "IRegistry", + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.IRegistry", + "text": "IRegistry" + }, + "" ], + "description": [], "tags": [], "children": [ { - "tags": [], - "id": "def-common.ExpressionsServiceStart.getFunction", + "id": "def-common.IRegistry.get", "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" - }, + "label": "get", "signature": [ - "(name: string) => ", + "(id: string) => T | null" + ], + "description": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunction", - "text": "ExpressionFunction" - }, - " | undefined" - ] + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 10 + } }, { - "tags": [], - "id": "def-common.ExpressionsServiceStart.getRenderer", + "id": "def-common.IRegistry.toJS", "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." + "label": "toJS", + "signature": [ + "() => Record" ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - ] + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 12 + } }, { - "tags": [], - "id": "def-common.ExpressionsServiceStart.getType", + "id": "def-common.IRegistry.toArray", "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." + "label": "toArray", + "signature": [ + "() => T[]" ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], "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" - ] - }, + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 14 + } + } + ], + "source": { + "path": "src/plugins/expressions/common/types/registry.ts", + "lineNumber": 9 + }, + "initialIsOpen": false + }, + { + "id": "def-common.MapColumnArguments", + "type": "Interface", + "label": "MapColumnArguments", + "description": [], + "tags": [], + "children": [ { "tags": [], - "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```" - ], + "id": "def-common.MapColumnArguments.id", + "type": "CompoundType", + "label": "id", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 14 }, "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" + "string | null | undefined" ] }, { "tags": [], - "id": "def-common.ExpressionsServiceStart.execute", + "id": "def-common.MapColumnArguments.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "id": "def-common.MapColumnArguments.expression", "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." - ], + "label": "expression", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 16 }, "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) => ", + "((datatable: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContract", - "text": "ExecutionContract" + "section": "def-common.Datatable", + "text": "Datatable" }, - "" + ") => Promise) | undefined" ] }, { "tags": [], - "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." - ], + "id": "def-common.MapColumnArguments.copyMetaFrom", + "type": "CompoundType", + "label": "copyMetaFrom", + "description": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 17 }, "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionsService", - "text": "ExpressionsService" - } + "string | null | undefined" ] } ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-common.ExpressionServiceParams", + "id": "def-common.MovingAverageArgs", "type": "Interface", - "label": "ExpressionServiceParams", + "label": "MovingAverageArgs", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.ExpressionServiceParams.executor", - "type": "Object", - "label": "executor", + "id": "def-common.MovingAverageArgs.by", + "type": "Array", + "label": "by", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 15 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Executor", - "text": "Executor" - }, - "> | undefined" + "string[] | undefined" ] }, { "tags": [], - "id": "def-common.ExpressionServiceParams.renderers", - "type": "Object", - "label": "renderers", + "id": "def-common.MovingAverageArgs.inputColumnId", + "type": "string", + "label": "inputColumnId", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-common.MovingAverageArgs.outputColumnId", + "type": "string", + "label": "outputColumnId", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-common.MovingAverageArgs.outputColumnName", + "type": "string", + "label": "outputColumnName", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 18 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionRendererRegistry", - "text": "ExpressionRendererRegistry" - }, - " | undefined" + "string | 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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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." + { + "tags": [], + "id": "def-common.MovingAverageArgs.window", + "type": "number", + "label": "window", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 19 + } + } ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 14 }, - "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", - "tags": [], + "id": "def-common.PointSeriesColumn", + "type": "Interface", + "label": "PointSeriesColumn", "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" + "\nColumn in a PointSeries" ], - "initialIsOpen": false - }, - { - "id": "def-common.UnmappedTypeStrings", - "type": "Type", - "label": "UnmappedTypeStrings", "tags": [], - "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\"" + "children": [ + { + "tags": [], + "id": "def-common.PointSeriesColumn.type", + "type": "CompoundType", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 24 + }, + "signature": [ + "\"string\" | \"number\"" + ] + }, + { + "tags": [], + "id": "def-common.PointSeriesColumn.role", + "type": "CompoundType", + "label": "role", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 25 + }, + "signature": [ + "\"measure\" | \"dimension\"" + ] + }, + { + "tags": [], + "id": "def-common.PointSeriesColumn.expression", + "type": "string", + "label": "expression", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 26 + } + } ], - "initialIsOpen": false - }, - { - "id": "def-common.Style", - "type": "Type", - "label": "Style", - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 23 }, - "signature": [ - "ExpressionTypeStyle" - ], "initialIsOpen": false }, { - "id": "def-common.InferFunctionDefinition", - "type": "Type", - "label": "InferFunctionDefinition", - "tags": [], + "id": "def-common.Range", + "type": "Interface", + "label": "Range", "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", "tags": [], - "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 | ", + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstFunction", - "text": "ExpressionAstFunction" + "tags": [], + "id": "def-common.Range.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 15 + }, + "signature": [ + "\"range\"" + ] }, - " | ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "tags": [], + "id": "def-common.Range.from", + "type": "number", + "label": "from", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 16 + } + }, + { + "tags": [], + "id": "def-common.Range.to", + "type": "number", + "label": "to", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 17 + } + }, + { + "tags": [], + "id": "def-common.Range.label", + "type": "string", + "label": "label", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 18 + }, + "signature": [ + "string | undefined" + ] } ], - "initialIsOpen": false - }, - { - "id": "def-common.ExpressionAstExpression", - "type": "Type", - "label": "ExpressionAstExpression", - "tags": [], - "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", - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 14 }, - "signature": [ - "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" - ], "initialIsOpen": false }, { - "id": "def-common.ExpressionAstFunctionDebug", - "type": "Type", - "label": "ExpressionAstFunctionDebug", - "tags": [], - "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" - }, + "id": "def-common.SerializedDatatable", + "type": "Interface", + "label": "SerializedDatatable", "signature": [ - "{ success: boolean; fn: string; input: ExpressionValue; args: Record; output?: ExpressionValue; error?: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.SerializedDatatable", + "text": "SerializedDatatable" }, - "<\"error\", { error: ", + " extends ", { "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; }" + "section": "def-common.Datatable", + "text": "Datatable" + } ], - "initialIsOpen": false - }, - { - "id": "def-common.ExpressionAstArgument", - "type": "Type", - "label": "ExpressionAstArgument", - "tags": [], "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SerializedDatatable.rows", + "type": "Array", + "label": "rows", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 105 + }, + "signature": [ + "string[][]" + ] + } + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 104 }, + "initialIsOpen": false + }, + { + "id": "def-common.SerializedFieldFormat", + "type": "Interface", + "label": "SerializedFieldFormat", "signature": [ - "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "" ], - "initialIsOpen": false - }, - { - "id": "def-common.FontLabel", - "type": "Type", - "label": "FontLabel", - "tags": [], "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." + "\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." + ], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.SerializedFieldFormat.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 54 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-common.SerializedFieldFormat.params", + "type": "Uncategorized", + "label": "params", + "description": [], + "source": { + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 55 + }, + "signature": [ + "TParams | undefined" + ] + } ], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 13, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13" + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 53 }, - "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 - }, + } + ], + "enums": [ { - "id": "def-common.FontValue", - "type": "Type", - "label": "FontValue", + "id": "def-common.BackgroundRepeat", + "type": "Enum", + "label": "BackgroundRepeat", "tags": [], "description": [ - "\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property." + "\nEnum of supported CSS `background-repeat` properties." ], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 14 }, - "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.BackgroundSize", + "type": "Enum", + "label": "BackgroundSize", "tags": [], - "id": "def-common.fonts", - "type": "Array", - "label": "fonts", "description": [ - "\nA collection of supported fonts." + "\nEnum of supported CSS `background-size` properties." ], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 123, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L123" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 26 }, - "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", + "id": "def-common.FontStyle", + "type": "Enum", + "label": "FontStyle", "tags": [], - "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" + "description": [ + "\nEnum of supported CSS `font-style` properties." ], - "initialIsOpen": false - }, - { - "id": "def-common.ExpressionValueBoxed", - "type": "Type", - "label": "ExpressionValueBoxed", - "tags": [], - "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 35 }, - "signature": [ - "{ type: Type; } & Value" - ], "initialIsOpen": false }, { - "id": "def-common.ExpressionValue", - "type": "Type", - "label": "ExpressionValue", + "id": "def-common.FontWeight", + "type": "Enum", + "label": "FontWeight", "tags": [], - "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" + "description": [ + "\nEnum of supported CSS `font-weight` properties." ], - "initialIsOpen": false - }, - { - "id": "def-common.ExpressionValueConverter", - "type": "Type", - "label": "ExpressionValueConverter", - "tags": [], - "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 43 }, - "signature": [ - "(input: I, availableTypes: Record) => O" - ], "initialIsOpen": false }, { - "id": "def-common.AnyExpressionTypeDefinition", - "type": "Type", - "label": "AnyExpressionTypeDefinition", + "id": "def-common.Overflow", + "type": "Enum", + "label": "Overflow", "tags": [], - "description": [], + "description": [ + "\nEnum of supported CSS `overflow` properties." + ], "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 62 }, - "signature": [ - "ExpressionTypeDefinition" - ], "initialIsOpen": false }, { + "id": "def-common.TextAlignment", + "type": "Enum", + "label": "TextAlignment", "tags": [], - "id": "def-common.typeSpecs", - "type": "Array", - "label": "typeSpecs", - "description": [], + "description": [ + "\nEnum of supported CSS `text-align` properties." + ], "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 72 }, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionTypeDefinition", - "text": "AnyExpressionTypeDefinition" - }, - "[]" - ], "initialIsOpen": false }, { - "id": "def-common.DatatableColumnType", - "type": "Type", - "label": "DatatableColumnType", + "id": "def-common.TextDecoration", + "type": "Enum", + "label": "TextDecoration", "tags": [], "description": [ - "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" + "\nEnum of supported CSS `text-decoration` properties." ], "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" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 82 }, - "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" - ], "initialIsOpen": false - }, + } + ], + "misc": [ { - "id": "def-common.DatatableRow", + "id": "def-common.AnyExpressionFunctionDefinition", "type": "Type", - "label": "DatatableRow", + "label": "AnyExpressionFunctionDefinition", "tags": [], "description": [ - "\nThis type represents a row in a `Datatable`." + "\nType to capture every possible expression function definition." ], "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" + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "lineNumber": 102 }, "signature": [ - "{ [x: string]: any; }" + "ExpressionFunctionDefinition, any, ExecutionContext<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionValueError", + "id": "def-common.AnyExpressionRenderDefinition", "type": "Type", - "label": "ExpressionValueError", + "label": "AnyExpressionRenderDefinition", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 49 }, "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "ExpressionRenderDefinition" ], "initialIsOpen": false }, { - "id": "def-common.InterpreterErrorType", + "id": "def-common.AnyExpressionTypeDefinition", "type": "Type", - "label": "InterpreterErrorType", - "tags": [ - "deprecated" - ], + "label": "AnyExpressionTypeDefinition", + "tags": [], "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" + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 46 }, "signature": [ - "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + "ExpressionTypeDefinition" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionValueFilter", + "id": "def-common.ArgumentType", "type": "Type", - "label": "ExpressionValueFilter", + "label": "ArgumentType", "tags": [], "description": [ - "\nRepresents an object that is a Filter." + "\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_types/specs/filter.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14" + "path": "src/plugins/expressions/common/expression_functions/arguments.ts", + "lineNumber": 16 }, "signature": [ - "{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }" + "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionValueNum", + "id": "def-common.DatatableColumnType", "type": "Type", - "label": "ExpressionValueNum", + "label": "DatatableColumnType", "tags": [], - "description": [], + "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/num.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 36 }, "signature": [ - "{ type: \"num\"; } & { value: number; }" + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\"" ], "initialIsOpen": false }, { - "id": "def-common.PointSeriesColumnName", + "id": "def-common.DatatableRow", "type": "Type", - "label": "PointSeriesColumnName", + "label": "DatatableRow", "tags": [], "description": [ - "\nAllowed column names in a PointSeries" + "\nThis type represents a row in a `Datatable`." ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 57 }, "signature": [ - "\"color\" | \"y\" | \"x\" | \"text\" | \"size\"" + "{ [x: string]: any; }" ], "initialIsOpen": false }, { - "id": "def-common.PointSeriesColumns", + "id": "def-common.ErrorLike", "type": "Type", - "label": "PointSeriesColumns", + "label": "ErrorLike", "tags": [], - "description": [ - "\nRepresents a collection of valid Columns in a PointSeries" - ], + "description": [], "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" + "path": "src/plugins/expressions/common/util/create_error.ts", + "lineNumber": 17 }, "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" - }, - ">" + "SerializedError & { original?: SerializedError | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.PointSeriesRow", + "id": "def-common.ExecutionContainer", "type": "Type", - "label": "PointSeriesRow", + "label": "ExecutionContainer", "tags": [], "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" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 73 }, "signature": [ - "{ [x: string]: any; }" + "StateContainer, ExecutionPureTransitions, {}>" ], "initialIsOpen": false }, { - "id": "def-common.PointSeries", + "id": "def-common.ExecutorContainer", "type": "Type", - "label": "PointSeries", + "label": "ExecutorContainer", "tags": [], - "description": [ - "\nA `PointSeries` is a unique structure that represents dots on a chart." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 55 }, "signature": [ - "{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }" + "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionValueRender", + "id": "def-common.ExpressionAstArgument", "type": "Type", - "label": "ExpressionValueRender", + "label": "ExpressionAstArgument", "tags": [], - "description": [ - "\nRepresents an object that is intended to be rendered." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 77 }, "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" + "string | number | false | true | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "initialIsOpen": false }, { - "id": "def-common.Render", + "id": "def-common.ExpressionAstExpression", "type": "Type", - "label": "Render", - "tags": [ - "deprecated" - ], + "label": "ExpressionAstExpression", + "tags": [], "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" + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 16 }, "signature": [ - "{ type: \"render\"; } & { as: string; value: T; }" + "{ type: 'expression'; chain: ExpressionAstFunction[]; }" ], "initialIsOpen": false }, { - "id": "def-common.AnyExpressionFunctionDefinition", + "id": "def-common.ExpressionAstFunction", "type": "Type", - "label": "AnyExpressionFunctionDefinition", + "label": "ExpressionAstFunction", "tags": [], - "description": [ - "\nType to capture every possible expression function definition." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 21 }, "signature": [ - "ExpressionFunctionDefinition, any, ExecutionContext<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableState", - ">>" + "{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.ArgumentType", + "id": "def-common.ExpressionAstFunctionDebug", "type": "Type", - "label": "ArgumentType", + "label": "ExpressionAstFunctionDebug", "tags": [], - "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." - ], + "description": [], "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" + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 32 }, "signature": [ - "SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType" + "{ 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.ExpressionAstNode", + "type": "Type", + "label": "ExpressionAstNode", "tags": [], - "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" + "path": "src/plugins/expressions/common/ast/types.ts", + "lineNumber": 11 }, "signature": [ + "string | number | false | true | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.AnyExpressionFunctionDefinition", - "text": "AnyExpressionFunctionDefinition" + "section": "def-common.ExpressionAstFunction", + "text": "ExpressionAstFunction" }, - "[]" + " | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } ], "initialIsOpen": false }, { - "id": "def-common.MathArguments", + "id": "def-common.ExpressionFunctionClog", "type": "Type", - "label": "MathArguments", + "label": "ExpressionFunctionClog", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 11 }, "signature": [ - "{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }" + "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" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-common.MathInput", + "id": "def-common.ExpressionFunctionCumulativeSum", "type": "Type", - "label": "MathInput", + "label": "ExpressionFunctionCumulativeSum", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 21 }, "signature": [ - "number | ", + "ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" + }, + "<", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ", ", + "SerializableState", + ">>" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionClog", + "id": "def-common.ExpressionFunctionDerivative", "type": "Type", - "label": "ExpressionFunctionClog", + "label": "ExpressionFunctionDerivative", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 21 }, "signature": [ - "ExpressionFunctionDefinition<\"clog\", unknown, {}, unknown, ", + "ExpressionFunctionDefinition<\"derivative\", Datatable, DerivativeArgs, Datatable, ", { "pluginId": "expressions", "scope": "common", @@ -28488,8 +26781,7 @@ "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" + "lineNumber": 44 }, "signature": [ "ExpressionFunctionDefinition<\"font\", null, Arguments, ", @@ -28523,18 +26815,50 @@ "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionVarSet", + "id": "def-common.ExpressionFunctionMovingAverage", + "type": "Type", + "label": "ExpressionFunctionMovingAverage", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 22 + }, + "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" + }, + ", ", + "SerializableState", + ">>" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionFunctionTheme", "type": "Type", - "label": "ExpressionFunctionVarSet", + "label": "ExpressionFunctionTheme", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 20 }, "signature": [ - "ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ", + "ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ", { "pluginId": "expressions", "scope": "common", @@ -28564,8 +26888,7 @@ "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" + "lineNumber": 16 }, "signature": [ "ExpressionFunctionDefinition<\"var\", unknown, Arguments, unknown, ", @@ -28591,18 +26914,17 @@ "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionTheme", + "id": "def-common.ExpressionFunctionVarSet", "type": "Type", - "label": "ExpressionFunctionTheme", + "label": "ExpressionFunctionVarSet", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 17 }, "signature": [ - "ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ", + "ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ", { "pluginId": "expressions", "scope": "common", @@ -28625,735 +26947,1328 @@ "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionCumulativeSum", + "id": "def-common.ExpressionsServiceSetup", "type": "Type", - "label": "ExpressionFunctionCumulativeSum", + "label": "ExpressionsServiceSetup", "tags": [], - "description": [], + "description": [ + "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle." + ], "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" + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "lineNumber": 26 }, "signature": [ - "ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ", + "{ readonly getType: (name: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "section": "def-common.ExpressionType", + "text": "ExpressionType" }, - "<", + " | undefined; readonly getFunction: (name: string) => ", { - "pluginId": "inspector", + "pluginId": "expressions", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" }, - ", ", - "SerializableState", - ">>" + " | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionRenderer", + "text": "ExpressionRenderer" + }, + " | null; readonly getRenderers: () => Record) => O" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueError", + "type": "Type", + "label": "ExpressionValueError", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 17 + }, + "signature": [ + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueFilter", + "type": "Type", + "label": "ExpressionValueFilter", + "tags": [], + "description": [ + "\nRepresents an object that is a Filter." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 14 + }, + "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", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 14 + }, + "signature": [ + "{ type: \"num\"; } & { value: number; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueRender", + "type": "Type", + "label": "ExpressionValueRender", + "tags": [], + "description": [ + "\nRepresents an object that is intended to be rendered." + ], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 16 + }, + "signature": [ + "{ type: \"render\"; } & { as: string; value: T; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.ExpressionValueUnboxed", + "type": "Type", + "label": "ExpressionValueUnboxed", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/types.ts", + "lineNumber": 9 + }, + "signature": [ + "any" + ], + "initialIsOpen": false + }, + { + "id": "def-common.FontLabel", + "type": "Type", + "label": "FontLabel", + "tags": [], + "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 + }, + "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 + }, + { + "tags": [], + "id": "def-common.fonts", + "type": "Array", + "label": "fonts", + "description": [ + "\nA collection of supported fonts." + ], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 123 + }, + "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.FontValue", + "type": "Type", + "label": "FontValue", + "tags": [], + "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 + }, + "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 + }, + { + "tags": [], + "id": "def-common.functionSpecs", + "type": "Array", + "label": "functionSpecs", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/index.ts", + "lineNumber": 21 }, "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" + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionFunctionDefinition", + "text": "AnyExpressionFunctionDefinition" }, - ", ", - "SerializableState", - ">>" + "[]" ], "initialIsOpen": false }, { - "id": "def-common.ExpressionFunctionMovingAverage", + "id": "def-common.InferFunctionDefinition", "type": "Type", - "label": "ExpressionFunctionMovingAverage", + "label": "InferFunctionDefinition", "tags": [], "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" + "path": "src/plugins/expressions/common/ast/build_function.ts", + "lineNumber": 24 }, "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" - }, - ", ", - "SerializableState", - ">>" + "FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never" ], "initialIsOpen": false }, { - "id": "def-common.AnyExpressionRenderDefinition", + "id": "def-common.InterpreterErrorType", "type": "Type", - "label": "AnyExpressionRenderDefinition", - "tags": [], + "label": "InterpreterErrorType", + "tags": [ + "deprecated" + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 33 }, "signature": [ - "ExpressionRenderDefinition" + "{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.RenderMode", + "id": "def-common.KnownTypeToString", "type": "Type", - "label": "RenderMode", + "label": "KnownTypeToString", "tags": [], "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" + "\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/expression_renderers/types.ts", - "lineNumber": 61, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L61" + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 26 }, "signature": [ - "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\"" + "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.ExecutorContainer", + "id": "def-common.MathArguments", "type": "Type", - "label": "ExecutorContainer", + "label": "MathArguments", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 15 }, "signature": [ - "StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>" + "{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }" ], "initialIsOpen": false }, { - "id": "def-common.ExecutionContainer", + "id": "def-common.MathInput", "type": "Type", - "label": "ExecutionContainer", + "label": "MathInput", "tags": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/math.ts", + "lineNumber": 20 }, "signature": [ - "StateContainer, ExecutionPureTransitions, {}>" + "number | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + } ], "initialIsOpen": false }, { - "id": "def-common.ExpressionsServiceSetup", + "id": "def-common.PointSeries", "type": "Type", - "label": "ExpressionsServiceSetup", + "label": "PointSeries", "tags": [], "description": [ - "\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle." + "\nA `PointSeries` is a unique structure that represents dots on a chart." ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 39 }, "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" + "section": "def-common.PointSeriesColumn", + "text": "PointSeriesColumn" }, - " | null; readonly getRenderers: () => Record" ], "initialIsOpen": false }, { - "id": "def-common.SerializedError", + "id": "def-common.PointSeriesRow", "type": "Type", - "label": "SerializedError", + "label": "PointSeriesRow", "tags": [], "description": [], "source": { - "path": "src/plugins/expressions/common/util/create_error.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/create_error.ts#L11" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 34 }, "signature": [ - "{ name: string; message: string; stack?: string | undefined; }" + "{ [x: string]: any; }" ], "initialIsOpen": false }, { - "id": "def-common.ErrorLike", + "id": "def-common.Render", "type": "Type", - "label": "ErrorLike", - "tags": [], - "description": [], - "source": { - "path": "src/plugins/expressions/common/util/create_error.ts", - "lineNumber": 17, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/create_error.ts#L17" - }, - "signature": [ - "SerializedError & { original?: SerializedError | undefined; }" + "label": "Render", + "tags": [ + "deprecated" ], - "initialIsOpen": false - } - ], - "objects": [ - { - "tags": [], - "id": "def-common.americanTypewriter", - "type": "Object", - "label": "americanTypewriter", "description": [], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 42, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L42" + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 29 }, "signature": [ - "{ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; }" + "{ type: \"render\"; } & { as: string; value: T; }" ], "initialIsOpen": false }, { + "id": "def-common.RenderMode", + "type": "Type", + "label": "RenderMode", "tags": [], - "id": "def-common.arial", - "type": "Object", - "label": "arial", - "description": [], + "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/fonts.ts", - "lineNumber": 47, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L47" + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "lineNumber": 61 }, "signature": [ - "{ label: \"Arial\"; value: \"Arial, sans-serif\"; }" + "\"display\" | \"noInteractivity\" | \"edit\" | \"preview\"" ], "initialIsOpen": false }, { + "id": "def-common.SerializedError", + "type": "Type", + "label": "SerializedError", "tags": [], - "id": "def-common.baskerville", - "type": "Object", - "label": "baskerville", "description": [], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 49, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L49" + "path": "src/plugins/expressions/common/util/create_error.ts", + "lineNumber": 11 }, "signature": [ - "{ label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + "{ name: string; message: string; stack?: string | undefined; }" ], "initialIsOpen": false }, { + "id": "def-common.Style", + "type": "Type", + "label": "Style", "tags": [], - "id": "def-common.bookAntiqua", - "type": "Object", - "label": "bookAntiqua", "description": [], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L54" + "path": "src/plugins/expressions/common/types/style.ts", + "lineNumber": 126 }, "signature": [ - "{ label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + "ExpressionTypeStyle" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.brushScript", - "type": "Object", - "label": "brushScript", + "id": "def-common.typeSpecs", + "type": "Array", + "label": "typeSpecs", "description": [], "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L59" + "path": "src/plugins/expressions/common/expression_types/specs/index.ts", + "lineNumber": 25 }, "signature": [ - "{ label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; }" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.AnyExpressionTypeDefinition", + "text": "AnyExpressionTypeDefinition" + }, + "[]" ], "initialIsOpen": false }, { + "id": "def-common.TypeString", + "type": "Type", + "label": "TypeString", "tags": [], - "id": "def-common.chalkboard", - "type": "Object", - "label": "chalkboard", - "description": [], + "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/fonts.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L64" + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 39 }, "signature": [ - "{ label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; }" + "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.TypeToString", + "type": "Type", + "label": "TypeToString", "tags": [], - "id": "def-common.didot", - "type": "Object", - "label": "didot", - "description": [], + "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/fonts.ts", - "lineNumber": 69, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L69" + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 17 }, "signature": [ - "{ label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + "\"date\" | \"filter\" | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.KnownTypeToString", + "text": "KnownTypeToString" + }, + "" ], "initialIsOpen": false }, { + "id": "def-common.UnmappedTypeStrings", + "type": "Type", + "label": "UnmappedTypeStrings", "tags": [], - "id": "def-common.futura", - "type": "Object", - "label": "futura", - "description": [], + "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/fonts.ts", - "lineNumber": 74, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L74" + "path": "src/plugins/expressions/common/types/common.ts", + "lineNumber": 46 }, "signature": [ - "{ label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; }" + "\"date\" | \"filter\"" ], "initialIsOpen": false - }, + } + ], + "objects": [ { "tags": [], - "id": "def-common.gillSans", + "id": "def-common.americanTypewriter", "type": "Object", - "label": "gillSans", + "label": "americanTypewriter", "description": [], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 79, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L79" + "lineNumber": 42 }, "signature": [ - "{ label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" + "{ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.helveticaNeue", + "id": "def-common.arial", "type": "Object", - "label": "helveticaNeue", + "label": "arial", "description": [], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 85, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L85" + "lineNumber": 47 }, "signature": [ - "{ label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; }" + "{ label: \"Arial\"; value: \"Arial, sans-serif\"; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.hoeflerText", + "id": "def-common.baskerville", "type": "Object", - "label": "hoeflerText", + "label": "baskerville", "description": [], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L90" + "lineNumber": 49 }, "signature": [ - "{ label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; }" + "{ label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.lucidaGrande", + "id": "def-common.bookAntiqua", "type": "Object", - "label": "lucidaGrande", + "label": "bookAntiqua", "description": [], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L95" + "lineNumber": 54 }, "signature": [ - "{ label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; }" + "{ label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" ], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.myriad", + "id": "def-common.boolean", "type": "Object", - "label": "myriad", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.boolean.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 16 + }, + "signature": [ + "\"boolean\"" + ] + }, + { + "id": "def-common.boolean.from", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.boolean.from.null", + "type": "Function", + "children": [], + "signature": [ + "() => false" + ], + "description": [], + "label": "null", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 18 + }, + "tags": [], + "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 + } + } + ], + "signature": [ + "(n: any) => boolean" + ], + "description": [], + "label": "number", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 19 + }, + "tags": [], + "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 + } + } + ], + "signature": [ + "(s: any) => boolean" + ], + "description": [], + "label": "string", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 20 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 17 + } + }, + { + "id": "def-common.boolean.to", + "type": "Object", + "tags": [], + "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 22 + } + } + ], "description": [], + "label": "boolean", "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 100, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L100" + "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", + "lineNumber": 15 }, - "signature": [ - "{ label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; }" - ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.openSans", + "id": "def-common.brushScript", "type": "Object", - "label": "openSans", + "label": "brushScript", "description": [], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 105, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L105" + "lineNumber": 59 }, "signature": [ - "{ label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; }" + "{ label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; }" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.optima", + "id": "def-common.chalkboard", "type": "Object", - "label": "optima", + "label": "chalkboard", "description": [], "source": { "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 110, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L110" + "lineNumber": 64 }, "signature": [ - "{ label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" + "{ label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; }" ], "initialIsOpen": false }, { - "tags": [], - "id": "def-common.palatino", + "id": "def-common.clog", "type": "Object", - "label": "palatino", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.clog.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 14 + }, + "signature": [ + "\"clog\"" + ] + }, + { + "id": "def-common.clog.args", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 15 + } + }, + { + "tags": [], + "id": "def-common.clog.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 16 + } + }, + { + "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 + } + } + ], + "signature": [ + "(input: unknown) => unknown" + ], + "description": [], + "label": "fn", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 17 + }, + "tags": [], + "returnComment": [] + } + ], "description": [], + "label": "clog", "source": { - "path": "src/plugins/expressions/common/fonts.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L115" + "path": "src/plugins/expressions/common/expression_functions/specs/clog.ts", + "lineNumber": 13 }, - "signature": [ - "{ label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" - ], "initialIsOpen": false }, { - "id": "def-common.boolean", + "id": "def-common.cumulativeSum", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.boolean.name", + "id": "def-common.cumulativeSum.name", "type": "string", "label": "name", "description": [], "source": { - "path": "src/plugins/expressions/common/expression_types/specs/boolean.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L16" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 56 }, "signature": [ - "\"boolean\"" + "\"cumulative_sum\"" ] }, { - "id": "def-common.boolean.from", + "tags": [], + "id": "def-common.cumulativeSum.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 57 + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 59 + }, + "signature": [ + "\"datatable\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 61 + } + }, + { + "id": "def-common.cumulativeSum.args", "type": "Object", "tags": [], "children": [ { - "id": "def-common.boolean.from.null", - "type": "Function", - "children": [], - "signature": [ - "() => false" + "id": "def-common.cumulativeSum.args.by", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "false" + ] + } ], "description": [], - "label": "null", + "label": "by", "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" - }, + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 66 + } + }, + { + "id": "def-common.cumulativeSum.args.inputColumnId", + "type": "Object", "tags": [], - "returnComment": [] + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "inputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 74 + } }, { - "id": "def-common.boolean.from.number", - "type": "Function", + "id": "def-common.cumulativeSum.args.outputColumnId", + "type": "Object", + "tags": [], "children": [ { - "type": "Any", - "label": "n", - "isRequired": true, + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, "signature": [ - "any" - ], + "\"string\"[]" + ] + }, + { + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnId.required", + "type": "boolean", + "label": "required", "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" - } + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 86 + }, + "signature": [ + "true" + ] } ], - "signature": [ - "(n: any) => boolean" - ], "description": [], - "label": "number", + "label": "outputColumnId", "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 81 + } }, { - "id": "def-common.boolean.from.string", - "type": "Function", + "id": "def-common.cumulativeSum.args.outputColumnName", + "type": "Object", + "tags": [], "children": [ { - "type": "Any", - "label": "s", - "isRequired": true, - "signature": [ - "any" - ], + "tags": [], + "id": "def-common.cumulativeSum.args.outputColumnName.help", + "type": "string", + "label": "help", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 89 } + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "false" + ] } ], - "signature": [ - "(s: any) => boolean" - ], "description": [], - "label": "string", + "label": "outputColumnName", "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 88 + } } ], "description": [], - "label": "from", + "label": "args", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 65 } }, { - "id": "def-common.boolean.to", - "type": "Object", - "tags": [], + "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": [ { - "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" - } - } - ], + "type": "Object", + "label": "input", + "isRequired": true, "signature": [ - "(value: boolean) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" - }, - "<\"render\", { as: string; value: { text: string; }; }>" + "section": "def-common.Datatable", + "text": "Datatable" + } ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 97 + } }, { - "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" - } - } - ], + "type": "Object", + "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", + "isRequired": true, "signature": [ - "(value: boolean) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "section": "def-common.CumulativeSumArgs", + "text": "CumulativeSumArgs" } ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 97 + } } ], - "description": [], - "label": "to", + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 97 } } ], - "description": [], - "label": "boolean", + "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_types/specs/boolean.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L15" + "path": "src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts", + "lineNumber": 55 }, "initialIsOpen": false }, @@ -29370,8 +28285,7 @@ "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" + "lineNumber": 116 }, "signature": [ "\"datatable\"" @@ -29391,8 +28305,7 @@ "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" + "lineNumber": 117 } } ], @@ -29403,8 +28316,7 @@ "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" + "lineNumber": 117 }, "tags": [], "returnComment": [] @@ -29429,8 +28341,7 @@ "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" + "lineNumber": 127 } } ], @@ -29457,8 +28368,7 @@ "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" + "lineNumber": 127 }, "tags": [], "returnComment": [] @@ -29483,8 +28393,7 @@ "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" + "lineNumber": 136 } } ], @@ -29511,8 +28420,7 @@ "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" + "lineNumber": 136 }, "tags": [], "returnComment": [] @@ -29533,8 +28441,7 @@ "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" + "lineNumber": 146 }, "tags": [], "returnComment": [] @@ -29568,8 +28475,7 @@ "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" + "lineNumber": 152 } } ], @@ -29596,8 +28502,7 @@ "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" + "lineNumber": 152 }, "tags": [], "returnComment": [] @@ -29607,8 +28512,7 @@ "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" + "lineNumber": 145 } }, { @@ -29636,8 +28540,7 @@ "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" + "lineNumber": 162 } } ], @@ -29664,8 +28567,7 @@ "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" + "lineNumber": 162 }, "tags": [], "returnComment": [] @@ -29690,8 +28592,7 @@ "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" + "lineNumber": 172 } } ], @@ -29726,556 +28627,506 @@ "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" + "lineNumber": 172 }, "tags": [], "returnComment": [] } ], "description": [], - "label": "to", + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 161 + } + } + ], + "description": [], + "label": "datatable", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", + "lineNumber": 115 + }, + "initialIsOpen": false + }, + { + "id": "def-common.defaultState", + "type": "Object", + "tags": [], + "children": [ + { + "id": "def-common.defaultState.functions", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "functions", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 23 + } + }, + { + "id": "def-common.defaultState.types", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "types", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 24 + } + }, + { + "id": "def-common.defaultState.context", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "context", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 25 } } ], "description": [], - "label": "datatable", + "label": "defaultState", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 22 }, "initialIsOpen": false }, { - "id": "def-common.error", + "id": "def-common.derivative", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.error.name", + "id": "def-common.derivative.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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 57 }, "signature": [ - "\"error\"" + "\"derivative\"" ] }, { - "id": "def-common.error.to", + "tags": [], + "id": "def-common.derivative.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 58 + }, + "signature": [ + "\"datatable\"" + ] + }, + { + "tags": [], + "id": "def-common.derivative.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 60 + }, + "signature": [ + "\"datatable\"[]" + ] + }, + { + "tags": [], + "id": "def-common.derivative.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 62 + } + }, + { + "id": "def-common.derivative.args", "type": "Object", "tags": [], "children": [ { - "id": "def-common.error.to.render", - "type": "Function", + "id": "def-common.derivative.args.by", + "type": "Object", + "tags": [], "children": [ { - "type": "CompoundType", - "label": "input", - "isRequired": true, + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, "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; }>" - ], + "true" + ] + }, + { + "tags": [], + "id": "def-common.derivative.args.by.types", + "type": "Array", + "label": "types", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 72 + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "false" + ] + } + ], + "description": [], + "label": "by", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 67 + } + }, + { + "id": "def-common.derivative.args.inputColumnId", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 } + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "true" + ] } ], - "signature": [ - "(input: ", + "description": [], + "label": "inputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 75 + } + }, + { + "id": "def-common.derivative.args.outputColumnId", + "type": "Object", + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "tags": [], + "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 + } }, - "<\"error\", { error: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ErrorLike", - "text": "ErrorLike" + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] }, - "; info?: ", { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" + "tags": [], + "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 + }, + "signature": [ + "true" + ] + } + ], + "description": [], + "label": "outputColumnId", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 82 + } + }, + { + "id": "def-common.derivative.args.outputColumnName", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + } }, - " | undefined; }>) => ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] }, - "<\"render\", { as: string; value: Pick<", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "tags": [], + "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 + }, + "signature": [ + "false" + ] } ], "description": [], - "label": "render", + "label": "outputColumnName", "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 89 + } } ], "description": [], - "label": "to", + "label": "args", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 66 } - } - ], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "children": [ + "id": "def-common.derivative.fn", + "type": "Function", + "label": "fn", + "signature": [ + "(input: ", { - "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" - }, - "tags": [], - "returnComment": [] + "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": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], "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" - } - } - ], + "type": "Object", + "label": "input", + "isRequired": true, "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\">; }>" + "section": "def-common.Datatable", + "text": "Datatable" + } ], "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "children": [ - { - "id": "def-common.nullType.from.'*'", - "type": "Function", - "children": [], + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 98 + } + }, + { + "type": "Object", + "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", + "isRequired": true, "signature": [ - "() => null" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DerivativeArgs", + "text": "DerivativeArgs" + } ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 98 + } } ], - "description": [], - "label": "from", + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/derivative.ts", + "lineNumber": 98 } } ], + "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 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.didot", + "type": "Object", + "label": "didot", "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" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 69 }, + "signature": [ + "{ label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + ], "initialIsOpen": false }, { - "id": "def-common.num", + "id": "def-common.error", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.num.name", + "id": "def-common.error.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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 36 }, "signature": [ - "\"num\"" + "\"error\"" ] }, { - "id": "def-common.num.from", - "type": "Object", - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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" - }, - "tags": [], - "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", + "id": "def-common.error.to", "type": "Object", "tags": [], "children": [ { - "id": "def-common.num.to.render", + "id": "def-common.error.to.render", "type": "Function", "children": [ { "type": "CompoundType", - "label": "{ value }", + "label": "input", "isRequired": true, "signature": [ { @@ -30285,18 +29136,33 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"num\", { value: number; }>" + "<\"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/num.ts", - "lineNumber": 55, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L55" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 38 } } ], "signature": [ - "({ value }: ", + "(input: ", { "pluginId": "expressions", "scope": "common", @@ -30304,54 +29170,23 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"num\", { value: number; }>) => ", + "<\"error\", { error: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.ErrorLike", + "text": "ErrorLike" }, - "<\"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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.num.to.datatable", - "type": "Function", - "children": [ + "; info?: ", { - "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": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + " | undefined; }>) => ", { "pluginId": "expressions", "scope": "common", @@ -30359,21 +29194,20 @@ "section": "def-common.ExpressionValueBoxed", "text": "ExpressionValueBoxed" }, - "<\"num\", { value: number; }>) => ", + "<\"render\", { as: string; value: Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" } ], "description": [], - "label": "datatable", + "label": "render", "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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 38 }, "tags": [], "returnComment": [] @@ -30382,867 +29216,1036 @@ "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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 37 } } ], "description": [], - "label": "num", + "label": "error", "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" + "path": "src/plugins/expressions/common/expression_types/specs/error.ts", + "lineNumber": 35 }, "initialIsOpen": false }, { - "id": "def-common.number", + "id": "def-common.executionPureTransitions", "type": "Object", "tags": [], "children": [ { - "tags": [], - "id": "def-common.number.name", - "type": "string", - "label": "name", + "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 + } + } + ], + "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/expression_types/specs/number.ts", - "lineNumber": 17, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L17" + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 57 }, - "signature": [ - "\"number\"" - ] + "tags": [], + "returnComment": [] }, { - "id": "def-common.number.from", - "type": "Object", - "tags": [], + "id": "def-common.executionPureTransitions.setResult", + "type": "Function", "children": [ { - "id": "def-common.number.from.null", - "type": "Function", - "children": [], + "type": "Object", + "label": "state", + "isRequired": true, "signature": [ - "() => number" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 61 + } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" }, + ") => (result: any) => { state: \"result\"; result: any; ast: ", { - "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" - }, - "tags": [], - "returnComment": [] + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.executionPureTransitions.setError", + "type": "Function", + "children": [ + { + "type": "Object", + "label": "state", + "isRequired": true, "signature": [ - "(n: any) => number" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutionState", + "text": "ExecutionState" + }, + "" ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 66 + } } ], + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "executionPureTransitions", + "source": { + "path": "src/plugins/expressions/common/execution/container.ts", + "lineNumber": 56 + }, + "initialIsOpen": false + }, + { + "id": "def-common.filter", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.filter.name", + "type": "string", + "label": "name", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 28 + }, + "signature": [ + "\"filter\"" + ] }, { - "id": "def-common.number.to", + "id": "def-common.filter.from", "type": "Object", "tags": [], "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.number.to.datatable", + "id": "def-common.filter.from.null", "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" - } - } - ], + "children": [], "signature": [ - "(value: number) => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "() => { type: \"filter\"; filterType: string; meta: {}; and: never[]; }" ], "description": [], - "label": "datatable", + "label": "null", "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" + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 30 }, "tags": [], "returnComment": [] } ], "description": [], - "label": "to", + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 29 } } ], "description": [], - "label": "number", + "label": "filter", "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" + "path": "src/plugins/expressions/common/expression_types/specs/filter.ts", + "lineNumber": 27 }, "initialIsOpen": false }, { - "id": "def-common.pointseries", + "id": "def-common.font", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.pointseries.name", + "id": "def-common.font.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" + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 47 }, "signature": [ - "\"pointseries\"" + "\"font\"" ] }, { - "id": "def-common.pointseries.from", + "tags": [], + "id": "def-common.font.aliases", + "type": "Array", + "label": "aliases", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 48 + }, + "signature": [ + "never[]" + ] + }, + { + "tags": [], + "id": "def-common.font.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 49 + }, + "signature": [ + "\"style\"" + ] + }, + { + "tags": [], + "id": "def-common.font.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 50 + } + }, + { + "tags": [], + "id": "def-common.font.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 53 + }, + "signature": [ + "\"null\"[]" + ] + }, + { + "id": "def-common.font.args", "type": "Object", "tags": [], "children": [ { - "id": "def-common.pointseries.from.null", - "type": "Function", - "children": [], - "signature": [ - "() => { type: \"pointseries\"; rows: never[]; columns: {}; }" + "id": "def-common.font.args.align", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.TextAlignment", + "text": "TextAlignment" + }, + "[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + } + ], + "description": [], + "label": "align", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 55 + } + }, + { + "id": "def-common.font.args.color", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + } ], "description": [], - "label": "null", + "label": "color", "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 63 + } + }, { - "id": "def-common.pointseries.to.render", - "type": "Function", + "id": "def-common.font.args.family", + "type": "Object", + "tags": [], "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[]; }>" - ], + "tags": [], + "id": "def-common.font.args.family.default", + "type": "string", + "label": "default", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 71 } }, { - "type": "Object", - "label": "types", - "isRequired": true, - "signature": [ - "Record" - ], + "tags": [], + "id": "def-common.font.args.family.help", + "type": "string", + "label": "help", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 72 } + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] } ], - "signature": [ - "(pseries: ", + "description": [], + "label": "family", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 70 + } + }, + { + "id": "def-common.font.args.italic", + "type": "Object", + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "tags": [], + "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 + } }, - "<\"pointseries\", { columns: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.PointSeriesColumns", - "text": "PointSeriesColumns" + "tags": [], + "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 + } }, - "; rows: Record[]; }>, types: Record) => ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "tags": [], + "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 + }, + "signature": [ + "boolean[]" + ] }, - "<\"render\", { as: string; value: { datatable: ", { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - "; showHeader: boolean; }; }>" + "tags": [], + "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 + }, + "signature": [ + "\"boolean\"[]" + ] + } ], "description": [], - "label": "render", + "label": "italic", "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "children": [ + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 80 + } + }, { - "id": "def-common.range.from.null", - "type": "Function", - "children": [], - "signature": [ - "() => ", + "id": "def-common.font.args.lHeight", + "type": "Object", + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Range", - "text": "Range" + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "(\"number\" | \"null\")[]" + ] } ], "description": [], - "label": "null", + "label": "lHeight", "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 88 + } + }, { - "id": "def-common.range.to.render", - "type": "Function", + "id": "def-common.font.args.size", + "type": "Object", + "tags": [], "children": [ { - "type": "Object", - "label": "value", - "isRequired": true, - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Range", - "text": "Range" - } - ], + "tags": [], + "id": "def-common.font.args.size.default", + "type": "string", + "label": "default", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 97 } - } - ], - "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" + "tags": [], + "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 + } }, - "<\"render\", { as: string; value: { text: string; }; }>" + { + "tags": [], + "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 + }, + "signature": [ + "\"number\"[]" + ] + } ], "description": [], - "label": "render", + "label": "size", "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "children": [ + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 96 + } + }, { - "id": "def-common.render.from.'*'", - "type": "Function", + "id": "def-common.font.args.underline", + "type": "Object", + "tags": [], "children": [ { - "type": "Uncategorized", - "label": "v", - "isRequired": true, - "signature": [ - "T" - ], + "tags": [], + "id": "def-common.font.args.underline.default", + "type": "string", + "label": "default", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 104 } - } - ], - "signature": [ - "(v: T) => ", + }, { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "tags": [], + "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 + } }, - "<\"render\", { as: string; value: T; }>" + { + "tags": [], + "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 + }, + "signature": [ + "boolean[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"boolean\"[]" + ] + } ], "description": [], - "label": "'*'", + "label": "underline", "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "children": [ - { - "id": "def-common.shape.to.render", - "type": "Function", + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 103 + } + }, + { + "id": "def-common.font.args.weight", + "type": "Object", + "tags": [], "children": [ { - "type": "CompoundType", - "label": "input", - "isRequired": true, + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + }, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionValueBoxed", - "text": "ExpressionValueBoxed" + "section": "def-common.FontWeight", + "text": "FontWeight" }, - "<\"render\", { as: string; value: any; }>" - ], + "[]" + ] + }, + { + "tags": [], + "id": "def-common.font.args.weight.types", + "type": "Array", + "label": "types", "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" - } + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 124 + }, + "signature": [ + "\"string\"[]" + ] } ], - "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", + "label": "weight", "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 111 + } } ], "description": [], - "label": "to", + "label": "args", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 54 } - } - ], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], + "id": "def-common.font.fn", + "type": "Function", "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" - }, - "tags": [], - "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" - } - } - ], + "type": "Uncategorized", + "label": "input", + "isRequired": true, "signature": [ - "(b: any) => string" + "null" ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 127 + } }, { - "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" - } - } - ], + "type": "Object", + "label": "args", + "isRequired": true, "signature": [ - "(n: any) => string" + "Arguments" ], "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 127 + } } ], + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "font", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/font.ts", + "lineNumber": 46 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.futura", + "type": "Object", + "label": "futura", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 74 + }, + "signature": [ + "{ label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.gillSans", + "type": "Object", + "label": "gillSans", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 79 + }, + "signature": [ + "{ label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.helveticaNeue", + "type": "Object", + "label": "helveticaNeue", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 85 + }, + "signature": [ + "{ label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.hoeflerText", + "type": "Object", + "label": "hoeflerText", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 90 + }, + "signature": [ + "{ label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.image", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.image.name", + "type": "string", + "label": "name", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 21 + }, + "signature": [ + "\"image\"" + ] }, { - "id": "def-common.string.to", + "id": "def-common.image.to", "type": "Object", "tags": [], "children": [ { - "id": "def-common.string.to.render", + "id": "def-common.image.to.render", "type": "Function", "children": [ { - "type": "Uncategorized", - "label": "text", + "type": "Object", + "label": "input", "isRequired": true, "signature": [ - "T" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionImage", + "text": "ExpressionImage" + } ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 23 } } ], "signature": [ - "(text: T) => ", + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionImage", + "text": "ExpressionImage" + }, + ") => ", { "pluginId": "expressions", "scope": "common", @@ -31250,53 +30253,21 @@ "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" - }, - "tags": [], - "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) => ", + "<\"render\", { as: string; value: Pick<", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "section": "def-common.ExpressionImage", + "text": "ExpressionImage" + }, + ", \"dataurl\" | \"mode\">; }>" ], "description": [], - "label": "datatable", + "label": "render", "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" + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 23 }, "tags": [], "returnComment": [] @@ -31305,80 +30276,32 @@ "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" + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 22 } } ], "description": [], - "label": "string", + "label": "image", "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" + "path": "src/plugins/expressions/common/expression_types/specs/image.ts", + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-common.style", - "type": "Object", "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "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" - }, - "tags": [], - "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" - } - } - ], + "id": "def-common.lucidaGrande", + "type": "Object", + "label": "lucidaGrande", "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" + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 95 }, + "signature": [ + "{ label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; }" + ], "initialIsOpen": false }, { @@ -31394,8 +30317,7 @@ "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" + "lineNumber": 26 }, "signature": [ "\"mapColumn\"" @@ -31409,8 +30331,7 @@ "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" + "lineNumber": 27 }, "signature": [ "string[]" @@ -31424,8 +30345,7 @@ "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" + "lineNumber": 28 }, "signature": [ "\"datatable\"" @@ -31439,8 +30359,7 @@ "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" + "lineNumber": 29 }, "signature": [ "\"datatable\"[]" @@ -31454,8 +30373,7 @@ "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" + "lineNumber": 30 } }, { @@ -31476,8 +30394,7 @@ "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" + "lineNumber": 42 }, "signature": [ "(\"string\" | \"null\")[]" @@ -31491,8 +30408,7 @@ "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" + "lineNumber": 43 } }, { @@ -31503,8 +30419,7 @@ "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" + "lineNumber": 47 }, "signature": [ "false" @@ -31518,8 +30433,7 @@ "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" + "lineNumber": 48 }, "signature": [ "null" @@ -31530,8 +30444,7 @@ "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" + "lineNumber": 41 } }, { @@ -31547,8 +30460,7 @@ "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" + "lineNumber": 51 }, "signature": [ "\"string\"[]" @@ -31562,8 +30474,7 @@ "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" + "lineNumber": 52 }, "signature": [ "string[]" @@ -31577,8 +30488,7 @@ "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" + "lineNumber": 53 } }, { @@ -31589,8 +30499,7 @@ "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" + "lineNumber": 56 }, "signature": [ "true" @@ -31601,8 +30510,7 @@ "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" + "lineNumber": 50 } }, { @@ -31618,8 +30526,7 @@ "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" + "lineNumber": 59 }, "signature": [ "(\"boolean\" | \"string\" | \"number\" | \"null\")[]" @@ -31633,8 +30540,7 @@ "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" + "lineNumber": 60 }, "signature": [ "false" @@ -31648,8 +30554,7 @@ "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" + "lineNumber": 61 }, "signature": [ "string[]" @@ -31663,8 +30568,7 @@ "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" + "lineNumber": 62 } }, { @@ -31675,8 +30579,7 @@ "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" + "lineNumber": 69 }, "signature": [ "true" @@ -31687,8 +30590,7 @@ "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" + "lineNumber": 58 } }, { @@ -31704,8 +30606,7 @@ "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" + "lineNumber": 72 }, "signature": [ "(\"string\" | \"null\")[]" @@ -31719,8 +30620,7 @@ "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" + "lineNumber": 73 } }, { @@ -31731,8 +30631,7 @@ "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" + "lineNumber": 77 }, "signature": [ "false" @@ -31746,8 +30645,7 @@ "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" + "lineNumber": 78 }, "signature": [ "null" @@ -31758,8 +30656,7 @@ "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" + "lineNumber": 71 } } ], @@ -31767,8 +30664,7 @@ "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" + "lineNumber": 40 } }, { @@ -31791,8 +30687,7 @@ "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" + "lineNumber": 81 } }, { @@ -31811,8 +30706,7 @@ "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" + "lineNumber": 81 } } ], @@ -31847,8 +30741,7 @@ "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" + "lineNumber": 81 }, "tags": [], "returnComment": [] @@ -31858,8 +30751,7 @@ "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" + "lineNumber": 20 }, "initialIsOpen": false }, @@ -31876,8 +30768,7 @@ "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" + "lineNumber": 85 }, "signature": [ "\"math\"" @@ -31891,8 +30782,7 @@ "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" + "lineNumber": 86 }, "signature": [ "undefined" @@ -31906,8 +30796,7 @@ "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" + "lineNumber": 87 }, "signature": [ "(\"number\" | \"datatable\")[]" @@ -31921,8 +30810,7 @@ "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" + "lineNumber": 88 } }, { @@ -31943,8 +30831,7 @@ "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" + "lineNumber": 103 }, "signature": [ "string[]" @@ -31958,8 +30845,7 @@ "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" + "lineNumber": 104 }, "signature": [ "\"string\"[]" @@ -31973,8 +30859,7 @@ "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" + "lineNumber": 105 } } ], @@ -31982,8 +30867,7 @@ "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" + "lineNumber": 102 } }, { @@ -31999,8 +30883,7 @@ "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" + "lineNumber": 114 }, "signature": [ "\"string\"[]" @@ -32014,8 +30897,7 @@ "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" + "lineNumber": 115 }, "signature": [ "(\"null\" | \"false\" | \"zero\" | \"throw\")[]" @@ -32029,8 +30911,7 @@ "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" + "lineNumber": 116 } } ], @@ -32038,8 +30919,7 @@ "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" + "lineNumber": 113 } } ], @@ -32047,8 +30927,7 @@ "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" + "lineNumber": 101 } }, { @@ -32071,8 +30950,7 @@ "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" + "lineNumber": 125 } }, { @@ -32091,8 +30969,7 @@ "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" + "lineNumber": 125 } } ], @@ -32119,8 +30996,7 @@ "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" + "lineNumber": 125 }, "tags": [], "returnComment": [] @@ -32130,3511 +31006,2878 @@ "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" + "lineNumber": 79 }, "initialIsOpen": false }, { - "id": "def-common.clog", + "id": "def-common.movingAverage", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.clog.name", + "id": "def-common.movingAverage.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 55 }, "signature": [ - "\"clog\"" + "\"moving_average\"" ] }, - { - "id": "def-common.clog.args", - "type": "Object", - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ { "tags": [], - "id": "def-common.font.name", + "id": "def-common.movingAverage.type", "type": "string", - "label": "name", + "label": "type", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 56 }, "signature": [ - "\"font\"" + "\"datatable\"" ] }, { "tags": [], - "id": "def-common.font.aliases", + "id": "def-common.movingAverage.inputTypes", "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[]" - ] - }, - { - "tags": [], - "id": "def-common.font.type", - "type": "string", - "label": "type", + "label": "inputTypes", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 58 }, "signature": [ - "\"style\"" + "\"datatable\"[]" ] }, { "tags": [], - "id": "def-common.font.help", + "id": "def-common.movingAverage.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 60 } }, { - "tags": [], - "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", + "id": "def-common.movingAverage.args", "type": "Object", "tags": [], "children": [ { - "id": "def-common.font.args.align", + "id": "def-common.movingAverage.args.by", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.font.args.align.default", + "id": "def-common.movingAverage.args.by.help", "type": "string", - "label": "default", + "label": "help", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 66 } }, { "tags": [], - "id": "def-common.font.args.align.help", - "type": "string", - "label": "help", + "id": "def-common.movingAverage.args.by.multi", + "type": "boolean", + "label": "multi", "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" - } + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 69 + }, + "signature": [ + "true" + ] }, { "tags": [], - "id": "def-common.font.args.align.options", + "id": "def-common.movingAverage.args.by.types", "type": "Array", - "label": "options", + "label": "types", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 70 }, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.TextAlignment", - "text": "TextAlignment" - }, - "[]" + "\"string\"[]" ] }, { "tags": [], - "id": "def-common.font.args.align.types", - "type": "Array", - "label": "types", + "id": "def-common.movingAverage.args.by.required", + "type": "boolean", + "label": "required", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 71 }, "signature": [ - "\"string\"[]" + "false" ] } ], "description": [], - "label": "align", + "label": "by", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 65 } }, { - "id": "def-common.font.args.color", + "id": "def-common.movingAverage.args.inputColumnId", "type": "Object", "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.font.args.color.help", + "id": "def-common.movingAverage.args.inputColumnId.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 74 } }, { "tags": [], - "id": "def-common.font.args.color.types", + "id": "def-common.movingAverage.args.inputColumnId.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 77 }, "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } }, { "tags": [], - "id": "def-common.font.args.family.types", - "type": "Array", - "label": "types", + "id": "def-common.movingAverage.args.inputColumnId.required", + "type": "boolean", + "label": "required", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 78 }, "signature": [ - "\"string\"[]" + "true" ] } ], "description": [], - "label": "family", + "label": "inputColumnId", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 73 } }, { - "id": "def-common.font.args.italic", + "id": "def-common.movingAverage.args.outputColumnId", "type": "Object", "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.font.args.italic.help", + "id": "def-common.movingAverage.args.outputColumnId.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 81 } }, { "tags": [], - "id": "def-common.font.args.italic.options", + "id": "def-common.movingAverage.args.outputColumnId.types", "type": "Array", - "label": "options", + "label": "types", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 84 }, "signature": [ - "boolean[]" + "\"string\"[]" ] }, { "tags": [], - "id": "def-common.font.args.italic.types", - "type": "Array", - "label": "types", + "id": "def-common.movingAverage.args.outputColumnId.required", + "type": "boolean", + "label": "required", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 85 }, "signature": [ - "\"boolean\"[]" + "true" ] } ], "description": [], - "label": "italic", + "label": "outputColumnId", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 80 } }, { - "id": "def-common.font.args.lHeight", + "id": "def-common.movingAverage.args.outputColumnName", "type": "Object", "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "id": "def-common.font.args.lHeight.help", + "id": "def-common.movingAverage.args.outputColumnName.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 88 } }, { "tags": [], - "id": "def-common.font.args.lHeight.types", + "id": "def-common.movingAverage.args.outputColumnName.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 91 }, "signature": [ - "(\"number\" | \"null\")[]" + "\"string\"[]" ] - } - ], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } }, { "tags": [], - "id": "def-common.font.args.size.types", - "type": "Array", - "label": "types", + "id": "def-common.movingAverage.args.outputColumnName.required", + "type": "boolean", + "label": "required", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 92 }, "signature": [ - "\"number\"[]" + "false" ] } ], "description": [], - "label": "size", + "label": "outputColumnName", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 87 } }, { - "id": "def-common.font.args.underline", + "id": "def-common.movingAverage.args.window", "type": "Object", "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.font.args.underline.help", + "id": "def-common.movingAverage.args.window.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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 95 } }, { "tags": [], - "id": "def-common.font.args.underline.options", + "id": "def-common.movingAverage.args.window.types", "type": "Array", - "label": "options", + "label": "types", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 98 }, "signature": [ - "boolean[]" + "\"number\"[]" ] }, { "tags": [], - "id": "def-common.font.args.underline.types", - "type": "Array", - "label": "types", + "id": "def-common.movingAverage.args.window.default", + "type": "number", + "label": "default", "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" - }, + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 99 + } + } + ], + "description": [], + "label": "window", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 94 + } + } + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 64 + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/moving_average.ts", + "lineNumber": 103 + } + } + ], + "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 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.myriad", + "type": "Object", + "label": "myriad", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 100 + }, + "signature": [ + "{ label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.nullType", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.nullType.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 14 + }, + "signature": [ + "\"null\"" + ] + }, + { + "id": "def-common.nullType.from", + "type": "Object", + "tags": [], + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 15 + } + } + ], + "description": [], + "label": "nullType", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/null.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + }, + { + "id": "def-common.num", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.num.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 22 + }, + "signature": [ + "\"num\"" + ] + }, + { + "id": "def-common.num.from", + "type": "Object", + "tags": [], + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.num.from.boolean", + "type": "Function", + "children": [ + { + "type": "Any", + "label": "b", + "isRequired": true, "signature": [ - "\"boolean\"[]" - ] + "any" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 28 + } } ], + "signature": [ + "(b: any) => { type: \"num\"; value: number; }" + ], "description": [], - "label": "underline", + "label": "boolean", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 28 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.font.args.weight", - "type": "Object", - "tags": [], + "id": "def-common.num.from.string", + "type": "Function", "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.font.args.weight.help", - "type": "string", - "label": "help", + "type": "Any", + "label": "n", + "isRequired": true, + "signature": [ + "any" + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 32 } - }, + } + ], + "signature": [ + "(n: any) => { type: \"num\"; value: number; }" + ], + "description": [], + "label": "string", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 32 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.num.from.'*'", + "type": "Function", + "children": [ { - "tags": [], - "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" - }, + "type": "Any", + "label": "value", + "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.FontWeight", - "text": "FontWeight" - }, - "[]" - ] - }, - { - "tags": [], - "id": "def-common.font.args.weight.types", - "type": "Array", - "label": "types", + "any" + ], "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\"[]" - ] + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 49 + } } ], + "signature": [ + "(value: any) => { type: \"num\"; value: number; }" + ], "description": [], - "label": "weight", + "label": "'*'", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 49 + }, + "tags": [], + "returnComment": [] } ], "description": [], - "label": "args", + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 23 } }, { - "id": "def-common.font.fn", - "type": "Function", + "id": "def-common.num.to", + "type": "Object", + "tags": [], "children": [ { - "type": "Uncategorized", - "label": "input", - "isRequired": true, + "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 + } + } + ], "signature": [ - "null" + "({ 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_functions/specs/font.ts", - "lineNumber": 127, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127" - } + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 55 + }, + "tags": [], + "returnComment": [] }, { - "type": "Object", - "label": "args", - "isRequired": true, + "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 + } + } + ], "signature": [ - "Arguments" + "({ 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_functions/specs/font.ts", - "lineNumber": 127, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127" - } + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 63 + }, + "tags": [], + "returnComment": [] } ], - "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", + "label": "to", "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" - }, - "tags": [], - "returnComment": [] + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 54 + } } ], "description": [], - "label": "font", + "label": "num", "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" + "path": "src/plugins/expressions/common/expression_types/specs/num.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-common.variableSet", + "id": "def-common.number", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.variableSet.name", + "id": "def-common.number.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" + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 17 }, - "signature": [ - "\"var_set\"" - ] - }, - { - "tags": [], - "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" - } + "signature": [ + "\"number\"" + ] }, { - "id": "def-common.variableSet.args", + "id": "def-common.number.from", "type": "Object", "tags": [], "children": [ { - "id": "def-common.variableSet.args.name", - "type": "Object", + "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 + }, "tags": [], + "returnComment": [] + }, + { + "id": "def-common.number.from.boolean", + "type": "Function", "children": [ { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - }, + "type": "Any", + "label": "b", + "isRequired": true, "signature": [ - "true" - ] - }, - { - "tags": [], - "id": "def-common.variableSet.args.name.help", - "type": "string", - "label": "help", + "any" + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 20 } } ], + "signature": [ + "(b: any) => number" + ], "description": [], - "label": "name", + "label": "boolean", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 20 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.variableSet.args.value", - "type": "Object", - "tags": [], + "id": "def-common.number.from.string", + "type": "Function", "children": [ { - "tags": [], - "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" - }, + "type": "Any", + "label": "n", + "isRequired": true, "signature": [ - "string[]" - ] - }, - { - "tags": [], - "id": "def-common.variableSet.args.value.help", - "type": "string", - "label": "help", + "any" + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 21 } } ], + "signature": [ + "(n: any) => number" + ], "description": [], - "label": "value", + "label": "string", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 21 + }, + "tags": [], + "returnComment": [] } ], "description": [], - "label": "args", + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 18 } }, { - "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": [], + "id": "def-common.number.to", + "type": "Object", + "tags": [], "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" + "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 + } + } ], - "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": [ + "(value: number) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.number.to.datatable", + "type": "Function", + "children": [ { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", + "type": "number", + "label": "value", + "isRequired": true, + "signature": [ + "number" + ], + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 45 + } + } + ], + "signature": [ + "(value: number) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" - }, - ">" + "section": "def-common.Datatable", + "text": "Datatable" + } ], "description": [], + "label": "datatable", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 45 + }, + "tags": [], + "returnComment": [] } ], - "tags": [], - "returnComment": [], + "description": [], + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 36 } } ], "description": [], - "label": "variableSet", + "label": "number", "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" + "path": "src/plugins/expressions/common/expression_types/specs/number.ts", + "lineNumber": 16 }, "initialIsOpen": false }, { - "id": "def-common.variable", + "tags": [], + "id": "def-common.openSans", + "type": "Object", + "label": "openSans", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 105 + }, + "signature": [ + "{ label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.optima", + "type": "Object", + "label": "optima", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 110 + }, + "signature": [ + "{ label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; }" + ], + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-common.palatino", + "type": "Object", + "label": "palatino", + "description": [], + "source": { + "path": "src/plugins/expressions/common/fonts.ts", + "lineNumber": 115 + }, + "signature": [ + "{ label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; }" + ], + "initialIsOpen": false + }, + { + "id": "def-common.pointseries", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.variable.name", + "id": "def-common.pointseries.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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 48 }, "signature": [ - "\"var\"" + "\"pointseries\"" ] }, { + "id": "def-common.pointseries.from", + "type": "Object", "tags": [], - "id": "def-common.variable.help", - "type": "string", - "label": "help", + "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 + }, + "tags": [], + "returnComment": [] + } + ], "description": [], + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 49 } }, { - "id": "def-common.variable.args", + "id": "def-common.pointseries.to", "type": "Object", "tags": [], "children": [ { - "id": "def-common.variable.args.name", - "type": "Object", - "tags": [], + "id": "def-common.pointseries.to.render", + "type": "Function", "children": [ { - "tags": [], - "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" - }, + "type": "CompoundType", + "label": "pseries", + "isRequired": true, "signature": [ - "\"string\"[]" - ] - }, - { - "tags": [], - "id": "def-common.variable.args.name.aliases", - "type": "Array", - "label": "aliases", + { + "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_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[]" - ] + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 60 + } }, { - "tags": [], - "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" - }, + "type": "Object", + "label": "types", + "isRequired": true, "signature": [ - "true" - ] - }, - { - "tags": [], - "id": "def-common.variable.args.name.help", - "type": "string", - "label": "help", + "Record" + ], "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 61 } } ], - "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": [ + "(pseries: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, - "<", + "<\"pointseries\", { columns: ", { - "pluginId": "inspector", + "pluginId": "expressions", "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" + "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.SerializableState", - "text": "SerializableState" + "section": "def-common.Datatable", + "text": "Datatable" }, - ">" + "; showHeader: boolean; }; }>" ], "description": [], + "label": "render", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 59 + }, + "tags": [], + "returnComment": [] } ], - "tags": [], - "returnComment": [], + "description": [], + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 58 } } ], "description": [], - "label": "variable", + "label": "pointseries", "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" + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "lineNumber": 47 }, "initialIsOpen": false }, { - "id": "def-common.theme", + "id": "def-common.pureSelectors", "type": "Object", "tags": [], "children": [ { - "tags": [], - "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\"" - ] - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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", - "tags": [], + "id": "def-common.pureSelectors.getFunction", + "type": "Function", "children": [ { - "id": "def-common.theme.args.variable", "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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[]" - ] - }, - { - "tags": [], - "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" - } - }, + "label": "state", + "isRequired": true, + "signature": [ { - "tags": [], - "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" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 50 } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, + ">) => (id: string) => ", { - "id": "def-common.theme.args.default", - "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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" - } + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunction", + "text": "ExpressionFunction" } ], "description": [], - "label": "args", + "label": "getFunction", "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" - } + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 50 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.theme.fn", + "id": "def-common.pureSelectors.getType", "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", + "label": "state", "isRequired": true, "signature": [ - "Arguments" + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" + }, + ">" ], "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 51 } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, + ">) => (id: string) => ", { - "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.ExpressionType", + "text": "ExpressionType" + } + ], + "description": [], + "label": "getType", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 51 + }, + "tags": [], + "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.SerializableState", - "text": "SerializableState" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - ">" + ">" ], "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 52 } } ], "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" - }, - ", ", + "({ context }: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.SerializableState", - "text": "SerializableState" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - ">) => any" + ">) => () => Record" ], "description": [], - "label": "fn", + "label": "getContext", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 52 }, "tags": [], "returnComment": [] } ], "description": [], - "label": "theme", + "label": "pureSelectors", "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 49 }, "initialIsOpen": false }, { - "id": "def-common.cumulativeSum", + "id": "def-common.pureTransitions", "type": "Object", "tags": [], "children": [ { - "tags": [], - "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\"" - ] - }, - { - "tags": [], - "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\"" - ] - }, - { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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", - "tags": [], + "id": "def-common.pureTransitions.addFunction", + "type": "Function", "children": [ { - "id": "def-common.cumulativeSum.args.by", "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, + "label": "state", + "isRequired": true, + "signature": [ { - "tags": [], - "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\"[]" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 35 } + } + ], + "signature": [ + "(state: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, + ">) => (fn: ", { - "id": "def-common.cumulativeSum.args.inputColumnId", - "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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" - } + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.pureTransitions.addType", + "type": "Function", + "children": [ { - "id": "def-common.cumulativeSum.args.outputColumnId", "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, + "label": "state", + "isRequired": true, + "signature": [ { - "tags": [], - "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\"[]" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 36 } + } + ], + "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 + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-common.pureTransitions.extendContext", + "type": "Function", + "children": [ { - "id": "def-common.cumulativeSum.args.outputColumnName", "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, + "label": "state", + "isRequired": true, + "signature": [ { - "tags": [], - "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\"[]" - ] + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 37 } } ], - "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: ", + "(state: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "section": "def-common.ExecutorState", + "text": "ExecutorState" }, - ", { by, inputColumnId, outputColumnId, outputColumnName }: ", + ">) => (extraContext: Record) => { context: { [x: string]: unknown; }; functions: Record ", + ">; types: Record; }" ], "description": [], + "label": "extendContext", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 37 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "pureTransitions", + "source": { + "path": "src/plugins/expressions/common/executor/container.ts", + "lineNumber": 34 + }, + "initialIsOpen": false + }, + { + "id": "def-common.range", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.range.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 22 + }, + "signature": [ + "\"range\"" + ] + }, + { + "id": "def-common.range.from", + "type": "Object", + "tags": [], "children": [ { - "type": "Object", - "label": "input", - "isRequired": true, + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 23 + } + }, + { + "id": "def-common.range.to", + "type": "Object", + "tags": [], + "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 + } + } + ], "signature": [ + "(value: ", { "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": [ + "section": "def-common.Range", + "text": "Range" + }, + ") => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.CumulativeSumArgs", - "text": "CumulativeSumArgs" - } + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: string; }; }>" ], "description": [], + "label": "render", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 33 + }, + "tags": [], + "returnComment": [] } ], - "tags": [], - "returnComment": [], + "description": [], + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 32 } } ], - "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", + "description": [], + "label": "range", "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" + "path": "src/plugins/expressions/common/expression_types/specs/range.ts", + "lineNumber": 21 }, "initialIsOpen": false }, { - "id": "def-common.derivative", + "id": "def-common.render", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.derivative.name", + "id": "def-common.render.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" + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 32 }, "signature": [ - "\"derivative\"" + "\"render\"" ] }, { + "id": "def-common.render.from", + "type": "Object", "tags": [], - "id": "def-common.derivative.type", - "type": "string", - "label": "type", + "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 + } + } + ], + "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 + }, + "tags": [], + "returnComment": [] + } + ], "description": [], + "label": "from", "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\"" - ] - }, + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 33 + } + } + ], + "description": [], + "label": "render", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/render.ts", + "lineNumber": 31 + }, + "initialIsOpen": false + }, + { + "id": "def-common.shape", + "type": "Object", + "tags": [], + "children": [ { "tags": [], - "id": "def-common.derivative.inputTypes", - "type": "Array", - "label": "inputTypes", + "id": "def-common.shape.name", + "type": "string", + "label": "name", "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" + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 15 }, "signature": [ - "\"datatable\"[]" + "\"shape\"" ] }, { - "tags": [], - "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", + "id": "def-common.shape.to", "type": "Object", "tags": [], "children": [ { - "id": "def-common.derivative.args.by", - "type": "Object", - "tags": [], + "id": "def-common.shape.to.render", + "type": "Function", "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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" - }, + "type": "CompoundType", + "label": "input", + "isRequired": true, "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.derivative.args.inputColumnId.types", - "type": "Array", - "label": "types", + { + "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_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\"[]" - ] + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 17 + } + } + ], + "signature": [ + "(input: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" }, + "<\"render\", { as: string; value: any; }>) => { type: string; as: string; value: ", { - "tags": [], - "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" - ] - } + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: any; }>; }" ], "description": [], - "label": "inputColumnId", + "label": "render", "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" - } - }, + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 17 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "to", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 16 + } + } + ], + "description": [], + "label": "shape", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/shape.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-common.string", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.string.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 16 + }, + "signature": [ + "\"string\"" + ] + }, + { + "id": "def-common.string.from", + "type": "Object", + "tags": [], + "children": [ { - "id": "def-common.derivative.args.outputColumnId", - "type": "Object", + "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 + }, "tags": [], + "returnComment": [] + }, + { + "id": "def-common.string.from.boolean", + "type": "Function", "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, + "type": "Any", + "label": "b", + "isRequired": true, "signature": [ - "\"string\"[]" - ] - }, - { - "tags": [], - "id": "def-common.derivative.args.outputColumnId.required", - "type": "boolean", - "label": "required", + "any" + ], "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" - ] + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 19 + } } ], + "signature": [ + "(b: any) => string" + ], "description": [], - "label": "outputColumnId", + "label": "boolean", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 19 + }, + "tags": [], + "returnComment": [] }, { - "id": "def-common.derivative.args.outputColumnName", - "type": "Object", - "tags": [], + "id": "def-common.string.from.number", + "type": "Function", "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, + "type": "Any", + "label": "n", + "isRequired": true, "signature": [ - "\"string\"[]" - ] - }, - { - "tags": [], - "id": "def-common.derivative.args.outputColumnName.required", - "type": "boolean", - "label": "required", + "any" + ], "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" - ] + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 20 + } } ], + "signature": [ + "(n: any) => string" + ], "description": [], - "label": "outputColumnName", + "label": "number", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 20 + }, + "tags": [], + "returnComment": [] } ], "description": [], - "label": "args", + "label": "from", "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" + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 17 } }, { - "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": [], + "id": "def-common.string.to", + "type": "Object", + "tags": [], "children": [ { - "type": "Object", - "label": "input", - "isRequired": true, + "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 + } + } + ], "signature": [ + "(text: T) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - } + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"render\", { as: string; value: { text: T; }; }>" ], "description": [], + "label": "render", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 23 + }, + "tags": [], + "returnComment": [] }, { - "type": "Object", - "label": "{ by, inputColumnId, outputColumnId, outputColumnName }", - "isRequired": true, + "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 + } + } + ], "signature": [ + "(value: string) => ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.DerivativeArgs", - "text": "DerivativeArgs" + "section": "def-common.Datatable", + "text": "Datatable" } ], "description": [], + "label": "datatable", "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" - } + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 30 + }, + "tags": [], + "returnComment": [] } ], - "tags": [], - "returnComment": [], + "description": [], + "label": "to", "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" + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 22 } } ], - "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", + "description": [], + "label": "string", "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" + "path": "src/plugins/expressions/common/expression_types/specs/string.ts", + "lineNumber": 15 }, "initialIsOpen": false }, { - "id": "def-common.movingAverage", + "id": "def-common.style", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.movingAverage.name", + "id": "def-common.style.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" + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 15 }, "signature": [ - "\"moving_average\"" + "\"style\"" ] }, { + "id": "def-common.style.from", + "type": "Object", "tags": [], - "id": "def-common.movingAverage.type", + "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 + }, + "tags": [], + "returnComment": [] + } + ], + "description": [], + "label": "from", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 16 + } + } + ], + "description": [], + "label": "style", + "source": { + "path": "src/plugins/expressions/common/expression_types/specs/style.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-common.theme", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.theme.name", "type": "string", - "label": "type", + "label": "name", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 28 }, "signature": [ - "\"datatable\"" + "\"theme\"" ] }, { "tags": [], - "id": "def-common.movingAverage.inputTypes", + "id": "def-common.theme.aliases", "type": "Array", - "label": "inputTypes", + "label": "aliases", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 29 }, "signature": [ - "\"datatable\"[]" + "never[]" ] }, { "tags": [], - "id": "def-common.movingAverage.help", + "id": "def-common.theme.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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 30 } }, { - "id": "def-common.movingAverage.args", - "type": "Object", "tags": [], - "children": [ - { - "id": "def-common.movingAverage.args.by", - "type": "Object", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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.theme.inputTypes", + "type": "Array", + "label": "inputTypes", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 33 + }, + "signature": [ + "\"null\"[]" + ] + }, + { + "id": "def-common.theme.args", + "type": "Object", + "tags": [], + "children": [ { - "id": "def-common.movingAverage.args.outputColumnId", + "id": "def-common.theme.args.variable", "type": "Object", "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.movingAverage.args.outputColumnId.types", + "id": "def-common.theme.args.variable.aliases", "type": "Array", - "label": "types", + "label": "aliases", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 36 }, "signature": [ - "\"string\"[]" + "string[]" ] }, { "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "id": "def-common.movingAverage.args.outputColumnName.help", + "id": "def-common.theme.args.variable.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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 37 } }, { "tags": [], - "id": "def-common.movingAverage.args.outputColumnName.types", - "type": "Array", - "label": "types", + "id": "def-common.theme.args.variable.required", + "type": "boolean", + "label": "required", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 40 }, "signature": [ - "\"string\"[]" + "true" ] }, { "tags": [], - "id": "def-common.movingAverage.args.outputColumnName.required", - "type": "boolean", - "label": "required", + "id": "def-common.theme.args.variable.types", + "type": "Array", + "label": "types", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 41 }, "signature": [ - "false" + "\"string\"[]" ] } ], "description": [], - "label": "outputColumnName", + "label": "variable", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 35 } }, { - "id": "def-common.movingAverage.args.window", + "id": "def-common.theme.args.default", "type": "Object", "tags": [], "children": [ { "tags": [], - "id": "def-common.movingAverage.args.window.help", + "id": "def-common.theme.args.default.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" - } - }, - { - "tags": [], - "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\"[]" - ] - }, - { - "tags": [], - "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 44 } } ], "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": [], + "label": "default", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 43 } } - ], - "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", - "tags": [], - "children": [ - { - "id": "def-common.defaultState.functions", - "type": "Object", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "children": [ + ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 34 + } + }, { - "id": "def-common.pureTransitions.addFunction", + "id": "def-common.theme.fn", "type": "Function", "children": [ { - "type": "Object", - "label": "state", + "type": "Uncategorized", + "label": "input", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ">" + "null" ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureTransitions.addType", - "type": "Function", - "children": [ { "type": "Object", - "label": "state", + "label": "handlers", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" + "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/executor/container.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L36" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49 } } ], "signature": [ - "(state: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ">) => (type: ", + "(input: null, args: Arguments, handlers: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, - ") => { types: { [x: string]: ", + "<", { - "pluginId": "expressions", + "pluginId": "inspector", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionType", - "text": "ExpressionType" + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" }, - "; }; functions: Record; context: Record; }" + ">) => any" ], "description": [], - "label": "addType", + "label": "fn", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 49 }, "tags": [], "returnComment": [] + } + ], + "description": [], + "label": "theme", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/theme.ts", + "lineNumber": 27 + }, + "initialIsOpen": false + }, + { + "id": "def-common.variable", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.variable.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 24 + }, + "signature": [ + "\"var\"" + ] }, { - "id": "def-common.pureTransitions.extendContext", - "type": "Function", + "tags": [], + "id": "def-common.variable.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 25 + } + }, + { + "id": "def-common.variable.args", + "type": "Object", + "tags": [], "children": [ { + "id": "def-common.variable.args.name", "type": "Object", - "label": "state", - "isRequired": true, - "signature": [ + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] }, - ">" + { + "tags": [], + "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 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "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 + } + } ], "description": [], + "label": "name", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 29 } } ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 28 + } + }, + { + "id": "def-common.variable.fn", + "type": "Function", + "label": "fn", "signature": [ - "(state: ", + "(input: unknown, args: Arguments, context: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, - ">) => (extraContext: Record) => { context: { [x: string]: unknown; }; functions: Record; types: Record; }" + ">) => any" ], "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" - }, - "tags": [], - "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", - "tags": [], - "children": [ - { - "id": "def-common.pureSelectors.getFunction", - "type": "Function", "children": [ { - "type": "Object", - "label": "state", + "type": "Unknown", + "label": "input", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ">" + "unknown" ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureSelectors.getType", - "type": "Function", - "children": [ { "type": "Object", - "label": "state", + "label": "args", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" - }, - ">" + "Arguments" ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.pureSelectors.getContext", - "type": "Function", - "children": [ { "type": "Object", - "label": "{ context }", + "label": "context", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutorState", - "text": "ExecutorState" + "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/executor/container.ts", - "lineNumber": 52, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L52" + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 38 + } } ], "description": [], - "label": "pureSelectors", + "label": "variable", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var.ts", + "lineNumber": 23 }, "initialIsOpen": false }, { - "id": "def-common.executionPureTransitions", + "id": "def-common.variableSet", "type": "Object", "tags": [], "children": [ { - "id": "def-common.executionPureTransitions.start", - "type": "Function", + "tags": [], + "id": "def-common.variableSet.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 25 + }, + "signature": [ + "\"var_set\"" + ] + }, + { + "tags": [], + "id": "def-common.variableSet.help", + "type": "string", + "label": "help", + "description": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 26 + } + }, + { + "id": "def-common.variableSet.args", + "type": "Object", + "tags": [], "children": [ { + "id": "def-common.variableSet.args.name", + "type": "Object", + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "\"string\"[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "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 + } + } + ], + "description": [], + "label": "name", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 30 + } + }, + { + "id": "def-common.variableSet.args.value", "type": "Object", - "label": "state", - "isRequired": true, - "signature": [ + "tags": [], + "children": [ { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" + "tags": [], + "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 + }, + "signature": [ + "string[]" + ] }, - "" + { + "tags": [], + "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 + } + } ], "description": [], + "label": "value", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 38 } } ], + "description": [], + "label": "args", + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 29 + } + }, + { + "id": "def-common.variableSet.fn", + "type": "Function", + "label": "fn", "signature": [ - "(state: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - ") => () => { state: \"pending\"; ast: ", + "(input: unknown, args: Arguments, context: ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExecutionContext", + "text": "ExecutionContext" }, - "; result?: any; error?: Error | undefined; functions: Record; types: Record; context: Record; }" + ">) => unknown" ], "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.executionPureTransitions.setResult", - "type": "Function", "children": [ { - "type": "Object", - "label": "state", + "type": "Unknown", + "label": "input", "isRequired": true, "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" - }, - "" + "unknown" ], "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46 } - } - ], - "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" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-common.executionPureTransitions.setError", - "type": "Function", - "children": [ { "type": "Object", - "label": "state", + "label": "context", "isRequired": true, "signature": [ { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionState", - "text": "ExecutionState" + "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/execution/container.ts", - "lineNumber": 66, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L66" + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46 } } ], - "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" - }, "tags": [], - "returnComment": [] + "returnComment": [], + "source": { + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 46 + } } ], "description": [], - "label": "executionPureTransitions", + "label": "variableSet", "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" + "path": "src/plugins/expressions/common/expression_functions/specs/var_set.ts", + "lineNumber": 24 }, "initialIsOpen": false } diff --git a/api_docs/features.json b/api_docs/features.json index 4e462e9905b7c..967dd11ffca34 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -17,8 +17,7 @@ "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" + "lineNumber": 138 }, "signature": [ { @@ -58,8 +57,7 @@ "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" + "lineNumber": 140 } } ], @@ -67,8 +65,7 @@ "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" + "lineNumber": 140 } }, { @@ -79,8 +76,7 @@ "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" + "lineNumber": 146 } }, { @@ -91,8 +87,7 @@ "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" + "lineNumber": 150 } }, { @@ -103,8 +98,7 @@ "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" + "lineNumber": 154 }, "signature": [ "number | undefined" @@ -118,8 +112,7 @@ "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" + "lineNumber": 158 }, "signature": [ "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" @@ -133,8 +126,7 @@ "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" + "lineNumber": 162 }, "signature": [ "readonly string[]" @@ -148,8 +140,7 @@ "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" + "lineNumber": 166 }, "signature": [ "readonly string[] | undefined" @@ -163,8 +154,7 @@ "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" + "lineNumber": 170 }, "signature": [ "Readonly<{ [x: string]: readonly string[]; }> | undefined" @@ -178,8 +168,7 @@ "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" + "lineNumber": 174 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -193,8 +182,7 @@ "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" + "lineNumber": 178 }, "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" @@ -208,8 +196,7 @@ "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" + "lineNumber": 182 }, "signature": [ "readonly string[] | undefined" @@ -223,8 +210,7 @@ "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" + "lineNumber": 186 } }, { @@ -235,8 +221,7 @@ "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" + "lineNumber": 190 }, "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" @@ -262,21 +247,165 @@ "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" + "lineNumber": 194 } } ], "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" + "lineNumber": 137 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ + { + "id": "def-public.FeatureKibanaPrivileges", + "type": "Interface", + "label": "FeatureKibanaPrivileges", + "description": [ + "\nFeature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "{ [sectionId: string]: readonly string[]; } | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "{ all: readonly string[]; read: readonly string[]; }" + ] + }, + { + "tags": [ + "see" + ], + "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 + }, + "signature": [ + "readonly string[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/feature_kibana_privileges.ts", + "lineNumber": 11 + }, + "initialIsOpen": false + }, { "id": "def-public.KibanaFeatureConfig", "type": "Interface", @@ -298,8 +427,7 @@ ], "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" + "lineNumber": 27 } }, { @@ -312,8 +440,7 @@ ], "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" + "lineNumber": 33 } }, { @@ -326,8 +453,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ { @@ -349,8 +475,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ "number | undefined" @@ -366,8 +491,7 @@ ], "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" + "lineNumber": 54 }, "signature": [ "boolean | undefined" @@ -383,8 +507,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -400,17 +523,14 @@ ], "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" + "lineNumber": 68 }, "signature": [ "readonly string[]" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-public.KibanaFeatureConfig.management", "type": "Object", "label": "management", @@ -419,8 +539,7 @@ ], "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" + "lineNumber": 84 }, "signature": [ "{ [sectionId: string]: readonly string[]; } | undefined" @@ -436,8 +555,7 @@ ], "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" + "lineNumber": 92 }, "signature": [ "readonly string[] | undefined" @@ -453,8 +571,7 @@ ], "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" + "lineNumber": 99 }, "signature": [ "readonly string[] | undefined" @@ -462,7 +579,6 @@ }, { "tags": [ - "example", "see" ], "id": "def-public.KibanaFeatureConfig.privileges", @@ -473,8 +589,7 @@ ], "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" + "lineNumber": 113 }, "signature": [ "{ all: ", @@ -506,8 +621,7 @@ ], "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" + "lineNumber": 121 }, "signature": [ "readonly ", @@ -531,8 +645,7 @@ ], "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" + "lineNumber": 126 }, "signature": [ "string | undefined" @@ -548,8 +661,7 @@ "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" + "lineNumber": 131 }, "signature": [ "{ description: string; privileges: readonly ", @@ -566,299 +678,130 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, { - "id": "def-public.FeatureKibanaPrivileges", + "id": "def-public.SubFeatureConfig", "type": "Interface", - "label": "FeatureKibanaPrivileges", + "label": "SubFeatureConfig", "description": [ - "\nFeature privilege definition" + "\nConfiguration for a sub-feature." ], "tags": [], "children": [ { "tags": [], - "id": "def-public.FeatureKibanaPrivileges.excludeFromBasePrivileges", - "type": "CompoundType", - "label": "excludeFromBasePrivileges", + "id": "def-public.SubFeatureConfig.name", + "type": "string", + "label": "name", "description": [ - "\nWhether or not this specific privilege should be excluded from the base privileges." + "Display name for this sub-feature" ], "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" - ] + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 17 + } }, { - "tags": [ - "example" - ], - "id": "def-public.FeatureKibanaPrivileges.management", + "tags": [], + "id": "def-public.SubFeatureConfig.privilegeGroups", "type": "Object", - "label": "management", + "label": "privilegeGroups", "description": [ - "\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n" + "Collection of privilege groups" ], "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" + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 20 }, "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" + "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 + }, + "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." + ], + "tags": [], + "children": [ { "tags": [], - "id": "def-public.FeatureKibanaPrivileges.catalogue", - "type": "Object", - "label": "catalogue", + "id": "def-public.SubFeaturePrivilegeConfig.id", + "type": "string", + "label": "id", "description": [ - "\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions." + "\nIdentifier for this privilege. Must be unique across all other privileges within a feature." ], "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" - ] + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 61 + } }, { - "tags": [ - "example" + "tags": [], + "id": "def-public.SubFeaturePrivilegeConfig.name", + "type": "string", + "label": "name", + "description": [ + "\nThe display name for this privilege." ], - "id": "def-public.FeatureKibanaPrivileges.api", - "type": "Object", - "label": "api", + "source": { + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 66 + } + }, + { + "tags": [], + "id": "def-public.SubFeaturePrivilegeConfig.includeIn", + "type": "CompoundType", + "label": "includeIn", "description": [ - "\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n" + "\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/feature_kibana_privileges.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64" + "path": "x-pack/plugins/features/common/sub_feature.ts", + "lineNumber": 72 }, "signature": [ - "readonly string[] | undefined" - ] - }, - { - "tags": [ - "example" - ], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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[]; }" - ] - }, - { - "tags": [ - "example", - "see" - ], - "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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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\"" + "\"read\" | \"all\" | \"none\"" ] }, { @@ -871,8 +814,7 @@ ], "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" + "lineNumber": 79 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -881,8 +823,7 @@ ], "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" + "lineNumber": 56 }, "initialIsOpen": false } @@ -898,8 +839,7 @@ "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" + "lineNumber": 27 }, "signature": [ "void" @@ -915,8 +855,7 @@ "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" + "lineNumber": 28 }, "signature": [ "{ getFeatures: () => Promise<", @@ -936,36 +875,14 @@ "server": { "classes": [ { - "id": "def-server.KibanaFeature", + "id": "def-server.ElasticsearchFeature", "type": "Class", "tags": [], - "label": "KibanaFeature", + "label": "ElasticsearchFeature", "description": [], "children": [ { - "tags": [], - "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", + "id": "def-server.ElasticsearchFeature.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -978,70 +895,232 @@ "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: ", + "Readonly<{ id: string; management?: Readonly<{ [x: string]: ", + "RecursiveReadonlyArray", + "; }> | undefined; catalogue?: ", + "RecursiveReadonlyArray", + " | undefined; privileges: ", + "RecursiveReadonlyArray", + "<", { "pluginId": "features", "scope": "common", "docId": "kibFeaturesPluginApi", - "section": "def-common.SubFeaturePrivilegeGroupType", - "text": "SubFeaturePrivilegeGroupType" + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" }, - "; 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" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65 } } ], "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" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 65 } }, { - "id": "def-server.KibanaFeature.id", + "id": "def-server.ElasticsearchFeature.id", "type": "string", "label": "id", "tags": [], "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" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 67 } }, { - "id": "def-server.KibanaFeature.name", - "type": "string", - "label": "name", + "id": "def-server.ElasticsearchFeature.catalogue", + "type": "Object", + "label": "catalogue", "tags": [], "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" - } + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 71 + }, + "signature": [ + "RecursiveReadonlyArray", + " | undefined" + ] }, { - "id": "def-server.KibanaFeature.order", - "type": "number", - "label": "order", + "id": "def-server.ElasticsearchFeature.management", + "type": "Object", + "label": "management", "tags": [], "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" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 75 }, "signature": [ - "number | undefined" - ] + "Readonly<{ [x: string]: ", + "RecursiveReadonlyArray", + "; }> | undefined" + ] + }, + { + "id": "def-server.ElasticsearchFeature.privileges", + "type": "Object", + "label": "privileges", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 79 + }, + "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 + } + } + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 64 + }, + "initialIsOpen": false + }, + { + "id": "def-server.KibanaFeature", + "type": "Class", + "tags": [], + "label": "KibanaFeature", + "description": [], + "children": [ + { + "tags": [], + "id": "def-server.KibanaFeature.subFeatures", + "type": "Array", + "label": "subFeatures", + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 138 + }, + "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 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 140 + } + }, + { + "id": "def-server.KibanaFeature.id", + "type": "string", + "label": "id", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 146 + } + }, + { + "id": "def-server.KibanaFeature.name", + "type": "string", + "label": "name", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 150 + } + }, + { + "id": "def-server.KibanaFeature.order", + "type": "number", + "label": "order", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 154 + }, + "signature": [ + "number | undefined" + ] }, { "id": "def-server.KibanaFeature.category", @@ -1051,8 +1130,7 @@ "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" + "lineNumber": 158 }, "signature": [ "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" @@ -1066,8 +1144,7 @@ "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" + "lineNumber": 162 }, "signature": [ "readonly string[]" @@ -1081,8 +1158,7 @@ "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" + "lineNumber": 166 }, "signature": [ "readonly string[] | undefined" @@ -1096,8 +1172,7 @@ "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" + "lineNumber": 170 }, "signature": [ "Readonly<{ [x: string]: readonly string[]; }> | undefined" @@ -1111,8 +1186,7 @@ "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" + "lineNumber": 174 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -1126,8 +1200,7 @@ "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" + "lineNumber": 178 }, "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" @@ -1141,8 +1214,7 @@ "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" + "lineNumber": 182 }, "signature": [ "readonly string[] | undefined" @@ -1156,8 +1228,7 @@ "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" + "lineNumber": 186 } }, { @@ -1168,8 +1239,7 @@ "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" + "lineNumber": 190 }, "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" @@ -1195,169 +1265,13 @@ "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" + "lineNumber": 194 } } ], "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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", - "tags": [], - "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" + "lineNumber": 137 }, "initialIsOpen": false } @@ -1365,11 +1279,11 @@ "functions": [], "interfaces": [ { - "id": "def-server.KibanaFeatureConfig", + "id": "def-server.ElasticsearchFeatureConfig", "type": "Interface", - "label": "KibanaFeatureConfig", + "label": "ElasticsearchFeatureConfig", "description": [ - "\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security." + "\nInterface for registering an Elasticsearch feature.\nFeature registration allows plugins to hide their applications based\non configured cluster or index privileges." ], "tags": [], "children": [ @@ -1377,284 +1291,162 @@ "tags": [ "see" ], - "id": "def-server.KibanaFeatureConfig.id", + "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/kibana_feature.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27" - } - }, - { - "tags": [], - "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" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 23 } }, { "tags": [], - "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" - } - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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[]" - ] - }, - { - "tags": [ - "example" - ], - "id": "def-server.KibanaFeatureConfig.management", + "id": "def-server.ElasticsearchFeatureConfig.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" + "\nManagement sections associated with this feature.\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" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 36 }, "signature": [ - "{ [sectionId: string]: readonly string[]; } | undefined" + "{ [sectionId: string]: string[]; } | undefined" ] }, { "tags": [], - "id": "def-server.KibanaFeatureConfig.catalogue", - "type": "Object", + "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\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" - ] - }, - { - "tags": [], - "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." + "\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/kibana_feature.ts", - "lineNumber": 99, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 44 }, "signature": [ - "readonly string[] | undefined" + "string[] | undefined" ] }, { "tags": [ - "example", "see" ], - "id": "def-server.KibanaFeatureConfig.privileges", - "type": "CompoundType", + "id": "def-server.ElasticsearchFeatureConfig.privileges", + "type": "Array", "label": "privileges", "description": [ - "\nFeature privilege definition.\n" + "\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/kibana_feature.ts", - "lineNumber": 113, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113" + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 61 }, "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" + "section": "def-common.FeatureElasticsearchPrivileges", + "text": "FeatureElasticsearchPrivileges" }, - "; } | null" + "[]" + ] + } + ], + "source": { + "path": "x-pack/plugins/features/common/elasticsearch_feature.ts", + "lineNumber": 16 + }, + "initialIsOpen": false + }, + { + "id": "def-server.FeatureElasticsearchPrivileges", + "type": "Interface", + "label": "FeatureElasticsearchPrivileges", + "description": [ + "\nElasticsearch Feature privilege definition" + ], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string[]" ] }, { "tags": [], - "id": "def-server.KibanaFeatureConfig.subFeatures", + "id": "def-server.FeatureElasticsearchPrivileges.requiredIndexPrivileges", "type": "Object", - "label": "subFeatures", + "label": "requiredIndexPrivileges", "description": [ - "\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined." + "\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/kibana_feature.ts", - "lineNumber": 121, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121" + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 38 }, "signature": [ - "readonly ", - { - "pluginId": "features", - "scope": "common", - "docId": "kibFeaturesPluginApi", - "section": "def-common.SubFeatureConfig", - "text": "SubFeatureConfig" - }, - "[] | undefined" + "{ [indexName: string]: string[]; } | undefined" ] }, { - "tags": [], - "id": "def-server.KibanaFeatureConfig.privilegesTooltip", - "type": "string", - "label": "privilegesTooltip", + "tags": [ + "deprecated" + ], + "id": "def-server.FeatureElasticsearchPrivileges.requiredRoles", + "type": "Array", + "label": "requiredRoles", "description": [ - "\nOptional message to display on the Role Management screen when configuring permissions for this feature." + "\nA set of Elasticsearch roles which are required for this feature to be enabled.\n" ], "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" + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 50 }, "signature": [ - "string | undefined" + "string[] | undefined" ] }, { "tags": [ - "private" + "see" + ], + "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" ], - "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" + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 72 }, "signature": [ - "{ description: string; privileges: readonly ", - { - "pluginId": "features", - "scope": "common", - "docId": "kibFeaturesPluginApi", - "section": "def-common.ReservedKibanaPrivilege", - "text": "ReservedKibanaPrivilege" - }, - "[]; } | undefined" + "string[]" ] } ], "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" + "path": "x-pack/plugins/features/common/feature_elasticsearch_privileges.ts", + "lineNumber": 11 }, "initialIsOpen": false }, @@ -1677,17 +1469,14 @@ ], "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" + "lineNumber": 15 }, "signature": [ "boolean | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-server.FeatureKibanaPrivileges.management", "type": "Object", "label": "management", @@ -1696,8 +1485,7 @@ ], "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" + "lineNumber": 29 }, "signature": [ "{ [sectionId: string]: readonly string[]; } | undefined" @@ -1713,17 +1501,14 @@ ], "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" + "lineNumber": 36 }, "signature": [ "readonly string[] | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-server.FeatureKibanaPrivileges.api", "type": "Object", "label": "api", @@ -1732,17 +1517,14 @@ ], "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" + "lineNumber": 64 }, "signature": [ "readonly string[] | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-server.FeatureKibanaPrivileges.app", "type": "Object", "label": "app", @@ -1751,8 +1533,7 @@ ], "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" + "lineNumber": 77 }, "signature": [ "readonly string[] | undefined" @@ -1768,8 +1549,7 @@ ], "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" + "lineNumber": 84 }, "signature": [ "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" @@ -1785,8 +1565,7 @@ ], "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" + "lineNumber": 110 }, "signature": [ "{ all: readonly string[]; read: readonly string[]; }" @@ -1794,7 +1573,6 @@ }, { "tags": [ - "example", "see" ], "id": "def-server.FeatureKibanaPrivileges.ui", @@ -1805,8 +1583,7 @@ ], "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" + "lineNumber": 153 }, "signature": [ "readonly string[]" @@ -1815,17 +1592,16 @@ ], "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" + "lineNumber": 11 }, "initialIsOpen": false }, { - "id": "def-server.ElasticsearchFeatureConfig", + "id": "def-server.KibanaFeatureConfig", "type": "Interface", - "label": "ElasticsearchFeatureConfig", + "label": "KibanaFeatureConfig", "description": [ - "\nInterface for registering an Elasticsearch feature.\nFeature registration allows plugins to hide their applications based\non configured cluster or index privileges." + "\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security." ], "tags": [], "children": [ @@ -1833,178 +1609,266 @@ "tags": [ "see" ], - "id": "def-server.ElasticsearchFeatureConfig.id", + "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/elasticsearch_feature.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L23" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 27 } }, { - "tags": [ - "example" + "tags": [], + "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." ], - "id": "def-server.ElasticsearchFeatureConfig.management", + "source": { + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 33 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.AppCategory", + "text": "AppCategory" + } + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "boolean | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "readonly string[]" + ] + }, + { + "tags": [], + "id": "def-server.KibanaFeatureConfig.management", "type": "Object", "label": "management", "description": [ - "\nManagement sections associated with this feature.\n" + "\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/elasticsearch_feature.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L36" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 84 }, "signature": [ - "{ [sectionId: string]: string[]; } | undefined" + "{ [sectionId: string]: readonly string[]; } | undefined" ] }, { "tags": [], - "id": "def-server.ElasticsearchFeatureConfig.catalogue", - "type": "Array", + "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" + "\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/elasticsearch_feature.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L44" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 92 }, "signature": [ - "string[] | undefined" + "readonly string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "readonly string[] | undefined" ] }, { "tags": [ - "example", "see" ], - "id": "def-server.ElasticsearchFeatureConfig.privileges", - "type": "Array", + "id": "def-server.KibanaFeatureConfig.privileges", + "type": "CompoundType", "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" + "\nFeature privilege definition.\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" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 113 }, "signature": [ + "{ all: ", { "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" - ], - "tags": [], - "children": [ - { - "tags": [], - "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[]" + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; read: ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.FeatureKibanaPrivileges", + "text": "FeatureKibanaPrivileges" + }, + "; } | null" ] }, { - "tags": [ - "example" - ], - "id": "def-server.FeatureElasticsearchPrivileges.requiredIndexPrivileges", + "tags": [], + "id": "def-server.KibanaFeatureConfig.subFeatures", "type": "Object", - "label": "requiredIndexPrivileges", + "label": "subFeatures", "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" + "\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined." ], "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" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 121 }, "signature": [ - "{ [indexName: string]: string[]; } | undefined" + "readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.SubFeatureConfig", + "text": "SubFeatureConfig" + }, + "[] | undefined" ] }, { - "tags": [ - "deprecated" - ], - "id": "def-server.FeatureElasticsearchPrivileges.requiredRoles", - "type": "Array", - "label": "requiredRoles", + "tags": [], + "id": "def-server.KibanaFeatureConfig.privilegesTooltip", + "type": "string", + "label": "privilegesTooltip", "description": [ - "\nA set of Elasticsearch roles which are required for this feature to be enabled.\n" + "\nOptional message to display on the Role Management screen when configuring permissions for this feature." ], "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" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 126 }, "signature": [ - "string[] | undefined" + "string | undefined" ] }, { "tags": [ - "example", - "see" - ], - "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" + "private" ], + "id": "def-server.KibanaFeatureConfig.reserved", + "type": "Object", + "label": "reserved", + "description": [], "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" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 131 }, "signature": [ - "string[]" + "{ description: string; privileges: readonly ", + { + "pluginId": "features", + "scope": "common", + "docId": "kibFeaturesPluginApi", + "section": "def-common.ReservedKibanaPrivilege", + "text": "ReservedKibanaPrivilege" + }, + "[]; } | undefined" ] } ], "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" + "path": "x-pack/plugins/features/common/kibana_feature.ts", + "lineNumber": 20 }, "initialIsOpen": false }, @@ -2050,8 +1914,7 @@ "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" + "lineNumber": 34 } } ], @@ -2059,8 +1922,7 @@ "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" + "lineNumber": 34 } }, { @@ -2096,8 +1958,7 @@ "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" + "lineNumber": 35 } } ], @@ -2105,8 +1966,7 @@ "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" + "lineNumber": 35 } }, { @@ -2130,8 +1990,7 @@ "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" + "lineNumber": 41 } }, { @@ -2155,8 +2014,7 @@ "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" + "lineNumber": 47 } }, { @@ -2179,15 +2037,13 @@ "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" + "lineNumber": 48 } } ], "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" + "lineNumber": 33 }, "initialIsOpen": false }, @@ -2219,8 +2075,7 @@ "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" + "lineNumber": 52 } }, { @@ -2244,15 +2099,13 @@ "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" + "lineNumber": 53 } } ], "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" + "lineNumber": 51 }, "initialIsOpen": false } @@ -2268,8 +2121,7 @@ "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" + "lineNumber": 23 }, "signature": [ "RegExp" @@ -2320,8 +2172,7 @@ "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" + "lineNumber": 65 } } ], @@ -2329,8 +2180,7 @@ "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" + "lineNumber": 65 } }, { @@ -2341,8 +2191,7 @@ "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" + "lineNumber": 67 } }, { @@ -2353,8 +2202,7 @@ "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" + "lineNumber": 71 }, "signature": [ "RecursiveReadonlyArray", @@ -2369,8 +2217,7 @@ "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" + "lineNumber": 75 }, "signature": [ "Readonly<{ [x: string]: ", @@ -2386,8 +2233,7 @@ "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" + "lineNumber": 79 }, "signature": [ "RecursiveReadonlyArray", @@ -2422,15 +2268,13 @@ "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" + "lineNumber": 83 } } ], "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" + "lineNumber": 64 }, "initialIsOpen": false }, @@ -2449,8 +2293,7 @@ "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" + "lineNumber": 138 }, "signature": [ { @@ -2490,8 +2333,7 @@ "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" + "lineNumber": 140 } } ], @@ -2499,8 +2341,7 @@ "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" + "lineNumber": 140 } }, { @@ -2511,8 +2352,7 @@ "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" + "lineNumber": 146 } }, { @@ -2523,8 +2363,7 @@ "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" + "lineNumber": 150 } }, { @@ -2535,8 +2374,7 @@ "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" + "lineNumber": 154 }, "signature": [ "number | undefined" @@ -2550,8 +2388,7 @@ "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" + "lineNumber": 158 }, "signature": [ "Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>" @@ -2565,8 +2402,7 @@ "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" + "lineNumber": 162 }, "signature": [ "readonly string[]" @@ -2580,8 +2416,7 @@ "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" + "lineNumber": 166 }, "signature": [ "readonly string[] | undefined" @@ -2595,8 +2430,7 @@ "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" + "lineNumber": 170 }, "signature": [ "Readonly<{ [x: string]: readonly string[]; }> | undefined" @@ -2610,8 +2444,7 @@ "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" + "lineNumber": 174 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -2625,8 +2458,7 @@ "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" + "lineNumber": 178 }, "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" @@ -2640,8 +2472,7 @@ "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" + "lineNumber": 182 }, "signature": [ "readonly string[] | undefined" @@ -2655,8 +2486,7 @@ "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" + "lineNumber": 186 } }, { @@ -2667,8 +2497,7 @@ "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" + "lineNumber": 190 }, "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" @@ -2694,15 +2523,13 @@ "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" + "lineNumber": 194 } } ], "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" + "lineNumber": 137 }, "initialIsOpen": false }, @@ -2740,8 +2567,7 @@ "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" + "lineNumber": 83 } } ], @@ -2749,8 +2575,7 @@ "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" + "lineNumber": 83 } }, { @@ -2761,8 +2586,7 @@ "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" + "lineNumber": 85 } }, { @@ -2773,8 +2597,7 @@ "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" + "lineNumber": 89 }, "signature": [ "readonly Readonly<{ groupType: ", @@ -2809,21 +2632,107 @@ "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" + "lineNumber": 93 } } ], "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" + "lineNumber": 82 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ + { + "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." + ], + "tags": [], + "children": [ + { + "tags": [ + "see" + ], + "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 + } + }, + { + "tags": [], + "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 + }, + "signature": [ + "{ [sectionId: string]: string[]; } | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [ + "see" + ], + "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 + }, + "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 + }, + "initialIsOpen": false + }, { "id": "def-common.FeatureElasticsearchPrivileges", "type": "Interface", @@ -2843,17 +2752,14 @@ ], "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" + "lineNumber": 17 }, "signature": [ "string[]" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-common.FeatureElasticsearchPrivileges.requiredIndexPrivileges", "type": "Object", "label": "requiredIndexPrivileges", @@ -2862,8 +2768,7 @@ ], "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" + "lineNumber": 38 }, "signature": [ "{ [indexName: string]: string[]; } | undefined" @@ -2881,8 +2786,7 @@ ], "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" + "lineNumber": 50 }, "signature": [ "string[] | undefined" @@ -2890,7 +2794,6 @@ }, { "tags": [ - "example", "see" ], "id": "def-common.FeatureElasticsearchPrivileges.ui", @@ -2901,8 +2804,7 @@ ], "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" + "lineNumber": 72 }, "signature": [ "string[]" @@ -2911,8 +2813,7 @@ ], "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" + "lineNumber": 11 }, "initialIsOpen": false }, @@ -2935,17 +2836,14 @@ ], "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" + "lineNumber": 15 }, "signature": [ "boolean | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-common.FeatureKibanaPrivileges.management", "type": "Object", "label": "management", @@ -2954,8 +2852,7 @@ ], "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" + "lineNumber": 29 }, "signature": [ "{ [sectionId: string]: readonly string[]; } | undefined" @@ -2971,17 +2868,14 @@ ], "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" + "lineNumber": 36 }, "signature": [ "readonly string[] | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-common.FeatureKibanaPrivileges.api", "type": "Object", "label": "api", @@ -2990,17 +2884,14 @@ ], "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" + "lineNumber": 64 }, "signature": [ "readonly string[] | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-common.FeatureKibanaPrivileges.app", "type": "Object", "label": "app", @@ -3009,8 +2900,7 @@ ], "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" + "lineNumber": 77 }, "signature": [ "readonly string[] | undefined" @@ -3026,8 +2916,7 @@ ], "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" + "lineNumber": 84 }, "signature": [ "{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined" @@ -3043,8 +2932,7 @@ ], "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" + "lineNumber": 110 }, "signature": [ "{ all: readonly string[]; read: readonly string[]; }" @@ -3052,7 +2940,6 @@ }, { "tags": [ - "example", "see" ], "id": "def-common.FeatureKibanaPrivileges.ui", @@ -3063,8 +2950,7 @@ ], "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" + "lineNumber": 153 }, "signature": [ "readonly string[]" @@ -3073,104 +2959,7 @@ ], "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." - ], - "tags": [], - "children": [ - { - "tags": [ - "see" - ], - "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" - } - }, - { - "tags": [ - "example" - ], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [ - "example", - "see" - ], - "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" + "lineNumber": 11 }, "initialIsOpen": false }, @@ -3195,8 +2984,7 @@ ], "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" + "lineNumber": 27 } }, { @@ -3209,8 +2997,7 @@ ], "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" + "lineNumber": 33 } }, { @@ -3223,8 +3010,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ { @@ -3246,8 +3032,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ "number | undefined" @@ -3263,8 +3048,7 @@ ], "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" + "lineNumber": 54 }, "signature": [ "boolean | undefined" @@ -3280,8 +3064,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -3297,17 +3080,14 @@ ], "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" + "lineNumber": 68 }, "signature": [ "readonly string[]" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-common.KibanaFeatureConfig.management", "type": "Object", "label": "management", @@ -3316,8 +3096,7 @@ ], "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" + "lineNumber": 84 }, "signature": [ "{ [sectionId: string]: readonly string[]; } | undefined" @@ -3333,8 +3112,7 @@ ], "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" + "lineNumber": 92 }, "signature": [ "readonly string[] | undefined" @@ -3350,8 +3128,7 @@ ], "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" + "lineNumber": 99 }, "signature": [ "readonly string[] | undefined" @@ -3359,7 +3136,6 @@ }, { "tags": [ - "example", "see" ], "id": "def-common.KibanaFeatureConfig.privileges", @@ -3370,8 +3146,7 @@ ], "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" + "lineNumber": 113 }, "signature": [ "{ all: ", @@ -3403,8 +3178,7 @@ ], "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" + "lineNumber": 121 }, "signature": [ "readonly ", @@ -3428,8 +3202,7 @@ ], "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" + "lineNumber": 126 }, "signature": [ "string | undefined" @@ -3445,8 +3218,7 @@ "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" + "lineNumber": 131 }, "signature": [ "{ description: string; privileges: readonly ", @@ -3463,8 +3235,7 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, @@ -3487,8 +3258,7 @@ ], "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" + "lineNumber": 17 } }, { @@ -3501,8 +3271,7 @@ ], "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" + "lineNumber": 20 }, "signature": [ "readonly ", @@ -3519,8 +3288,7 @@ ], "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" + "lineNumber": 15 }, "initialIsOpen": false }, @@ -3561,8 +3329,7 @@ ], "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" + "lineNumber": 61 } }, { @@ -3575,8 +3342,7 @@ ], "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" + "lineNumber": 66 } }, { @@ -3589,8 +3355,7 @@ ], "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" + "lineNumber": 72 }, "signature": [ "\"read\" | \"all\" | \"none\"" @@ -3606,8 +3371,7 @@ ], "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" + "lineNumber": 79 }, "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined" @@ -3616,8 +3380,7 @@ ], "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" + "lineNumber": 56 }, "initialIsOpen": false }, @@ -3640,8 +3403,7 @@ ], "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" + "lineNumber": 45 }, "signature": [ { @@ -3663,8 +3425,7 @@ ], "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" + "lineNumber": 50 }, "signature": [ "readonly ", @@ -3681,8 +3442,7 @@ ], "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" + "lineNumber": 36 }, "initialIsOpen": false } @@ -3699,8 +3459,7 @@ ], "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" + "lineNumber": 31 }, "signature": [ "\"mutually_exclusive\" | \"independent\"" diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json index d816e2747ae63..350bd1aa067f3 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -4,6 +4,102 @@ "classes": [], "functions": [], "interfaces": [ + { + "id": "def-public.CreateDocsResponse", + "type": "Interface", + "label": "CreateDocsResponse", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.CreateDocsResponse.success", + "type": "boolean", + "label": "success", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 31 + } + }, + { + "tags": [], + "id": "def-public.CreateDocsResponse.remainder", + "type": "number", + "label": "remainder", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 32 + } + }, + { + "tags": [], + "id": "def-public.CreateDocsResponse.docs", + "type": "Array", + "label": "docs", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 33 + }, + "signature": [ + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.ImportDoc", + "text": "ImportDoc" + }, + "[]" + ] + }, + { + "tags": [], + "id": "def-public.CreateDocsResponse.error", + "type": "Any", + "label": "error", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 34 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Doc", + "type": "Interface", + "label": "Doc", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Doc.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 26 + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 25 + }, + "initialIsOpen": false + }, { "id": "def-public.FileUploadComponentProps", "type": "Interface", @@ -19,8 +115,7 @@ "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" + "lineNumber": 14 } }, { @@ -31,8 +126,7 @@ "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" + "lineNumber": 15 }, "signature": [ "(geojsonFile: GeoJSON.FeatureCollection, name: string, previewCoverage: number) => void" @@ -46,8 +140,7 @@ "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" + "lineNumber": 16 }, "signature": [ "() => void" @@ -61,8 +154,7 @@ "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" + "lineNumber": 17 }, "signature": [ "(indexReady: boolean) => void" @@ -76,8 +168,7 @@ "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" + "lineNumber": 18 }, "signature": [ "(results: { indexDataResp: ", @@ -107,8 +198,7 @@ "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" + "lineNumber": 22 }, "signature": [ "() => void" @@ -117,545 +207,519 @@ ], "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" + "lineNumber": 13 }, "initialIsOpen": false }, { - "id": "def-public.ImportResponse", + "id": "def-public.IImporter", "type": "Interface", - "label": "ImportResponse", + "label": "IImporter", "description": [], "tags": [], "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, + "id": "def-public.IImporter.read", + "type": "Function", + "label": "read", "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.ImportResponse.pipelineId", - "type": "string", - "label": "pipelineId", + "(data: ArrayBuffer) => { success: boolean; }" + ], "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" - ] - }, - { + "children": [ + { + "type": "Object", + "label": "data", + "isRequired": true, + "signature": [ + "ArrayBuffer" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 44 + } + } + ], "tags": [], - "id": "def-public.ImportResponse.docCount", - "type": "number", - "label": "docCount", - "description": [], + "returnComment": [], "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 44 } }, { - "tags": [], - "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" - }, + "id": "def-public.IImporter.initializeImport", + "type": "Function", + "label": "initializeImport", "signature": [ + "(index: string, settings: ", { "pluginId": "fileUpload", "scope": "common", "docId": "kibFileUploadPluginApi", - "section": "def-common.ImportFailure", - "text": "ImportFailure" + "section": "def-common.Settings", + "text": "Settings" }, - "[]" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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": [ + ", mappings: ", { "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": [], - "tags": [], - "children": [ - { + "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": 46 + } + }, + { + "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": 47 + } + }, + { + "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": 48 + } + }, + { + "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": 49 + } + } + ], "tags": [], - "id": "def-public.Doc.message", - "type": "string", - "label": "message", + "returnComment": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 45 + } + }, + { + "id": "def-public.IImporter.import", + "type": "Function", + "label": "import", + "signature": [ + "(id: string, index: string, pipelineId: string | undefined, 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": 52 + } + }, + { + "type": "string", + "label": "index", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 53 + } + }, + { + "type": "string", + "label": "pipelineId", + "isRequired": false, + "signature": [ + "string | undefined" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 54 + } + }, + { + "type": "Function", + "label": "setImportProgress", + "isRequired": true, + "signature": [ + "(progress: number) => void" + ], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 55 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 51 } } ], "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 43 }, "initialIsOpen": false }, { - "id": "def-public.Settings", + "id": "def-public.ImportConfig", "type": "Interface", - "label": "Settings", + "label": "ImportConfig", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.Settings.pipeline", - "type": "string", - "label": "pipeline", + "id": "def-public.ImportConfig.settings", + "type": "Object", + "label": "settings", "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 18 }, "signature": [ - "string | undefined" + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Settings", + "text": "Settings" + } ] }, { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-public.Settings.body", - "type": "Array", - "label": "body", + "id": "def-public.ImportConfig.mappings", + "type": "Object", + "label": "mappings", "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 19 }, "signature": [ - "any[]" + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + } ] }, { - "id": "def-public.Settings.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-public.ImportConfig.pipeline", + "type": "Object", + "label": "pipeline", "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 20 }, "signature": [ - "any" + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + } ] } ], "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-public.Mappings", + "id": "def-public.ImportFactoryOptions", "type": "Interface", - "label": "Mappings", + "label": "ImportFactoryOptions", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.Mappings._meta", - "type": "Object", - "label": "_meta", + "id": "def-public.ImportFactoryOptions.excludeLinesPattern", + "type": "string", + "label": "excludeLinesPattern", "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 38 }, "signature": [ - "{ created_by: string; } | undefined" + "string | undefined" ] }, { "tags": [], - "id": "def-public.Mappings.properties", + "id": "def-public.ImportFactoryOptions.multilineStartPattern", + "type": "string", + "label": "multilineStartPattern", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 39 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ImportFactoryOptions.importConfig", "type": "Object", - "label": "properties", + "label": "importConfig", "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 40 }, "signature": [ - "{ [key: string]: any; }" + { + "pluginId": "fileUpload", + "scope": "public", + "docId": "kibFileUploadPluginApi", + "section": "def-public.ImportConfig", + "text": "ImportConfig" + } ] } ], "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" + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 37 }, "initialIsOpen": false }, { - "id": "def-public.IngestPipelineWrapper", + "id": "def-public.ImportFailure", "type": "Interface", - "label": "IngestPipelineWrapper", + "label": "ImportFailure", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.IngestPipelineWrapper.id", + "id": "def-public.ImportFailure.item", + "type": "number", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 20 + } + }, + { + "tags": [], + "id": "def-public.ImportFailure.reason", "type": "string", - "label": "id", + "label": "reason", "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" + "lineNumber": 21 } }, { "tags": [], - "id": "def-public.IngestPipelineWrapper.pipeline", - "type": "Object", - "label": "pipeline", + "id": "def-public.ImportFailure.doc", + "type": "CompoundType", + "label": "doc", "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" + "lineNumber": 22 }, "signature": [ { "pluginId": "fileUpload", "scope": "common", "docId": "kibFileUploadPluginApi", - "section": "def-common.IngestPipeline", - "text": "IngestPipeline" + "section": "def-common.ImportDoc", + "text": "ImportDoc" } ] } ], "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" + "lineNumber": 19 }, "initialIsOpen": false }, { - "id": "def-public.IngestPipeline", + "id": "def-public.ImportResponse", "type": "Interface", - "label": "IngestPipeline", + "label": "ImportResponse", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.IngestPipeline.description", - "type": "string", - "label": "description", + "id": "def-public.ImportResponse.success", + "type": "boolean", + "label": "success", "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" + "lineNumber": 9 } }, { "tags": [], - "id": "def-public.IngestPipeline.processors", - "type": "Array", - "label": "processors", + "id": "def-public.ImportResponse.id", + "type": "string", + "label": "id", "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": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-public.ImportConfig.settings", - "type": "Object", - "label": "settings", - "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": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.Settings", - "text": "Settings" - } - ] + "lineNumber": 10 + } }, { "tags": [], - "id": "def-public.ImportConfig.mappings", - "type": "Object", - "label": "mappings", + "id": "def-public.ImportResponse.index", + "type": "string", + "label": "index", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 11 }, "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.Mappings", - "text": "Mappings" - } + "string | undefined" ] }, { "tags": [], - "id": "def-public.ImportConfig.pipeline", - "type": "Object", - "label": "pipeline", + "id": "def-public.ImportResponse.pipelineId", + "type": "string", + "label": "pipelineId", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 12 }, "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.IngestPipeline", - "text": "IngestPipeline" - } + "string | undefined" ] - } - ], - "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" - }, - "initialIsOpen": false - }, - { - "id": "def-public.ImportResults", - "type": "Interface", - "label": "ImportResults", - "description": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-public.ImportResults.success", - "type": "boolean", - "label": "success", + "id": "def-public.ImportResponse.docCount", + "type": "number", + "label": "docCount", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 13 } }, { "tags": [], - "id": "def-public.ImportResults.failures", + "id": "def-public.ImportResponse.failures", "type": "Array", "label": "failures", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 14 }, "signature": [ { @@ -665,110 +729,106 @@ "section": "def-common.ImportFailure", "text": "ImportFailure" }, - "[] | undefined" + "[]" ] }, { "tags": [], - "id": "def-public.ImportResults.docCount", - "type": "number", - "label": "docCount", + "id": "def-public.ImportResponse.error", + "type": "Any", + "label": "error", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 15 }, "signature": [ - "number | undefined" + "any" ] }, { "tags": [], - "id": "def-public.ImportResults.error", - "type": "Any", - "label": "error", + "id": "def-public.ImportResponse.ingestError", + "type": "CompoundType", + "label": "ingestError", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 16 }, "signature": [ - "any" + "boolean | undefined" ] } ], "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 8 }, "initialIsOpen": false }, { - "id": "def-public.CreateDocsResponse", + "id": "def-public.ImportResults", "type": "Interface", - "label": "CreateDocsResponse", + "label": "ImportResults", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.CreateDocsResponse.success", + "id": "def-public.ImportResults.success", "type": "boolean", "label": "success", "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" - } - }, - { - "tags": [], - "id": "def-public.CreateDocsResponse.remainder", - "type": "number", - "label": "remainder", - "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" + "lineNumber": 24 } }, { "tags": [], - "id": "def-public.CreateDocsResponse.docs", + "id": "def-public.ImportResults.failures", "type": "Array", - "label": "docs", + "label": "failures", "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" + "lineNumber": 25 }, "signature": [ { "pluginId": "fileUpload", "scope": "common", "docId": "kibFileUploadPluginApi", - "section": "def-common.ImportDoc", - "text": "ImportDoc" + "section": "def-common.ImportFailure", + "text": "ImportFailure" }, - "[]" + "[] | undefined" ] }, { "tags": [], - "id": "def-public.CreateDocsResponse.error", + "id": "def-public.ImportResults.docCount", + "type": "number", + "label": "docCount", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/public/importer/types.ts", + "lineNumber": 26 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-public.ImportResults.error", "type": "Any", "label": "error", "description": [], "source": { "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L34" + "lineNumber": 27 }, "signature": [ "any" @@ -777,327 +837,200 @@ ], "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" + "lineNumber": 23 }, "initialIsOpen": false }, { - "id": "def-public.ImportFactoryOptions", + "id": "def-public.IngestPipeline", "type": "Interface", - "label": "ImportFactoryOptions", + "label": "IngestPipeline", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.ImportFactoryOptions.excludeLinesPattern", + "id": "def-public.IngestPipeline.description", "type": "string", - "label": "excludeLinesPattern", + "label": "description", "description": [], "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" - }, - "signature": [ - "string | undefined" - ] + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 53 + } }, { "tags": [], - "id": "def-public.ImportFactoryOptions.multilineStartPattern", - "type": "string", - "label": "multilineStartPattern", + "id": "def-public.IngestPipeline.processors", + "type": "Array", + "label": "processors", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 54 }, "signature": [ - "string | undefined" + "any[]" ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 52 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IngestPipelineWrapper", + "type": "Interface", + "label": "IngestPipelineWrapper", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IngestPipelineWrapper.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 48 + } }, { "tags": [], - "id": "def-public.ImportFactoryOptions.importConfig", + "id": "def-public.IngestPipelineWrapper.pipeline", "type": "Object", - "label": "importConfig", + "label": "pipeline", "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 49 }, "signature": [ { "pluginId": "fileUpload", - "scope": "public", + "scope": "common", "docId": "kibFileUploadPluginApi", - "section": "def-public.ImportConfig", - "text": "ImportConfig" + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" } ] } ], "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 47 }, "initialIsOpen": false }, { - "id": "def-public.IImporter", + "id": "def-public.Mappings", "type": "Interface", - "label": "IImporter", + "label": "Mappings", "description": [], "tags": [], "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": 44, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L44" - } - } - ], "tags": [], - "returnComment": [], + "id": "def-public.Mappings._meta", + "type": "Object", + "label": "_meta", + "description": [], "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" - } + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 39 + }, + "signature": [ + "{ created_by: string; } | undefined" + ] }, { - "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" - }, - ">" - ], + "tags": [], + "id": "def-public.Mappings.properties", + "type": "Object", + "label": "properties", "description": [], - "children": [ - { - "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": "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": 47, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L47" - } - }, - { - "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": 48, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L48" - } - }, - { - "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": 49, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L49" - } - } - ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 42 + }, + "signature": [ + "{ [key: string]: any; }" + ] + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 38 + }, + "initialIsOpen": false + }, + { + "id": "def-public.Settings", + "type": "Interface", + "label": "Settings", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.Settings.pipeline", + "type": "string", + "label": "pipeline", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 32 + }, + "signature": [ + "string | undefined" + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-public.Settings.index", + "type": "string", + "label": "index", + "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" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 33 } }, { - "id": "def-public.IImporter.import", - "type": "Function", - "label": "import", - "signature": [ - "(id: string, index: string, pipelineId: string | undefined, setImportProgress: (progress: number) => void) => Promise<", - { - "pluginId": "fileUpload", - "scope": "public", - "docId": "kibFileUploadPluginApi", - "section": "def-public.ImportResults", - "text": "ImportResults" - }, - ">" - ], + "tags": [], + "id": "def-public.Settings.body", + "type": "Array", + "label": "body", "description": [], - "children": [ - { - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 52, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L52" - } - }, - { - "type": "string", - "label": "index", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 53, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L53" - } - }, - { - "type": "string", - "label": "pipelineId", - "isRequired": false, - "signature": [ - "string | undefined" - ], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L54" - } - }, - { - "type": "Function", - "label": "setImportProgress", - "isRequired": true, - "signature": [ - "(progress: number) => void" - ], - "description": [], - "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 55, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L55" - } - } - ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 34 + }, + "signature": [ + "any[]" + ] + }, + { + "id": "def-public.Settings.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "returnComment": [], + "description": [], "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 51, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L51" - } + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 35 + }, + "signature": [ + "any" + ] } ], "source": { - "path": "x-pack/plugins/file_upload/public/importer/types.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L43" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 31 }, "initialIsOpen": false } @@ -1106,133 +1039,125 @@ "misc": [ { "tags": [], - "id": "def-public.UI_SETTING_MAX_FILE_SIZE", - "type": "string", - "label": "UI_SETTING_MAX_FILE_SIZE", + "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": 8, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L8" + "lineNumber": 14 }, "signature": [ - "\"fileUpload:maxFileSize\"" + "1073741274" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.MB", - "type": "number", - "label": "MB", + "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": 10, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L10" + "lineNumber": 15 }, + "signature": [ + "\"0,0.[0] b\"" + ], "initialIsOpen": false }, { + "id": "def-public.ImportDoc", + "type": "Type", + "label": "ImportDoc", "tags": [], - "id": "def-public.MAX_FILE_SIZE", - "type": "string", - "label": "MAX_FILE_SIZE", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L11" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 29 }, "signature": [ - "\"100MB\"" + "string | object | ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Doc", + "text": "Doc" + } ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.MAX_FILE_SIZE_BYTES", - "type": "number", - "label": "MAX_FILE_SIZE_BYTES", + "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": 12, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L12" + "lineNumber": 19 }, "signature": [ - "104857600" + "\"ml-file-data-visualizer\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.ABSOLUTE_MAX_FILE_SIZE_BYTES", - "type": "number", - "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", + "id": "def-public.MAX_FILE_SIZE", + "type": "string", + "label": "MAX_FILE_SIZE", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L14" + "lineNumber": 11 }, "signature": [ - "1073741274" + "\"100MB\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.FILE_SIZE_DISPLAY_FORMAT", - "type": "string", - "label": "FILE_SIZE_DISPLAY_FORMAT", + "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": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L15" + "lineNumber": 12 }, "signature": [ - "\"0,0.[0] b\"" + "104857600" ], "initialIsOpen": false }, { "tags": [], - "id": "def-public.INDEX_META_DATA_CREATED_BY", - "type": "string", - "label": "INDEX_META_DATA_CREATED_BY", + "id": "def-public.MB", + "type": "number", + "label": "MB", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L19" + "lineNumber": 10 }, - "signature": [ - "\"ml-file-data-visualizer\"" - ], "initialIsOpen": false }, { - "id": "def-public.ImportDoc", - "type": "Type", - "label": "ImportDoc", "tags": [], + "id": "def-public.UI_SETTING_MAX_FILE_SIZE", + "type": "string", + "label": "UI_SETTING_MAX_FILE_SIZE", "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" + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 8 }, "signature": [ - "string | object | ", - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.Doc", - "text": "Doc" - } + "\"fileUpload:maxFileSize\"" ], "initialIsOpen": false } @@ -1246,8 +1171,7 @@ "description": [], "source": { "path": "x-pack/plugins/file_upload/public/plugin.ts", - "lineNumber": 21, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/plugin.ts#L21" + "lineNumber": 21 }, "signature": [ "FileUploadStartApi" @@ -1268,6 +1192,87 @@ "classes": [], "functions": [], "interfaces": [ + { + "id": "def-common.Doc", + "type": "Interface", + "label": "Doc", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Doc.message", + "type": "string", + "label": "message", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 26 + } + } + ], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 25 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ImportFailure", + "type": "Interface", + "label": "ImportFailure", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ImportFailure.item", + "type": "number", + "label": "item", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 20 + } + }, + { + "tags": [], + "id": "def-common.ImportFailure.reason", + "type": "string", + "label": "reason", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 21 + } + }, + { + "tags": [], + "id": "def-common.ImportFailure.doc", + "type": "CompoundType", + "label": "doc", + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 22 + }, + "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 + }, + "initialIsOpen": false + }, { "id": "def-common.ImportResponse", "type": "Interface", @@ -1283,8 +1288,7 @@ "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" + "lineNumber": 9 } }, { @@ -1295,8 +1299,7 @@ "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" + "lineNumber": 10 } }, { @@ -1307,8 +1310,7 @@ "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" + "lineNumber": 11 }, "signature": [ "string | undefined" @@ -1322,8 +1324,7 @@ "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" + "lineNumber": 12 }, "signature": [ "string | undefined" @@ -1337,8 +1338,7 @@ "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" + "lineNumber": 13 } }, { @@ -1349,8 +1349,7 @@ "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" + "lineNumber": 14 }, "signature": [ { @@ -1371,8 +1370,7 @@ "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" + "lineNumber": 15 }, "signature": [ "any" @@ -1386,8 +1384,7 @@ "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" + "lineNumber": 16 }, "signature": [ "boolean | undefined" @@ -1396,167 +1393,91 @@ ], "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" + "lineNumber": 8 }, "initialIsOpen": false }, { - "id": "def-common.ImportFailure", + "id": "def-common.IngestPipeline", "type": "Interface", - "label": "ImportFailure", + "label": "IngestPipeline", "description": [], "tags": [], "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.ImportFailure.reason", + "id": "def-common.IngestPipeline.description", "type": "string", - "label": "reason", + "label": "description", "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" + "lineNumber": 53 } }, { "tags": [], - "id": "def-common.ImportFailure.doc", - "type": "CompoundType", - "label": "doc", + "id": "def-common.IngestPipeline.processors", + "type": "Array", + "label": "processors", "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" + "lineNumber": 54 }, "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.ImportDoc", - "text": "ImportDoc" - } + "any[]" ] } ], "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" + "lineNumber": 52 }, "initialIsOpen": false }, { - "id": "def-common.Settings", + "id": "def-common.IngestPipelineWrapper", "type": "Interface", - "label": "Settings", + "label": "IngestPipelineWrapper", "description": [], "tags": [], "children": [ { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.Settings.index", + "id": "def-common.IngestPipelineWrapper.id", "type": "string", - "label": "index", + "label": "id", "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" + "lineNumber": 48 } }, { "tags": [], - "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", - "tags": [], + "id": "def-common.IngestPipelineWrapper.pipeline", + "type": "Object", + "label": "pipeline", "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" + "lineNumber": 49 }, "signature": [ - "any" + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.IngestPipeline", + "text": "IngestPipeline" + } ] } ], "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" + "lineNumber": 47 }, "initialIsOpen": false }, @@ -1575,8 +1496,7 @@ "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" + "lineNumber": 39 }, "signature": [ "{ created_by: string; } | undefined" @@ -1590,8 +1510,7 @@ "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" + "lineNumber": 42 }, "signature": [ "{ [key: string]: any; }" @@ -1600,98 +1519,74 @@ ], "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" + "lineNumber": 38 }, "initialIsOpen": false }, { - "id": "def-common.IngestPipelineWrapper", + "id": "def-common.Settings", "type": "Interface", - "label": "IngestPipelineWrapper", + "label": "Settings", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.IngestPipelineWrapper.id", + "id": "def-common.Settings.pipeline", "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" - } - }, - { - "tags": [], - "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" + "lineNumber": 32 }, "signature": [ - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.IngestPipeline", - "text": "IngestPipeline" - } + "string | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.IngestPipeline.description", + "id": "def-common.Settings.index", "type": "string", - "label": "description", + "label": "index", "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" + "lineNumber": 33 } }, { "tags": [], - "id": "def-common.IngestPipeline.processors", + "id": "def-common.Settings.body", "type": "Array", - "label": "processors", + "label": "body", "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" + "lineNumber": 34 }, "signature": [ "any[]" ] + }, + { + "id": "def-common.Settings.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 35 + }, + "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" + "lineNumber": 31 }, "initialIsOpen": false } @@ -1700,133 +1595,125 @@ "misc": [ { "tags": [], - "id": "def-common.UI_SETTING_MAX_FILE_SIZE", - "type": "string", - "label": "UI_SETTING_MAX_FILE_SIZE", + "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": 8, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L8" + "lineNumber": 14 }, "signature": [ - "\"fileUpload:maxFileSize\"" + "1073741274" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.MB", - "type": "number", - "label": "MB", + "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": 10, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L10" + "lineNumber": 15 }, + "signature": [ + "\"0,0.[0] b\"" + ], "initialIsOpen": false }, { + "id": "def-common.ImportDoc", + "type": "Type", + "label": "ImportDoc", "tags": [], - "id": "def-common.MAX_FILE_SIZE", - "type": "string", - "label": "MAX_FILE_SIZE", "description": [], "source": { - "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 11, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L11" + "path": "x-pack/plugins/file_upload/common/types.ts", + "lineNumber": 29 }, "signature": [ - "\"100MB\"" + "string | object | ", + { + "pluginId": "fileUpload", + "scope": "common", + "docId": "kibFileUploadPluginApi", + "section": "def-common.Doc", + "text": "Doc" + } ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.MAX_FILE_SIZE_BYTES", - "type": "number", - "label": "MAX_FILE_SIZE_BYTES", + "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": 12, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L12" + "lineNumber": 19 }, "signature": [ - "104857600" + "\"ml-file-data-visualizer\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES", - "type": "number", - "label": "ABSOLUTE_MAX_FILE_SIZE_BYTES", + "id": "def-common.MAX_FILE_SIZE", + "type": "string", + "label": "MAX_FILE_SIZE", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 14, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L14" + "lineNumber": 11 }, "signature": [ - "1073741274" + "\"100MB\"" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.FILE_SIZE_DISPLAY_FORMAT", - "type": "string", - "label": "FILE_SIZE_DISPLAY_FORMAT", + "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": 15, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L15" + "lineNumber": 12 }, "signature": [ - "\"0,0.[0] b\"" + "104857600" ], "initialIsOpen": false }, { "tags": [], - "id": "def-common.INDEX_META_DATA_CREATED_BY", - "type": "string", - "label": "INDEX_META_DATA_CREATED_BY", + "id": "def-common.MB", + "type": "number", + "label": "MB", "description": [], "source": { "path": "x-pack/plugins/file_upload/common/constants.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L19" + "lineNumber": 10 }, - "signature": [ - "\"ml-file-data-visualizer\"" - ], "initialIsOpen": false }, { - "id": "def-common.ImportDoc", - "type": "Type", - "label": "ImportDoc", "tags": [], + "id": "def-common.UI_SETTING_MAX_FILE_SIZE", + "type": "string", + "label": "UI_SETTING_MAX_FILE_SIZE", "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" + "path": "x-pack/plugins/file_upload/common/constants.ts", + "lineNumber": 8 }, "signature": [ - "string | object | ", - { - "pluginId": "fileUpload", - "scope": "common", - "docId": "kibFileUploadPluginApi", - "section": "def-common.Doc", - "text": "Doc" - } + "\"fileUpload:maxFileSize\"" ], "initialIsOpen": false } diff --git a/api_docs/global_search.json b/api_docs/global_search.json index 0f5b9e711cba4..1743ce6e588b1 100644 --- a/api_docs/global_search.json +++ b/api_docs/global_search.json @@ -25,8 +25,7 @@ ], "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" + "lineNumber": 89 }, "signature": [ { @@ -42,8 +41,122 @@ ], "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" + "lineNumber": 85 + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchFindOptions", + "type": "Interface", + "label": "GlobalSearchFindOptions", + "description": [ + "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}" + ], + "tags": [], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "Observable", + " | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/public/services/types.ts", + "lineNumber": 13 + }, + "initialIsOpen": false + }, + { + "id": "def-public.GlobalSearchFindParams", + "type": "Interface", + "label": "GlobalSearchFindParams", + "description": [ + "\nSearch parameters for the {@link GlobalSearchPluginStart.find | `find` API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "string[] | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 97 }, "initialIsOpen": false }, @@ -66,8 +179,7 @@ ], "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" + "lineNumber": 20 } }, { @@ -80,8 +192,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "Observable", @@ -98,15 +209,13 @@ ], "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" + "lineNumber": 33 } } ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -129,8 +238,7 @@ ], "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" + "lineNumber": 46 } }, { @@ -143,8 +251,7 @@ ], "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" + "lineNumber": 48 } }, { @@ -157,8 +264,7 @@ ], "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" + "lineNumber": 50 } }, { @@ -171,17 +277,14 @@ ], "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" + "lineNumber": 52 }, "signature": [ "string | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-public.GlobalSearchProviderResult.url", "type": "CompoundType", "label": "url", @@ -190,8 +293,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ { @@ -213,8 +315,7 @@ ], "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" + "lineNumber": 64 } }, { @@ -227,8 +328,7 @@ ], "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" + "lineNumber": 66 }, "signature": [ "Record string[] | Promise" @@ -451,66 +473,30 @@ ], "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" + "lineNumber": 22 }, "initialIsOpen": false - }, + } + ], + "enums": [], + "misc": [ { - "id": "def-public.GlobalSearchFindOptions", - "type": "Interface", - "label": "GlobalSearchFindOptions", - "description": [ - "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}" - ], - "tags": [], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - } + "id": "def-public.GlobalSearchProviderFindParams", + "type": "Type", + "label": "GlobalSearchProviderFindParams", + "tags": [ + "public" ], + "description": [], "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" + "path": "x-pack/plugins/global_search/common/types.ts", + "lineNumber": 115 }, + "signature": [ + "GlobalSearchFindParams" + ], "initialIsOpen": false - } - ], - "enums": [], - "misc": [ + }, { "id": "def-public.GlobalSearchProviderResultUrl", "type": "Type", @@ -521,8 +507,7 @@ ], "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" + "lineNumber": 39 }, "signature": [ "string | { path: string; prependBasePath: boolean; }" @@ -539,31 +524,12 @@ ], "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" + "lineNumber": 72 }, "signature": [ "Pick & { url: string; }" ], "initialIsOpen": false - }, - { - "id": "def-public.GlobalSearchProviderFindParams", - "type": "Type", - "label": "GlobalSearchProviderFindParams", - "tags": [ - "public" - ], - "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": [], @@ -575,8 +541,7 @@ "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" + "lineNumber": 16 }, "signature": [ "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" @@ -592,8 +557,7 @@ "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" + "lineNumber": 17 }, "signature": [ "{ find: (params: ", @@ -639,8 +603,7 @@ ], "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" + "lineNumber": 89 }, "signature": [ { @@ -656,8 +619,123 @@ ], "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" + "lineNumber": 85 + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchFindOptions", + "type": "Interface", + "label": "GlobalSearchFindOptions", + "description": [ + "\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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 + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "Observable", + " | undefined" + ] + } + ], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 88 + }, + "initialIsOpen": false + }, + { + "id": "def-server.GlobalSearchProviderContext", + "type": "Interface", + "label": "GlobalSearchProviderContext", + "description": [ + "\nContext passed to server-side {@GlobalSearchResultProvider | result provider}'s `find` method.\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.GlobalSearchProviderContext.core", + "type": "Object", + "label": "core", + "description": [], + "source": { + "path": "x-pack/plugins/global_search/server/types.ts", + "lineNumber": 66 + }, + "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 }, "initialIsOpen": false }, @@ -680,8 +758,7 @@ ], "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" + "lineNumber": 20 } }, { @@ -694,8 +771,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "Observable", @@ -712,15 +788,13 @@ ], "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" + "lineNumber": 33 } } ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -743,8 +817,7 @@ ], "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" + "lineNumber": 46 } }, { @@ -757,8 +830,7 @@ ], "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" + "lineNumber": 48 } }, { @@ -771,8 +843,7 @@ ], "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" + "lineNumber": 50 } }, { @@ -785,17 +856,14 @@ ], "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" + "lineNumber": 52 }, "signature": [ "string | undefined" ] }, { - "tags": [ - "example" - ], + "tags": [], "id": "def-server.GlobalSearchProviderResult.url", "type": "CompoundType", "label": "url", @@ -804,8 +872,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ { @@ -827,8 +894,7 @@ ], "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" + "lineNumber": 64 } }, { @@ -841,8 +907,7 @@ ], "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" + "lineNumber": 66 }, "signature": [ "Record | 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" - ], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" + "lineNumber": 44 }, "initialIsOpen": false }, @@ -1006,8 +949,7 @@ ], "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" + "lineNumber": 112 } }, { @@ -1070,8 +1012,7 @@ "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" + "lineNumber": 131 } }, { @@ -1090,8 +1031,7 @@ "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" + "lineNumber": 132 } }, { @@ -1110,19 +1050,15 @@ "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" + "lineNumber": 133 } } ], - "tags": [ - "example" - ], + "tags": [], "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" + "lineNumber": 130 } }, { @@ -1135,8 +1071,7 @@ ], "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" + "lineNumber": 140 }, "signature": [ "(context: ", @@ -1153,8 +1088,7 @@ ], "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" + "lineNumber": 108 }, "initialIsOpen": false }, @@ -1222,8 +1156,7 @@ "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" + "lineNumber": 51 } }, { @@ -1242,8 +1175,7 @@ "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" + "lineNumber": 52 } } ], @@ -1251,8 +1183,7 @@ "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" + "lineNumber": 50 } }, { @@ -1265,8 +1196,7 @@ ], "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" + "lineNumber": 57 }, "signature": [ "() => Promise" @@ -1275,8 +1205,7 @@ ], "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" + "lineNumber": 46 }, "initialIsOpen": false } @@ -1293,8 +1222,7 @@ ], "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" + "lineNumber": 39 }, "signature": [ "string | { path: string; prependBasePath: boolean; }" @@ -1311,8 +1239,7 @@ ], "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" + "lineNumber": 72 }, "signature": [ "Pick & { url: string; }" @@ -1329,8 +1256,7 @@ "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" + "lineNumber": 28 }, "signature": [ "{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ", @@ -1362,8 +1288,7 @@ "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" + "lineNumber": 27 }, "signature": [ "{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }" diff --git a/api_docs/home.json b/api_docs/home.json index 2043b0066d976..9f2c7929503d1 100644 --- a/api_docs/home.json +++ b/api_docs/home.json @@ -24,8 +24,7 @@ "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" + "lineNumber": 55 } } ], @@ -38,13 +37,67 @@ ], "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" + "lineNumber": 55 }, "initialIsOpen": false } ], "interfaces": [ + { + "id": "def-public.Environment", + "type": "Interface", + "label": "Environment", + "description": [], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + }, + { + "tags": [], + "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 + } + } + ], + "source": { + "path": "src/plugins/home/public/services/environment/environment.ts", + "lineNumber": 10 + }, + "initialIsOpen": false + }, { "id": "def-public.FeatureCatalogueEntry", "type": "Interface", @@ -64,8 +117,7 @@ ], "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" + "lineNumber": 22 } }, { @@ -78,8 +130,7 @@ ], "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" + "lineNumber": 24 } }, { @@ -92,8 +143,7 @@ ], "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" + "lineNumber": 26 }, "signature": [ { @@ -115,8 +165,7 @@ ], "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" + "lineNumber": 28 }, "signature": [ "string | undefined" @@ -132,8 +181,7 @@ ], "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" + "lineNumber": 30 } }, { @@ -146,8 +194,7 @@ ], "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" + "lineNumber": 32 }, "signature": [ "IconType" @@ -163,8 +210,7 @@ ], "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" + "lineNumber": 34 } }, { @@ -177,8 +223,7 @@ ], "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" + "lineNumber": 36 } }, { @@ -191,8 +236,7 @@ ], "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" + "lineNumber": 38 }, "signature": [ "number | undefined" @@ -208,8 +252,7 @@ ], "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" + "lineNumber": 40 }, "signature": [ "(() => boolean) | undefined" @@ -225,8 +268,7 @@ ], "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" + "lineNumber": 42 }, "signature": [ "string | undefined" @@ -235,8 +277,7 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, @@ -259,8 +300,7 @@ ], "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" + "lineNumber": 48 } }, { @@ -273,8 +313,7 @@ ], "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" + "lineNumber": 50 } }, { @@ -287,8 +326,7 @@ ], "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" + "lineNumber": 52 } }, { @@ -301,8 +339,7 @@ ], "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" + "lineNumber": 54 }, "signature": [ "string | undefined" @@ -318,8 +355,7 @@ ], "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" + "lineNumber": 56 }, "signature": [ "string[]" @@ -335,8 +371,7 @@ ], "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" + "lineNumber": 58 }, "signature": [ "IconType" @@ -352,8 +387,7 @@ ], "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" + "lineNumber": 60 } }, { @@ -366,8 +400,7 @@ ], "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" + "lineNumber": 62 }, "signature": [ "number | undefined" @@ -376,67 +409,7 @@ ], "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": [], - "tags": [ - "public" - ], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" + "lineNumber": 46 }, "initialIsOpen": false } @@ -452,166 +425,158 @@ "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" + "lineNumber": 13 }, "initialIsOpen": false } ], "misc": [ { - "id": "def-public.FeatureCatalogueSetup", + "id": "def-public.EnvironmentSetup", "type": "Type", - "label": "FeatureCatalogueSetup", + "label": "EnvironmentSetup", "tags": [ "public" ], "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" + "lineNumber": 161 }, "signature": [ - "{ register: (feature: ", - { - "pluginId": "home", - "scope": "public", - "docId": "kibHomePluginApi", - "section": "def-public.FeatureCatalogueEntry", - "text": "FeatureCatalogueEntry" - }, - ") => void; registerSolution: (solution: ", + "{ update: (update: Partial<", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", - "section": "def-public.FeatureCatalogueSolution", - "text": "FeatureCatalogueSolution" + "section": "def-public.Environment", + "text": "Environment" }, - ") => void; }" + ">) => void; }" ], "initialIsOpen": false }, { - "id": "def-public.EnvironmentSetup", + "id": "def-public.FeatureCatalogueSetup", "type": "Type", - "label": "EnvironmentSetup", + "label": "FeatureCatalogueSetup", "tags": [ "public" ], "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" + "lineNumber": 158 }, "signature": [ - "{ update: (update: Partial<", + "{ register: (feature: ", { "pluginId": "home", "scope": "public", "docId": "kibHomePluginApi", - "section": "def-public.Environment", - "text": "Environment" + "section": "def-public.FeatureCatalogueEntry", + "text": "FeatureCatalogueEntry" }, - ">) => void; }" + ") => void; registerSolution: (solution: ", + { + "pluginId": "home", + "scope": "public", + "docId": "kibHomePluginApi", + "section": "def-public.FeatureCatalogueSolution", + "text": "FeatureCatalogueSolution" + }, + ") => void; }" ], "initialIsOpen": false }, { - "id": "def-public.TutorialSetup", + "id": "def-public.TutorialDirectoryHeaderLinkComponent", "type": "Type", - "label": "TutorialSetup", + "label": "TutorialDirectoryHeaderLinkComponent", "tags": [ "public" ], "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" + "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", + "lineNumber": 18 }, "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; }" + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" ], "initialIsOpen": false }, { - "id": "def-public.TutorialVariables", + "id": "def-public.TutorialDirectoryNoticeComponent", "type": "Type", - "label": "TutorialVariables", + "label": "TutorialDirectoryNoticeComponent", "tags": [ "public" ], "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" + "lineNumber": 15 }, "signature": [ - "{ [x: string]: unknown; }" + "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" ], "initialIsOpen": false }, { - "id": "def-public.TutorialDirectoryNoticeComponent", + "id": "def-public.TutorialModuleNoticeComponent", "type": "Type", - "label": "TutorialDirectoryNoticeComponent", + "label": "TutorialModuleNoticeComponent", "tags": [ "public" ], "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" + "lineNumber": 21 }, "signature": [ - "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" ], "initialIsOpen": false }, { - "id": "def-public.TutorialDirectoryHeaderLinkComponent", + "id": "def-public.TutorialSetup", "type": "Type", - "label": "TutorialDirectoryHeaderLinkComponent", + "label": "TutorialSetup", "tags": [ "public" ], "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" + "path": "src/plugins/home/public/plugin.ts", + "lineNumber": 164 }, "signature": [ - "(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null" + "{ 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.TutorialModuleNoticeComponent", + "id": "def-public.TutorialVariables", "type": "Type", - "label": "TutorialModuleNoticeComponent", + "label": "TutorialVariables", "tags": [ "public" ], "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" + "lineNumber": 12 }, "signature": [ - "(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null" + "{ [x: string]: unknown; }" ], "initialIsOpen": false } @@ -630,8 +595,7 @@ "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" + "lineNumber": 10 } }, { @@ -642,8 +606,7 @@ "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" + "lineNumber": 11 } }, { @@ -654,8 +617,7 @@ "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" + "lineNumber": 12 } }, { @@ -666,8 +628,7 @@ "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" + "lineNumber": 13 } }, { @@ -678,8 +639,7 @@ "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" + "lineNumber": 14 } }, { @@ -690,8 +650,7 @@ "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" + "lineNumber": 15 } }, { @@ -702,8 +661,7 @@ "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" + "lineNumber": 16 } }, { @@ -714,8 +672,7 @@ "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" + "lineNumber": 17 } }, { @@ -726,8 +683,7 @@ "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" + "lineNumber": 18 } }, { @@ -738,8 +694,7 @@ "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" + "lineNumber": 19 } }, { @@ -750,8 +705,7 @@ "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" + "lineNumber": 20 } }, { @@ -762,8 +716,7 @@ "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" + "lineNumber": 21 } }, { @@ -774,8 +727,7 @@ "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" + "lineNumber": 22 } }, { @@ -786,8 +738,7 @@ "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" + "lineNumber": 23 } }, { @@ -798,8 +749,7 @@ "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" + "lineNumber": 24 } }, { @@ -810,8 +760,7 @@ "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" + "lineNumber": 25 } }, { @@ -822,8 +771,7 @@ "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" + "lineNumber": 26 } } ], @@ -831,8 +779,7 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false } @@ -854,8 +801,7 @@ "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" + "lineNumber": 168 }, "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; }" @@ -869,8 +815,7 @@ "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" + "lineNumber": 169 }, "signature": [ "{ register: (feature: ", @@ -904,8 +849,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 176, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L176" + "lineNumber": 176 }, "signature": [ "{ update: (update: Partial<", @@ -922,8 +866,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 167, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L167" + "lineNumber": 167 }, "lifecycle": "setup", "initialIsOpen": true @@ -943,8 +886,7 @@ "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" + "lineNumber": 179 }, "signature": [ { @@ -959,8 +901,7 @@ ], "source": { "path": "src/plugins/home/public/plugin.ts", - "lineNumber": 178, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L178" + "lineNumber": 178 }, "lifecycle": "start", "initialIsOpen": true @@ -985,8 +926,7 @@ "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" + "lineNumber": 60 }, "signature": [ "{ documentationUrl: string; } | undefined" @@ -1000,8 +940,7 @@ "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" + "lineNumber": 63 }, "signature": [ { @@ -1022,8 +961,7 @@ "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" + "lineNumber": 64 }, "signature": [ "{ path: string; label: string; } | undefined" @@ -1032,8 +970,7 @@ ], "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" + "lineNumber": 59 }, "initialIsOpen": false } @@ -1049,29 +986,26 @@ "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" + "lineNumber": 13 }, "initialIsOpen": false } ], "misc": [ { - "id": "def-server.TutorialProvider", + "id": "def-server.SampleDataRegistrySetup", "type": "Type", - "label": "TutorialProvider", - "tags": [], + "label": "SampleDataRegistrySetup", + "tags": [ + "public" + ], "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" + "path": "src/plugins/home/server/services/sample_data/sample_data_registry.ts", + "lineNumber": 168 }, "signature": [ - "(context: ", - "TutorialContext", - ") => ", - "TutorialSchema" + "{ 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 }, @@ -1083,8 +1017,7 @@ "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" + "lineNumber": 82 }, "signature": [ "() => ", @@ -1094,20 +1027,20 @@ "initialIsOpen": false }, { - "id": "def-server.SampleDataRegistrySetup", + "id": "def-server.TutorialProvider", "type": "Type", - "label": "SampleDataRegistrySetup", - "tags": [ - "public" - ], + "label": "TutorialProvider", + "tags": [], "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" + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "lineNumber": 100 }, "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; }" + "(context: ", + "TutorialContext", + ") => ", + "TutorialSchema" ], "initialIsOpen": false } @@ -1126,8 +1059,7 @@ "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" + "lineNumber": 10 } }, { @@ -1138,8 +1070,7 @@ "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" + "lineNumber": 11 } }, { @@ -1150,8 +1081,7 @@ "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" + "lineNumber": 12 } }, { @@ -1162,8 +1092,7 @@ "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" + "lineNumber": 13 } }, { @@ -1174,8 +1103,7 @@ "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" + "lineNumber": 14 } }, { @@ -1186,8 +1114,7 @@ "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" + "lineNumber": 15 } }, { @@ -1198,8 +1125,7 @@ "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" + "lineNumber": 16 } }, { @@ -1210,8 +1136,7 @@ "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" + "lineNumber": 17 } }, { @@ -1222,8 +1147,7 @@ "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" + "lineNumber": 18 } }, { @@ -1234,8 +1158,7 @@ "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" + "lineNumber": 19 } }, { @@ -1246,8 +1169,7 @@ "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" + "lineNumber": 20 } }, { @@ -1258,8 +1180,7 @@ "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" + "lineNumber": 21 } }, { @@ -1270,8 +1191,7 @@ "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" + "lineNumber": 22 } }, { @@ -1282,8 +1202,7 @@ "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" + "lineNumber": 23 } }, { @@ -1294,8 +1213,7 @@ "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" + "lineNumber": 24 } }, { @@ -1306,8 +1224,7 @@ "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" + "lineNumber": 25 } }, { @@ -1318,8 +1235,7 @@ "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" + "lineNumber": 26 } } ], @@ -1327,8 +1243,7 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false } @@ -1350,8 +1265,7 @@ "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" + "lineNumber": 55 }, "signature": [ "{ registerTutorial: (specProvider: ", @@ -1389,8 +1303,7 @@ "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" + "lineNumber": 56 }, "signature": [ "{ registerSampleDataset: (specProvider: ", @@ -1438,8 +1351,7 @@ ], "source": { "path": "src/plugins/home/server/plugin.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L54" + "lineNumber": 54 }, "lifecycle": "setup", "initialIsOpen": true @@ -1461,8 +1373,7 @@ "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" + "lineNumber": 61 }, "signature": [ "{}" @@ -1476,8 +1387,7 @@ "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" + "lineNumber": 62 }, "signature": [ "{}" @@ -1486,8 +1396,7 @@ ], "source": { "path": "src/plugins/home/server/plugin.ts", - "lineNumber": 60, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L60" + "lineNumber": 60 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/index_lifecycle_management.json b/api_docs/index_lifecycle_management.json index b65eeabefba20..d5b36eeb587d6 100644 --- a/api_docs/index_lifecycle_management.json +++ b/api_docs/index_lifecycle_management.json @@ -19,8 +19,7 @@ "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" + "lineNumber": 22 }, "signature": [ "\"policies_list\" | \"policy_edit\" | \"policy_create\"" @@ -34,8 +33,7 @@ "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" + "lineNumber": 23 }, "signature": [ "string | undefined" @@ -49,8 +47,7 @@ "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" + "lineNumber": 24 }, "signature": [ "boolean | undefined" @@ -59,8 +56,7 @@ ], "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" + "lineNumber": 21 }, "initialIsOpen": false } @@ -75,8 +71,7 @@ "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" + "lineNumber": 19 }, "signature": [ "\"ILM_URL_GENERATOR_ID\"" diff --git a/api_docs/index_management.json b/api_docs/index_management.json index 28b1309c0bd9c..8c6ba711642ff 100644 --- a/api_docs/index_management.json +++ b/api_docs/index_management.json @@ -17,8 +17,7 @@ "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" + "lineNumber": 38 } }, { @@ -31,8 +30,7 @@ "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" + "lineNumber": 38 } } ], @@ -43,8 +41,7 @@ "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" + "lineNumber": 38 }, "tags": [], "returnComment": [], @@ -52,42 +49,6 @@ } ], "interfaces": [ - { - "id": "def-public.IndexManagementPluginSetup", - "type": "Interface", - "label": "IndexManagementPluginSetup", - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "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", @@ -103,8 +64,7 @@ "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" + "lineNumber": 55 } }, { @@ -115,8 +75,7 @@ "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" + "lineNumber": 56 } }, { @@ -127,8 +86,7 @@ "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" + "lineNumber": 57 } }, { @@ -139,8 +97,7 @@ "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" + "lineNumber": 58 } }, { @@ -151,8 +108,7 @@ "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" + "lineNumber": 59 } }, { @@ -163,8 +119,7 @@ "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" + "lineNumber": 60 } }, { @@ -175,8 +130,7 @@ "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" + "lineNumber": 61 }, "signature": [ "any" @@ -190,8 +144,7 @@ "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" + "lineNumber": 62 }, "signature": [ "any" @@ -205,8 +158,7 @@ "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" + "lineNumber": 63 } }, { @@ -217,8 +169,7 @@ "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" + "lineNumber": 64 }, "signature": [ "string | string[]" @@ -232,8 +183,7 @@ "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" + "lineNumber": 65 }, "signature": [ "string | undefined" @@ -247,8 +197,7 @@ "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" + "lineNumber": 66 }, "signature": [ "any" @@ -257,8 +206,41 @@ ], "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" + "lineNumber": 54 + }, + "initialIsOpen": false + }, + { + "id": "def-public.IndexManagementPluginSetup", + "type": "Interface", + "label": "IndexManagementPluginSetup", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-public.IndexManagementPluginSetup.extensionsService", + "type": "Object", + "label": "extensionsService", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/public/types.ts", + "lineNumber": 14 + }, + "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 }, "initialIsOpen": false } @@ -286,8 +268,7 @@ "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" + "lineNumber": 21 }, "signature": [ { @@ -307,8 +288,7 @@ "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" + "lineNumber": 22 }, "signature": [ { @@ -328,8 +308,7 @@ "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" + "lineNumber": 23 }, "signature": [ { @@ -344,8 +323,7 @@ ], "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" + "lineNumber": 20 }, "initialIsOpen": false }, @@ -364,8 +342,7 @@ "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" + "lineNumber": 55 } }, { @@ -376,8 +353,7 @@ "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" + "lineNumber": 56 } }, { @@ -388,8 +364,7 @@ "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" + "lineNumber": 57 } }, { @@ -400,8 +375,7 @@ "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" + "lineNumber": 58 } }, { @@ -412,8 +386,7 @@ "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" + "lineNumber": 59 } }, { @@ -424,8 +397,7 @@ "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" + "lineNumber": 60 } }, { @@ -436,8 +408,7 @@ "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" + "lineNumber": 61 }, "signature": [ "any" @@ -451,8 +422,7 @@ "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" + "lineNumber": 62 }, "signature": [ "any" @@ -466,8 +436,7 @@ "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" + "lineNumber": 63 } }, { @@ -478,8 +447,7 @@ "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" + "lineNumber": 64 }, "signature": [ "string | string[]" @@ -493,8 +461,7 @@ "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" + "lineNumber": 65 }, "signature": [ "string | undefined" @@ -508,8 +475,7 @@ "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" + "lineNumber": 66 }, "signature": [ "any" @@ -518,8 +484,7 @@ ], "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" + "lineNumber": 54 }, "initialIsOpen": false }, @@ -540,8 +505,7 @@ "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" + "lineNumber": 100 }, "signature": [ "string[]" @@ -555,8 +519,7 @@ "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" + "lineNumber": 101 }, "signature": [ "number | undefined" @@ -570,8 +533,7 @@ "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" + "lineNumber": 102 }, "signature": [ { @@ -592,8 +554,7 @@ "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" + "lineNumber": 103 }, "signature": [ { @@ -614,8 +575,7 @@ "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" + "lineNumber": 104 }, "signature": [ { @@ -636,8 +596,7 @@ "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" + "lineNumber": 105 }, "signature": [ "number | undefined" @@ -646,8 +605,7 @@ ], "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" + "lineNumber": 99 }, "initialIsOpen": false } @@ -662,8 +620,7 @@ "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" + "lineNumber": 14 }, "signature": [ "{ readonly enabled: boolean; }" @@ -687,8 +644,7 @@ "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" + "lineNumber": 26 }, "signature": [ "{ add: (enricher: ", @@ -705,8 +661,7 @@ ], "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" + "lineNumber": 25 }, "lifecycle": "setup", "initialIsOpen": true @@ -743,8 +698,7 @@ "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" + "lineNumber": 22 } }, { @@ -757,8 +711,7 @@ "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" + "lineNumber": 23 } } ], @@ -793,8 +746,7 @@ "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" + "lineNumber": 21 }, "tags": [], "returnComment": [], @@ -803,213 +755,294 @@ ], "interfaces": [ { - "id": "def-common.DataStreamFromEs", + "id": "def-common.Aliases", "type": "Interface", - "label": "DataStreamFromEs", + "label": "Aliases", "description": [], "tags": [], "children": [ { + "id": "def-common.Aliases.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" - } - }, - { - "tags": [], - "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" + "path": "x-pack/plugins/index_management/common/types/aliases.ts", + "lineNumber": 9 }, "signature": [ - "TimestampFieldFromEs" + "any" ] - }, + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/aliases.ts", + "lineNumber": 8 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateDeserialized", + "type": "Interface", + "label": "ComponentTemplateDeserialized", + "signature": [ { - "tags": [], - "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" - }, - "[]" - ] + "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": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.DataStreamFromEs.generation", - "type": "number", - "label": "generation", + "id": "def-common.ComponentTemplateDeserialized.name", + "type": "string", + "label": "name", "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 23 } }, { "tags": [], - "id": "def-common.DataStreamFromEs._meta", + "id": "def-common.ComponentTemplateDeserialized._kbnMeta", "type": "Object", - "label": "_meta", + "label": "_kbnMeta", "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 24 }, "signature": [ - "MetaFromEs | undefined" + "{ usedBy: string[]; isManaged: boolean; }" ] + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 22 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateFromEs", + "type": "Interface", + "label": "ComponentTemplateFromEs", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ComponentTemplateFromEs.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 31 + } }, { "tags": [], - "id": "def-common.DataStreamFromEs.status", - "type": "CompoundType", - "label": "status", + "id": "def-common.ComponentTemplateFromEs.component_template", + "type": "Object", + "label": "component_template", "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 32 }, "signature": [ { "pluginId": "indexManagement", "scope": "common", "docId": "kibIndexManagementPluginApi", - "section": "def-common.HealthFromEs", - "text": "HealthFromEs" + "section": "def-common.ComponentTemplateSerialized", + "text": "ComponentTemplateSerialized" } ] - }, + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateListItem", + "type": "Interface", + "label": "ComponentTemplateListItem", + "description": [], + "tags": [], + "children": [ { "tags": [], - "id": "def-common.DataStreamFromEs.template", + "id": "def-common.ComponentTemplateListItem.name", "type": "string", - "label": "template", + "label": "name", "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 36 } }, { "tags": [], - "id": "def-common.DataStreamFromEs.ilm_policy", - "type": "string", - "label": "ilm_policy", + "id": "def-common.ComponentTemplateListItem.usedBy", + "type": "Array", + "label": "usedBy", "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 37 }, "signature": [ - "string | undefined" + "string[]" ] }, { "tags": [], - "id": "def-common.DataStreamFromEs.store_size", - "type": "string", - "label": "store_size", + "id": "def-common.ComponentTemplateListItem.hasMappings", + "type": "boolean", + "label": "hasMappings", "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" - ] + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 38 + } }, { "tags": [], - "id": "def-common.DataStreamFromEs.store_size_bytes", - "type": "number", - "label": "store_size_bytes", + "id": "def-common.ComponentTemplateListItem.hasAliases", + "type": "boolean", + "label": "hasAliases", "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" - ] + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 39 + } }, { "tags": [], - "id": "def-common.DataStreamFromEs.maximum_timestamp", - "type": "number", - "label": "maximum_timestamp", + "id": "def-common.ComponentTemplateListItem.hasSettings", + "type": "boolean", + "label": "hasSettings", "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" - ] - }, + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 40 + } + }, { "tags": [], - "id": "def-common.DataStreamFromEs.privileges", + "id": "def-common.ComponentTemplateListItem.isManaged", + "type": "boolean", + "label": "isManaged", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 41 + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 35 + }, + "initialIsOpen": false + }, + { + "id": "def-common.ComponentTemplateSerialized", + "type": "Interface", + "label": "ComponentTemplateSerialized", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.ComponentTemplateSerialized.template", "type": "Object", - "label": "privileges", + "label": "template", "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 13 }, "signature": [ - "PrivilegesFromEs" + "{ 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; }" ] }, { "tags": [], - "id": "def-common.DataStreamFromEs.hidden", - "type": "boolean", - "label": "hidden", + "id": "def-common.ComponentTemplateSerialized.version", + "type": "number", + "label": "version", "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" - } + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 18 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.ComponentTemplateSerialized._meta", + "type": "Object", + "label": "_meta", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 19 + }, + "signature": [ + "{ [key: string]: any; } | undefined" + ] } ], "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" + "path": "x-pack/plugins/index_management/common/types/component_templates.ts", + "lineNumber": 12 }, "initialIsOpen": false }, @@ -1028,8 +1061,7 @@ "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" + "lineNumber": 54 } }, { @@ -1040,8 +1072,7 @@ "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" + "lineNumber": 55 }, "signature": [ "TimestampFieldFromEs" @@ -1055,8 +1086,7 @@ "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" + "lineNumber": 56 }, "signature": [ { @@ -1077,8 +1107,7 @@ "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" + "lineNumber": 57 } }, { @@ -1089,8 +1118,7 @@ "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" + "lineNumber": 58 }, "signature": [ { @@ -1110,8 +1138,7 @@ "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" + "lineNumber": 59 } }, { @@ -1122,8 +1149,7 @@ "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" + "lineNumber": 60 }, "signature": [ "string | undefined" @@ -1137,8 +1163,7 @@ "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" + "lineNumber": 61 }, "signature": [ "string | undefined" @@ -1152,8 +1177,7 @@ "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" + "lineNumber": 62 }, "signature": [ "number | undefined" @@ -1167,8 +1191,7 @@ "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" + "lineNumber": 63 }, "signature": [ "number | undefined" @@ -1182,8 +1205,7 @@ "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" + "lineNumber": 64 }, "signature": [ "MetaFromEs | undefined" @@ -1197,8 +1219,7 @@ "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" + "lineNumber": 65 }, "signature": [ "PrivilegesFromEs" @@ -1212,213 +1233,310 @@ "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" + "lineNumber": 66 } } ], "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" + "lineNumber": 53 }, "initialIsOpen": false }, { - "id": "def-common.DataStreamIndex", + "id": "def-common.DataStreamFromEs", "type": "Interface", - "label": "DataStreamIndex", + "label": "DataStreamFromEs", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-common.DataStreamIndex.name", + "id": "def-common.DataStreamFromEs.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" + "lineNumber": 31 } }, { "tags": [], - "id": "def-common.DataStreamIndex.uuid", - "type": "string", - "label": "uuid", + "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": 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": [], - "tags": [], - "children": [ + "lineNumber": 32 + }, + "signature": [ + "TimestampFieldFromEs" + ] + }, { - "id": "def-common.Aliases.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-common.DataStreamFromEs.indices", + "type": "Array", + "label": "indices", "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" + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 33 }, "signature": [ - "any" + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.DataStreamIndexFromEs", + "text": "DataStreamIndexFromEs" + }, + "[]" ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.IndexSettings.index", - "type": "Object", - "label": "index", + "id": "def-common.DataStreamFromEs.generation", + "type": "number", + "label": "generation", "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" - ] + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 34 + } }, { "tags": [], - "id": "def-common.IndexSettings.analysis", + "id": "def-common.DataStreamFromEs._meta", "type": "Object", - "label": "analysis", + "label": "_meta", "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" + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 35 }, "signature": [ - "AnalysisModule | undefined" + "MetaFromEs | undefined" ] }, { - "id": "def-common.IndexSettings.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-common.DataStreamFromEs.status", + "type": "CompoundType", + "label": "status", "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" + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 36 }, "signature": [ - "any" + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.HealthFromEs", + "text": "HealthFromEs" + } ] - } - ], - "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": [], - "tags": [], - "children": [ + }, { "tags": [], - "id": "def-common.Index.health", + "id": "def-common.DataStreamFromEs.template", "type": "string", - "label": "health", + "label": "template", "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" + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 37 } }, { "tags": [], - "id": "def-common.Index.status", + "id": "def-common.DataStreamFromEs.ilm_policy", "type": "string", - "label": "status", + "label": "ilm_policy", "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" - } + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 38 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-common.Index.name", + "id": "def-common.DataStreamFromEs.store_size", "type": "string", - "label": "name", + "label": "store_size", "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" - } + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 39 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-common.Index.uuid", - "type": "string", - "label": "uuid", + "id": "def-common.DataStreamFromEs.store_size_bytes", + "type": "number", + "label": "store_size_bytes", "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" - } + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 40 + }, + "signature": [ + "number | undefined" + ] }, { "tags": [], - "id": "def-common.Index.primary", - "type": "string", - "label": "primary", + "id": "def-common.DataStreamFromEs.maximum_timestamp", + "type": "number", + "label": "maximum_timestamp", "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" - } + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 41 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.privileges", + "type": "Object", + "label": "privileges", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 42 + }, + "signature": [ + "PrivilegesFromEs" + ] + }, + { + "tags": [], + "id": "def-common.DataStreamFromEs.hidden", + "type": "boolean", + "label": "hidden", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 43 + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 30 + }, + "initialIsOpen": false + }, + { + "id": "def-common.DataStreamIndex", + "type": "Interface", + "label": "DataStreamIndex", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.DataStreamIndex.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 70 + } + }, + { + "tags": [], + "id": "def-common.DataStreamIndex.uuid", + "type": "string", + "label": "uuid", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 71 + } + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/data_streams.ts", + "lineNumber": 69 + }, + "initialIsOpen": false + }, + { + "id": "def-common.Index", + "type": "Interface", + "label": "Index", + "description": [], + "tags": [], + "children": [ + { + "tags": [], + "id": "def-common.Index.health", + "type": "string", + "label": "health", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 55 + } + }, + { + "tags": [], + "id": "def-common.Index.status", + "type": "string", + "label": "status", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 56 + } + }, + { + "tags": [], + "id": "def-common.Index.name", + "type": "string", + "label": "name", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 57 + } + }, + { + "tags": [], + "id": "def-common.Index.uuid", + "type": "string", + "label": "uuid", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 58 + } + }, + { + "tags": [], + "id": "def-common.Index.primary", + "type": "string", + "label": "primary", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 59 + } }, { "tags": [], @@ -1428,8 +1546,7 @@ "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" + "lineNumber": 60 } }, { @@ -1440,8 +1557,7 @@ "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" + "lineNumber": 61 }, "signature": [ "any" @@ -1455,8 +1571,7 @@ "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" + "lineNumber": 62 }, "signature": [ "any" @@ -1470,8 +1585,7 @@ "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" + "lineNumber": 63 } }, { @@ -1482,8 +1596,7 @@ "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" + "lineNumber": 64 }, "signature": [ "string | string[]" @@ -1497,8 +1610,7 @@ "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" + "lineNumber": 65 }, "signature": [ "string | undefined" @@ -1512,8 +1624,7 @@ "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" + "lineNumber": 66 }, "signature": [ "any" @@ -1522,28 +1633,54 @@ ], "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" + "lineNumber": 54 }, "initialIsOpen": false }, { - "id": "def-common.Mappings", + "id": "def-common.IndexSettings", "type": "Interface", - "label": "Mappings", + "label": "IndexSettings", "description": [], "tags": [], "children": [ { - "id": "def-common.Mappings.Unnamed", + "tags": [], + "id": "def-common.IndexSettings.index", + "type": "Object", + "label": "index", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 49 + }, + "signature": [ + "Partial | undefined" + ] + }, + { + "tags": [], + "id": "def-common.IndexSettings.analysis", + "type": "Object", + "label": "analysis", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 50 + }, + "signature": [ + "AnalysisModule | undefined" + ] + }, + { + "id": "def-common.IndexSettings.Unnamed", "type": "Any", "label": "Unnamed", "tags": [], "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" + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 51 }, "signature": [ "any" @@ -1551,31 +1688,29 @@ } ], "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" + "path": "x-pack/plugins/index_management/common/types/indices.ts", + "lineNumber": 48 }, "initialIsOpen": false }, { - "id": "def-common.TemplateSerialized", + "id": "def-common.LegacyTemplateSerialized", "type": "Interface", - "label": "TemplateSerialized", + "label": "LegacyTemplateSerialized", "description": [ - "\nIndex template format from Elasticsearch" + "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" ], "tags": [], "children": [ { "tags": [], - "id": "def-common.TemplateSerialized.index_patterns", + "id": "def-common.LegacyTemplateSerialized.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" + "lineNumber": 100 }, "signature": [ "string[]" @@ -1583,17 +1718,29 @@ }, { "tags": [], - "id": "def-common.TemplateSerialized.template", + "id": "def-common.LegacyTemplateSerialized.version", + "type": "number", + "label": "version", + "description": [], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 101 + }, + "signature": [ + "number | undefined" + ] + }, + { + "tags": [], + "id": "def-common.LegacyTemplateSerialized.settings", "type": "Object", - "label": "template", + "label": "settings", "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" + "lineNumber": 102 }, "signature": [ - "{ settings?: ", { "pluginId": "indexManagement", "scope": "common", @@ -1601,105 +1748,97 @@ "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" + " | undefined" ] }, { "tags": [], - "id": "def-common.TemplateSerialized.composed_of", - "type": "Array", - "label": "composed_of", + "id": "def-common.LegacyTemplateSerialized.aliases", + "type": "Object", + "label": "aliases", "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" + "lineNumber": 103 }, "signature": [ - "string[] | undefined" + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Aliases", + "text": "Aliases" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.TemplateSerialized.version", - "type": "number", - "label": "version", + "id": "def-common.LegacyTemplateSerialized.mappings", + "type": "Object", + "label": "mappings", "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" + "lineNumber": 104 }, "signature": [ - "number | undefined" + { + "pluginId": "indexManagement", + "scope": "common", + "docId": "kibIndexManagementPluginApi", + "section": "def-common.Mappings", + "text": "Mappings" + }, + " | undefined" ] }, { "tags": [], - "id": "def-common.TemplateSerialized.priority", + "id": "def-common.LegacyTemplateSerialized.order", "type": "number", - "label": "priority", + "label": "order", "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" + "lineNumber": 105 }, "signature": [ "number | undefined" ] - }, + } + ], + "source": { + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 99 + }, + "initialIsOpen": false + }, + { + "id": "def-common.Mappings", + "type": "Interface", + "label": "Mappings", + "description": [], + "tags": [], + "children": [ { + "id": "def-common.Mappings.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "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" + "path": "x-pack/plugins/index_management/common/types/mappings.ts", + "lineNumber": 11 }, "signature": [ - "{ [key: string]: any; } | undefined" - ] - }, - { - "tags": [], - "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" + "any" ] } ], "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" + "path": "x-pack/plugins/index_management/common/types/mappings.ts", + "lineNumber": 10 }, "initialIsOpen": false }, @@ -1720,8 +1859,7 @@ "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" + "lineNumber": 35 } }, { @@ -1732,8 +1870,7 @@ "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" + "lineNumber": 36 }, "signature": [ "string[]" @@ -1747,8 +1884,7 @@ "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" + "lineNumber": 37 }, "signature": [ "{ settings?: ", @@ -1786,8 +1922,7 @@ "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" + "lineNumber": 42 }, "signature": [ "string[] | undefined" @@ -1801,8 +1936,7 @@ "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" + "lineNumber": 43 }, "signature": [ "number | undefined" @@ -1816,8 +1950,7 @@ "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" + "lineNumber": 44 }, "signature": [ "number | undefined" @@ -1831,8 +1964,7 @@ "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" + "lineNumber": 45 }, "signature": [ "number | undefined" @@ -1846,8 +1978,7 @@ "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" + "lineNumber": 46 }, "signature": [ "{ name: string; } | undefined" @@ -1861,8 +1992,7 @@ "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" + "lineNumber": 49 }, "signature": [ "{ [key: string]: any; } | undefined" @@ -1876,8 +2006,7 @@ "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" + "lineNumber": 51 }, "signature": [ "{ [key: string]: any; hidden?: boolean | undefined; } | undefined" @@ -1891,8 +2020,7 @@ "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" + "lineNumber": 55 }, "signature": [ "{ type: ", @@ -1909,8 +2037,7 @@ ], "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" + "lineNumber": 34 }, "initialIsOpen": false }, @@ -1929,8 +2056,7 @@ "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" + "lineNumber": 65 } }, { @@ -1941,8 +2067,7 @@ "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" + "lineNumber": 66 }, "signature": [ { @@ -1957,8 +2082,7 @@ ], "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" + "lineNumber": 64 }, "initialIsOpen": false }, @@ -1979,8 +2103,7 @@ "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" + "lineNumber": 75 } }, { @@ -1991,8 +2114,7 @@ "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" + "lineNumber": 76 }, "signature": [ "string[]" @@ -2006,8 +2128,7 @@ "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" + "lineNumber": 77 }, "signature": [ "number | undefined" @@ -2021,8 +2142,7 @@ "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" + "lineNumber": 78 }, "signature": [ "number | undefined" @@ -2036,8 +2156,7 @@ "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" + "lineNumber": 79 }, "signature": [ "number | undefined" @@ -2051,8 +2170,7 @@ "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" + "lineNumber": 80 } }, { @@ -2063,8 +2181,7 @@ "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" + "lineNumber": 81 } }, { @@ -2075,8 +2192,7 @@ "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" + "lineNumber": 82 } }, { @@ -2087,8 +2203,7 @@ "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" + "lineNumber": 83 }, "signature": [ "{ name: string; } | undefined" @@ -2102,8 +2217,7 @@ "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" + "lineNumber": 86 }, "signature": [ "{ type: ", @@ -2120,30 +2234,28 @@ ], "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" + "lineNumber": 74 }, "initialIsOpen": false }, { - "id": "def-common.LegacyTemplateSerialized", + "id": "def-common.TemplateSerialized", "type": "Interface", - "label": "LegacyTemplateSerialized", + "label": "TemplateSerialized", "description": [ - "\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------" + "\nIndex template format from Elasticsearch" ], "tags": [], "children": [ { "tags": [], - "id": "def-common.LegacyTemplateSerialized.index_patterns", + "id": "def-common.TemplateSerialized.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" + "lineNumber": 16 }, "signature": [ "string[]" @@ -2151,31 +2263,16 @@ }, { "tags": [], - "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" - ] - }, - { - "tags": [], - "id": "def-common.LegacyTemplateSerialized.settings", + "id": "def-common.TemplateSerialized.template", "type": "Object", - "label": "settings", + "label": "template", "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" + "lineNumber": 17 }, "signature": [ + "{ settings?: ", { "pluginId": "indexManagement", "scope": "common", @@ -2183,21 +2280,7 @@ "section": "def-common.IndexSettings", "text": "IndexSettings" }, - " | undefined" - ] - }, - { - "tags": [], - "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": [ + " | undefined; aliases?: ", { "pluginId": "indexManagement", "scope": "common", @@ -2205,21 +2288,7 @@ "section": "def-common.Aliases", "text": "Aliases" }, - " | undefined" - ] - }, - { - "tags": [], - "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": [ + " | undefined; mappings?: ", { "pluginId": "indexManagement", "scope": "common", @@ -2227,88 +2296,32 @@ "section": "def-common.Mappings", "text": "Mappings" }, - " | undefined" + " | undefined; } | undefined" ] }, { "tags": [], - "id": "def-common.LegacyTemplateSerialized.order", - "type": "number", - "label": "order", + "id": "def-common.TemplateSerialized.composed_of", + "type": "Array", + "label": "composed_of", "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" + "lineNumber": 22 }, "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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; }" + "string[] | undefined" ] }, { "tags": [], - "id": "def-common.ComponentTemplateSerialized.version", + "id": "def-common.TemplateSerialized.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" + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 23 }, "signature": [ "number | undefined" @@ -2316,221 +2329,50 @@ }, { "tags": [], - "id": "def-common.ComponentTemplateSerialized._meta", - "type": "Object", - "label": "_meta", + "id": "def-common.TemplateSerialized.priority", + "type": "number", + "label": "priority", "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" + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 24 }, "signature": [ - "{ [key: string]: any; } | undefined" + "number | 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": [], - "tags": [], - "children": [ { "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.ComponentTemplateDeserialized._kbnMeta", + "id": "def-common.TemplateSerialized._meta", "type": "Object", - "label": "_kbnMeta", + "label": "_meta", "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" + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 25 }, "signature": [ - "{ usedBy: string[]; isManaged: boolean; }" + "{ [key: string]: any; } | undefined" ] - } - ], - "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } }, { "tags": [], - "id": "def-common.ComponentTemplateFromEs.component_template", + "id": "def-common.TemplateSerialized.data_stream", "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": [], - "tags": [], - "children": [ - { - "tags": [], - "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" - } - }, - { - "tags": [], - "id": "def-common.ComponentTemplateListItem.usedBy", - "type": "Array", - "label": "usedBy", + "label": "data_stream", "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" + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 26 }, "signature": [ - "string[]" + "{} | undefined" ] - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" + "path": "x-pack/plugins/index_management/common/types/templates.ts", + "lineNumber": 15 }, "initialIsOpen": false } @@ -2545,8 +2387,7 @@ "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" + "lineNumber": 8 }, "signature": [ "\"/api/index_management\"" @@ -2561,8 +2402,7 @@ "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" + "lineNumber": 8 }, "signature": [ "\"/management/data/index_management/\"" @@ -2577,8 +2417,7 @@ "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" + "lineNumber": 51 }, "signature": [ "\"green\" | \"yellow\" | \"red\"" @@ -2593,8 +2432,7 @@ "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" + "lineNumber": 62 }, "signature": [ "\"default\" | \"system\" | \"managed\" | \"cloudManaged\"" diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json index f2bc819f7e99e..f2ff1bea4733d 100644 --- a/api_docs/index_pattern_field_editor.json +++ b/api_docs/index_pattern_field_editor.json @@ -31,8 +31,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L75" + "lineNumber": 75 } }, { @@ -43,8 +42,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 76, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L76" + "lineNumber": 76 }, "signature": [ { @@ -91,8 +89,7 @@ "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" + "lineNumber": 78 } }, { @@ -111,8 +108,7 @@ "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" + "lineNumber": 78 } } ], @@ -120,8 +116,7 @@ "returnComment": [], "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" + "lineNumber": 78 } }, { @@ -138,8 +133,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L90" + "lineNumber": 90 } } ], @@ -150,8 +144,7 @@ "label": "onChange", "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 90, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L90" + "lineNumber": 90 }, "tags": [], "returnComment": [] @@ -169,15 +162,13 @@ "returnComment": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 99, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L99" + "lineNumber": 99 } } ], "source": { "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L71" + "lineNumber": 71 }, "initialIsOpen": false } @@ -185,78 +176,80 @@ "functions": [], "interfaces": [ { - "id": "def-public.OpenFieldEditorOptions", + "id": "def-public.FieldEditorContext", "type": "Interface", - "label": "OpenFieldEditorOptions", + "label": "FieldEditorContext", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.OpenFieldEditorOptions.ctx", + "id": "def-public.FieldEditorContext.indexPattern", "type": "Object", - "label": "ctx", + "label": "indexPattern", "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" + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 28 }, "signature": [ - "{ indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" - }, - "; }" + } ] }, { "tags": [], - "id": "def-public.OpenFieldEditorOptions.onSave", - "type": "Function", - "label": "onSave", - "description": [], + "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/open_editor.tsx", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L31" + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 33 }, "signature": [ - "((field: ", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IndexPatternField", - "text": "IndexPatternField" - }, - ") => void) | undefined" + "pluginId": "indexPatternFieldEditor", + "scope": "public", + "docId": "kibIndexPatternFieldEditorPluginApi", + "section": "def-public.InternalFieldType", + "text": "InternalFieldType" + } ] }, { "tags": [], - "id": "def-public.OpenFieldEditorOptions.fieldName", - "type": "string", - "label": "fieldName", - "description": [], + "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/open_editor.tsx", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L32" + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 35 }, "signature": [ - "string | undefined" + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataSearchPluginApi", + "section": "def-public.ISearchStart", + "text": "ISearchStart" + } ] } ], "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" + "path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx", + "lineNumber": 27 }, "initialIsOpen": false }, @@ -275,8 +268,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_delete_modal.tsx#L25" + "lineNumber": 25 }, "signature": [ "{ indexPattern: ", @@ -298,8 +290,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_delete_modal.tsx#L28" + "lineNumber": 28 }, "signature": [ "((fieldNames: string[]) => void) | undefined" @@ -313,8 +304,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_delete_modal.tsx#L29" + "lineNumber": 29 }, "signature": [ "string | string[]" @@ -323,90 +313,79 @@ ], "source": { "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_delete_modal.tsx#L24" + "lineNumber": 24 }, "initialIsOpen": false }, { - "id": "def-public.FieldEditorContext", + "id": "def-public.OpenFieldEditorOptions", "type": "Interface", - "label": "FieldEditorContext", + "label": "OpenFieldEditorOptions", "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.FieldEditorContext.indexPattern", + "id": "def-public.OpenFieldEditorOptions.ctx", "type": "Object", - "label": "indexPattern", + "label": "ctx", "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" + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 28 }, "signature": [ + "{ indexPattern: ", { "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", "section": "def-common.IndexPattern", "text": "IndexPattern" - } + }, + "; }" ] }, { "tags": [], - "id": "def-public.FieldEditorContext.fieldTypeToProcess", - "type": "CompoundType", - "label": "fieldTypeToProcess", - "description": [ - "\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\"" - ], + "id": "def-public.OpenFieldEditorOptions.onSave", + "type": "Function", + "label": "onSave", + "description": [], "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" + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 31 }, "signature": [ + "((field: ", { - "pluginId": "indexPatternFieldEditor", - "scope": "public", - "docId": "kibIndexPatternFieldEditorPluginApi", - "section": "def-public.InternalFieldType", - "text": "InternalFieldType" - } + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + ") => void) | undefined" ] }, { "tags": [], - "id": "def-public.FieldEditorContext.search", - "type": "Object", - "label": "search", - "description": [ - "The search service from the data plugin" - ], + "id": "def-public.OpenFieldEditorOptions.fieldName", + "type": "string", + "label": "fieldName", + "description": [], "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" + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 32 }, "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataSearchPluginApi", - "section": "def-public.ISearchStart", - "text": "ISearchStart" - } + "string | undefined" ] } ], "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" + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "lineNumber": 27 }, "initialIsOpen": false } @@ -454,8 +433,7 @@ "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" + "lineNumber": 27 } } ], @@ -463,8 +441,7 @@ "returnComment": [], "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" + "lineNumber": 27 } }, { @@ -500,8 +477,7 @@ "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" + "lineNumber": 28 } } ], @@ -509,8 +485,7 @@ "returnComment": [], "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" + "lineNumber": 28 } }, { @@ -521,8 +496,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L29" + "lineNumber": 29 }, "signature": [ "{ getAll: () => typeof ", @@ -552,8 +526,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L30" + "lineNumber": 30 }, "signature": [ "{ editIndexPattern: () => boolean; }" @@ -567,8 +540,7 @@ "description": [], "source": { "path": "src/plugins/index_pattern_field_editor/public/types.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L33" + "lineNumber": 33 }, "signature": [ "React.FunctionComponent<", @@ -585,8 +557,7 @@ ], "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" + "lineNumber": 26 }, "lifecycle": "start", "initialIsOpen": true diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json index 50e37fec7ad65..8a1a9bbdf10bb 100644 --- a/api_docs/index_pattern_management.json +++ b/api_docs/index_pattern_management.json @@ -17,8 +17,7 @@ "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" + "lineNumber": 38 }, "signature": [ "\"default\"" @@ -32,8 +31,7 @@ "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" + "lineNumber": 40 }, "signature": [ "string | undefined" @@ -47,8 +45,7 @@ "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" + "lineNumber": 41 } }, { @@ -59,8 +56,7 @@ "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" + "lineNumber": 42 } }, { @@ -71,8 +67,7 @@ "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" + "lineNumber": 43 }, "signature": [ "object | null" @@ -86,8 +81,7 @@ "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" + "lineNumber": 44 } }, { @@ -114,8 +108,7 @@ "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" + "lineNumber": 53 }, "signature": [ "string | undefined" @@ -129,8 +122,7 @@ "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" + "lineNumber": 54 }, "signature": [ "string | undefined" @@ -144,8 +136,7 @@ "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" + "lineNumber": 55 }, "signature": [ "boolean | undefined" @@ -159,8 +150,7 @@ "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" + "lineNumber": 56 }, "signature": [ "object | null | undefined" @@ -174,8 +164,7 @@ "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" + "lineNumber": 57 }, "signature": [ "boolean | undefined" @@ -184,8 +173,7 @@ ], "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" + "lineNumber": 52 } } ], @@ -193,8 +181,7 @@ "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" + "lineNumber": 46 } }, { @@ -237,8 +224,7 @@ "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" + "lineNumber": 66 } } ], @@ -246,8 +232,7 @@ "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" + "lineNumber": 66 } }, { @@ -263,8 +248,7 @@ "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" + "lineNumber": 77 } }, { @@ -280,8 +264,7 @@ "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" + "lineNumber": 81 } }, { @@ -297,8 +280,7 @@ "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" + "lineNumber": 85 } }, { @@ -314,8 +296,7 @@ "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" + "lineNumber": 89 } }, { @@ -337,8 +318,7 @@ "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" + "lineNumber": 93 } } ], @@ -346,8 +326,7 @@ "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" + "lineNumber": 93 } }, { @@ -384,8 +363,7 @@ "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" + "lineNumber": 97 } } ], @@ -393,8 +371,7 @@ "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" + "lineNumber": 97 } }, { @@ -410,8 +387,7 @@ "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" + "lineNumber": 101 } }, { @@ -427,8 +403,7 @@ "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" + "lineNumber": 105 } }, { @@ -444,15 +419,13 @@ "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" + "lineNumber": 109 } } ], "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" + "lineNumber": 37 }, "initialIsOpen": false }, @@ -471,8 +444,7 @@ "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" + "lineNumber": 26 }, "signature": [ "\"default\"" @@ -552,8 +524,7 @@ "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" + "lineNumber": 29 } }, { @@ -566,8 +537,7 @@ "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" + "lineNumber": 30 } } ], @@ -575,8 +545,7 @@ "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" + "lineNumber": 28 } }, { @@ -620,8 +589,7 @@ "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" + "lineNumber": 42 } }, { @@ -640,8 +608,7 @@ "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" + "lineNumber": 42 } } ], @@ -649,8 +616,7 @@ "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" + "lineNumber": 42 } }, { @@ -686,8 +652,7 @@ "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" + "lineNumber": 46 } } ], @@ -695,15 +660,13 @@ "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" + "lineNumber": 46 } } ], "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" + "lineNumber": 25 }, "initialIsOpen": false } @@ -725,8 +688,7 @@ "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" + "lineNumber": 30 } }, { @@ -737,8 +699,7 @@ "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" + "lineNumber": 31 } }, { @@ -749,8 +710,7 @@ "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" + "lineNumber": 32 } }, { @@ -761,8 +721,7 @@ "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" + "lineNumber": 33 }, "signature": [ "() => void" @@ -776,8 +735,7 @@ "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" + "lineNumber": 34 }, "signature": [ "boolean | undefined" @@ -786,8 +744,7 @@ ], "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" + "lineNumber": 29 }, "initialIsOpen": false } @@ -801,8 +758,7 @@ "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" + "lineNumber": 42 }, "initialIsOpen": false } @@ -817,8 +773,7 @@ "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" + "lineNumber": 32 }, "signature": [ "{ creation: { addCreationConfig: (Config: typeof ", @@ -852,8 +807,7 @@ "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" + "lineNumber": 34 }, "signature": [ "{ creation: { getType: (key: string | undefined) => ", diff --git a/api_docs/infra.json b/api_docs/infra.json index 88b628bbfaef8..a10be8ce8bf04 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -25,8 +25,7 @@ "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" + "lineNumber": 13 } } ], @@ -39,8 +38,7 @@ "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" + "lineNumber": 13 }, "tags": [], "returnComment": [], @@ -57,8 +55,7 @@ "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" + "lineNumber": 147 }, "initialIsOpen": false } @@ -72,8 +69,7 @@ "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" + "lineNumber": 29 }, "signature": [ "\"metrics\" | \"logs\"" @@ -95,8 +91,7 @@ "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" + "lineNumber": 16 }, "signature": [ "(val: number) => string" @@ -112,8 +107,7 @@ ], "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" + "lineNumber": 19 }, "signature": [ "(bytes: number) => string" @@ -129,8 +123,7 @@ ], "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" + "lineNumber": 21 }, "signature": [ "(bytes: number) => string" @@ -146,8 +139,7 @@ ], "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" + "lineNumber": 23 }, "signature": [ "(bytes: number) => string" @@ -161,8 +153,7 @@ "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" + "lineNumber": 24 }, "signature": [ "(val: number) => string" @@ -176,8 +167,7 @@ "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" + "lineNumber": 25 }, "signature": [ "(val: number) => string" @@ -188,8 +178,7 @@ "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" + "lineNumber": 15 }, "initialIsOpen": false } @@ -209,8 +198,7 @@ "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" + "lineNumber": 64 }, "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; }>; }" @@ -234,8 +222,7 @@ "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" + "lineNumber": 75 }, "signature": [ "(sourceId: string, sourceProperties: ", @@ -252,8 +239,7 @@ ], "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" + "lineNumber": 74 }, "lifecycle": "setup", "initialIsOpen": true diff --git a/api_docs/ingest_pipelines.json b/api_docs/ingest_pipelines.json index 8bc2770d5b94a..79fe652cf4dbf 100644 --- a/api_docs/ingest_pipelines.json +++ b/api_docs/ingest_pipelines.json @@ -46,8 +46,7 @@ "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" + "lineNumber": 57 } } ], @@ -55,8 +54,7 @@ "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" + "lineNumber": 57 } }, { @@ -67,8 +65,7 @@ "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" + "lineNumber": 59 }, "signature": [ "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" @@ -94,8 +91,7 @@ "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" + "lineNumber": 61 } } ], @@ -114,8 +110,7 @@ "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" + "lineNumber": 61 }, "tags": [], "returnComment": [] @@ -123,8 +118,7 @@ ], "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" + "lineNumber": 55 }, "initialIsOpen": false } @@ -140,8 +134,7 @@ "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" + "lineNumber": 22 }, "initialIsOpen": false } @@ -155,8 +148,7 @@ "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" + "lineNumber": 20 }, "signature": [ "\"INGEST_PIPELINES_APP_URL_GENERATOR\"" @@ -171,8 +163,7 @@ "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" + "lineNumber": 49 }, "signature": [ "PipelinesListUrlGeneratorState", diff --git a/api_docs/inspector.json b/api_docs/inspector.json index 55132039eda18..2d42ec9fbff8b 100644 --- a/api_docs/inspector.json +++ b/api_docs/inspector.json @@ -51,8 +51,7 @@ "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" + "lineNumber": 55 }, "signature": [ { @@ -91,8 +90,7 @@ "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" + "lineNumber": 57 } } ], @@ -100,8 +98,7 @@ "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" + "lineNumber": 57 } }, { @@ -154,8 +151,7 @@ "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" + "lineNumber": 59 } } ], @@ -163,8 +159,7 @@ "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" + "lineNumber": 59 } }, { @@ -231,8 +226,7 @@ "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" + "lineNumber": 73 } } ], @@ -240,8 +234,7 @@ "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" + "lineNumber": 73 } }, { @@ -257,15 +250,13 @@ "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" + "lineNumber": 114 } } ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L54" + "lineNumber": 54 }, "initialIsOpen": false }, @@ -304,8 +295,7 @@ "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" + "lineNumber": 24 } }, { @@ -346,8 +336,7 @@ ], "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" + "lineNumber": 39 } }, { @@ -366,8 +355,7 @@ "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" + "lineNumber": 39 } } ], @@ -379,8 +367,7 @@ ], "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" + "lineNumber": 39 } }, { @@ -396,8 +383,7 @@ "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" + "lineNumber": 52 } }, { @@ -419,8 +405,7 @@ "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" + "lineNumber": 57 } } ], @@ -428,8 +413,7 @@ "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" + "lineNumber": 57 } }, { @@ -453,15 +437,13 @@ "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" + "lineNumber": 62 } } ], "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" + "lineNumber": 21 }, "initialIsOpen": false }, @@ -499,8 +481,7 @@ "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" + "lineNumber": 20 } }, { @@ -513,8 +494,7 @@ "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" + "lineNumber": 20 } } ], @@ -522,8 +502,7 @@ "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" + "lineNumber": 20 } }, { @@ -552,8 +531,7 @@ "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" + "lineNumber": 25 } } ], @@ -561,8 +539,7 @@ "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" + "lineNumber": 25 } }, { @@ -605,8 +582,7 @@ "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" + "lineNumber": 31 } } ], @@ -614,8 +590,7 @@ "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" + "lineNumber": 31 } }, { @@ -659,8 +634,7 @@ "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" + "lineNumber": 53 } }, { @@ -679,8 +653,7 @@ "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" + "lineNumber": 53 } } ], @@ -688,8 +661,7 @@ "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" + "lineNumber": 53 } }, { @@ -725,8 +697,7 @@ "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" + "lineNumber": 60 } } ], @@ -734,8 +705,7 @@ "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" + "lineNumber": 60 } }, { @@ -771,8 +741,7 @@ "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" + "lineNumber": 64 } } ], @@ -780,15 +749,13 @@ "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" + "lineNumber": 64 } } ], "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" + "lineNumber": 16 }, "initialIsOpen": false } @@ -796,67 +763,90 @@ "functions": [], "interfaces": [ { - "id": "def-public.InspectorViewProps", + "id": "def-public.Adapters", "type": "Interface", - "label": "InspectorViewProps", - "signature": [ - { - "pluginId": "inspector", - "scope": "public", - "docId": "kibInspectorPluginApi", - "section": "def-public.InspectorViewProps", - "text": "InspectorViewProps" - }, - "" - ], + "label": "Adapters", "description": [ - "\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use." + "\nThe interface that the adapters used to open an inspector have to fullfill." ], "tags": [], "children": [ { "tags": [], - "id": "def-public.InspectorViewProps.adapters", - "type": "Uncategorized", - "label": "adapters", - "description": [ - "\nAdapters used to open the inspector." - ], + "id": "def-public.Adapters.requests", + "type": "Object", + "label": "requests", + "description": [], "source": { - "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L20" + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 15 }, "signature": [ - "TAdapters" + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined" ] }, { + "id": "def-public.Adapters.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "id": "def-public.InspectorViewProps.title", + "description": [], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 16 + }, + "signature": [ + "any" + ] + } + ], + "source": { + "path": "src/plugins/inspector/common/adapters/types.ts", + "lineNumber": 14 + }, + "initialIsOpen": false + }, + { + "id": "def-public.InspectorOptions", + "type": "Interface", + "label": "InspectorOptions", + "description": [ + "\nOptions that can be specified when opening the inspector." + ], + "tags": [ + "property" + ], + "children": [ + { + "tags": [], + "id": "def-public.InspectorOptions.title", "type": "string", "label": "title", - "description": [ - "\nThe title that the inspector is currently using e.g. a visualization name." - ], + "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L24" - } + "lineNumber": 60 + }, + "signature": [ + "string | undefined" + ] }, { "tags": [], - "id": "def-public.InspectorViewProps.options", + "id": "def-public.InspectorOptions.options", "type": "Unknown", "label": "options", - "description": [ - "\nA set of specific options for each view." - ], + "description": [], "source": { "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L28" + "lineNumber": 61 }, "signature": [ "unknown" @@ -865,8 +855,7 @@ ], "source": { "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L16" + "lineNumber": 59 }, "initialIsOpen": false }, @@ -889,8 +878,7 @@ "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" + "lineNumber": 46 }, "signature": [ "React.ComponentType<", @@ -920,8 +908,7 @@ "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" + "lineNumber": 47 }, "signature": [ "string | undefined" @@ -935,8 +922,7 @@ "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" + "lineNumber": 48 }, "signature": [ "number | undefined" @@ -950,8 +936,7 @@ "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" + "lineNumber": 49 }, "signature": [ "((adapters: ", @@ -973,55 +958,75 @@ "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" + "lineNumber": 50 } } ], "source": { "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L45" + "lineNumber": 45 }, "initialIsOpen": false }, { - "id": "def-public.InspectorOptions", + "id": "def-public.InspectorViewProps", "type": "Interface", - "label": "InspectorOptions", - "description": [ - "\nOptions that can be specified when opening the inspector." + "label": "InspectorViewProps", + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.InspectorViewProps", + "text": "InspectorViewProps" + }, + "" ], - "tags": [ - "property", - "property" + "description": [ + "\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use." ], + "tags": [], "children": [ { "tags": [], - "id": "def-public.InspectorOptions.title", - "type": "string", - "label": "title", - "description": [], + "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": 60, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L60" + "lineNumber": 20 }, "signature": [ - "string | undefined" + "TAdapters" ] }, { "tags": [], - "id": "def-public.InspectorOptions.options", + "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 + } + }, + { + "tags": [], + "id": "def-public.InspectorViewProps.options", "type": "Unknown", "label": "options", - "description": [], + "description": [ + "\nA set of specific options for each view." + ], "source": { "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 61, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L61" + "lineNumber": 28 }, "signature": [ "unknown" @@ -1030,8 +1035,7 @@ ], "source": { "path": "src/plugins/inspector/public/types.ts", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L59" + "lineNumber": 16 }, "initialIsOpen": false }, @@ -1050,8 +1054,7 @@ "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" + "lineNumber": 49 } }, { @@ -1062,8 +1065,7 @@ "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" + "lineNumber": 50 }, "signature": [ "string | undefined" @@ -1077,8 +1079,7 @@ "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" + "lineNumber": 51 }, "signature": [ "any" @@ -1087,8 +1088,7 @@ ], "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" + "lineNumber": 48 }, "initialIsOpen": false }, @@ -1107,8 +1107,7 @@ "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" + "lineNumber": 45 }, "signature": [ "any" @@ -1117,62 +1116,7 @@ ], "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." - ], - "tags": [], - "children": [ - { - "tags": [], - "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", - "tags": [], - "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" + "lineNumber": 44 }, "initialIsOpen": false } @@ -1188,8 +1132,7 @@ ], "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" + "lineNumber": 12 }, "initialIsOpen": false } @@ -1203,8 +1146,7 @@ "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" + "lineNumber": 64 }, "signature": [ "OverlayRef" @@ -1228,8 +1170,7 @@ "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" + "lineNumber": 21 }, "signature": [ "(view: ", @@ -1251,8 +1192,7 @@ "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" + "lineNumber": 23 }, "signature": [ "{ views: ", @@ -1269,8 +1209,7 @@ ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L20" + "lineNumber": 20 }, "lifecycle": "setup", "initialIsOpen": true @@ -1292,8 +1231,7 @@ ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L37" + "lineNumber": 37 }, "signature": [ "(adapters?: ", @@ -1320,8 +1258,7 @@ ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 51, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L51" + "lineNumber": 51 }, "signature": [ "(adapters: ", @@ -1353,8 +1290,7 @@ ], "source": { "path": "src/plugins/inspector/public/plugin.tsx", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L28" + "lineNumber": 28 }, "lifecycle": "start", "initialIsOpen": true @@ -1405,8 +1341,7 @@ "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" + "lineNumber": 24 } }, { @@ -1447,8 +1382,7 @@ ], "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" + "lineNumber": 39 } }, { @@ -1467,8 +1401,7 @@ "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" + "lineNumber": 39 } } ], @@ -1480,8 +1413,7 @@ ], "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" + "lineNumber": 39 } }, { @@ -1497,8 +1429,7 @@ "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" + "lineNumber": 52 } }, { @@ -1520,8 +1451,7 @@ "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" + "lineNumber": 57 } } ], @@ -1529,8 +1459,7 @@ "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" + "lineNumber": 57 } }, { @@ -1554,15 +1483,13 @@ "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" + "lineNumber": 62 } } ], "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" + "lineNumber": 21 }, "initialIsOpen": false }, @@ -1600,8 +1527,7 @@ "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" + "lineNumber": 20 } }, { @@ -1614,8 +1540,7 @@ "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" + "lineNumber": 20 } } ], @@ -1623,8 +1548,7 @@ "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" + "lineNumber": 20 } }, { @@ -1653,8 +1577,7 @@ "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" + "lineNumber": 25 } } ], @@ -1662,8 +1585,7 @@ "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" + "lineNumber": 25 } }, { @@ -1706,8 +1628,7 @@ "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" + "lineNumber": 31 } } ], @@ -1715,8 +1636,7 @@ "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" + "lineNumber": 31 } }, { @@ -1760,8 +1680,7 @@ "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" + "lineNumber": 53 } }, { @@ -1780,8 +1699,7 @@ "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" + "lineNumber": 53 } } ], @@ -1789,8 +1707,7 @@ "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" + "lineNumber": 53 } }, { @@ -1826,8 +1743,7 @@ "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" + "lineNumber": 60 } } ], @@ -1835,8 +1751,7 @@ "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" + "lineNumber": 60 } }, { @@ -1872,8 +1787,7 @@ "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" + "lineNumber": 64 } } ], @@ -1881,15 +1795,13 @@ "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" + "lineNumber": 64 } } ], "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" + "lineNumber": 16 }, "initialIsOpen": false } @@ -1913,8 +1825,7 @@ "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" + "lineNumber": 15 }, "signature": [ { @@ -1935,8 +1846,7 @@ "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" + "lineNumber": 16 }, "signature": [ "any" @@ -1945,8 +1855,7 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -1965,8 +1874,7 @@ "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" + "lineNumber": 49 } }, { @@ -1977,8 +1885,7 @@ "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" + "lineNumber": 50 }, "signature": [ "string | undefined" @@ -1992,8 +1899,7 @@ "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" + "lineNumber": 51 }, "signature": [ "any" @@ -2002,8 +1908,7 @@ ], "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" + "lineNumber": 48 }, "initialIsOpen": false }, @@ -2022,8 +1927,7 @@ "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" + "lineNumber": 45 }, "signature": [ "any" @@ -2032,8 +1936,7 @@ ], "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" + "lineNumber": 44 }, "initialIsOpen": false } @@ -2049,8 +1952,7 @@ ], "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" + "lineNumber": 12 }, "initialIsOpen": false } diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json index 183ab1e9169e0..f86d9eb480e59 100644 --- a/api_docs/kibana_legacy.json +++ b/api_docs/kibana_legacy.json @@ -35,8 +35,7 @@ "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" + "lineNumber": 15 } } ], @@ -44,8 +43,7 @@ "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" + "lineNumber": 15 } }, { @@ -98,8 +96,7 @@ "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" + "lineNumber": 17 } } ], @@ -107,8 +104,7 @@ "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" + "lineNumber": 17 } }, { @@ -152,8 +148,7 @@ "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" + "lineNumber": 21 } } ], @@ -161,15 +156,13 @@ "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" + "lineNumber": 21 } } ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, @@ -188,8 +181,7 @@ "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" + "lineNumber": 12 }, "signature": [ { @@ -229,8 +221,7 @@ "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" + "lineNumber": 16 } } ], @@ -238,8 +229,7 @@ "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" + "lineNumber": 16 } }, { @@ -256,8 +246,7 @@ "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" + "lineNumber": 26 } } ], @@ -268,8 +257,7 @@ "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" + "lineNumber": 26 }, "tags": [], "returnComment": [] @@ -294,8 +282,7 @@ "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" + "lineNumber": 30 } } ], @@ -321,8 +308,7 @@ "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" + "lineNumber": 30 }, "tags": [], "returnComment": [] @@ -347,8 +333,7 @@ "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" + "lineNumber": 31 } } ], @@ -367,8 +352,7 @@ "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" + "lineNumber": 31 }, "tags": [], "returnComment": [] @@ -393,8 +377,7 @@ "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" + "lineNumber": 32 } } ], @@ -420,8 +403,7 @@ "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" + "lineNumber": 32 }, "tags": [], "returnComment": [] @@ -446,8 +428,7 @@ "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" + "lineNumber": 33 } } ], @@ -473,8 +454,7 @@ "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" + "lineNumber": 33 }, "tags": [], "returnComment": [] @@ -499,8 +479,7 @@ "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" + "lineNumber": 34 } } ], @@ -526,8 +505,7 @@ "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" + "lineNumber": 34 }, "tags": [], "returnComment": [] @@ -546,8 +524,7 @@ "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" + "lineNumber": 35 } }, { @@ -566,8 +543,7 @@ "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" + "lineNumber": 35 } } ], @@ -593,8 +569,7 @@ "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" + "lineNumber": 35 }, "tags": [], "returnComment": [] @@ -602,312 +577,165 @@ ], "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" + "lineNumber": 11 }, "initialIsOpen": false } ], "functions": [ { - "tags": [], - "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", + "id": "def-public.$setupXsrfRequestInterceptor", "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", + "type": "string", + "label": "version", "isRequired": true, "signature": [ - "any" + "string" ], "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" + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 136 } } ], - "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" + "(version: string) => ($httpProvider: angular.IHttpProvider) => void" ], "description": [], - "children": [], - "tags": [], - "returnComment": [], + "label": "$setupXsrfRequestInterceptor", "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" + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "lineNumber": 136 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.PromiseServiceCreator", + "id": "def-public.addFatalError", "type": "Function", - "label": "PromiseServiceCreator", + "label": "addFatalError", "signature": [ - "($q: unknown, $timeout: unknown) => (fn: unknown) => unknown" + "(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": "Unknown", - "label": "$q", + "type": "Object", + "label": "fatalErrors", "isRequired": true, "signature": [ - "unknown" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.FatalErrorsSetup", + "text": "FatalErrorsSetup" + } ], "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" + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 17 } }, { - "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", + "type": "CompoundType", + "label": "error", "isRequired": true, "signature": [ - "unknown" + "string | Error | ", + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.AngularHttpError", + "text": "AngularHttpError" + } ], "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" + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 18 } - } - ], - "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 - }, - { - "tags": [], - "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, + "type": "string", + "label": "location", + "isRequired": false, "signature": [ - "unknown" + "string | undefined" ], "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" + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 19 } } ], "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" + "path": "src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts", + "lineNumber": 16 }, "initialIsOpen": false }, { - "id": "def-public.subscribeWithScope", + "id": "def-public.addSystemApiHeader", "type": "Function", - "label": "subscribeWithScope", + "label": "addSystemApiHeader", "signature": [ - "($scope: angular.IScope, observable: ", - "Observable", - ", observer: ", - "NextObserver", - " | ", - "ErrorObserver", - " | ", - "CompletionObserver", - " | undefined, fatalError: FatalErrorFn | undefined) => ", - "Subscription" + "(originalHeaders: Record) => { \"kbn-system-request\": boolean; }" ], "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." + "\nAdds a custom header designating request as system API" ], "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", + "label": "originalHeaders", "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" + "Record" ], - "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": [ + "Object representing set of headers" ], - "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" + "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", + "lineNumber": 19 } } ], - "tags": [], - "returnComment": [], + "tags": [ + "return" + ], + "returnComment": [ + "Object representing set of headers, with system API header added in" + ], "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" + "path": "src/plugins/kibana_legacy/public/utils/system_api.ts", + "lineNumber": 19 }, "initialIsOpen": false }, @@ -925,8 +753,7 @@ "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" + "lineNumber": 63 } }, { @@ -944,8 +771,7 @@ "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" + "lineNumber": 65 }, "signature": [ { @@ -965,8 +791,7 @@ "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" + "lineNumber": 66 }, "signature": [ "{ mode: Readonly<", @@ -979,8 +804,7 @@ ], "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" + "lineNumber": 64 } }, { @@ -993,8 +817,7 @@ "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" + "lineNumber": 71 } }, { @@ -1009,8 +832,7 @@ "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" + "lineNumber": 72 } } ], @@ -1035,44 +857,70 @@ "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" + "lineNumber": 62 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.$setupXsrfRequestInterceptor", + "tags": [], + "id": "def-public.createTopNavHelper", "type": "Function", + "label": "createTopNavHelper", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 14 + }, + "signature": [ + "(options: unknown) => angular.Injectable>" + ], + "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": "string", - "label": "version", + "type": "Object", + "label": "error", "isRequired": true, "signature": [ - "string" + { + "pluginId": "kibanaLegacy", + "scope": "public", + "docId": "kibKibanaLegacyPluginApi", + "section": "def-public.AngularHttpError", + "text": "AngularHttpError" + } ], "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" + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 24 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 24 + }, "initialIsOpen": false }, { @@ -1089,8 +937,7 @@ "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" + "lineNumber": 18 } } ], @@ -1103,8 +950,7 @@ "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" + "lineNumber": 18 }, "tags": [], "returnComment": [], @@ -1131,8 +977,7 @@ "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" + "lineNumber": 21 } }, { @@ -1147,8 +992,7 @@ ], "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" + "lineNumber": 21 } } ], @@ -1156,8 +1000,7 @@ "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" + "lineNumber": 21 }, "initialIsOpen": false }, @@ -1180,8 +1023,7 @@ "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" + "lineNumber": 12 } } ], @@ -1189,9 +1031,23 @@ "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" + "lineNumber": 12 + }, + "initialIsOpen": false + }, + { + "tags": [], + "id": "def-public.initAngularBootstrap", + "type": "Function", + "label": "initAngularBootstrap", + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular_bootstrap/index.ts", + "lineNumber": 15 }, + "signature": [ + "() => void" + ], "initialIsOpen": false }, { @@ -1213,8 +1069,7 @@ "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" + "lineNumber": 14 } } ], @@ -1222,145 +1077,138 @@ "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" + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-public.formatAngularHttpError", + "id": "def-public.isSystemApiRequest", "type": "Function", - "label": "formatAngularHttpError", + "label": "isSystemApiRequest", "signature": [ - "(error: ", + "(request: angular.IRequestConfig) => boolean | undefined" + ], + "description": [ + "\nReturns true if request is a system API request; false otherwise\n" + ], + "children": [ { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.AngularHttpError", - "text": "AngularHttpError" - }, - ") => string" + "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 + } + } + ], + "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 + }, + "initialIsOpen": false + }, + { + "id": "def-public.loadKbnTopNavDirectives", + "type": "Function", + "label": "loadKbnTopNavDirectives", + "signature": [ + "(navUi: unknown) => void" ], "description": [], "children": [ { - "type": "Object", - "label": "error", + "type": "Unknown", + "label": "navUi", "isRequired": true, "signature": [ - { - "pluginId": "kibanaLegacy", - "scope": "public", - "docId": "kibKibanaLegacyPluginApi", - "section": "def-public.AngularHttpError", - "text": "AngularHttpError" - } + "unknown" ], "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" + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 17 } } ], "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" + "path": "src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts", + "lineNumber": 17 }, "initialIsOpen": false }, { - "id": "def-public.addFatalError", + "id": "def-public.PaginateControlsDirectiveProvider", "type": "Function", - "label": "addFatalError", + "label": "PaginateControlsDirectiveProvider", "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" + "() => any" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 10 + }, + "initialIsOpen": false + }, + { + "id": "def-public.PaginateDirectiveProvider", + "type": "Function", + "label": "PaginateDirectiveProvider", + "signature": [ + "($parse: any, $compile: any) => any" ], "description": [], "children": [ { - "type": "Object", - "label": "fatalErrors", + "type": "Any", + "label": "$parse", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.FatalErrorsSetup", - "text": "FatalErrorsSetup" - } + "any" ], "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" + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9 } }, { - "type": "CompoundType", - "label": "error", + "type": "Any", + "label": "$compile", "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" + "any" ], "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" + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9 } } ], "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" + "path": "src/plugins/kibana_legacy/public/paginate/paginate.d.ts", + "lineNumber": 9 }, "initialIsOpen": false }, @@ -1377,8 +1225,51 @@ "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" + "lineNumber": 13 + }, + "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 + } + }, + { + "type": "Unknown", + "label": "$timeout", + "isRequired": true, + "signature": [ + "unknown" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", + "lineNumber": 9 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/promises.d.ts", + "lineNumber": 9 }, "initialIsOpen": false }, @@ -1401,8 +1292,7 @@ "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" + "lineNumber": 9 } } ], @@ -1410,90 +1300,125 @@ "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" + "lineNumber": 9 }, "initialIsOpen": false }, { - "id": "def-public.addSystemApiHeader", + "id": "def-public.subscribeWithScope", "type": "Function", - "label": "addSystemApiHeader", + "label": "subscribeWithScope", "signature": [ - "(originalHeaders: Record) => { \"kbn-system-request\": boolean; }" + "($scope: angular.IScope, observable: ", + "Observable", + ", observer: ", + "NextObserver", + " | ", + "ErrorObserver", + " | ", + "CompletionObserver", + " | undefined, fatalError: FatalErrorFn | undefined) => ", + "Subscription" ], "description": [ - "\nAdds a custom header designating request as system API" + "\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": "originalHeaders", + "label": "$scope", "isRequired": true, "signature": [ - "Record" + "angular.IScope" ], - "description": [ - "Object representing set of headers" + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 40 + } + }, + { + "type": "Object", + "label": "observable", + "isRequired": true, + "signature": [ + "Observable", + "" ], + "description": [], "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" + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 41 + } + }, + { + "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 + } + }, + { + "type": "Function", + "label": "fatalError", + "isRequired": false, + "signature": [ + "FatalErrorFn | undefined" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 43 } } ], - "tags": [ - "return" - ], - "returnComment": [ - "Object representing set of headers, with system API header added in" - ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts", + "lineNumber": 39 }, "initialIsOpen": false }, { - "id": "def-public.isSystemApiRequest", + "id": "def-public.watchMultiDecorator", "type": "Function", - "label": "isSystemApiRequest", + "label": "watchMultiDecorator", "signature": [ - "(request: angular.IRequestConfig) => boolean | undefined" - ], - "description": [ - "\nReturns true if request is a system API request; false otherwise\n" + "($provide: unknown) => void" ], + "description": [], "children": [ { - "type": "Object", - "label": "request", + "type": "Unknown", + "label": "$provide", "isRequired": true, "signature": [ - "angular.IRequestConfig" - ], - "description": [ - "Object Request object created by $http service" + "unknown" ], + "description": [], "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" + "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", + "lineNumber": 9 } } ], - "tags": [ - "return" - ], - "returnComment": [ - "true if request is a system API request; false otherwise" - ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/kibana_legacy/public/angular/watch_multi.d.ts", + "lineNumber": 9 }, "initialIsOpen": false } @@ -1514,8 +1439,7 @@ "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" + "lineNumber": 29 }, "signature": [ "string | ((...args: any[]) => void) | undefined" @@ -1529,8 +1453,7 @@ "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" + "lineNumber": 30 }, "signature": [ "string | undefined" @@ -1544,8 +1467,7 @@ "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" + "lineNumber": 31 }, "signature": [ "((...args: any[]) => void) | undefined" @@ -1559,8 +1481,7 @@ "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" + "lineNumber": 32 }, "signature": [ "boolean | undefined" @@ -1574,8 +1495,7 @@ "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" + "lineNumber": 33 }, "signature": [ "boolean | undefined" @@ -1589,8 +1509,7 @@ "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" + "lineNumber": 34 }, "signature": [ "boolean | undefined" @@ -1604,8 +1523,7 @@ "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" + "lineNumber": 35 }, "signature": [ "object | undefined" @@ -1619,8 +1537,7 @@ "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" + "lineNumber": 36 }, "signature": [ "string | undefined" @@ -1634,8 +1551,7 @@ "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" + "lineNumber": 37 }, "signature": [ "((...args: any[]) => ", @@ -1651,8 +1567,7 @@ "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" + "lineNumber": 38 }, "signature": [ "string | undefined" @@ -1661,8 +1576,7 @@ ], "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" + "lineNumber": 28 }, "initialIsOpen": false } @@ -1670,36 +1584,17 @@ "enums": [], "misc": [ { - "id": "def-public.KibanaLegacySetup", - "type": "Type", - "label": "KibanaLegacySetup", - "tags": [], - "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", + "id": "def-public.AngularHttpError", "type": "Type", - "label": "KibanaLegacyStart", + "label": "AngularHttpError", "tags": [], "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" + "path": "src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts", + "lineNumber": 12 }, "signature": [ - "{ dashboardConfig: ", - "DashboardConfig", - "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" + "IHttpResponse<{ message: string; }>" ], "initialIsOpen": false }, @@ -1711,8 +1606,7 @@ "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" + "lineNumber": 11 }, "signature": [ "angular.Injectable>" @@ -1720,18 +1614,17 @@ "initialIsOpen": false }, { - "id": "def-public.AngularHttpError", + "id": "def-public.IPrivate", "type": "Type", - "label": "AngularHttpError", + "label": "IPrivate", "tags": [], "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" + "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", + "lineNumber": 11 }, "signature": [ - "IHttpResponse<{ message: string; }>" + "(provider: (...injectable: any[]) => T) => T" ], "initialIsOpen": false }, @@ -1743,8 +1636,7 @@ "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" + "lineNumber": 11 }, "signature": [ "angular.Injectable>" @@ -1752,18 +1644,34 @@ "initialIsOpen": false }, { - "id": "def-public.IPrivate", + "id": "def-public.KibanaLegacySetup", "type": "Type", - "label": "IPrivate", + "label": "KibanaLegacySetup", "tags": [], "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" + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 45 }, "signature": [ - "(provider: (...injectable: any[]) => T) => T" + "{}" + ], + "initialIsOpen": false + }, + { + "id": "def-public.KibanaLegacyStart", + "type": "Type", + "label": "KibanaLegacyStart", + "tags": [], + "description": [], + "source": { + "path": "src/plugins/kibana_legacy/public/plugin.ts", + "lineNumber": 46 + }, + "signature": [ + "{ dashboardConfig: ", + "DashboardConfig", + "; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }" ], "initialIsOpen": false } diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json index 5c68f2b84ded3..7541987ba4215 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -2,206 +2,6 @@ "id": "kibanaReact", "client": { "classes": [ - { - "id": "def-public.ValidatedDualRange", - "type": "Class", - "tags": [], - "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", - "tags": [], - "children": [ - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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", - "tags": [], - "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" - }, - "tags": [], - "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", @@ -260,8 +60,7 @@ "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" + "lineNumber": 90 } } ], @@ -269,8 +68,7 @@ "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" + "lineNumber": 90 } }, { @@ -286,8 +84,7 @@ "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" + "lineNumber": 111 } }, { @@ -303,8 +100,7 @@ "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" + "lineNumber": 115 } }, { @@ -320,8 +116,7 @@ "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" + "lineNumber": 120 } }, { @@ -332,8 +127,7 @@ "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" + "lineNumber": 124 }, "signature": [ "((filter: string) => Promise) & _.Cancelable" @@ -350,8 +144,7 @@ "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" + "lineNumber": 156 }, "tags": [], "returnComment": [] @@ -367,8 +160,7 @@ "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" + "lineNumber": 166 }, "tags": [], "returnComment": [] @@ -384,8 +176,7 @@ "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" + "lineNumber": 196 }, "tags": [], "returnComment": [] @@ -401,8 +192,7 @@ "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" + "lineNumber": 200 }, "tags": [], "returnComment": [] @@ -431,15 +221,13 @@ "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" + "lineNumber": 204 } } ], "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" + "lineNumber": 204 } } ], @@ -447,8 +235,7 @@ "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" + "lineNumber": 204 } }, { @@ -464,8 +251,7 @@ "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" + "lineNumber": 215 } }, { @@ -481,8 +267,7 @@ "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" + "lineNumber": 223 } }, { @@ -498,8 +283,7 @@ "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" + "lineNumber": 277 } }, { @@ -515,8 +299,7 @@ "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" + "lineNumber": 319 } }, { @@ -532,8 +315,7 @@ "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" + "lineNumber": 350 } }, { @@ -549,8 +331,7 @@ "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" + "lineNumber": 364 } }, { @@ -566,8 +347,7 @@ "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" + "lineNumber": 395 } }, { @@ -583,8 +363,7 @@ "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" + "lineNumber": 475 } }, { @@ -600,8 +379,7 @@ "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" + "lineNumber": 483 } }, { @@ -617,8 +395,7 @@ "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" + "lineNumber": 528 } }, { @@ -634,920 +411,1025 @@ "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" + "lineNumber": 540 } } ], "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" + "lineNumber": 86 }, "initialIsOpen": false - } - ], - "functions": [ + }, { - "id": "def-public.Markdown", - "type": "Function", + "id": "def-public.ValidatedDualRange", + "type": "Class", + "tags": [], + "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", - "label": "props", - "isRequired": true, - "signature": [ + "tags": [], + "children": [ { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.MarkdownProps", - "text": "MarkdownProps" + "tags": [], + "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 + }, + "signature": [ + "true" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "false" + ] + }, + { + "tags": [], + "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 + }, + "signature": [ + "false" + ] } ], "description": [], + "label": "defaultProps", "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" + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 40 } - } - ], - "signature": [ - "(props: ", - "MarkdownProps", - ") => JSX.Element" - ], - "description": [], - "label": "Markdown", + }, + { + "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 + } + }, + { + "type": "Object", + "label": "prevState", + "isRequired": true, + "signature": [ + "State" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 46 + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 46 + } + }, + { + "id": "def-public.ValidatedDualRange.state", + "type": "Object", + "tags": [], + "children": [], + "description": [], + "label": "state", + "source": { + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 66 + } + }, + { + "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 + } + } + ], + "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 + }, + "tags": [], + "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 + } + } + ], "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" + "path": "src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx", + "lineNumber": 39 }, - "tags": [], - "returnComment": [], "initialIsOpen": false - }, + } + ], + "functions": [ { - "id": "def-public.MarkdownSimple", + "id": "def-public.CodeEditor", "type": "Function", "children": [ { - "type": "Object", + "type": "CompoundType", "label": "props", "isRequired": true, "signature": [ + "React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", - "section": "def-public.MarkdownSimpleProps", - "text": "MarkdownSimpleProps" - } + "section": "def-public.Props", + "text": "Props" + }, + ">" ], "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" + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 22 } } ], "signature": [ - "(props: ", - "MarkdownSimpleProps", - ") => JSX.Element" + "(props: React.PropsWithChildren<", + "Props", + ">) => JSX.Element" ], "description": [], - "label": "MarkdownSimple", + "label": "CodeEditor", "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" + "path": "src/plugins/kibana_react/public/code_editor/index.tsx", + "lineNumber": 22 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.reactToUiComponent", + "id": "def-public.createKibanaReactContext", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "ReactComp", + "type": "Uncategorized", + "label": "services", "isRequired": true, "signature": [ - "React.ComponentType" + "Services" ], "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" + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 46 } } ], "signature": [ - "(ReactComp: React.ComponentType) => ", + "" - ], - "description": [ - "\nTransform a React component into a `UiComponent`.\n" + ">>(services: Services) => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContext", + "text": "KibanaReactContext" + }, + "" ], - "label": "reactToUiComponent", + "description": [], + "label": "createKibanaReactContext", "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" + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 45 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.uiToReactComponent", + "id": "def-public.createNotifications", "type": "Function", "children": [ { - "type": "Function", - "label": "Comp", + "type": "Object", + "label": "services", "isRequired": true, "signature": [ + "Partial<", { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.UiComponent", - "text": "UiComponent" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" }, - "" - ], - "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" + "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", + "lineNumber": 14 } } ], "signature": [ - "(Comp: ", + "(services: Partial<", { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.UiComponent", - "text": "UiComponent" + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" }, - ", as?: string) => React.FC" - ], - "description": [ - "\nTransforms `UiComponent` into a React component." + ">) => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactNotifications", + "text": "KibanaReactNotifications" + } ], - "label": "uiToReactComponent", + "description": [], + "label": "createNotifications", "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" + "path": "src/plugins/kibana_react/public/notifications/create_notifications.tsx", + "lineNumber": 14 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.toMountPoint", + "id": "def-public.createReactOverlays", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "node", - "isRequired": false, + "type": "Object", + "label": "services", + "isRequired": true, "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) => ", + "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 + } + } + ], + "signature": [ + "(services: Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" + "section": "def-public.CoreStart", + "text": "CoreStart" }, - "" - ], - "description": [ - "\nMountPoint converter for react nodes.\n" + ">) => ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactOverlays", + "text": "KibanaReactOverlays" + } ], - "label": "toMountPoint", + "description": [], + "label": "createReactOverlays", "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" + "path": "src/plugins/kibana_react/public/overlays/create_react_overlays.tsx", + "lineNumber": 14 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.MountPointPortal", + "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": "CompoundType", - "label": "{ children, setMountPoint }", + "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": [ - "React.PropsWithChildren" + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.FieldButtonProps", + "text": "FieldButtonProps" + } ], "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" + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 68 } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 68 + }, + "initialIsOpen": false + }, + { + "id": "def-public.FieldIcon", + "type": "Function", + "label": "FieldIcon", "signature": [ - "({ children, setMountPoint }: React.PropsWithChildren) => React.ReactPortal | null" + "({\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": [ - "\nUtility component to portal a part of a react application into the provided `MountPoint`." + "\nField token icon used across the app" ], - "label": "MountPointPortal", + "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": 59 + } + } + ], + "tags": [], + "returnComment": [], "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" + "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", + "lineNumber": 59 }, + "initialIsOpen": false + }, + { + "id": "def-public.KibanaContextProvider", + "type": "Function", + "label": "KibanaContextProvider", "tags": [], - "returnComment": [], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 76 + }, + "signature": [ + "React.FC<{ services?: {} | undefined; }>" + ], "initialIsOpen": false }, { - "id": "def-public.RedirectAppLinks", + "id": "def-public.Markdown", "type": "Function", "children": [ { - "type": "CompoundType", - "label": "{\n application,\n children,\n className,\n ...otherProps\n}", + "type": "Object", + "label": "props", "isRequired": true, "signature": [ - "React.PropsWithChildren" + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.MarkdownProps", + "text": "MarkdownProps" + } ], "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" + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 28 } } ], "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" + "(props: ", + "MarkdownProps", + ") => JSX.Element" ], - "label": "RedirectAppLinks", + "description": [], + "label": "Markdown", "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" + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 28 }, - "tags": [ - "example", - "remarks" - ], + "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.CodeEditor", + "id": "def-public.MarkdownSimple", "type": "Function", "children": [ { - "type": "CompoundType", + "type": "Object", "label": "props", "isRequired": true, "signature": [ - "React.PropsWithChildren<", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - }, - ">" + "section": "def-public.MarkdownSimpleProps", + "text": "MarkdownSimpleProps" + } ], "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" + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 21 } } ], "signature": [ - "(props: React.PropsWithChildren<", - "Props", - ">) => JSX.Element" + "(props: ", + "MarkdownSimpleProps", + ") => JSX.Element" ], "description": [], - "label": "CodeEditor", + "label": "MarkdownSimple", "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" + "path": "src/plugins/kibana_react/public/markdown/index.tsx", + "lineNumber": 21 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.UrlTemplateEditor", + "id": "def-public.MountPointPortal", "type": "Function", "children": [ { "type": "CompoundType", - "label": "{\n height = 105,\n value,\n variables,\n onChange,\n onEditor,\n Editor = CodeEditor,\n}", + "label": "{ children, setMountPoint }", "isRequired": true, "signature": [ - "React.PropsWithChildren<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.UrlTemplateEditorProps", - "text": "UrlTemplateEditorProps" - }, - ">" + "React.PropsWithChildren" ], "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" + "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", + "lineNumber": 22 } } ], "signature": [ - "({ height, value, variables, onChange, onEditor, Editor, }: React.PropsWithChildren<", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.UrlTemplateEditorProps", - "text": "UrlTemplateEditorProps" - }, - ">) => JSX.Element" + "({ children, setMountPoint }: React.PropsWithChildren) => React.ReactPortal | null" ], - "description": [], - "label": "UrlTemplateEditor", + "description": [ + "\nUtility component to portal a part of a react application into the provided `MountPoint`." + ], + "label": "MountPointPortal", "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" + "path": "src/plugins/kibana_react/public/util/mount_point_portal.tsx", + "lineNumber": 22 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.createKibanaReactContext", + "id": "def-public.OverviewPageFooter", "type": "Function", "children": [ { - "type": "Uncategorized", - "label": "services", + "type": "CompoundType", + "label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}", "isRequired": true, "signature": [ - "Services" + "React.PropsWithChildren" ], "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" + "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", + "lineNumber": 28 } } ], "signature": [ - ">(services: Services) => ", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactContext", - "text": "KibanaReactContext" - }, - "" + "({ addBasePath, path, onSetDefaultRoute, onChangeDefaultRoute, }: React.PropsWithChildren) => JSX.Element" ], "description": [], - "label": "createKibanaReactContext", + "label": "OverviewPageFooter", "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" + "path": "src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx", + "lineNumber": 28 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.KibanaContextProvider", - "type": "Function", - "label": "KibanaContextProvider", - "tags": [], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.withKibana", + "id": "def-public.OverviewPageHeader", "type": "Function", "children": [ { "type": "CompoundType", - "label": "type", + "label": "{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}", "isRequired": true, "signature": [ - "React.ComponentType" + "React.PropsWithChildren" ], "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" + "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", + "lineNumber": 35 } } ], "signature": [ - "; }>(type: React.ComponentType) => React.FC>>" + "({ hideToolbar, iconType, overlap, showDevToolsLink, showManagementLink, title, addBasePath, }: React.PropsWithChildren) => JSX.Element" ], "description": [], - "label": "withKibana", + "label": "OverviewPageHeader", "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" + "path": "src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx", + "lineNumber": 35 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.UseKibana", + "id": "def-public.Panel", "type": "Function", + "label": "Panel", + "signature": [ + "({ children, className, initialWidth = 100, style = {} }: ", + "Props", + ") => JSX.Element" + ], + "description": [], "children": [ { - "type": "CompoundType", - "label": "{ children }", + "type": "Object", + "label": "{ children, className, initialWidth = 100, style = {} }", "isRequired": true, "signature": [ - "React.PropsWithChildren<{ children: (kibana: ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactContextValue", - "text": "KibanaReactContextValue" - }, - ") => React.ReactNode; }>" + "section": "def-public.Props", + "text": "Props" + } ], "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" + "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", + "lineNumber": 23 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel.tsx", + "lineNumber": 23 + }, "initialIsOpen": false }, { - "id": "def-public.OverviewPageFooter", + "id": "def-public.PanelsContainer", "type": "Function", + "label": "PanelsContainer", + "signature": [ + "({\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}: ", + "Props", + ") => JSX.Element" + ], + "description": [], "children": [ { - "type": "CompoundType", - "label": "{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}", + "type": "Object", + "label": "{\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}", "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/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" + "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", + "lineNumber": 32 } } ], - "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" - }, "tags": [], "returnComment": [], + "source": { + "path": "src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx", + "lineNumber": 32 + }, "initialIsOpen": false }, { - "id": "def-public.OverviewPageHeader", + "id": "def-public.reactRouterNavigate", "type": "Function", "children": [ { "type": "CompoundType", - "label": "{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}", + "label": "history", "isRequired": true, "signature": [ - "React.PropsWithChildren" + "History", + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" ], "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" + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 27 } - } - ], - "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" - }, - "tags": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "id": "def-public.createReactOverlays", - "type": "Function", - "children": [ + }, { - "type": "Object", - "label": "services", + "type": "CompoundType", + "label": "to", "isRequired": true, "signature": [ - "Partial<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ">" + "string | LocationObject" ], "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" + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 28 + } + }, + { + "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 } } ], "signature": [ - "(services: Partial<", + "(history: ", + "History", + " | ", { "pluginId": "core", "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" }, - ">) => ", - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactOverlays", - "text": "KibanaReactOverlays" - } + ", to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: any) => void; }" ], "description": [], - "label": "createReactOverlays", + "label": "reactRouterNavigate", "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" + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 26 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.useUiSetting", + "id": "def-public.reactRouterOnClickHandler", "type": "Function", "children": [ { - "type": "string", - "label": "key", + "type": "CompoundType", + "label": "history", "isRequired": true, "signature": [ - "string" + "History", + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + "" ], "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" + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 36 } }, { - "type": "Uncategorized", - "label": "defaultValue", - "isRequired": false, + "type": "CompoundType", + "label": "to", + "isRequired": true, "signature": [ - "T | undefined" + "string | LocationObject" ], "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" + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 37 } - } + }, + { + "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 + } + } ], "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```" + "(history: ", + "History", + " | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ScopedHistory", + "text": "ScopedHistory" + }, + ", to: string | LocationObject, onClickCallback?: Function | undefined) => (event: any) => void" ], - "label": "useUiSetting", + "description": [], + "label": "reactRouterOnClickHandler", "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" + "path": "src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx", + "lineNumber": 35 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.useUiSetting$", + "id": "def-public.reactToUiComponent", "type": "Function", "children": [ { - "type": "string", - "label": "key", + "type": "CompoundType", + "label": "ReactComp", "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" + "React.ComponentType" ], "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" + "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", + "lineNumber": 19 } } ], "signature": [ - "(key: string, defaultValue?: T | undefined) => [T, Setter]" + "(ReactComp: React.ComponentType) => ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.UiComponent", + "text": "UiComponent" + }, + "" ], "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```" + "\nTransform a React component into a `UiComponent`.\n" ], - "label": "useUiSetting$", + "label": "reactToUiComponent", "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" + "path": "src/plugins/kibana_react/public/adapters/react_to_ui_component.ts", + "lineNumber": 18 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.FieldIcon", + "id": "def-public.RedirectAppLinks", "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}", + "type": "CompoundType", + "label": "{\n application,\n children,\n className,\n ...otherProps\n}", "isRequired": true, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.FieldIconProps", - "text": "FieldIconProps" - } + "React.PropsWithChildren" ], "description": [], "source": { - "path": "src/plugins/kibana_react/public/field_icon/field_icon.tsx", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L59" + "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", + "lineNumber": 38 } } ], - "tags": [], - "returnComment": [], + "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/field_icon/field_icon.tsx", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L59" + "path": "src/plugins/kibana_react/public/app_links/redirect_app_link.tsx", + "lineNumber": 38 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.FieldButton", + "id": "def-public.toMountPoint", "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, + "type": "CompoundType", + "label": "node", + "isRequired": false, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.FieldButtonProps", - "text": "FieldButtonProps" - } + "React.ReactNode" ], "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" + "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", + "lineNumber": 19 } } ], - "tags": [], - "returnComment": [], + "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/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" + "path": "src/plugins/kibana_react/public/util/to_mount_point.tsx", + "lineNumber": 19 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { @@ -1572,8 +1454,7 @@ "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" + "lineNumber": 49 } } ], @@ -1592,528 +1473,333 @@ "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" + "lineNumber": 49 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.Panel", + "id": "def-public.uiToReactComponent", "type": "Function", - "label": "Panel", - "signature": [ - "({ children, className, initialWidth = 100, style = {} }: ", - "Props", - ") => JSX.Element" - ], - "description": [], "children": [ { - "type": "Object", - "label": "{ children, className, initialWidth = 100, style = {} }", + "type": "Function", + "label": "Comp", "isRequired": true, "signature": [ { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.Props", - "text": "Props" - } + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.UiComponent", + "text": "UiComponent" + }, + "" ], "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" + "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", + "lineNumber": 16 + } + }, + { + "type": "string", + "label": "as", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", + "lineNumber": 17 } } ], - "tags": [], - "returnComment": [], + "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/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" + "path": "src/plugins/kibana_react/public/adapters/ui_to_react_component.ts", + "lineNumber": 15 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.PanelsContainer", + "id": "def-public.UrlTemplateEditor", "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}", + "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.Props", - "text": "Props" - } + "section": "def-public.UrlTemplateEditorProps", + "text": "UrlTemplateEditorProps" + }, + ">" ], "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" + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 40 } } ], "signature": [ - "(history: ", - "History", - " | ", + "({ height, value, variables, onChange, onEditor, Editor, }: React.PropsWithChildren<", { - "pluginId": "core", + "pluginId": "kibanaReact", "scope": "public", - "docId": "kibCoreApplicationPluginApi", - "section": "def-public.ScopedHistory", - "text": "ScopedHistory" + "docId": "kibKibanaReactPluginApi", + "section": "def-public.UrlTemplateEditorProps", + "text": "UrlTemplateEditorProps" }, - ", to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: any) => void; }" + ">) => JSX.Element" ], "description": [], - "label": "reactRouterNavigate", + "label": "UrlTemplateEditor", "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" + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "lineNumber": 40 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.reactRouterOnClickHandler", + "id": "def-public.useKibana", "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" - } - }, + "children": [], + "signature": [ + "() => ", { - "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" - } + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" }, - { - "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", - " | ", + ", to: string | LocationObject, onClickCallback?: Function | undefined) => (event: any) => void" + "> & Extra>" ], "description": [], - "label": "reactRouterOnClickHandler", + "label": "useKibana", "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" + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 24 }, "tags": [], "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.createNotifications", + "id": "def-public.UseKibana", "type": "Function", "children": [ { - "type": "Object", - "label": "services", + "type": "CompoundType", + "label": "{ children }", "isRequired": true, "signature": [ - "Partial<", + "React.PropsWithChildren<{ children: (kibana: ", { - "pluginId": "core", + "pluginId": "kibanaReact", "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "docId": "kibKibanaReactPluginApi", + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" }, - ">" + ") => React.ReactNode; }>" ], "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" + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 43 } } ], "signature": [ - "(services: Partial<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ">) => ", + "({ children }: React.PropsWithChildren<{ children: (kibana: ", { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactNotifications", - "text": "KibanaReactNotifications" - } + "section": "def-public.KibanaReactContextValue", + "text": "KibanaReactContextValue" + }, + ") => React.ReactNode; }>) => JSX.Element" ], "description": [], - "label": "createNotifications", + "label": "UseKibana", "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" + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 41 }, "tags": [], "returnComment": [], "initialIsOpen": false - } - ], - "interfaces": [ + }, { - "id": "def-public.UrlTemplateEditorVariable", - "type": "Interface", - "label": "UrlTemplateEditorVariable", - "description": [], - "tags": [], + "id": "def-public.useUiSetting", + "type": "Function", "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - }, + "label": "key", + "isRequired": true, "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.UrlTemplateEditorVariable.documentation", - "type": "string", - "label": "documentation", + "string" + ], "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" - ] + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 22 + } }, { - "tags": [], - "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" - }, + "type": "Uncategorized", + "label": "defaultValue", + "isRequired": false, "signature": [ - "languages", - ".CompletionItemKind | undefined" - ] - }, - { - "tags": [], - "id": "def-public.UrlTemplateEditorVariable.sortText", - "type": "string", - "label": "sortText", + "T | undefined" + ], "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" - ] + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 22 + } } ], + "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/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" + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 22 }, + "tags": [], + "returnComment": [], "initialIsOpen": false }, { - "id": "def-public.UrlTemplateEditorProps", - "type": "Interface", - "label": "UrlTemplateEditorProps", - "description": [], - "tags": [], + "id": "def-public.useUiSetting$", + "type": "Function", "children": [ { - "tags": [], - "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" - } - }, - { - "tags": [], - "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" - ] - }, - { - "tags": [], - "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" - }, + "label": "key", + "isRequired": true, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.UrlTemplateEditorVariable", - "text": "UrlTemplateEditorVariable" - }, - "[] | undefined" - ] - }, - { - "tags": [], - "id": "def-public.UrlTemplateEditorProps.onChange", - "type": "Function", - "label": "onChange", + "string" + ], "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" - ] + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 47 + } }, { - "tags": [], - "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" - }, + "type": "Uncategorized", + "label": "defaultValue", + "isRequired": false, "signature": [ - "((editor: ", - "editor", - ".IStandaloneCodeEditor) => void) | undefined" - ] - }, - { - "tags": [], - "id": "def-public.UrlTemplateEditorProps.Editor", - "type": "CompoundType", - "label": "Editor", + "T | undefined" + ], "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" - ] + "path": "src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts", + "lineNumber": 47 + } + } + ], + "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 + }, + "tags": [], + "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 + } } ], + "signature": [ + "; }>(type: React.ComponentType) => React.FC>>" + ], + "description": [], + "label": "withKibana", "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" + "path": "src/plugins/kibana_react/public/context/context.tsx", + "lineNumber": 31 }, + "tags": [], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "id": "def-public.ExitFullScreenButtonProps", "type": "Interface", @@ -2129,8 +1815,7 @@ "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" + "lineNumber": 15 }, "signature": [ "() => void" @@ -2139,250 +1824,207 @@ ], "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" + "lineNumber": 14 }, "initialIsOpen": false }, { - "id": "def-public.KibanaReactContext", + "id": "def-public.FieldButtonProps", "type": "Interface", - "label": "KibanaReactContext", + "label": "FieldButtonProps", "signature": [ { "pluginId": "kibanaReact", "scope": "public", "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactContext", - "text": "KibanaReactContext" + "section": "def-public.FieldButtonProps", + "text": "FieldButtonProps" }, - "" + " extends React.HTMLAttributes" ], "description": [], "tags": [], "children": [ { "tags": [], - "id": "def-public.KibanaReactContext.value", - "type": "Object", - "label": "value", - "description": [], + "id": "def-public.FieldButtonProps.fieldName", + "type": "CompoundType", + "label": "fieldName", + "description": [ + "\nLabel for the button" + ], "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" + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 18 }, "signature": [ - { - "pluginId": "kibanaReact", - "scope": "public", - "docId": "kibKibanaReactPluginApi", - "section": "def-public.KibanaReactContextValue", - "text": "KibanaReactContextValue" - }, - "" + "React.ReactNode" ] }, { "tags": [], - "id": "def-public.KibanaReactContext.Provider", - "type": "Function", - "label": "Provider", - "description": [], + "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/context/types.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L24" + "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", + "lineNumber": 23 }, "signature": [ - "React.FC<{ services?: T | undefined; }>" + "React.ReactNode" ] }, { "tags": [], - "id": "def-public.KibanaReactContext.Consumer", - "type": "Function", - "label": "Consumer", - "description": [], + "id": "def-public.FieldButtonProps.fieldInfoIcon", + "type": "CompoundType", + "label": "fieldInfoIcon", + "description": [ + "\nAn optional node to place inside and at the end of the