kibana/api_docs/embeddable_enhanced.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733)
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

350 lines
10 KiB
JSON

{
"id": "embeddableEnhanced",
"client": {
"classes": [],
"functions": [
{
"id": "def-public.isEnhancedEmbeddable",
"type": "Function",
"children": [
{
"id": "def-public.isEnhancedEmbeddable.$1",
"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": []
}
}