kibana/api_docs/embeddable_enhanced.json
Stacey Gammon 6b8ebbfa18
API docs clean up (#93508) (#93881)
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
# Conflicts:
#	api_docs/actions.json
#	api_docs/advanced_settings.json
#	api_docs/alerting.json
#	api_docs/apm.json
#	api_docs/apm_oss.json
#	api_docs/banners.json
#	api_docs/beats_management.json
#	api_docs/bfetch.json
#	api_docs/canvas.json
#	api_docs/case.json
#	api_docs/charts.json
#	api_docs/cloud.json
#	api_docs/console.json
#	api_docs/core.json
#	api_docs/core_application.json
#	api_docs/core_chrome.json
#	api_docs/core_http.json
#	api_docs/core_saved_objects.json
#	api_docs/dashboard.json
#	api_docs/dashboard_enhanced.json
#	api_docs/dashboard_mode.json
#	api_docs/data.json
#	api_docs/data_autocomplete.json
#	api_docs/data_enhanced.json
#	api_docs/data_field_formats.json
#	api_docs/data_index_patterns.json
#	api_docs/data_query.json
#	api_docs/data_search.json
#	api_docs/data_ui.json
#	api_docs/dev_tools.json
#	api_docs/discover.json
#	api_docs/discover_enhanced.json
#	api_docs/embeddable.json
#	api_docs/embeddable_enhanced.json
#	api_docs/encrypted_saved_objects.json
#	api_docs/enterprise_search.json
#	api_docs/es_ui_shared.json
#	api_docs/event_log.json
#	api_docs/expressions.json
#	api_docs/features.json
#	api_docs/file_upload.json
#	api_docs/fleet.json
#	api_docs/global_search.json
#	api_docs/home.json
#	api_docs/index_lifecycle_management.json
#	api_docs/index_management.json
#	api_docs/index_pattern_field_editor.json
#	api_docs/index_pattern_management.json
#	api_docs/infra.json
#	api_docs/ingest_pipelines.json
#	api_docs/inspector.json
#	api_docs/kibana_legacy.json
#	api_docs/kibana_react.json
#	api_docs/kibana_utils.json
#	api_docs/lens.json
#	api_docs/license_management.json
#	api_docs/licensing.json
#	api_docs/lists.json
#	api_docs/management.json
#	api_docs/maps.json
#	api_docs/maps_legacy.json
#	api_docs/ml.json
#	api_docs/monitoring.json
#	api_docs/navigation.json
#	api_docs/newsfeed.json
#	api_docs/observability.json
#	api_docs/osquery.json
#	api_docs/presentation_util.json
#	api_docs/remote_clusters.json
#	api_docs/reporting.json
#	api_docs/rollup.json
#	api_docs/runtime_fields.json
#	api_docs/saved_objects.json
#	api_docs/saved_objects_management.json
#	api_docs/saved_objects_tagging.json
#	api_docs/saved_objects_tagging_oss.json
#	api_docs/security.json
#	api_docs/security_oss.json
#	api_docs/security_solution.json
#	api_docs/share.json
#	api_docs/snapshot_restore.json
#	api_docs/spaces.json
#	api_docs/spaces_oss.json
#	api_docs/stack_alerts.json
#	api_docs/task_manager.json
#	api_docs/telemetry.json
#	api_docs/telemetry_collection_manager.json
#	api_docs/telemetry_collection_xpack.json
#	api_docs/telemetry_management_section.json
#	api_docs/triggers_actions_ui.json
#	api_docs/ui_actions.json
#	api_docs/ui_actions_enhanced.json
#	api_docs/uptime.json
#	api_docs/url_forwarding.json
#	api_docs/usage_collection.json
#	api_docs/vis_type_timeseries.json
#	api_docs/visualizations.json
2021-03-06 10:05:27 -05:00

349 lines
No EOL
10 KiB
JSON

{
"id": "embeddableEnhanced",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.isEnhancedEmbeddable",
"type": "Function",
"children": [
{
"type": "Uncategorized",
"label": "maybeEnhancedEmbeddable",
"isRequired": true,
"signature": [
"E"
],
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 12
}
}
],
"signature": [
"<E>(maybeEnhancedEmbeddable: E) => maybeEnhancedEmbeddable is ",
{
"pluginId": "embeddableEnhanced",
"scope": "public",
"docId": "kibEmbeddableEnhancedPluginApi",
"section": "def-public.EnhancedEmbeddable",
"text": "EnhancedEmbeddable"
},
"<E extends ",
{
"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"
},
"> ? E : never>"
],
"description": [],
"label": "isEnhancedEmbeddable",
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts",
"lineNumber": 11
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"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",
"label": "SetupDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SetupDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 36
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableSetup",
"text": "EmbeddableSetup"
}
]
},
{
"tags": [],
"id": "def-public.SetupDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 37
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
}
]
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 35
},
"initialIsOpen": false
},
{
"id": "def-public.StartDependencies",
"type": "Interface",
"label": "StartDependencies",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.StartDependencies.embeddable",
"type": "Object",
"label": "embeddable",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 41
},
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableStart",
"text": "EmbeddableStart"
}
]
},
{
"tags": [],
"id": "def-public.StartDependencies.uiActionsEnhanced",
"type": "Object",
"label": "uiActionsEnhanced",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 42
},
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
}
]
}
],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 40
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.drilldownGrouping",
"type": "Array",
"label": "drilldownGrouping",
"description": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts",
"lineNumber": 12
},
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.PresentableGrouping",
"text": "PresentableGrouping"
},
"<{ embeddable?: ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
"> | undefined; }>"
],
"initialIsOpen": false
},
{
"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": [],
"setup": {
"id": "def-public.SetupContract",
"type": "Interface",
"label": "SetupContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 46
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.StartContract",
"type": "Interface",
"label": "StartContract",
"description": [],
"tags": [],
"children": [],
"source": {
"path": "x-pack/plugins/embeddable_enhanced/public/plugin.ts",
"lineNumber": 49
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}