Embeddables: basic documentation (elastic#78900)

docs/developer/plugin-list.asciidoc

@@ -62,8 +62,8 @@ This API doesn't support angular, for registering angular dev tools, bootstrap a
 |Contains the Discover application and the saved search embeddable.
 
 
-|{kib-repo}blob/{branch}/src/plugins/embeddable/README.md[embeddable]
-|Embeddables are re-usable widgets that can be rendered in any environment or plugin. Developers can embed them directly in their plugin. End users can dynamically add them to any embeddable containers.
+|<<embeddable-plugin>>
+|Embeddables are re-usable widgets that can be rendered in any environment or plugin. Developers can embed them directly in their plugin. End users can dynamically add them to any embeddable _containers_.
 
 
 |{kib-repo}blob/{branch}/src/plugins/es_ui_shared[esUiShared]
@@ -539,6 +539,7 @@ in their infrastructure.
 |===
 
 include::{kibana-root}/src/plugins/dashboard/README.asciidoc[leveloffset=+1]
+include::{kibana-root}/src/plugins/embeddable/README.asciidoc[leveloffset=+1]
 include::{kibana-root}/src/plugins/expressions/README.asciidoc[leveloffset=+1]
 include::{kibana-root}/src/plugins/ui_actions/README.asciidoc[leveloffset=+1]
 include::{kibana-root}/x-pack/plugins/dashboard_enhanced/README.asciidoc[leveloffset=+1]

docs/development/plugins/embeddable/public/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) |  |
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.action_add_panel.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [ACTION\_ADD\_PANEL](./kibana-plugin-plugins-embeddable-public.action_add_panel.md)
+
+## ACTION\_ADD\_PANEL variable
+
+<b>Signature:</b>
+
+```typescript
+ACTION_ADD_PANEL = "ACTION_ADD_PANEL"
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.action_edit_panel.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [ACTION\_EDIT\_PANEL](./kibana-plugin-plugins-embeddable-public.action_edit_panel.md)
+
+## ACTION\_EDIT\_PANEL variable
+
+<b>Signature:</b>
+
+```typescript
+ACTION_EDIT_PANEL = "editPanel"
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.adapters.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Adapters](./kibana-plugin-plugins-embeddable-public.adapters.md)
+
+## Adapters interface
+
+The interface that the adapters used to open an inspector have to fullfill.
+
+<b>Signature:</b>
+
+```typescript
+export interface Adapters 
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction._constructor_.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [(constructor)](./kibana-plugin-plugins-embeddable-public.addpanelaction._constructor_.md)
+
+## AddPanelAction.(constructor)
+
+Constructs a new instance of the `AddPanelAction` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(getFactory: EmbeddableStart['getEmbeddableFactory'], getAllFactories: EmbeddableStart['getEmbeddableFactories'], overlays: OverlayStart, notifications: NotificationsStart, SavedObjectFinder: React.ComponentType<any>);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  getFactory | <code>EmbeddableStart['getEmbeddableFactory']</code> |  |
+|  getAllFactories | <code>EmbeddableStart['getEmbeddableFactories']</code> |  |
+|  overlays | <code>OverlayStart</code> |  |
+|  notifications | <code>NotificationsStart</code> |  |
+|  SavedObjectFinder | <code>React.ComponentType&lt;any&gt;</code> |  |
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.execute.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [execute](./kibana-plugin-plugins-embeddable-public.addpanelaction.execute.md)
+
+## AddPanelAction.execute() method
+
+<b>Signature:</b>
+
+```typescript
+execute(context: ActionExecutionContext<ActionContext>): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  context | <code>ActionExecutionContext&lt;ActionContext&gt;</code> |  |
+
+<b>Returns:</b>
+
+`Promise<void>`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.getdisplayname.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [getDisplayName](./kibana-plugin-plugins-embeddable-public.addpanelaction.getdisplayname.md)
+
+## AddPanelAction.getDisplayName() method
+
+<b>Signature:</b>
+
+```typescript
+getDisplayName(): string;
+```
+<b>Returns:</b>
+
+`string`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.geticontype.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [getIconType](./kibana-plugin-plugins-embeddable-public.addpanelaction.geticontype.md)
+
+## AddPanelAction.getIconType() method
+
+<b>Signature:</b>
+
+```typescript
+getIconType(): string;
+```
+<b>Returns:</b>
+
+`string`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [id](./kibana-plugin-plugins-embeddable-public.addpanelaction.id.md)
+
+## AddPanelAction.id property
+
+<b>Signature:</b>
+
+```typescript
+readonly id = "ACTION_ADD_PANEL";
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.iscompatible.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [isCompatible](./kibana-plugin-plugins-embeddable-public.addpanelaction.iscompatible.md)
+
+## AddPanelAction.isCompatible() method
+
+<b>Signature:</b>
+
+```typescript
+isCompatible(context: ActionExecutionContext<ActionContext>): Promise<boolean>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  context | <code>ActionExecutionContext&lt;ActionContext&gt;</code> |  |
+
+<b>Returns:</b>
+
+`Promise<boolean>`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md)
+
+## AddPanelAction class
+
+<b>Signature:</b>
+
+```typescript
+export declare class AddPanelAction implements Action<ActionContext> 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(getFactory, getAllFactories, overlays, notifications, SavedObjectFinder)](./kibana-plugin-plugins-embeddable-public.addpanelaction._constructor_.md) |  | Constructs a new instance of the <code>AddPanelAction</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [id](./kibana-plugin-plugins-embeddable-public.addpanelaction.id.md) |  | <code></code> |  |
+|  [type](./kibana-plugin-plugins-embeddable-public.addpanelaction.type.md) |  | <code></code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [execute(context)](./kibana-plugin-plugins-embeddable-public.addpanelaction.execute.md) |  |  |
+|  [getDisplayName()](./kibana-plugin-plugins-embeddable-public.addpanelaction.getdisplayname.md) |  |  |
+|  [getIconType()](./kibana-plugin-plugins-embeddable-public.addpanelaction.geticontype.md) |  |  |
+|  [isCompatible(context)](./kibana-plugin-plugins-embeddable-public.addpanelaction.iscompatible.md) |  |  |
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.addpanelaction.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [AddPanelAction](./kibana-plugin-plugins-embeddable-public.addpanelaction.md) &gt; [type](./kibana-plugin-plugins-embeddable-public.addpanelaction.type.md)
+
+## AddPanelAction.type property
+
+<b>Signature:</b>
+
+```typescript
+readonly type = "ACTION_ADD_PANEL";
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.chartactioncontext.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [ChartActionContext](./kibana-plugin-plugins-embeddable-public.chartactioncontext.md)
+
+## ChartActionContext type
+
+<b>Signature:</b>
+
+```typescript
+export declare type ChartActionContext<T extends IEmbeddable = IEmbeddable> = ValueClickContext<T> | RangeSelectContext<T>;
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container._constructor_.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [(constructor)](./kibana-plugin-plugins-embeddable-public.container._constructor_.md)
+
+## Container.(constructor)
+
+Constructs a new instance of the `Container` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(input: TContainerInput, output: TContainerOutput, getFactory: EmbeddableStart['getEmbeddableFactory'], parent?: Container);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  input | <code>TContainerInput</code> |  |
+|  output | <code>TContainerOutput</code> |  |
+|  getFactory | <code>EmbeddableStart['getEmbeddableFactory']</code> |  |
+|  parent | <code>Container</code> |  |
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.addnewembeddable.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [addNewEmbeddable](./kibana-plugin-plugins-embeddable-public.container.addnewembeddable.md)
+
+## Container.addNewEmbeddable() method
+
+<b>Signature:</b>
+
+```typescript
+addNewEmbeddable<EEI extends EmbeddableInput = EmbeddableInput, EEO extends EmbeddableOutput = EmbeddableOutput, E extends IEmbeddable<EEI, EEO> = IEmbeddable<EEI, EEO>>(type: string, explicitInput: Partial<EEI>): Promise<E | ErrorEmbeddable>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | <code>string</code> |  |
+|  explicitInput | <code>Partial&lt;EEI&gt;</code> |  |
+
+<b>Returns:</b>
+
+`Promise<E | ErrorEmbeddable>`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.children.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [children](./kibana-plugin-plugins-embeddable-public.container.children.md)
+
+## Container.children property
+
+<b>Signature:</b>
+
+```typescript
+protected readonly children: {
+        [key: string]: IEmbeddable<any, any> | ErrorEmbeddable;
+    };
+```

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.createnewpanelstate.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [createNewPanelState](./kibana-plugin-plugins-embeddable-public.container.createnewpanelstate.md)
+
+## Container.createNewPanelState() method
+
+<b>Signature:</b>
+
+```typescript
+protected createNewPanelState<TEmbeddableInput extends EmbeddableInput, TEmbeddable extends IEmbeddable<TEmbeddableInput, any>>(factory: EmbeddableFactory<TEmbeddableInput, any, TEmbeddable>, partial?: Partial<TEmbeddableInput>): PanelState<TEmbeddableInput>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  factory | <code>EmbeddableFactory&lt;TEmbeddableInput, any, TEmbeddable&gt;</code> |  |
+|  partial | <code>Partial&lt;TEmbeddableInput&gt;</code> |  |
+
+<b>Returns:</b>
+
+`PanelState<TEmbeddableInput>`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.destroy.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [destroy](./kibana-plugin-plugins-embeddable-public.container.destroy.md)
+
+## Container.destroy() method
+
+<b>Signature:</b>
+
+```typescript
+destroy(): void;
+```
+<b>Returns:</b>
+
+`void`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.getchild.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [getChild](./kibana-plugin-plugins-embeddable-public.container.getchild.md)
+
+## Container.getChild() method
+
+<b>Signature:</b>
+
+```typescript
+getChild<E extends IEmbeddable>(id: string): E;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`E`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.getchildids.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [getChildIds](./kibana-plugin-plugins-embeddable-public.container.getchildids.md)
+
+## Container.getChildIds() method
+
+<b>Signature:</b>
+
+```typescript
+getChildIds(): string[];
+```
+<b>Returns:</b>
+
+`string[]`
+

docs/development/plugins/embeddable/public/kibana-plugin-plugins-embeddable-public.container.getfactory.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Container](./kibana-plugin-plugins-embeddable-public.container.md) &gt; [getFactory](./kibana-plugin-plugins-embeddable-public.container.getfactory.md)
+
+## Container.getFactory property
+
+<b>Signature:</b>
+
+```typescript
+protected readonly getFactory: EmbeddableStart['getEmbeddableFactory'];
+```