Skip to content

Commit 7bd34f4

Browse files
Merge branch 'master' into i18n/fix_eui_tokens
2 parents 5228484 + 27039e5 commit 7bd34f4

565 files changed

Lines changed: 18711 additions & 3661 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/developer/architecture/code-exploration.asciidoc

Lines changed: 0 additions & 598 deletions
This file was deleted.

docs/developer/plugin-list.asciidoc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ This API doesn't support angular, for registering angular dev tools, bootstrap a
6262
|Contains the Discover application and the saved search embeddable.
6363
6464
65-
|{kib-repo}blob/{branch}/src/plugins/embeddable/README.md[embeddable]
66-
|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.
65+
|<<embeddable-plugin>>
66+
|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_.
6767
6868
6969
|{kib-repo}blob/{branch}/src/plugins/es_ui_shared/README.md[esUiShared]
@@ -180,9 +180,16 @@ It also provides a stateful version of it on the start contract.
180180
which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.
181181
182182
183-
|{kib-repo}blob/{branch}/src/plugins/ui_actions/README.md[uiActions]
183+
|<<uiactions-plugin>>
184184
|An API for:
185185
186+
- creating custom functionality (`actions`)
187+
- creating custom user interaction events (`triggers`)
188+
- attaching and detaching `actions` to `triggers`.
189+
- emitting `trigger` events
190+
- executing `actions` attached to a given `trigger`.
191+
- exposing a context menu for the user to choose the appropriate action when there are multiple actions attached to a single trigger.
192+
186193
187194
|{kib-repo}blob/{branch}/src/plugins/url_forwarding/README.md[urlForwarding]
188195
|This plugins contains helpers to redirect legacy URLs. It can be used to forward old URLs to their new counterparts.
@@ -523,6 +530,8 @@ in their infrastructure.
523530
|===
524531
525532
include::{kibana-root}/src/plugins/dashboard/README.asciidoc[leveloffset=+1]
533+
include::{kibana-root}/src/plugins/embeddable/README.asciidoc[leveloffset=+1]
526534
include::{kibana-root}/src/plugins/expressions/README.asciidoc[leveloffset=+1]
535+
include::{kibana-root}/src/plugins/ui_actions/README.asciidoc[leveloffset=+1]
527536
include::{kibana-root}/x-pack/plugins/dashboard_enhanced/README.asciidoc[leveloffset=+1]
528537
include::{kibana-root}/x-pack/plugins/embeddable_enhanced/README.asciidoc[leveloffset=+1]
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md)
4+
5+
## API Reference
6+
7+
## Packages
8+
9+
| Package | Description |
10+
| --- | --- |
11+
| [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) | |
12+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## ACTION\_ADD\_PANEL variable
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
ACTION_ADD_PANEL = "ACTION_ADD_PANEL"
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## ACTION\_EDIT\_PANEL variable
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
ACTION_EDIT_PANEL = "editPanel"
11+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-embeddable-public](./kibana-plugin-plugins-embeddable-public.md) &gt; [Adapters](./kibana-plugin-plugins-embeddable-public.adapters.md)
4+
5+
## Adapters interface
6+
7+
The interface that the adapters used to open an inspector have to fullfill.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface Adapters
13+
```
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## AddPanelAction.(constructor)
6+
7+
Constructs a new instance of the `AddPanelAction` class
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
constructor(getFactory: EmbeddableStart['getEmbeddableFactory'], getAllFactories: EmbeddableStart['getEmbeddableFactories'], overlays: OverlayStart, notifications: NotificationsStart, SavedObjectFinder: React.ComponentType<any>);
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| getFactory | <code>EmbeddableStart['getEmbeddableFactory']</code> | |
20+
| getAllFactories | <code>EmbeddableStart['getEmbeddableFactories']</code> | |
21+
| overlays | <code>OverlayStart</code> | |
22+
| notifications | <code>NotificationsStart</code> | |
23+
| SavedObjectFinder | <code>React.ComponentType&lt;any&gt;</code> | |
24+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## AddPanelAction.execute() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
execute(context: ActionExecutionContext<ActionContext>): Promise<void>;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| context | <code>ActionExecutionContext&lt;ActionContext&gt;</code> | |
18+
19+
<b>Returns:</b>
20+
21+
`Promise<void>`
22+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## AddPanelAction.getDisplayName() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getDisplayName(): string;
11+
```
12+
<b>Returns:</b>
13+
14+
`string`
15+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## AddPanelAction.getIconType() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getIconType(): string;
11+
```
12+
<b>Returns:</b>
13+
14+
`string`
15+

0 commit comments

Comments
 (0)