Skip to content

Commit

Permalink
Merge branch 'master' into alerts/license-checks
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Dec 14, 2020
2 parents 04584bc + 3f7f0be commit 76b4f17
Show file tree
Hide file tree
Showing 595 changed files with 21,589 additions and 5,594 deletions.
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) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md)

## ChromeHelpExtensionLinkBase type


<b>Signature:</b>

```typescript
export declare type ChromeHelpExtensionLinkBase = Pick<EuiButtonEmptyProps, 'iconType' | 'target' | 'rel' | 'data-test-subj'>;
```
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) &gt; [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md)

## ChromeHelpExtensionMenuCustomLink.content property

Content of the button (in lieu of `children`<!-- -->)

<b>Signature:</b>

```typescript
content: React.ReactNode;
```
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) &gt; [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md)

## ChromeHelpExtensionMenuCustomLink.href property

URL of the link

<b>Signature:</b>

```typescript
href: string;
```
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) &gt; [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md)

## ChromeHelpExtensionMenuCustomLink.linkType property

Extend EuiButtonEmpty to provide extra functionality

<b>Signature:</b>

```typescript
linkType: 'custom';
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,20 @@

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md)

## ChromeHelpExtensionMenuCustomLink type
## ChromeHelpExtensionMenuCustomLink interface


<b>Signature:</b>

```typescript
export declare type ChromeHelpExtensionMenuCustomLink = EuiButtonEmptyProps & {
linkType: 'custom';
content: React.ReactNode;
};
export interface ChromeHelpExtensionMenuCustomLink extends ChromeHelpExtensionLinkBase
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [content](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.content.md) | <code>React.ReactNode</code> | Content of the button (in lieu of <code>children</code>) |
| [href](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.href.md) | <code>string</code> | URL of the link |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.linktype.md) | <code>'custom'</code> | Extend EuiButtonEmpty to provide extra functionality |
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) &gt; [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md)

## ChromeHelpExtensionMenuDiscussLink.href property

URL to discuss page. i.e. `https://discuss.elastic.co/c/${appName}`

<b>Signature:</b>

```typescript
href: string;
```
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) &gt; [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md)

## ChromeHelpExtensionMenuDiscussLink.linkType property

Creates a generic give feedback link with comment icon

<b>Signature:</b>

```typescript
linkType: 'discuss';
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md)

## ChromeHelpExtensionMenuDiscussLink type
## ChromeHelpExtensionMenuDiscussLink interface


<b>Signature:</b>

```typescript
export declare type ChromeHelpExtensionMenuDiscussLink = EuiButtonEmptyProps & {
linkType: 'discuss';
href: string;
};
export interface ChromeHelpExtensionMenuDiscussLink extends ChromeHelpExtensionLinkBase
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [href](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.href.md) | <code>string</code> | URL to discuss page. i.e. <code>https://discuss.elastic.co/c/${appName}</code> |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.linktype.md) | <code>'discuss'</code> | Creates a generic give feedback link with comment icon |
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) &gt; [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md)

## ChromeHelpExtensionMenuDocumentationLink.href property

URL to documentation page. i.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`<!-- -->,

<b>Signature:</b>

```typescript
href: string;
```
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) &gt; [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md)

## ChromeHelpExtensionMenuDocumentationLink.linkType property

Creates a deep-link to app-specific documentation

<b>Signature:</b>

```typescript
linkType: 'documentation';
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md)

## ChromeHelpExtensionMenuDocumentationLink type
## ChromeHelpExtensionMenuDocumentationLink interface


<b>Signature:</b>

```typescript
export declare type ChromeHelpExtensionMenuDocumentationLink = EuiButtonEmptyProps & {
linkType: 'documentation';
href: string;
};
export interface ChromeHelpExtensionMenuDocumentationLink extends ChromeHelpExtensionLinkBase
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [href](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.href.md) | <code>string</code> | URL to documentation page. i.e. <code>${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html</code>, |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.linktype.md) | <code>'documentation'</code> | Creates a deep-link to app-specific documentation |
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) &gt; [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md)

## ChromeHelpExtensionMenuGitHubLink.labels property

Include at least one app-specific label to be applied to the new github issue

<b>Signature:</b>

```typescript
labels: string[];
```
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) &gt; [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md)

## ChromeHelpExtensionMenuGitHubLink.linkType property

Creates a link to a new github issue in the Kibana repo

<b>Signature:</b>

```typescript
linkType: 'github';
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md)

## ChromeHelpExtensionMenuGitHubLink type
## ChromeHelpExtensionMenuGitHubLink interface


<b>Signature:</b>

```typescript
export declare type ChromeHelpExtensionMenuGitHubLink = EuiButtonEmptyProps & {
linkType: 'github';
labels: string[];
title?: string;
};
export interface ChromeHelpExtensionMenuGitHubLink extends ChromeHelpExtensionLinkBase
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [labels](./kibana-plugin-core-public.chromehelpextensionmenugithublink.labels.md) | <code>string[]</code> | Include at least one app-specific label to be applied to the new github issue |
| [linkType](./kibana-plugin-core-public.chromehelpextensionmenugithublink.linktype.md) | <code>'github'</code> | Creates a link to a new github issue in the Kibana repo |
| [title](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md) | <code>string</code> | Provides initial text for the title of the issue |
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-core-public](./kibana-plugin-core-public.md) &gt; [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) &gt; [title](./kibana-plugin-core-public.chromehelpextensionmenugithublink.title.md)

## ChromeHelpExtensionMenuGitHubLink.title property

Provides initial text for the title of the issue

<b>Signature:</b>

```typescript
title?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
<b>Signature:</b>

```typescript
export declare type ChromeHelpExtensionMenuLink = ExclusiveUnion<ChromeHelpExtensionMenuGitHubLink, ExclusiveUnion<ChromeHelpExtensionMenuDiscussLink, ExclusiveUnion<ChromeHelpExtensionMenuDocumentationLink, ChromeHelpExtensionMenuCustomLink>>>;
export declare type ChromeHelpExtensionMenuLink = ChromeHelpExtensionMenuGitHubLink | ChromeHelpExtensionMenuDiscussLink | ChromeHelpExtensionMenuDocumentationLink | ChromeHelpExtensionMenuCustomLink;
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## IExternalUrlPolicy.host property

Optional host describing the external destination. May be combined with `protocol`<!-- -->. Required if `protocol` is not defined.
Optional host describing the external destination. May be combined with `protocol`<!-- -->.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ export interface IExternalUrlPolicy
| Property | Type | Description |
| --- | --- | --- |
| [allow](./kibana-plugin-core-public.iexternalurlpolicy.allow.md) | <code>boolean</code> | Indicates if this policy allows or denies access to the described destination. |
| [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | <code>string</code> | Optional host describing the external destination. May be combined with <code>protocol</code>. Required if <code>protocol</code> is not defined. |
| [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | <code>string</code> | Optional protocol describing the external destination. May be combined with <code>host</code>. Required if <code>host</code> is not defined. |
| [host](./kibana-plugin-core-public.iexternalurlpolicy.host.md) | <code>string</code> | Optional host describing the external destination. May be combined with <code>protocol</code>. |
| [protocol](./kibana-plugin-core-public.iexternalurlpolicy.protocol.md) | <code>string</code> | Optional protocol describing the external destination. May be combined with <code>host</code>. |

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## IExternalUrlPolicy.protocol property

Optional protocol describing the external destination. May be combined with `host`<!-- -->. Required if `host` is not defined.
Optional protocol describing the external destination. May be combined with `host`<!-- -->.

<b>Signature:</b>

Expand Down
9 changes: 5 additions & 4 deletions docs/development/core/public/kibana-plugin-core-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ChromeBrand](./kibana-plugin-core-public.chromebrand.md) | |
| [ChromeDocTitle](./kibana-plugin-core-public.chromedoctitle.md) | APIs for accessing and updating the document title. |
| [ChromeHelpExtension](./kibana-plugin-core-public.chromehelpextension.md) | |
| [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) | |
| [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) | |
| [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) | |
| [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) | |
| [ChromeNavControl](./kibana-plugin-core-public.chromenavcontrol.md) | |
| [ChromeNavControls](./kibana-plugin-core-public.chromenavcontrols.md) | [APIs](./kibana-plugin-core-public.chromenavcontrols.md) for registering new controls to be displayed in the navigation bar. |
| [ChromeNavLink](./kibana-plugin-core-public.chromenavlink.md) | |
Expand Down Expand Up @@ -145,10 +149,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [AppUpdatableFields](./kibana-plugin-core-public.appupdatablefields.md) | Defines the list of fields that can be updated via an [AppUpdater](./kibana-plugin-core-public.appupdater.md)<!-- -->. |
| [AppUpdater](./kibana-plugin-core-public.appupdater.md) | Updater for applications. see [ApplicationSetup](./kibana-plugin-core-public.applicationsetup.md) |
| [ChromeBreadcrumb](./kibana-plugin-core-public.chromebreadcrumb.md) | |
| [ChromeHelpExtensionMenuCustomLink](./kibana-plugin-core-public.chromehelpextensionmenucustomlink.md) | |
| [ChromeHelpExtensionMenuDiscussLink](./kibana-plugin-core-public.chromehelpextensionmenudiscusslink.md) | |
| [ChromeHelpExtensionMenuDocumentationLink](./kibana-plugin-core-public.chromehelpextensionmenudocumentationlink.md) | |
| [ChromeHelpExtensionMenuGitHubLink](./kibana-plugin-core-public.chromehelpextensionmenugithublink.md) | |
| [ChromeHelpExtensionLinkBase](./kibana-plugin-core-public.chromehelpextensionlinkbase.md) | |
| [ChromeHelpExtensionMenuLink](./kibana-plugin-core-public.chromehelpextensionmenulink.md) | |
| [ChromeNavLinkUpdateableFields](./kibana-plugin-core-public.chromenavlinkupdateablefields.md) | |
| [FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Embeddable.getUpdated$() method

Merges input$ and output$ streams and denounces emit till next macro-task Could be useful to batch reactions to input$ and output$ updates that happen separately but synchronously In case corresponding state change triggered `reload` this stream is guarantied to emit later which allows to skip any state handling in case `reload` already handled it
Merges input$ and output$ streams and debounces emit till next macro-task. Could be useful to batch reactions to input$ and output$ updates that happen separately but synchronously. In case corresponding state change triggered `reload` this stream is guarantied to emit later, which allows to skip any state handling in case `reload` already handled it.

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export declare abstract class Embeddable<TEmbeddableInput extends EmbeddableInpu
| [getOutput$()](./kibana-plugin-plugins-embeddable-public.embeddable.getoutput_.md) | | |
| [getRoot()](./kibana-plugin-plugins-embeddable-public.embeddable.getroot.md) | | Returns the top most parent embeddable, or itself if this embeddable is not within a parent. |
| [getTitle()](./kibana-plugin-plugins-embeddable-public.embeddable.gettitle.md) | | |
| [getUpdated$()](./kibana-plugin-plugins-embeddable-public.embeddable.getupdated_.md) | | Merges input$ and output$ streams and denounces emit till next macro-task Could be useful to batch reactions to input$ and output$ updates that happen separately but synchronously In case corresponding state change triggered <code>reload</code> this stream is guarantied to emit later which allows to skip any state handling in case <code>reload</code> already handled it |
| [getUpdated$()](./kibana-plugin-plugins-embeddable-public.embeddable.getupdated_.md) | | Merges input$ and output$ streams and debounces emit till next macro-task. Could be useful to batch reactions to input$ and output$ updates that happen separately but synchronously. In case corresponding state change triggered <code>reload</code> this stream is guarantied to emit later, which allows to skip any state handling in case <code>reload</code> already handled it. |
| [onFatalError(e)](./kibana-plugin-plugins-embeddable-public.embeddable.onfatalerror.md) | | |
| [reload()](./kibana-plugin-plugins-embeddable-public.embeddable.reload.md) | | Reload will be called when there is a request to refresh the data or view, even if the input data did not change.<!-- -->In case if input data did change and reload is requested input$ and output$ would still emit before <code>reload</code> is called<!-- -->The order would be as follows: input$ output$ reload() \-\-\-- updated$ |
| [render(el)](./kibana-plugin-plugins-embeddable-public.embeddable.render.md) | | |
Expand Down
Loading

0 comments on commit 76b4f17

Please sign in to comment.