mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
Use @link references on CoreSetup to improve doc navigation
This commit is contained in:
Rudolf Meijering
parent
b2ea641b56
commit
cb0818b805
28 changed files with 73 additions and 11 deletions
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.basePath property
|
||||
|
||||
[BasePathSetup](./kibana-plugin-public.basepathsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.capabilities property
|
||||
|
||||
[CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.chrome property
|
||||
|
||||
[ChromeSetup](./kibana-plugin-public.chromesetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.fatalErrors property
|
||||
|
||||
[FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.http property
|
||||
|
||||
[HttpSetup](./kibana-plugin-public.httpsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.i18n property
|
||||
|
||||
[I18nSetup](./kibana-plugin-public.i18nsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.injectedMetadata property
|
||||
|
||||
[InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -16,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,6 +4,8 @@
|
|||
|
||||
## CoreSetup.notifications property
|
||||
|
||||
[NotificationsSetup](./kibana-plugin-public.notificationssetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.overlays property
|
||||
|
||||
[OverlaySetup](./kibana-plugin-public.overlaysetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
## CoreSetup.uiSettings property
|
||||
|
||||
[UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md) > [atPath](./kibana-plugin-server.configservice.atpath.md)
|
||||
|
||||
## ConfigService.atPath() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md) > [getConfig$](./kibana-plugin-server.configservice.getconfig$.md)
|
||||
|
||||
## ConfigService.getConfig$() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md) > [getUnusedPaths](./kibana-plugin-server.configservice.getunusedpaths.md)
|
||||
|
||||
## ConfigService.getUnusedPaths() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md) > [getUsedPaths](./kibana-plugin-server.configservice.getusedpaths.md)
|
||||
|
||||
## ConfigService.getUsedPaths() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md) > [isEnabledAtPath](./kibana-plugin-server.configservice.isenabledatpath.md)
|
||||
|
||||
## ConfigService.isEnabledAtPath() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md)
|
||||
|
||||
## ConfigService class
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ConfigService](./kibana-plugin-server.configservice.md) > [optionalAtPath](./kibana-plugin-server.configservice.optionalatpath.md)
|
||||
|
||||
## ConfigService.optionalAtPath() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) > [adminClient$](./kibana-plugin-server.elasticsearchservicesetup.adminclient$.md)
|
||||
|
||||
## ElasticsearchServiceSetup.adminClient$ property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) > [createClient](./kibana-plugin-server.elasticsearchservicesetup.createclient.md)
|
||||
|
||||
## ElasticsearchServiceSetup.createClient property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) > [dataClient$](./kibana-plugin-server.elasticsearchservicesetup.dataclient$.md)
|
||||
|
||||
## ElasticsearchServiceSetup.dataClient$ property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) > [legacy](./kibana-plugin-server.elasticsearchservicesetup.legacy.md)
|
||||
|
||||
## ElasticsearchServiceSetup.legacy property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md)
|
||||
|
||||
## ElasticsearchServiceSetup interface
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Plugin](./kibana-plugin-server.plugin.md)
|
||||
|
||||
## Plugin interface
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Plugin](./kibana-plugin-server.plugin.md) > [setup](./kibana-plugin-server.plugin.setup.md)
|
||||
|
||||
## Plugin.setup property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Plugin](./kibana-plugin-server.plugin.md) > [stop](./kibana-plugin-server.plugin.stop.md)
|
||||
|
||||
## Plugin.stop property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [PluginInitializer](./kibana-plugin-server.plugininitializer.md)
|
||||
|
||||
## PluginInitializer type
|
||||
|
|
|
|||
|
|
@ -37,15 +37,25 @@ export { CoreContext, CoreSystem } from './core_system';
|
|||
* @public
|
||||
*/
|
||||
export interface CoreSetup {
|
||||
/** {@link I18nSetup} */
|
||||
i18n: I18nSetup;
|
||||
/** {@link InjectedMetadataSetup} */
|
||||
injectedMetadata: InjectedMetadataSetup;
|
||||
/** {@link FatalErrorsSetup} */
|
||||
fatalErrors: FatalErrorsSetup;
|
||||
/** {@link NotificationsSetup} */
|
||||
notifications: NotificationsSetup;
|
||||
/** {@link HttpSetup} */
|
||||
http: HttpSetup;
|
||||
/** {@link BasePathSetup} */
|
||||
basePath: BasePathSetup;
|
||||
/** {@link CapabilitiesSetup} */
|
||||
capabilities: CapabilitiesSetup;
|
||||
/** {@link UiSettingsSetup} */
|
||||
uiSettings: UiSettingsSetup;
|
||||
/** {@link ChromeSetup} */
|
||||
chrome: ChromeSetup;
|
||||
/** {@link OverlaySetup} */
|
||||
overlays: OverlaySetup;
|
||||
}
|
||||
|
||||
|
|
@ -53,13 +63,13 @@ export {
|
|||
BasePathSetup,
|
||||
HttpSetup,
|
||||
FatalErrorsSetup,
|
||||
I18nSetup,
|
||||
CapabilitiesSetup,
|
||||
Capabilities,
|
||||
ChromeSetup,
|
||||
ChromeBreadcrumb,
|
||||
ChromeBrand,
|
||||
ChromeHelpExtension,
|
||||
I18nSetup,
|
||||
InjectedMetadataSetup,
|
||||
InjectedMetadataParams,
|
||||
Plugin,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue