Skip to content

Commit

Permalink
Merge branch '7.x' into backport/7.x/pr-79830
Browse files Browse the repository at this point in the history
  • Loading branch information
Maja Grubic authored Oct 13, 2020
2 parents 3ecbe5b + 5074199 commit 9f691f7
Show file tree
Hide file tree
Showing 1,225 changed files with 21,939 additions and 4,528 deletions.
6 changes: 3 additions & 3 deletions docs/canvas/canvas-share-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ When you've finished your workpad, you can share it outside of {kib}.

Create a JSON file of your workpad that you can export outside of {kib}.

Click *Share > Download as JSON*.
To begin, click *Share > Download as JSON*.

[role="screenshot"]
image::images/canvas-export-workpad.png[Export single workpad through JSON, from Share dropdown]
Expand All @@ -23,7 +23,7 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp

If you have a subscription that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.

Click *Share > PDF reports > Generate PDF*.
To begin, click *Share > PDF reports > Generate PDF*.

[role="screenshot"]
image::images/canvas-generate-pdf.gif[Image showing how to generate a PDF]
Expand All @@ -36,7 +36,7 @@ For more information, refer to <<reporting-getting-started, Reporting from Kiban

If you have a subscription that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using <<watcher-ui,Watcher>> or a script.

Click *Share > PDF reports > Copy POST URL*.
To begin, click *Share > PDF reports > Copy POST URL*.

[role="screenshot"]
image::images/canvas-create-URL.gif[Image showing how to create POST URL]
Expand Down
10 changes: 4 additions & 6 deletions docs/canvas/canvas-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[canvas-tutorial]]
== Tutorial: Create a workpad for monitoring sales

To get up and running with Canvas, use the following tutorial where you'll create a workpad for monitoring sales at an eCommerce store.
To get up and running with Canvas, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.

[float]
=== Before you begin
Expand Down Expand Up @@ -114,18 +114,16 @@ image::images/canvas-timefilter-element.png[Image showing Canvas workpad with fi

To see how the data changes, set the time filter to *Last 7 days*. As you change the time filter options, the elements automatically update.

Your workpad is now complete!
Your workpad is complete!

[float]
=== Next steps
=== What's next?
Now that you know the Canvas basics, you're ready to explore on your own.

Here are some things to try:

* Play with the {kibana-ref}/add-sample-data.html[sample Canvas workpads].

* Build presentations of your own live data with <<create-workpads,workpads>>.

* Learn more about <<add-canvas-elements,elements>> &mdash; the building blocks of your workpad.
* Build presentations of your own data with <<create-workpads,workpads>>.

* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive Canvas.
Binary file added docs/canvas/images/canvas-zoom-controls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 27 additions & 5 deletions docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,28 @@ 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]
|WARNING: Missing README.
|{kib-repo}blob/{branch}/src/plugins/expressions/README.md[expressions]
|This plugin provides methods which will parse & execute an expression pipeline
|<<kibana-expressions-plugin>>
|Expression pipeline is a chain of functions that *pipe* its output to the
input of the next function. Functions can be configured using arguments provided
by the user. The final output of the expression pipeline can be rendered using
one of the *renderers* registered in `expressions` plugin.
All the arguments to expression functions need to be serializable, as well as input and output.
Expression functions should try to stay 'pure'. This makes functions easy to reuse and also
make it possible to serialize the whole chain as well as output at every step of execution.
Expressions power visualizations in Dashboard and Lens, as well as, every
*element* in Canvas is backed by an expression.
This plugin provides methods which will parse & execute an *expression pipeline*
string for you, as well as a series of registries for advanced users who might
want to incorporate their own functions, types, and renderers into the service
for use in their own application.
Expand Down Expand Up @@ -177,9 +189,16 @@ so they can properly protect the data within their clusters.
which also contains the timelion APIs and backend, look at the vis_type_timelion plugin.
|{kib-repo}blob/{branch}/src/plugins/ui_actions/README.md[uiActions]
|<<uiactions-plugin>>
|An API for:
- creating custom functionality (`actions`)
- creating custom user interaction events (`triggers`)
- attaching and detaching `actions` to `triggers`.
- emitting `trigger` events
- executing `actions` attached to a given `trigger`.
- exposing a context menu for the user to choose the appropriate action when there are multiple actions attached to a single trigger.
|{kib-repo}blob/{branch}/src/plugins/url_forwarding/README.md[urlForwarding]
|This plugins contains helpers to redirect legacy URLs. It can be used to forward old URLs to their new counterparts.
Expand Down Expand Up @@ -520,5 +539,8 @@ 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]
include::{kibana-root}/x-pack/plugins/embeddable_enhanced/README.asciidoc[leveloffset=+1]

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
| [DataPublicPluginStartUi](./kibana-plugin-plugins-data-public.datapublicpluginstartui.md) | Data plugin prewired UI components |
| [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) | |
| [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) | |
| [FieldMappingSpec](./kibana-plugin-plugins-data-public.fieldmappingspec.md) | |
| [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) | |
| [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) | |
| [IFieldSubType](./kibana-plugin-plugins-data-public.ifieldsubtype.md) | |
Expand Down Expand Up @@ -108,7 +107,6 @@
| [esFilters](./kibana-plugin-plugins-data-public.esfilters.md) | |
| [esKuery](./kibana-plugin-plugins-data-public.eskuery.md) | |
| [esQuery](./kibana-plugin-plugins-data-public.esquery.md) | |
| [expandShorthand](./kibana-plugin-plugins-data-public.expandshorthand.md) | |
| [extractSearchSourceReferences](./kibana-plugin-plugins-data-public.extractsearchsourcereferences.md) | |
| [fieldFormats](./kibana-plugin-plugins-data-public.fieldformats.md) | |
| [fieldList](./kibana-plugin-plugins-data-public.fieldlist.md) | |
Expand Down Expand Up @@ -163,7 +161,6 @@
| [ISearch](./kibana-plugin-plugins-data-public.isearch.md) | |
| [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) | |
| [ISearchSource](./kibana-plugin-plugins-data-public.isearchsource.md) | search source interface |
| [MappingObject](./kibana-plugin-plugins-data-public.mappingobject.md) | |
| [MatchAllFilter](./kibana-plugin-plugins-data-public.matchallfilter.md) | |
| [ParsedInterval](./kibana-plugin-plugins-data-public.parsedinterval.md) | |
| [PhraseFilter](./kibana-plugin-plugins-data-public.phrasefilter.md) | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

```typescript
start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps): {
indexPatternsServiceFactory: (kibanaRequest: KibanaRequest) => Promise<IndexPatternsCommonService>;
indexPatternsServiceFactory: (savedObjectsClient: SavedObjectsClientContract) => Promise<IndexPatternsCommonService>;
};
```

Expand All @@ -22,6 +22,6 @@ start(core: CoreStart, { fieldFormats, logger }: IndexPatternsServiceStartDeps):
<b>Returns:</b>

`{
indexPatternsServiceFactory: (kibanaRequest: KibanaRequest) => Promise<IndexPatternsCommonService>;
indexPatternsServiceFactory: (savedObjectsClient: SavedObjectsClientContract) => Promise<IndexPatternsCommonService>;
}`

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ start(core: CoreStart): {
fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise<import("../common").FieldFormatsRegistry>;
};
indexPatterns: {
indexPatternsServiceFactory: (kibanaRequest: import("../../../core/server").KibanaRequest<unknown, unknown, unknown, any>) => Promise<import("../public").IndexPatternsService>;
indexPatternsServiceFactory: (savedObjectsClient: Pick<import("../../../core/server").SavedObjectsClient, "update" | "find" | "get" | "delete" | "errors" | "create" | "bulkCreate" | "checkConflicts" | "bulkGet" | "addToNamespaces" | "deleteFromNamespaces" | "bulkUpdate">) => Promise<import("../public").IndexPatternsService>;
};
search: ISearchStart<import("./search").IEsSearchRequest, import("./search").IEsSearchResponse<any>>;
};
Expand All @@ -31,7 +31,7 @@ start(core: CoreStart): {
fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise<import("../common").FieldFormatsRegistry>;
};
indexPatterns: {
indexPatternsServiceFactory: (kibanaRequest: import("../../../core/server").KibanaRequest<unknown, unknown, unknown, any>) => Promise<import("../public").IndexPatternsService>;
indexPatternsServiceFactory: (savedObjectsClient: Pick<import("../../../core/server").SavedObjectsClient, "update" | "find" | "get" | "delete" | "errors" | "create" | "bulkCreate" | "checkConflicts" | "bulkGet" | "addToNamespaces" | "deleteFromNamespaces" | "bulkUpdate">) => Promise<import("../public").IndexPatternsService>;
};
search: ISearchStart<import("./search").IEsSearchRequest, import("./search").IEsSearchResponse<any>>;
}`
Expand Down
12 changes: 12 additions & 0 deletions docs/development/plugins/embeddable/public/index.md
Original file line number Diff line number Diff line change
@@ -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) | |

Original file line number Diff line number Diff line change
@@ -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"
```
Original file line number Diff line number Diff line change
@@ -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"
```
Original file line number Diff line number Diff line change
@@ -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
```
Original file line number Diff line number Diff line change
@@ -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> | |

Original file line number Diff line number Diff line change
@@ -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>`

Original file line number Diff line number Diff line change
@@ -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`

Original file line number Diff line number Diff line change
@@ -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`

Loading

0 comments on commit 9f691f7

Please sign in to comment.