github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[new-platform] Explicitly define core setup types (#34817) (#35209)

Browse source 
* Explicitly define BasePathSetup type

* Explicitly define I18nSetup type

* Explicitly define InjectedMetadataSetup type

* Explicitly define FatalErrorSetup type

* Fix lint errors

* Fix BasePathSetup types

* Fix lint errors

* Clarify basePath add() docs

* Upgrade api-documenter for 'do not edit' header

* Use @link references on CoreSetup to improve doc navigation

* Add comment that links to upstream api-documenter issue

* PR Comments: make FatalErrorsService.add() private

* Revert "PR Comments: make FatalErrorsService.add() private"

This reverts commit fe9e6e62df.
This commit is contained in:
Rudolf Meijering 2019-04-17 12:01:17 +02:00 • committed by GitHub
parent b6989eb13e
commit 59a74b1851
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
146 changed files with 741 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/development/core/public/kibana-plugin-public.basepathsetup.addtopath.md Normal file
View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [BasePathSetup](./kibana-plugin-public.basepathsetup.md) &gt; [addToPath](./kibana-plugin-public.basepathsetup.addtopath.md)
## BasePathSetup.addToPath() method
Add the current basePath to a path string.
<b>Signature:</b>
```typescript
addToPath(path: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | <code>string</code> | A relative url including the leading <code>/</code>, otherwise it will be returned without modification |
<b>Returns:</b>
`string`

19
docs/development/core/public/kibana-plugin-public.basepathsetup.get.md Normal file
View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [BasePathSetup](./kibana-plugin-public.basepathsetup.md) &gt; [get](./kibana-plugin-public.basepathsetup.get.md)
## BasePathSetup.get() method
Get the basePath as defined by the server
<b>Signature:</b>
```typescript
get(): string;
```
<b>Returns:</b>
`string`
The basePath as defined by the server

16
docs/development/core/public/kibana-plugin-public.basepathsetup.md
View file

@ -1,10 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [BasePathSetup](./kibana-plugin-public.basepathsetup.md)
## BasePathSetup type
## BasePathSetup interface
Provides access to the 'server.basePath' configuration option in kibana.yml
<b>Signature:</b>
```typescript
export declare type BasePathSetup = ReturnType<BasePathService['setup']>;
export interface BasePathSetup
```
## Methods
| Method | Description |
| --- | --- |
| [addToPath(path)](./kibana-plugin-public.basepathsetup.addtopath.md) | Add the current basePath to a path string. |
| [get()](./kibana-plugin-public.basepathsetup.get.md) | Get the basePath as defined by the server |
| [removeFromPath(path)](./kibana-plugin-public.basepathsetup.removefrompath.md) | Removes basePath from the given path if the path starts with it |

24
docs/development/core/public/kibana-plugin-public.basepathsetup.removefrompath.md Normal file
View file

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [BasePathSetup](./kibana-plugin-public.basepathsetup.md) &gt; [removeFromPath](./kibana-plugin-public.basepathsetup.removefrompath.md)
## BasePathSetup.removeFromPath() method
Removes basePath from the given path if the path starts with it
<b>Signature:</b>
```typescript
removeFromPath(path: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | <code>string</code> | A relative url that starts with the basePath, which will be stripped |
<b>Returns:</b>
`string`

2
docs/development/core/public/kibana-plugin-public.capabilities.catalogue.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Capabilities](./kibana-plugin-public.capabilities.md) &gt; [catalogue](./kibana-plugin-public.capabilities.catalogue.md)
## Capabilities.catalogue property

2
docs/development/core/public/kibana-plugin-public.capabilities.management.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Capabilities](./kibana-plugin-public.capabilities.md) &gt; [management](./kibana-plugin-public.capabilities.management.md)
## Capabilities.management property

2
docs/development/core/public/kibana-plugin-public.capabilities.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Capabilities](./kibana-plugin-public.capabilities.md)
## Capabilities interface

2
docs/development/core/public/kibana-plugin-public.capabilities.navlinks.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Capabilities](./kibana-plugin-public.capabilities.md) &gt; [navLinks](./kibana-plugin-public.capabilities.navlinks.md)
## Capabilities.navLinks property

2
docs/development/core/public/kibana-plugin-public.capabilitiessetup.getcapabilities.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) &gt; [getCapabilities](./kibana-plugin-public.capabilitiessetup.getcapabilities.md)
## CapabilitiesSetup.getCapabilities property

2
docs/development/core/public/kibana-plugin-public.capabilitiessetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
## CapabilitiesSetup interface

2
docs/development/core/public/kibana-plugin-public.chromebrand.logo.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBrand](./kibana-plugin-public.chromebrand.md) &gt; [logo](./kibana-plugin-public.chromebrand.logo.md)
## ChromeBrand.logo property

2
docs/development/core/public/kibana-plugin-public.chromebrand.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBrand](./kibana-plugin-public.chromebrand.md)
## ChromeBrand interface

2
docs/development/core/public/kibana-plugin-public.chromebrand.smalllogo.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBrand](./kibana-plugin-public.chromebrand.md) &gt; [smallLogo](./kibana-plugin-public.chromebrand.smalllogo.md)
## ChromeBrand.smallLogo property

2
docs/development/core/public/kibana-plugin-public.chromebreadcrumb.data-test-subj.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [data-test-subj](./kibana-plugin-public.chromebreadcrumb.data-test-subj.md)
## ChromeBreadcrumb.data-test-subj property

2
docs/development/core/public/kibana-plugin-public.chromebreadcrumb.href.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [href](./kibana-plugin-public.chromebreadcrumb.href.md)
## ChromeBreadcrumb.href property

2
docs/development/core/public/kibana-plugin-public.chromebreadcrumb.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md)
## ChromeBreadcrumb interface

2
docs/development/core/public/kibana-plugin-public.chromebreadcrumb.text.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [text](./kibana-plugin-public.chromebreadcrumb.text.md)
## ChromeBreadcrumb.text property

2
docs/development/core/public/kibana-plugin-public.chromehelpextension.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md)
## ChromeHelpExtension type

2
docs/development/core/public/kibana-plugin-public.chromesetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeSetup](./kibana-plugin-public.chromesetup.md)
## ChromeSetup type

4
docs/development/core/public/kibana-plugin-public.coresetup.basepath.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [basePath](./kibana-plugin-public.coresetup.basepath.md)
## CoreSetup.basePath property
[BasePathSetup](./kibana-plugin-public.basepathsetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.capabilities.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [capabilities](./kibana-plugin-public.coresetup.capabilities.md)
## CoreSetup.capabilities property
[CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.chrome.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [chrome](./kibana-plugin-public.coresetup.chrome.md)
## CoreSetup.chrome property
[ChromeSetup](./kibana-plugin-public.chromesetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.fatalerrors.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md)
## CoreSetup.fatalErrors property
[FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.http.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [http](./kibana-plugin-public.coresetup.http.md)
## CoreSetup.http property
[HttpSetup](./kibana-plugin-public.httpsetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.i18n.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [i18n](./kibana-plugin-public.coresetup.i18n.md)
## CoreSetup.i18n property
[I18nSetup](./kibana-plugin-public.i18nsetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.injectedmetadata.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md)
## CoreSetup.injectedMetadata property
[InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md)
<b>Signature:</b>
```typescript

22
docs/development/core/public/kibana-plugin-public.coresetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md)
## CoreSetup interface
@ -14,14 +16,14 @@ export interface CoreSetup
| Property | Type | Description |
| --- | --- | --- |
| [basePath](./kibana-plugin-public.coresetup.basepath.md) | <code>BasePathSetup</code> | |
| [capabilities](./kibana-plugin-public.coresetup.capabilities.md) | <code>CapabilitiesSetup</code> | |
| [chrome](./kibana-plugin-public.coresetup.chrome.md) | <code>ChromeSetup</code> | |
| [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | |
| [http](./kibana-plugin-public.coresetup.http.md) | <code>HttpSetup</code> | |
| [i18n](./kibana-plugin-public.coresetup.i18n.md) | <code>I18nSetup</code> | |
| [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> | |
| [notifications](./kibana-plugin-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | |
| [overlays](./kibana-plugin-public.coresetup.overlays.md) | <code>OverlaySetup</code> | |
| [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | <code>UiSettingsSetup</code> | |
| [basePath](./kibana-plugin-public.coresetup.basepath.md) | <code>BasePathSetup</code> | [BasePathSetup](./kibana-plugin-public.basepathsetup.md) |
| [capabilities](./kibana-plugin-public.coresetup.capabilities.md) | <code>CapabilitiesSetup</code> | [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) |
| [chrome](./kibana-plugin-public.coresetup.chrome.md) | <code>ChromeSetup</code> | [ChromeSetup](./kibana-plugin-public.chromesetup.md) |
| [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) |
| [http](./kibana-plugin-public.coresetup.http.md) | <code>HttpSetup</code> | [HttpSetup](./kibana-plugin-public.httpsetup.md) |
| [i18n](./kibana-plugin-public.coresetup.i18n.md) | <code>I18nSetup</code> | [I18nSetup](./kibana-plugin-public.i18nsetup.md) |
| [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> | [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) |
| [notifications](./kibana-plugin-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) |
| [overlays](./kibana-plugin-public.coresetup.overlays.md) | <code>OverlaySetup</code> | [OverlaySetup](./kibana-plugin-public.overlaysetup.md) |
| [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | <code>UiSettingsSetup</code> | [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md) |

4
docs/development/core/public/kibana-plugin-public.coresetup.notifications.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [notifications](./kibana-plugin-public.coresetup.notifications.md)
## CoreSetup.notifications property
[NotificationsSetup](./kibana-plugin-public.notificationssetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.overlays.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [overlays](./kibana-plugin-public.coresetup.overlays.md)
## CoreSetup.overlays property
[OverlaySetup](./kibana-plugin-public.overlaysetup.md)
<b>Signature:</b>
```typescript

4
docs/development/core/public/kibana-plugin-public.coresetup.uisettings.md
View file

@ -1,7 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [uiSettings](./kibana-plugin-public.coresetup.uisettings.md)
## CoreSetup.uiSettings property
[UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md)
<b>Signature:</b>
```typescript

13
docs/development/core/public/kibana-plugin-public.fatalerrorssetup.add.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) &gt; [add](./kibana-plugin-public.fatalerrorssetup.add.md)
## FatalErrorsSetup.add property
Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error.
<b>Signature:</b>
```typescript
add: (error: string | Error, source?: string) => never;
```

13
docs/development/core/public/kibana-plugin-public.fatalerrorssetup.get$.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) &gt; [get$](./kibana-plugin-public.fatalerrorssetup.get$.md)
## FatalErrorsSetup.get$ property
An Observable that will emit whenever a fatal error is added with `add()`
<b>Signature:</b>
```typescript
get$: () => Rx.Observable<ErrorInfo>;
```

15
docs/development/core/public/kibana-plugin-public.fatalerrorssetup.md
View file

@ -1,10 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md)
## FatalErrorsSetup type
## FatalErrorsSetup interface
FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error.
<b>Signature:</b>
```typescript
export declare type FatalErrorsSetup = ReturnType<FatalErrorsService['setup']>;
export interface FatalErrorsSetup
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [add](./kibana-plugin-public.fatalerrorssetup.add.md) | <code>(error: string &#124; Error, source?: string) =&gt; never</code> | Add a new fatal error. This will stop the Kibana Public Core and display a fatal error screen with details about the Kibana build and the error. |
| [get$](./kibana-plugin-public.fatalerrorssetup.get$.md) | <code>() =&gt; Rx.Observable&lt;ErrorInfo&gt;</code> | An Observable that will emit whenever a fatal error is added with <code>add()</code> |

2
docs/development/core/public/kibana-plugin-public.flyoutref.close.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FlyoutRef](./kibana-plugin-public.flyoutref.md) &gt; [close](./kibana-plugin-public.flyoutref.close.md)
## FlyoutRef.close() method

2
docs/development/core/public/kibana-plugin-public.flyoutref.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FlyoutRef](./kibana-plugin-public.flyoutref.md)
## FlyoutRef class

2
docs/development/core/public/kibana-plugin-public.flyoutref.onclose.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FlyoutRef](./kibana-plugin-public.flyoutref.md) &gt; [onClose](./kibana-plugin-public.flyoutref.onclose.md)
## FlyoutRef.onClose property

2
docs/development/core/public/kibana-plugin-public.httpsetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpSetup](./kibana-plugin-public.httpsetup.md)
## HttpSetup type

15
docs/development/core/public/kibana-plugin-public.i18nsetup.context.md Normal file
View file

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [I18nSetup](./kibana-plugin-public.i18nsetup.md) &gt; [Context](./kibana-plugin-public.i18nsetup.context.md)
## I18nSetup.Context property
React Context provider required as the topmost component for any i18n-compatible React tree.
<b>Signature:</b>
```typescript
Context: ({ children }: {
children: React.ReactNode;
}) => JSX.Element;
```

14
docs/development/core/public/kibana-plugin-public.i18nsetup.md
View file

@ -1,10 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [I18nSetup](./kibana-plugin-public.i18nsetup.md)
## I18nSetup type
## I18nSetup interface
I18nSetup.Context is required by any localizable React component from @<!-- -->kbn/i18n and @<!-- -->elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree.
<b>Signature:</b>
```typescript
export declare type I18nSetup = ReturnType<I18nService['setup']>;
export interface I18nSetup
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [Context](./kibana-plugin-public.i18nsetup.context.md) | <code>({ children }: {`<p/>` children: React.ReactNode;`<p/>` }) =&gt; JSX.Element</code> | React Context provider required as the topmost component for any i18n-compatible React tree. |

11
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getbasepath.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getBasePath](./kibana-plugin-public.injectedmetadatasetup.getbasepath.md)
## InjectedMetadataSetup.getBasePath property
<b>Signature:</b>
```typescript
getBasePath: () => string;
```

13
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getcspconfig.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getCspConfig](./kibana-plugin-public.injectedmetadatasetup.getcspconfig.md)
## InjectedMetadataSetup.getCspConfig property
<b>Signature:</b>
```typescript
getCspConfig: () => {
warnLegacyBrowsers: boolean;
};
```

11
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getinjectedvar.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getInjectedVar](./kibana-plugin-public.injectedmetadatasetup.getinjectedvar.md)
## InjectedMetadataSetup.getInjectedVar property
<b>Signature:</b>
```typescript
getInjectedVar: (name: string, defaultValue?: any) => unknown;
```

13
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getinjectedvars.md Normal file
View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getInjectedVars](./kibana-plugin-public.injectedmetadatasetup.getinjectedvars.md)
## InjectedMetadataSetup.getInjectedVars property
<b>Signature:</b>
```typescript
getInjectedVars: () => {
[key: string]: unknown;
};
```

11
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getkibanaversion.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getKibanaVersion](./kibana-plugin-public.injectedmetadatasetup.getkibanaversion.md)
## InjectedMetadataSetup.getKibanaVersion property
<b>Signature:</b>
```typescript
getKibanaVersion: () => string;
```

27
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getlegacymetadata.md Normal file
View file

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getLegacyMetadata](./kibana-plugin-public.injectedmetadatasetup.getlegacymetadata.md)
## InjectedMetadataSetup.getLegacyMetadata property
<b>Signature:</b>
```typescript
getLegacyMetadata: () => {
app: unknown;
translations: unknown;
bundleId: string;
nav: unknown;
version: string;
branch: string;
buildNum: number;
buildSha: string;
basePath: string;
serverName: string;
devMode: boolean;
uiSettings: {
defaults: UiSettingsState;
user?: UiSettingsState | undefined;
};
};
```

16
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.getplugins.md Normal file
View file

@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) &gt; [getPlugins](./kibana-plugin-public.injectedmetadatasetup.getplugins.md)
## InjectedMetadataSetup.getPlugins property
An array of frontend plugins in topological order.
<b>Signature:</b>
```typescript
getPlugins: () => Array<{
id: string;
plugin: DiscoveredPlugin;
}>;
```

20
docs/development/core/public/kibana-plugin-public.injectedmetadatasetup.md
View file

@ -1,10 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md)
## InjectedMetadataSetup type
## InjectedMetadataSetup interface
Provides access to the metadata injected by the server into the page
<b>Signature:</b>
```typescript
export declare type InjectedMetadataSetup = ReturnType<InjectedMetadataService['setup']>;
export interface InjectedMetadataSetup
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [getBasePath](./kibana-plugin-public.injectedmetadatasetup.getbasepath.md) | <code>() =&gt; string</code> | |
| [getCspConfig](./kibana-plugin-public.injectedmetadatasetup.getcspconfig.md) | <code>() =&gt; {`<p/>` warnLegacyBrowsers: boolean;`<p/>` }</code> | |
| [getInjectedVar](./kibana-plugin-public.injectedmetadatasetup.getinjectedvar.md) | <code>(name: string, defaultValue?: any) =&gt; unknown</code> | |
| [getInjectedVars](./kibana-plugin-public.injectedmetadatasetup.getinjectedvars.md) | <code>() =&gt; {`<p/>` [key: string]: unknown;`<p/>` }</code> | |
| [getKibanaVersion](./kibana-plugin-public.injectedmetadatasetup.getkibanaversion.md) | <code>() =&gt; string</code> | |
| [getLegacyMetadata](./kibana-plugin-public.injectedmetadatasetup.getlegacymetadata.md) | <code>() =&gt; {`<p/>` app: unknown;`<p/>` translations: unknown;`<p/>` bundleId: string;`<p/>` nav: unknown;`<p/>` version: string;`<p/>` branch: string;`<p/>` buildNum: number;`<p/>` buildSha: string;`<p/>` basePath: string;`<p/>` serverName: string;`<p/>` devMode: boolean;`<p/>` uiSettings: {`<p/>` defaults: UiSettingsState;`<p/>` user?: UiSettingsState &#124; undefined;`<p/>` };`<p/>` }</code> | |
| [getPlugins](./kibana-plugin-public.injectedmetadatasetup.getplugins.md) | <code>() =&gt; Array&lt;{`<p/>` id: string;`<p/>` plugin: DiscoveredPlugin;`<p/>` }&gt;</code> | An array of frontend plugins in topological order. |

10
docs/development/core/public/kibana-plugin-public.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md)
## kibana-plugin-public package
@ -14,11 +16,15 @@
| Interface | Description |
| --- | --- |
| [BasePathSetup](./kibana-plugin-public.basepathsetup.md) | Provides access to the 'server.basePath' configuration option in kibana.yml |
| [Capabilities](./kibana-plugin-public.capabilities.md) | The read-only set of capabilities available for the current UI session. Capabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID, and the boolean is a flag indicating if the capability is enabled or disabled. |
| [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) | Capabilities Setup. |
| [ChromeBrand](./kibana-plugin-public.chromebrand.md) | |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the start lifecycle |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
| [I18nSetup](./kibana-plugin-public.i18nsetup.md) | I18nSetup.Context is required by any localizable React component from @<!-- -->kbn/i18n and @<!-- -->elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. |
| [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) | Provides access to the metadata injected by the server into the page |
| [OverlaySetup](./kibana-plugin-public.overlaysetup.md) | |
| [Plugin](./kibana-plugin-public.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
| [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md) | The available core services passed to a <code>PluginInitializer</code> |
@ -29,13 +35,9 @@
| Type Alias | Description |
| --- | --- |
| [BasePathSetup](./kibana-plugin-public.basepathsetup.md) | |
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeSetup](./kibana-plugin-public.chromesetup.md) | |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | |
| [HttpSetup](./kibana-plugin-public.httpsetup.md) | |
| [I18nSetup](./kibana-plugin-public.i18nsetup.md) | |
| [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) | |
| [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) | |
| [PluginInitializer](./kibana-plugin-public.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>public</code> directory should conform to this interface. |
| [ToastInput](./kibana-plugin-public.toastinput.md) | |

2
docs/development/core/public/kibana-plugin-public.notificationssetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [NotificationsSetup](./kibana-plugin-public.notificationssetup.md)
## NotificationsSetup type

2
docs/development/core/public/kibana-plugin-public.overlaysetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [OverlaySetup](./kibana-plugin-public.overlaysetup.md)
## OverlaySetup interface

2
docs/development/core/public/kibana-plugin-public.overlaysetup.openflyout.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [OverlaySetup](./kibana-plugin-public.overlaysetup.md) &gt; [openFlyout](./kibana-plugin-public.overlaysetup.openflyout.md)
## OverlaySetup.openFlyout property

2
docs/development/core/public/kibana-plugin-public.plugin.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Plugin](./kibana-plugin-public.plugin.md)
## Plugin interface

2
docs/development/core/public/kibana-plugin-public.plugin.setup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Plugin](./kibana-plugin-public.plugin.md) &gt; [setup](./kibana-plugin-public.plugin.setup.md)
## Plugin.setup property

2
docs/development/core/public/kibana-plugin-public.plugin.stop.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [Plugin](./kibana-plugin-public.plugin.md) &gt; [stop](./kibana-plugin-public.plugin.stop.md)
## Plugin.stop property

2
docs/development/core/public/kibana-plugin-public.plugininitializer.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginInitializer](./kibana-plugin-public.plugininitializer.md)
## PluginInitializer type

2
docs/development/core/public/kibana-plugin-public.plugininitializercontext.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md)
## PluginInitializerContext interface

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.basepath.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) &gt; [basePath](./kibana-plugin-public.pluginsetupcontext.basepath.md)
## PluginSetupContext.basePath property

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.chrome.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) &gt; [chrome](./kibana-plugin-public.pluginsetupcontext.chrome.md)
## PluginSetupContext.chrome property

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.fatalerrors.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) &gt; [fatalErrors](./kibana-plugin-public.pluginsetupcontext.fatalerrors.md)
## PluginSetupContext.fatalErrors property

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.i18n.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) &gt; [i18n](./kibana-plugin-public.pluginsetupcontext.i18n.md)
## PluginSetupContext.i18n property

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md)
## PluginSetupContext interface

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.notifications.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) &gt; [notifications](./kibana-plugin-public.pluginsetupcontext.notifications.md)
## PluginSetupContext.notifications property

2
docs/development/core/public/kibana-plugin-public.pluginsetupcontext.uisettings.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) &gt; [uiSettings](./kibana-plugin-public.pluginsetupcontext.uisettings.md)
## PluginSetupContext.uiSettings property

2
docs/development/core/public/kibana-plugin-public.toastinput.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastInput](./kibana-plugin-public.toastinput.md)
## ToastInput type

2
docs/development/core/public/kibana-plugin-public.toastssetup.add.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [add](./kibana-plugin-public.toastssetup.add.md)
## ToastsSetup.add() method

2
docs/development/core/public/kibana-plugin-public.toastssetup.adddanger.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addDanger](./kibana-plugin-public.toastssetup.adddanger.md)
## ToastsSetup.addDanger() method

2
docs/development/core/public/kibana-plugin-public.toastssetup.addsuccess.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addSuccess](./kibana-plugin-public.toastssetup.addsuccess.md)
## ToastsSetup.addSuccess() method

2
docs/development/core/public/kibana-plugin-public.toastssetup.addwarning.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addWarning](./kibana-plugin-public.toastssetup.addwarning.md)
## ToastsSetup.addWarning() method

2
docs/development/core/public/kibana-plugin-public.toastssetup.get$.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [get$](./kibana-plugin-public.toastssetup.get$.md)
## ToastsSetup.get$() method

2
docs/development/core/public/kibana-plugin-public.toastssetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md)
## ToastsSetup class

2
docs/development/core/public/kibana-plugin-public.toastssetup.remove.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [remove](./kibana-plugin-public.toastssetup.remove.md)
## ToastsSetup.remove() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.get$.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [get$](./kibana-plugin-public.uisettingsclient.get$.md)
## UiSettingsClient.get$() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.get.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [get](./kibana-plugin-public.uisettingsclient.get.md)
## UiSettingsClient.get() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.getall.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getAll](./kibana-plugin-public.uisettingsclient.getall.md)
## UiSettingsClient.getAll() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.getsaved$.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getSaved$](./kibana-plugin-public.uisettingsclient.getsaved$.md)
## UiSettingsClient.getSaved$() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.getupdate$.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [getUpdate$](./kibana-plugin-public.uisettingsclient.getupdate$.md)
## UiSettingsClient.getUpdate$() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.iscustom.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [isCustom](./kibana-plugin-public.uisettingsclient.iscustom.md)
## UiSettingsClient.isCustom() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.isdeclared.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [isDeclared](./kibana-plugin-public.uisettingsclient.isdeclared.md)
## UiSettingsClient.isDeclared() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.isdefault.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [isDefault](./kibana-plugin-public.uisettingsclient.isdefault.md)
## UiSettingsClient.isDefault() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.isoverridden.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [isOverridden](./kibana-plugin-public.uisettingsclient.isoverridden.md)
## UiSettingsClient.isOverridden() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md)
## UiSettingsClient class

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.overridelocaldefault.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [overrideLocalDefault](./kibana-plugin-public.uisettingsclient.overridelocaldefault.md)
## UiSettingsClient.overrideLocalDefault() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.params.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [params](./kibana-plugin-public.uisettingsclient.params.md)
## UiSettingsClient.params property

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.remove.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [remove](./kibana-plugin-public.uisettingsclient.remove.md)
## UiSettingsClient.remove() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.set.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [set](./kibana-plugin-public.uisettingsclient.set.md)
## UiSettingsClient.set() method

2
docs/development/core/public/kibana-plugin-public.uisettingsclient.stop.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) &gt; [stop](./kibana-plugin-public.uisettingsclient.stop.md)
## UiSettingsClient.stop() method

2
docs/development/core/public/kibana-plugin-public.uisettingssetup.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md)
## UiSettingsSetup type

2
docs/development/core/public/kibana-plugin-public.uisettingsstate.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [UiSettingsState](./kibana-plugin-public.uisettingsstate.md)
## UiSettingsState interface

2
docs/development/core/server/kibana-plugin-server.apicaller.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [APICaller](./kibana-plugin-server.apicaller.md)
## APICaller type

2
docs/development/core/server/kibana-plugin-server.callapioptions.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CallAPIOptions](./kibana-plugin-server.callapioptions.md)
## CallAPIOptions interface

2
docs/development/core/server/kibana-plugin-server.callapioptions.wrap401errors.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CallAPIOptions](./kibana-plugin-server.callapioptions.md) &gt; [wrap401Errors](./kibana-plugin-server.callapioptions.wrap401errors.md)
## CallAPIOptions.wrap401Errors property

2
docs/development/core/server/kibana-plugin-server.clusterclient.asscoped.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [asScoped](./kibana-plugin-server.clusterclient.asscoped.md)
## ClusterClient.asScoped() method

2
docs/development/core/server/kibana-plugin-server.clusterclient.callasinternaluser.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md)
## ClusterClient.callAsInternalUser property

2
docs/development/core/server/kibana-plugin-server.clusterclient.close.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md) &gt; [close](./kibana-plugin-server.clusterclient.close.md)
## ClusterClient.close() method

2
docs/development/core/server/kibana-plugin-server.clusterclient.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ClusterClient](./kibana-plugin-server.clusterclient.md)
## ClusterClient class

2
docs/development/core/server/kibana-plugin-server.configservice.atpath.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [atPath](./kibana-plugin-server.configservice.atpath.md)
## ConfigService.atPath() method

2
docs/development/core/server/kibana-plugin-server.configservice.getconfig$.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [getConfig$](./kibana-plugin-server.configservice.getconfig$.md)
## ConfigService.getConfig$() method

2
docs/development/core/server/kibana-plugin-server.configservice.getunusedpaths.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [getUnusedPaths](./kibana-plugin-server.configservice.getunusedpaths.md)
## ConfigService.getUnusedPaths() method

2
docs/development/core/server/kibana-plugin-server.configservice.getusedpaths.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [getUsedPaths](./kibana-plugin-server.configservice.getusedpaths.md)
## ConfigService.getUsedPaths() method

2
docs/development/core/server/kibana-plugin-server.configservice.isenabledatpath.md
View file

@ -1,3 +1,5 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ConfigService](./kibana-plugin-server.configservice.md) &gt; [isEnabledAtPath](./kibana-plugin-server.configservice.isenabledatpath.md)
## ConfigService.isEnabledAtPath() method

Some files were not shown because too many files have changed in this diff Show more