11 KiB
11 KiB
kibana-plugin-public package
The Kibana Core APIs for client-side plugins.
A plugin's public/index file must contain a named import, plugin, that implements PluginInitializer which returns an object that implements Plugin.
The plugin integrates with the core system via lifecycle events: setup, start, and stop. In each lifecycle method, the plugin will receive the corresponding core services available (either CoreSetup or CoreStart) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked.
Classes
| Class | Description |
|---|---|
| SavedObjectsClient | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state. The client-side SavedObjectsClient is a thin convenience library around the SavedObjects HTTP API for interacting with Saved Objects. |
| SimpleSavedObject | This class is a very simple wrapper for SavedObjects loaded from the server with the SavedObjectsClient.It provides basic functionality for creating/saving/deleting saved objects, but doesn't include any type-specific implementations. |
| ToastsApi | |
| UiSettingsClient |
Interfaces
| Interface | Description |
|---|---|
| App | Extension of common app properties with the mount function. |
| AppBase | |
| ApplicationSetup | |
| ApplicationStart | |
| AppMountContext | The context object received when applications are mounted to the DOM. |
| AppMountParameters | |
| Capabilities | 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. |
| ChromeBadge | |
| ChromeBrand | |
| ChromeBreadcrumb | |
| ChromeNavControl | |
| ChromeNavControls | APIs for registering new controls to be displayed in the navigation bar. |
| ChromeNavLink | |
| ChromeNavLinks | APIs for manipulating nav links. |
| ChromeRecentlyAccessed | APIs for recently accessed history. |
| ChromeRecentlyAccessedHistoryItem | |
| ChromeStart | ChromeStart allows plugins to customize the global chrome header UI and enrich the UX with additional information about the current location of the browser. |
| ContextSetup | An object that handles registration of context providers and configuring handlers with context. |
| CoreSetup | Core services exposed to the Plugin setup lifecycle |
| CoreStart | Core services exposed to the Plugin start lifecycle |
| DocLinksStart | |
| ErrorToastOptions | |
| FatalErrorInfo | Represents the message and stack of a fatal Error |
| FatalErrorsSetup | FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
| HttpErrorRequest | |
| HttpErrorResponse | |
| HttpFetchOptions | |
| HttpFetchQuery | |
| HttpHeadersInit | |
| HttpInterceptor | |
| HttpRequestInit | |
| HttpResponse | |
| HttpServiceBase | |
| I18nStart | I18nStart.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. |
| IContextContainer | An object that handles registration of context providers and configuring handlers with context. |
| LegacyCoreSetup | Setup interface exposed to the legacy platform via the ui/new_platform module. |
| LegacyCoreStart | Start interface exposed to the legacy platform via the ui/new_platform module. |
| LegacyNavLink | |
| NotificationsSetup | |
| NotificationsStart | |
| OverlayBannersStart | |
| OverlayRef | |
| OverlayStart | |
| Plugin | The interface that should be returned by a PluginInitializer. |
| PluginInitializerContext | The available core services passed to a PluginInitializer |
| SavedObject | |
| SavedObjectAttributes | The data for a Saved Object is stored in the attributes key as either an object or an array of objects. |
| SavedObjectReference | A reference to another saved object. |
| SavedObjectsBaseOptions | |
| SavedObjectsBatchResponse | |
| SavedObjectsBulkCreateObject | |
| SavedObjectsBulkCreateOptions | |
| SavedObjectsCreateOptions | |
| SavedObjectsFindOptions | |
| SavedObjectsFindResponsePublic | Return type of the Saved Objects find() method.*Note*: this type is different between the Public and Server Saved Objects clients. |
| SavedObjectsMigrationVersion | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
| SavedObjectsStart | |
| SavedObjectsUpdateOptions | |
| UiSettingsState |
Type Aliases
| Type Alias | Description |
|---|---|
| AppUnmount | A function called when an application should be unmounted from the page. This function should be synchronous. |
| ChromeHelpExtension | |
| ChromeNavLinkUpdateableFields | |
| HttpBody | |
| HttpHandler | |
| HttpSetup | |
| HttpStart | |
| IContextHandler | A function registered by a plugin to perform some action. |
| IContextProvider | A function that returns a context value for a specific key of given context type. |
| OverlayBannerMount | A function that will mount the banner inside the provided element. |
| OverlayBannerUnmount | A function that will unmount the banner from the element. |
| PluginInitializer | The plugin export at the root of a plugin's public directory should conform to this interface. |
| PluginOpaqueId | |
| RecursiveReadonly | |
| SavedObjectAttribute | |
| SavedObjectsClientContract | SavedObjectsClientContract as implemented by the SavedObjectsClient |
| ToastInput | |
| UiSettingsClientContract | UiSettingsClient |