mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
Merge branch 'master' into feature-secops
This commit is contained in:
FrankHassanabad
commit
6b35ff1c86
2206 changed files with 111239 additions and 27978 deletions
|
|
@ -2,6 +2,7 @@ node_modules
|
|||
bower_components
|
||||
/data
|
||||
/build
|
||||
/target
|
||||
/.es
|
||||
/plugins
|
||||
/optimize
|
||||
|
|
@ -32,5 +33,8 @@ bower_components
|
|||
/packages/kbn-interpreter/src/common/lib/grammar.js
|
||||
/x-pack/plugins/canvas/canvas_plugin
|
||||
/x-pack/plugins/canvas/canvas_plugin_src/lib/flot-charts
|
||||
/x-pack/plugins/infra/common/graphql/types.ts
|
||||
/x-pack/plugins/infra/public/graphql/types.ts
|
||||
/x-pack/plugins/infra/server/graphql/types.ts
|
||||
**/*.js.snap
|
||||
!/.eslintrc.js
|
||||
|
|
|
|||
263
.eslintrc.js
263
.eslintrc.js
|
|
@ -1,7 +1,5 @@
|
|||
const { resolve } = require('path');
|
||||
const { readdirSync } = require('fs');
|
||||
|
||||
const restrictedModules = { paths: ['gulp-util'] };
|
||||
const { resolve } = require('path');
|
||||
|
||||
const APACHE_2_0_LICENSE_HEADER = `
|
||||
/*
|
||||
|
|
@ -33,62 +31,7 @@ const ELASTIC_LICENSE_HEADER = `
|
|||
`;
|
||||
|
||||
module.exports = {
|
||||
extends: ['@elastic/eslint-config-kibana', '@elastic/eslint-config-kibana/jest'],
|
||||
plugins: ['@kbn/eslint-plugin-eslint'],
|
||||
|
||||
settings: {
|
||||
'import/resolver': {
|
||||
'@kbn/eslint-import-resolver-kibana': {
|
||||
forceNode: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
rules: {
|
||||
'no-restricted-imports': [2, restrictedModules],
|
||||
'no-restricted-modules': [2, restrictedModules],
|
||||
'@kbn/eslint/no-restricted-paths': [
|
||||
'error',
|
||||
{
|
||||
basePath: __dirname,
|
||||
zones: [
|
||||
{
|
||||
target: [
|
||||
'src/legacy/**/*',
|
||||
'x-pack/**/*',
|
||||
'!x-pack/**/*.test.*',
|
||||
'src/plugins/**/(public|server)/**/*',
|
||||
'src/core/(public|server)/**/*',
|
||||
],
|
||||
from: [
|
||||
'src/core/public/**/*',
|
||||
'!src/core/public/index*',
|
||||
'!src/core/public/utils/**/*',
|
||||
|
||||
'src/core/server/**/*',
|
||||
'!src/core/server/index*',
|
||||
|
||||
'src/plugins/**/public/**/*',
|
||||
'!src/plugins/**/public/index*',
|
||||
|
||||
'src/plugins/**/server/**/*',
|
||||
'!src/plugins/**/server/index*',
|
||||
],
|
||||
allowSameFolder: true,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
'@kbn/eslint/module_migration': [
|
||||
'error',
|
||||
[
|
||||
{
|
||||
from: 'expect.js',
|
||||
to: '@kbn/expect',
|
||||
},
|
||||
],
|
||||
],
|
||||
},
|
||||
extends: ['@elastic/eslint-config-kibana'],
|
||||
|
||||
overrides: [
|
||||
/**
|
||||
|
|
@ -112,6 +55,7 @@ module.exports = {
|
|||
'src/legacy/server/saved_objects/**/*',
|
||||
'x-pack/plugins/apm/**/*',
|
||||
'x-pack/plugins/canvas/**/*',
|
||||
'**/*.{ts,tsx}',
|
||||
],
|
||||
plugins: ['prettier'],
|
||||
rules: Object.assign(
|
||||
|
|
@ -123,11 +67,98 @@ module.exports = {
|
|||
),
|
||||
},
|
||||
|
||||
/**
|
||||
* Files that require Apache 2.0 headers, settings
|
||||
* are overridden below for files that require Elastic
|
||||
* Licence headers
|
||||
*/
|
||||
{
|
||||
files: ['**/*.{js,ts,tsx}'],
|
||||
rules: {
|
||||
'@kbn/eslint/require-license-header': [
|
||||
'error',
|
||||
{
|
||||
license: APACHE_2_0_LICENSE_HEADER,
|
||||
},
|
||||
],
|
||||
'@kbn/eslint/disallow-license-headers': [
|
||||
'error',
|
||||
{
|
||||
licenses: [ELASTIC_LICENSE_HEADER],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Files that require Elastic license headers instead of Apache 2.0 header
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/**/*.{js,ts,tsx}'],
|
||||
rules: {
|
||||
'@kbn/eslint/require-license-header': [
|
||||
'error',
|
||||
{
|
||||
license: ELASTIC_LICENSE_HEADER,
|
||||
},
|
||||
],
|
||||
'@kbn/eslint/disallow-license-headers': [
|
||||
'error',
|
||||
{
|
||||
licenses: [APACHE_2_0_LICENSE_HEADER],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Restricted paths
|
||||
*/
|
||||
{
|
||||
files: ['**/*.{js,ts,tsx}'],
|
||||
rules: {
|
||||
'@kbn/eslint/no-restricted-paths': [
|
||||
'error',
|
||||
{
|
||||
basePath: __dirname,
|
||||
zones: [
|
||||
{
|
||||
target: [
|
||||
'src/legacy/**/*',
|
||||
'x-pack/**/*',
|
||||
'!x-pack/**/*.test.*',
|
||||
'src/plugins/**/(public|server)/**/*',
|
||||
'src/core/(public|server)/**/*',
|
||||
],
|
||||
from: [
|
||||
'src/core/public/**/*',
|
||||
'!src/core/public/index.ts',
|
||||
'!src/core/public/mocks.ts',
|
||||
'!src/core/public/utils/**/*',
|
||||
|
||||
'src/core/server/**/*',
|
||||
'!src/core/server/index.ts',
|
||||
'!src/core/server/mocks.ts',
|
||||
|
||||
'src/plugins/**/public/**/*',
|
||||
'!src/plugins/**/public/index*',
|
||||
|
||||
'src/plugins/**/server/**/*',
|
||||
'!src/plugins/**/server/index*',
|
||||
],
|
||||
allowSameFolder: true,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Allow default exports
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/test/functional/apps/**/*', 'x-pack/plugins/apm/**/*'],
|
||||
files: ['x-pack/test/functional/apps/**/*.js', 'x-pack/plugins/apm/**/*.js'],
|
||||
rules: {
|
||||
'import/no-default-export': 'off',
|
||||
'import/no-named-as-default': 'off',
|
||||
|
|
@ -139,10 +170,10 @@ module.exports = {
|
|||
*/
|
||||
{
|
||||
files: [
|
||||
'**/public/**',
|
||||
'**/webpackShims/**',
|
||||
'packages/kbn-ui-framework/doc_site/src/**',
|
||||
'src/fixtures/**', // TODO: this directory needs to be more obviously "public" (or go away)
|
||||
'**/public/**/*.js',
|
||||
'**/webpackShims/**/*.js',
|
||||
'packages/kbn-ui-framework/doc_site/src/**/*.js',
|
||||
'src/fixtures/**/*.js', // TODO: this directory needs to be more obviously "public" (or go away)
|
||||
],
|
||||
settings: {
|
||||
// instructs import/no-extraneous-dependencies to treat modules
|
||||
|
|
@ -170,7 +201,11 @@ module.exports = {
|
|||
* Files that ARE NOT allowed to use devDependencies
|
||||
*/
|
||||
{
|
||||
files: ['packages/kbn-ui-framework/**/*', 'x-pack/**/*', 'packages/kbn-interpreter/**/*'],
|
||||
files: [
|
||||
'packages/kbn-ui-framework/**/*.js',
|
||||
'x-pack/**/*.js',
|
||||
'packages/kbn-interpreter/**/*.js',
|
||||
],
|
||||
rules: {
|
||||
'import/no-extraneous-dependencies': [
|
||||
'error',
|
||||
|
|
@ -188,14 +223,14 @@ module.exports = {
|
|||
{
|
||||
files: [
|
||||
'packages/kbn-ui-framework/**/*.test.js',
|
||||
'packages/kbn-ui-framework/doc_site/**/*',
|
||||
'packages/kbn-ui-framework/generator-kui/**/*',
|
||||
'packages/kbn-ui-framework/doc_site/**/*.js',
|
||||
'packages/kbn-ui-framework/generator-kui/**/*.js',
|
||||
'packages/kbn-ui-framework/Gruntfile.js',
|
||||
'packages/kbn-es/src/**/*',
|
||||
'packages/kbn-interpreter/tasks/**/*',
|
||||
'packages/kbn-interpreter/src/plugin/**/*',
|
||||
'x-pack/{dev-tools,tasks,scripts,test,build_chromium}/**/*',
|
||||
'x-pack/**/{__tests__,__test__,__jest__,__fixtures__,__mocks__}/**/*',
|
||||
'packages/kbn-es/src/**/*.js',
|
||||
'packages/kbn-interpreter/tasks/**/*.js',
|
||||
'packages/kbn-interpreter/src/plugin/**/*.js',
|
||||
'x-pack/{dev-tools,tasks,scripts,test,build_chromium}/**/*.js',
|
||||
'x-pack/**/{__tests__,__test__,__jest__,__fixtures__,__mocks__}/**/*.js',
|
||||
'x-pack/**/*.test.js',
|
||||
'x-pack/test_utils/**/*',
|
||||
'x-pack/gulpfile.js',
|
||||
|
|
@ -216,7 +251,7 @@ module.exports = {
|
|||
* Files that run BEFORE node version check
|
||||
*/
|
||||
{
|
||||
files: ['scripts/**/*', 'src/setup_node_env/**/*'],
|
||||
files: ['scripts/**/*.js', 'src/setup_node_env/**/*.js'],
|
||||
rules: {
|
||||
'import/no-commonjs': 'off',
|
||||
'prefer-object-spread/prefer-object-spread': 'off',
|
||||
|
|
@ -249,7 +284,7 @@ module.exports = {
|
|||
{
|
||||
files: [
|
||||
'test/functional/services/lib/web_element_wrapper/scroll_into_view_if_necessary.js',
|
||||
'**/browser_exec_scripts/**/*',
|
||||
'**/browser_exec_scripts/**/*.js',
|
||||
],
|
||||
rules: {
|
||||
'prefer-object-spread/prefer-object-spread': 'off',
|
||||
|
|
@ -280,14 +315,14 @@ module.exports = {
|
|||
{
|
||||
files: [
|
||||
'.eslintrc.js',
|
||||
'**/webpackShims/**/*',
|
||||
'packages/kbn-plugin-generator/**/*',
|
||||
'packages/kbn-plugin-helpers/**/*',
|
||||
'packages/kbn-eslint-import-resolver-kibana/**/*',
|
||||
'**/webpackShims/**/*.js',
|
||||
'packages/kbn-plugin-generator/**/*.js',
|
||||
'packages/kbn-plugin-helpers/**/*.js',
|
||||
'packages/kbn-eslint-import-resolver-kibana/**/*.js',
|
||||
'packages/kbn-eslint-plugin-eslint/**/*',
|
||||
'x-pack/gulpfile.js',
|
||||
'x-pack/dev-tools/mocha/setup_mocha.js',
|
||||
'x-pack/scripts/*',
|
||||
'x-pack/scripts/*.js',
|
||||
],
|
||||
rules: {
|
||||
'import/no-commonjs': 'off',
|
||||
|
|
@ -302,55 +337,11 @@ module.exports = {
|
|||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Files that require Apache 2.0 headers, settings
|
||||
* are overridden below for files that require Elastic
|
||||
* Licence headers
|
||||
*/
|
||||
{
|
||||
files: ['**/*.js'],
|
||||
rules: {
|
||||
'@kbn/eslint/require-license-header': [
|
||||
'error',
|
||||
{
|
||||
license: APACHE_2_0_LICENSE_HEADER,
|
||||
},
|
||||
],
|
||||
'@kbn/eslint/disallow-license-headers': [
|
||||
'error',
|
||||
{
|
||||
licenses: [ELASTIC_LICENSE_HEADER],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Files that require Elastic license headers instead of Apache 2.0 header
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/**/*.js'],
|
||||
rules: {
|
||||
'@kbn/eslint/require-license-header': [
|
||||
'error',
|
||||
{
|
||||
license: ELASTIC_LICENSE_HEADER,
|
||||
},
|
||||
],
|
||||
'@kbn/eslint/disallow-license-headers': [
|
||||
'error',
|
||||
{
|
||||
licenses: [APACHE_2_0_LICENSE_HEADER],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* APM overrides
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/plugins/apm/**/*'],
|
||||
files: ['x-pack/plugins/apm/**/*.js'],
|
||||
rules: {
|
||||
'no-unused-vars': ['error', { ignoreRestSiblings: true }],
|
||||
'no-console': ['warn', { allow: ['error'] }],
|
||||
|
|
@ -361,7 +352,7 @@ module.exports = {
|
|||
* GIS overrides
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/plugins/maps/**/*'],
|
||||
files: ['x-pack/plugins/maps/**/*.js'],
|
||||
rules: {
|
||||
'react/prefer-stateless-function': [0, { ignorePureComponents: false }],
|
||||
},
|
||||
|
|
@ -371,7 +362,7 @@ module.exports = {
|
|||
* Graph overrides
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/plugins/graph/**/*'],
|
||||
files: ['x-pack/plugins/graph/**/*.js'],
|
||||
globals: {
|
||||
angular: true,
|
||||
$: true,
|
||||
|
|
@ -394,7 +385,7 @@ module.exports = {
|
|||
* ML overrides
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/plugins/ml/**/*'],
|
||||
files: ['x-pack/plugins/ml/**/*.js'],
|
||||
rules: {
|
||||
'no-shadow': 'error',
|
||||
},
|
||||
|
|
@ -404,7 +395,7 @@ module.exports = {
|
|||
* disable jsx-a11y for kbn-ui-framework
|
||||
*/
|
||||
{
|
||||
files: ['packages/kbn-ui-framework/**'],
|
||||
files: ['packages/kbn-ui-framework/**/*.js'],
|
||||
rules: {
|
||||
'jsx-a11y/click-events-have-key-events': 'off',
|
||||
'jsx-a11y/anchor-has-content': 'off',
|
||||
|
|
@ -418,7 +409,7 @@ module.exports = {
|
|||
* Monitoring overrides
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/plugins/monitoring/**/*'],
|
||||
files: ['x-pack/plugins/monitoring/**/*.js'],
|
||||
rules: {
|
||||
'block-spacing': ['error', 'always'],
|
||||
curly: ['error', 'all'],
|
||||
|
|
@ -427,7 +418,7 @@ module.exports = {
|
|||
},
|
||||
},
|
||||
{
|
||||
files: ['x-pack/plugins/monitoring/public/**/*'],
|
||||
files: ['x-pack/plugins/monitoring/public/**/*.js'],
|
||||
env: { browser: true },
|
||||
},
|
||||
|
||||
|
|
@ -435,7 +426,7 @@ module.exports = {
|
|||
* Canvas overrides
|
||||
*/
|
||||
{
|
||||
files: ['x-pack/plugins/canvas/**/*'],
|
||||
files: ['x-pack/plugins/canvas/**/*.js'],
|
||||
rules: {
|
||||
radix: 'error',
|
||||
curly: ['error', 'all'],
|
||||
|
|
@ -485,8 +476,8 @@ module.exports = {
|
|||
'x-pack/plugins/canvas/scripts/*.js',
|
||||
'x-pack/plugins/canvas/tasks/*.js',
|
||||
'x-pack/plugins/canvas/tasks/**/*.js',
|
||||
'x-pack/plugins/canvas/__tests__/**/*',
|
||||
'x-pack/plugins/canvas/**/{__tests__,__test__,__jest__,__fixtures__,__mocks__}/**/*',
|
||||
'x-pack/plugins/canvas/__tests__/**/*.js',
|
||||
'x-pack/plugins/canvas/**/{__tests__,__test__,__jest__,__fixtures__,__mocks__}/**/*.js',
|
||||
],
|
||||
rules: {
|
||||
'import/no-extraneous-dependencies': [
|
||||
|
|
@ -499,7 +490,7 @@ module.exports = {
|
|||
},
|
||||
},
|
||||
{
|
||||
files: ['x-pack/plugins/canvas/canvas_plugin_src/**/*'],
|
||||
files: ['x-pack/plugins/canvas/canvas_plugin_src/**/*.js'],
|
||||
globals: { canvas: true, $: true },
|
||||
rules: {
|
||||
'import/no-unresolved': [
|
||||
|
|
@ -511,13 +502,13 @@ module.exports = {
|
|||
},
|
||||
},
|
||||
{
|
||||
files: ['x-pack/plugins/canvas/public/**/*'],
|
||||
files: ['x-pack/plugins/canvas/public/**/*.js'],
|
||||
env: {
|
||||
browser: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
files: ['x-pack/plugins/canvas/canvas_plugin_src/lib/flot-charts/**/*'],
|
||||
files: ['x-pack/plugins/canvas/canvas_plugin_src/lib/flot-charts/**/*.js'],
|
||||
env: {
|
||||
jquery: true,
|
||||
},
|
||||
|
|
|
|||
3
.github/CODEOWNERS
vendored
3
.github/CODEOWNERS
vendored
|
|
@ -36,3 +36,6 @@
|
|||
/x-pack/plugins/rollup/ @elastic/es-ui
|
||||
/x-pack/plugins/searchprofiler/ @elastic/es-ui
|
||||
/x-pack/plugins/watcher/ @elastic/es-ui
|
||||
|
||||
# Kibana TSVB external contractors
|
||||
/src/legacy/core_plugins/metrics/ @elastic/kibana-tsvb-external
|
||||
|
|
|
|||
|
|
@ -388,7 +388,7 @@ In the screenshot below, you'll notice the URL is `localhost:9876/debug.html`. Y
|
|||
|
||||
### Unit Testing Plugins
|
||||
|
||||
This should work super if you're using the [Kibana plugin generator](https://github.com/elastic/generator-kibana-plugin). If you're not using the generator, well, you're on your own. We suggest you look at how the generator works.
|
||||
This should work super if you're using the [Kibana plugin generator](https://github.com/elastic/kibana/tree/master/packages/kbn-plugin-generator). If you're not using the generator, well, you're on your own. We suggest you look at how the generator works.
|
||||
|
||||
To run the tests for just your particular plugin run the following command from your plugin:
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
|
||||
To convert existing code over to TypeScript:
|
||||
1. rename the file from `.js` to either `.ts` (if there is no html or jsx in the file) or `.tsx` (if there is).
|
||||
2. Ensure tslint is running and installed in the IDE of your choice. There will usually be some linter errors after the file rename.
|
||||
3. Auto-fix what you can. This will save you a lot of time! VSCode can be set to auto fix tslint errors when files are saved.
|
||||
2. Ensure eslint is running and installed in the IDE of your choice. There will usually be some linter errors after the file rename.
|
||||
3. Auto-fix what you can. This will save you a lot of time! VSCode can be set to auto fix eslint errors when files are saved.
|
||||
|
||||
### How to fix common TypeScript errors
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,7 @@ NOTE: You cannot access these APIs via the Console in Kibana.
|
|||
|
||||
[float]
|
||||
== APIs
|
||||
* <<features-api>>
|
||||
* <<spaces-api>>
|
||||
* <<role-management-api>>
|
||||
* <<saved-objects-api>>
|
||||
|
|
@ -37,6 +38,7 @@ NOTE: You cannot access these APIs via the Console in Kibana.
|
|||
* <<upgrade-assistant-api>>
|
||||
--
|
||||
|
||||
include::api/features.asciidoc[]
|
||||
include::api/spaces-management.asciidoc[]
|
||||
include::api/role-management.asciidoc[]
|
||||
include::api/saved-objects.asciidoc[]
|
||||
|
|
|
|||
13
docs/api/features.asciidoc
Normal file
13
docs/api/features.asciidoc
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
[role="xpack"]
|
||||
[[features-api]]
|
||||
== Features API
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The features API allows you to view information about available features in {kib}. Features are used by spaces and security to refine and secure access to {kib}.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in {kib}.
|
||||
|
||||
* <<features-api-get>>
|
||||
|
||||
include::features/get.asciidoc[]
|
||||
219
docs/api/features/get.asciidoc
Normal file
219
docs/api/features/get.asciidoc
Normal file
|
|
@ -0,0 +1,219 @@
|
|||
[[features-api-get]]
|
||||
=== Get Features
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
Retrieves all {kib} features.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in {kib}.
|
||||
|
||||
==== Get all {kib} features
|
||||
|
||||
===== Request
|
||||
|
||||
To retrieve all features, issue a GET request to the
|
||||
/api/features/v1 endpoint.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/features/v1
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body containing a JSON
|
||||
representation of the features.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"id": "discover",
|
||||
"name": "Discover",
|
||||
"icon": "discoverApp",
|
||||
"navLinkId": "kibana:discover",
|
||||
"app": [
|
||||
"kibana"
|
||||
],
|
||||
"catalogue": [
|
||||
"discover"
|
||||
],
|
||||
"privileges": {
|
||||
"all": {
|
||||
"savedObject": {
|
||||
"all": [
|
||||
"search",
|
||||
"url"
|
||||
],
|
||||
"read": [
|
||||
"config",
|
||||
"index-pattern"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show",
|
||||
"createShortUrl",
|
||||
"save"
|
||||
]
|
||||
},
|
||||
"read": {
|
||||
"savedObject": {
|
||||
"all": [],
|
||||
"read": [
|
||||
"config",
|
||||
"index-pattern",
|
||||
"search",
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "visualize",
|
||||
"name": "Visualize",
|
||||
"icon": "visualizeApp",
|
||||
"navLinkId": "kibana:visualize",
|
||||
"app": [
|
||||
"kibana"
|
||||
],
|
||||
"catalogue": [
|
||||
"visualize"
|
||||
],
|
||||
"privileges": {
|
||||
"all": {
|
||||
"savedObject": {
|
||||
"all": [
|
||||
"visualization",
|
||||
"url"
|
||||
],
|
||||
"read": [
|
||||
"config",
|
||||
"index-pattern",
|
||||
"search"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show",
|
||||
"createShortUrl",
|
||||
"delete",
|
||||
"save"
|
||||
]
|
||||
},
|
||||
"read": {
|
||||
"savedObject": {
|
||||
"all": [],
|
||||
"read": [
|
||||
"config",
|
||||
"index-pattern",
|
||||
"search",
|
||||
"visualization"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "dashboard",
|
||||
"name": "Dashboard",
|
||||
"icon": "dashboardApp",
|
||||
"navLinkId": "kibana:dashboard",
|
||||
"app": [
|
||||
"kibana"
|
||||
],
|
||||
"catalogue": [
|
||||
"dashboard"
|
||||
],
|
||||
"privileges": {
|
||||
"all": {
|
||||
"savedObject": {
|
||||
"all": [
|
||||
"dashboard",
|
||||
"url"
|
||||
],
|
||||
"read": [
|
||||
"config",
|
||||
"index-pattern",
|
||||
"search",
|
||||
"visualization",
|
||||
"timelion-sheet",
|
||||
"canvas-workpad"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"createNew",
|
||||
"show",
|
||||
"showWriteControls"
|
||||
]
|
||||
},
|
||||
"read": {
|
||||
"savedObject": {
|
||||
"all": [],
|
||||
"read": [
|
||||
"config",
|
||||
"index-pattern",
|
||||
"search",
|
||||
"visualization",
|
||||
"timelion-sheet",
|
||||
"canvas-workpad",
|
||||
"dashboard"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "dev_tools",
|
||||
"name": "Dev Tools",
|
||||
"icon": "devToolsApp",
|
||||
"navLinkId": "kibana:dev_tools",
|
||||
"app": [
|
||||
"kibana"
|
||||
],
|
||||
"catalogue": [
|
||||
"console",
|
||||
"searchprofiler",
|
||||
"grokdebugger"
|
||||
],
|
||||
"privileges": {
|
||||
"all": {
|
||||
"api": [
|
||||
"console"
|
||||
],
|
||||
"savedObject": {
|
||||
"all": [],
|
||||
"read": [
|
||||
"config"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show"
|
||||
]
|
||||
},
|
||||
"read": {
|
||||
"api": [
|
||||
"console"
|
||||
],
|
||||
"savedObject": {
|
||||
"all": [],
|
||||
"read": [
|
||||
"config"
|
||||
]
|
||||
},
|
||||
"ui": [
|
||||
"show"
|
||||
]
|
||||
}
|
||||
},
|
||||
"privilegesTooltip": "User should also be granted the appropriate Elasticsearch cluster and index privileges"
|
||||
},
|
||||
--------------------------------------------------
|
||||
|
|
@ -32,6 +32,7 @@ representation of the spaces.
|
|||
"id": "default",
|
||||
"name": "Default",
|
||||
"description" : "This is the Default Space",
|
||||
"disabledFeatures": [],
|
||||
"_reserved": true
|
||||
},
|
||||
{
|
||||
|
|
@ -39,12 +40,14 @@ representation of the spaces.
|
|||
"name": "Marketing",
|
||||
"description" : "This is the Marketing Space",
|
||||
"color": "#aabbcc",
|
||||
"disabledFeatures": ["apm"],
|
||||
"initials": "MK"
|
||||
},
|
||||
{
|
||||
"id": "sales",
|
||||
"name": "Sales",
|
||||
"initials": "MK"
|
||||
"initials": "MK",
|
||||
"disabledFeatures": ["discover", "timelion"],
|
||||
},
|
||||
]
|
||||
--------------------------------------------------
|
||||
|
|
@ -74,6 +77,7 @@ representation of the space.
|
|||
"name": "Marketing",
|
||||
"description" : "This is the Marketing Space",
|
||||
"color": "#aabbcc",
|
||||
"initials": "MK"
|
||||
"initials": "MK",
|
||||
"disabledFeatures": []
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -27,6 +27,8 @@ The following parameters can be specified in the body of a POST request to creat
|
|||
|
||||
`description`:: (string) Optional description for the space.
|
||||
|
||||
`disabledFeatures`:: (string array) Optional list of features that are disabled for the space. Use the <<features-api-get, Features API>> to get a list of available features IDs.
|
||||
|
||||
`initials`:: (string) Optionally specify the initials shown in the Space Avatar for this space. By default, the initials will be automatically generated from the space name.
|
||||
If specified, initials should be either 1 or 2 characters.
|
||||
|
||||
|
|
@ -42,7 +44,8 @@ POST /api/spaces/space
|
|||
"name": "Marketing",
|
||||
"description" : "This is the Marketing Space",
|
||||
"color": "#aabbcc",
|
||||
"initials": "MK"
|
||||
"initials": "MK",
|
||||
"disabledFeatures": ["timelion"]
|
||||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
|
|
|||
|
|
@ -27,6 +27,8 @@ The following parameters can be specified in the body of a PUT request to update
|
|||
|
||||
`description`:: (string) Optional description for the space.
|
||||
|
||||
`disabledFeatures`:: (string array) Optional list of features that are disabled for the space. Use the <<features-api-get, Features API>> to get a list of available features IDs.
|
||||
|
||||
`initials`:: (string) Optionally specify the initials shown in the Space Avatar for this space. By default, the initials will be automatically generated from the space name.
|
||||
If specified, initials should be either 1 or 2 characters.
|
||||
|
||||
|
|
@ -42,7 +44,8 @@ PUT /api/spaces/space/marketing
|
|||
"name": "Marketing",
|
||||
"description" : "This is the Marketing Space",
|
||||
"color": "#aabbcc",
|
||||
"initials": "MK"
|
||||
"initials": "MK",
|
||||
"disabledFeatures": []
|
||||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@ include::development/core-development.asciidoc[]
|
|||
|
||||
include::development/plugin-development.asciidoc[]
|
||||
|
||||
include::development/visualize/development-visualize-index.asciidoc[]
|
||||
|
||||
include::development/add-data-guide.asciidoc[]
|
||||
|
||||
include::development/security/index.asciidoc[]
|
||||
|
||||
include::development/pr-review.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [BasePathSetup](./kibana-plugin-public.basepathsetup.md) > [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`
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [BasePathSetup](./kibana-plugin-public.basepathsetup.md) > [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
|
||||
|
||||
|
|
@ -1,10 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [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 |
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [BasePathSetup](./kibana-plugin-public.basepathsetup.md) > [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`
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Capabilities](./kibana-plugin-public.capabilities.md) > [catalogue](./kibana-plugin-public.capabilities.catalogue.md)
|
||||
|
||||
## Capabilities.catalogue property
|
||||
|
||||
Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
catalogue: Record<string, boolean>;
|
||||
```
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Capabilities](./kibana-plugin-public.capabilities.md) > [management](./kibana-plugin-public.capabilities.management.md)
|
||||
|
||||
## Capabilities.management property
|
||||
|
||||
Management section capabilities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
management: {
|
||||
[sectionId: string]: Record<string, boolean>;
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Capabilities](./kibana-plugin-public.capabilities.md)
|
||||
|
||||
## Capabilities interface
|
||||
|
||||
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.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Capabilities
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [catalogue](./kibana-plugin-public.capabilities.catalogue.md) | <code>Record<string, boolean></code> | Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options. |
|
||||
| [management](./kibana-plugin-public.capabilities.management.md) | <code>{`<p/>` [sectionId: string]: Record<string, boolean>;`<p/>` }</code> | Management section capabilities. |
|
||||
| [navLinks](./kibana-plugin-public.capabilities.navlinks.md) | <code>Record<string, boolean></code> | Navigation link capabilities. |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Capabilities](./kibana-plugin-public.capabilities.md) > [navLinks](./kibana-plugin-public.capabilities.navlinks.md)
|
||||
|
||||
## Capabilities.navLinks property
|
||||
|
||||
Navigation link capabilities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
navLinks: Record<string, boolean>;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md) > [getCapabilities](./kibana-plugin-public.capabilitiessetup.getcapabilities.md)
|
||||
|
||||
## CapabilitiesSetup.getCapabilities property
|
||||
|
||||
Gets the read-only capabilities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getCapabilities: () => Capabilities;
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
|
||||
|
||||
## CapabilitiesSetup interface
|
||||
|
||||
Capabilities Setup.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface CapabilitiesSetup
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [getCapabilities](./kibana-plugin-public.capabilitiessetup.getcapabilities.md) | <code>() => Capabilities</code> | Gets the read-only capabilities. |
|
||||
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBrand](./kibana-plugin-public.chromebrand.md) > [logo](./kibana-plugin-public.chromebrand.logo.md)
|
||||
|
||||
## ChromeBrand.logo property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBrand](./kibana-plugin-public.chromebrand.md)
|
||||
|
||||
## ChromeBrand interface
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBrand](./kibana-plugin-public.chromebrand.md) > [smallLogo](./kibana-plugin-public.chromebrand.smalllogo.md)
|
||||
|
||||
## ChromeBrand.smallLogo property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) > [data-test-subj](./kibana-plugin-public.chromebreadcrumb.data-test-subj.md)
|
||||
|
||||
## ChromeBreadcrumb.data-test-subj property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) > [href](./kibana-plugin-public.chromebreadcrumb.href.md)
|
||||
|
||||
## ChromeBreadcrumb.href property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md)
|
||||
|
||||
## ChromeBreadcrumb interface
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) > [text](./kibana-plugin-public.chromebreadcrumb.text.md)
|
||||
|
||||
## ChromeBreadcrumb.text property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md)
|
||||
|
||||
## ChromeHelpExtension type
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ChromeSetup](./kibana-plugin-public.chromesetup.md)
|
||||
|
||||
## ChromeSetup type
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [basePath](./kibana-plugin-public.coresetup.basepath.md)
|
||||
|
||||
## CoreSetup.basePath property
|
||||
|
||||
[BasePathSetup](./kibana-plugin-public.basepathsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [capabilities](./kibana-plugin-public.coresetup.capabilities.md)
|
||||
|
||||
## CoreSetup.capabilities property
|
||||
|
||||
[CapabilitiesSetup](./kibana-plugin-public.capabilitiessetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
capabilities: CapabilitiesSetup;
|
||||
```
|
||||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [chrome](./kibana-plugin-public.coresetup.chrome.md)
|
||||
|
||||
## CoreSetup.chrome property
|
||||
|
||||
[ChromeSetup](./kibana-plugin-public.chromesetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md)
|
||||
|
||||
## CoreSetup.fatalErrors property
|
||||
|
||||
[FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [http](./kibana-plugin-public.coresetup.http.md)
|
||||
|
||||
## CoreSetup.http property
|
||||
|
||||
[HttpSetup](./kibana-plugin-public.httpsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [i18n](./kibana-plugin-public.coresetup.i18n.md)
|
||||
|
||||
## CoreSetup.i18n property
|
||||
|
||||
[I18nSetup](./kibana-plugin-public.i18nsetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md)
|
||||
|
||||
## CoreSetup.injectedMetadata property
|
||||
|
||||
[InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.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-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md)
|
||||
|
||||
## CoreSetup interface
|
||||
|
|
@ -14,12 +16,14 @@ export interface CoreSetup
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [basePath](./kibana-plugin-public.coresetup.basepath.md) | <code>BasePathSetup</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> | |
|
||||
| [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) |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [notifications](./kibana-plugin-public.coresetup.notifications.md)
|
||||
|
||||
## CoreSetup.notifications property
|
||||
|
||||
[NotificationsSetup](./kibana-plugin-public.notificationssetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [overlays](./kibana-plugin-public.coresetup.overlays.md)
|
||||
|
||||
## CoreSetup.overlays property
|
||||
|
||||
[OverlaySetup](./kibana-plugin-public.overlaysetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
overlays: OverlaySetup;
|
||||
```
|
||||
|
|
@ -1,7 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [CoreSetup](./kibana-plugin-public.coresetup.md) > [uiSettings](./kibana-plugin-public.coresetup.uisettings.md)
|
||||
|
||||
## CoreSetup.uiSettings property
|
||||
|
||||
[UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) > [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;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) > [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>;
|
||||
```
|
||||
|
|
@ -1,10 +1,21 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [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 | Error, source?: string) => 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>() => Rx.Observable<ErrorInfo></code> | An Observable that will emit whenever a fatal error is added with <code>add()</code> |
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,17 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [FlyoutRef](./kibana-plugin-public.flyoutref.md) > [close](./kibana-plugin-public.flyoutref.close.md)
|
||||
|
||||
## FlyoutRef.close() method
|
||||
|
||||
Closes the referenced flyout if it's still open which in turn will resolve the `onClose` Promise. If the flyout had already been closed this method does nothing.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
close(): Promise<void>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<void>`
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [FlyoutRef](./kibana-plugin-public.flyoutref.md)
|
||||
|
||||
## FlyoutRef class
|
||||
|
||||
A FlyoutRef is a reference to an opened flyout panel. It offers methods to close the flyout panel again. If you open a flyout panel you should make sure you call `close()` when it should be closed. Since a flyout could also be closed by a user or from another flyout being opened, you must bind to the `onClose` Promise on the FlyoutRef instance. The Promise will resolve whenever the flyout was closed at which point you should discard the FlyoutRef.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class FlyoutRef
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [onClose](./kibana-plugin-public.flyoutref.onclose.md) | | <code>Promise<void></code> | An Promise that will resolve once this flyout is closed.<!-- -->Flyouts can close from user interaction, calling <code>close()</code> on the flyout reference or another call to <code>openFlyout()</code> replacing your flyout. |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [close()](./kibana-plugin-public.flyoutref.close.md) | | Closes the referenced flyout if it's still open which in turn will resolve the <code>onClose</code> Promise. If the flyout had already been closed this method does nothing. |
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [FlyoutRef](./kibana-plugin-public.flyoutref.md) > [onClose](./kibana-plugin-public.flyoutref.onclose.md)
|
||||
|
||||
## FlyoutRef.onClose property
|
||||
|
||||
An Promise that will resolve once this flyout is closed.
|
||||
|
||||
Flyouts can close from user interaction, calling `close()` on the flyout reference or another call to `openFlyout()` replacing your flyout.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly onClose: Promise<void>;
|
||||
```
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [HttpSetup](./kibana-plugin-public.httpsetup.md)
|
||||
|
||||
## HttpSetup type
|
||||
|
|
|
|||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [I18nSetup](./kibana-plugin-public.i18nsetup.md) > [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;
|
||||
```
|
||||
|
|
@ -1,10 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [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/>` }) => JSX.Element</code> | React Context provider required as the topmost component for any i18n-compatible React tree. |
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [getBasePath](./kibana-plugin-public.injectedmetadatasetup.getbasepath.md)
|
||||
|
||||
## InjectedMetadataSetup.getBasePath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getBasePath: () => string;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [getCspConfig](./kibana-plugin-public.injectedmetadatasetup.getcspconfig.md)
|
||||
|
||||
## InjectedMetadataSetup.getCspConfig property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getCspConfig: () => {
|
||||
warnLegacyBrowsers: boolean;
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [getInjectedVar](./kibana-plugin-public.injectedmetadatasetup.getinjectedvar.md)
|
||||
|
||||
## InjectedMetadataSetup.getInjectedVar property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getInjectedVar: (name: string, defaultValue?: any) => unknown;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [getInjectedVars](./kibana-plugin-public.injectedmetadatasetup.getinjectedvars.md)
|
||||
|
||||
## InjectedMetadataSetup.getInjectedVars property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getInjectedVars: () => {
|
||||
[key: string]: unknown;
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [getKibanaVersion](./kibana-plugin-public.injectedmetadatasetup.getkibanaversion.md)
|
||||
|
||||
## InjectedMetadataSetup.getKibanaVersion property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getKibanaVersion: () => string;
|
||||
```
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [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;
|
||||
};
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) > [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;
|
||||
}>;
|
||||
```
|
||||
|
|
@ -1,10 +1,26 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [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>() => string</code> | |
|
||||
| [getCspConfig](./kibana-plugin-public.injectedmetadatasetup.getcspconfig.md) | <code>() => {`<p/>` warnLegacyBrowsers: boolean;`<p/>` }</code> | |
|
||||
| [getInjectedVar](./kibana-plugin-public.injectedmetadatasetup.getinjectedvar.md) | <code>(name: string, defaultValue?: any) => unknown</code> | |
|
||||
| [getInjectedVars](./kibana-plugin-public.injectedmetadatasetup.getinjectedvars.md) | <code>() => {`<p/>` [key: string]: unknown;`<p/>` }</code> | |
|
||||
| [getKibanaVersion](./kibana-plugin-public.injectedmetadatasetup.getkibanaversion.md) | <code>() => string</code> | |
|
||||
| [getLegacyMetadata](./kibana-plugin-public.injectedmetadatasetup.getlegacymetadata.md) | <code>() => {`<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 | undefined;`<p/>` };`<p/>` }</code> | |
|
||||
| [getPlugins](./kibana-plugin-public.injectedmetadatasetup.getplugins.md) | <code>() => Array<{`<p/>` id: string;`<p/>` plugin: DiscoveredPlugin;`<p/>` }></code> | An array of frontend plugins in topological order. |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md)
|
||||
|
||||
## kibana-plugin-public package
|
||||
|
|
@ -6,6 +8,7 @@
|
|||
|
||||
| Class | Description |
|
||||
| --- | --- |
|
||||
| [FlyoutRef](./kibana-plugin-public.flyoutref.md) | A FlyoutRef is a reference to an opened flyout panel. It offers methods to close the flyout panel again. If you open a flyout panel you should make sure you call <code>close()</code> when it should be closed. Since a flyout could also be closed by a user or from another flyout being opened, you must bind to the <code>onClose</code> Promise on the FlyoutRef instance. The Promise will resolve whenever the flyout was closed at which point you should discard the FlyoutRef. |
|
||||
| [ToastsSetup](./kibana-plugin-public.toastssetup.md) | |
|
||||
| [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) | |
|
||||
|
||||
|
|
@ -13,9 +16,16 @@
|
|||
|
||||
| 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> |
|
||||
| [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) | The available core services passed to a plugin's <code>Plugin#setup</code> method. |
|
||||
|
|
@ -25,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) | |
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [NotificationsSetup](./kibana-plugin-public.notificationssetup.md)
|
||||
|
||||
## NotificationsSetup type
|
||||
|
|
|
|||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlaySetup](./kibana-plugin-public.overlaysetup.md)
|
||||
|
||||
## OverlaySetup interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface OverlaySetup
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [openFlyout](./kibana-plugin-public.overlaysetup.openflyout.md) | <code>(flyoutChildren: React.ReactNode, flyoutProps?: {`<p/>` closeButtonAriaLabel?: string;`<p/>` 'data-test-subj'?: string;`<p/>` }) => FlyoutRef</code> | |
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlaySetup](./kibana-plugin-public.overlaysetup.md) > [openFlyout](./kibana-plugin-public.overlaysetup.openflyout.md)
|
||||
|
||||
## OverlaySetup.openFlyout property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
openFlyout: (flyoutChildren: React.ReactNode, flyoutProps?: {
|
||||
closeButtonAriaLabel?: string;
|
||||
'data-test-subj'?: string;
|
||||
}) => FlyoutRef;
|
||||
```
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Plugin](./kibana-plugin-public.plugin.md)
|
||||
|
||||
## Plugin interface
|
||||
|
|
@ -7,13 +9,13 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Plugin<TSetup, TDependencies extends Record<string, unknown> =
|
||||
export interface Plugin<TSetup, TPluginsSetup extends Record<string, unknown> =
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [setup](./kibana-plugin-public.plugin.setup.md) | <code>(core: PluginSetupContext, dependencies: TDependencies) => TSetup | Promise<TSetup></code> | |
|
||||
| [setup](./kibana-plugin-public.plugin.setup.md) | <code>(core: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup></code> | |
|
||||
| [stop](./kibana-plugin-public.plugin.stop.md) | <code>() => void</code> | |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Plugin](./kibana-plugin-public.plugin.md) > [setup](./kibana-plugin-public.plugin.setup.md)
|
||||
|
||||
## Plugin.setup property
|
||||
|
|
@ -5,5 +7,5 @@
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setup: (core: PluginSetupContext, dependencies: TDependencies) => TSetup | Promise<TSetup>;
|
||||
setup: (core: PluginSetupContext, plugins: TPluginsSetup) => TSetup | Promise<TSetup>;
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [Plugin](./kibana-plugin-public.plugin.md) > [stop](./kibana-plugin-public.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-public](./kibana-plugin-public.md) > [PluginInitializer](./kibana-plugin-public.plugininitializer.md)
|
||||
|
||||
## PluginInitializer type
|
||||
|
|
@ -7,5 +9,5 @@ The `plugin` export at the root of a plugin's `public` directory should conform
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type PluginInitializer<TSetup, TDependencies extends Record<string, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TDependencies>;
|
||||
export declare type PluginInitializer<TSetup, TPluginsSetup extends Record<string, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TPluginsSetup>;
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginInitializerContext](./kibana-plugin-public.plugininitializercontext.md)
|
||||
|
||||
## PluginInitializerContext interface
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) > [basePath](./kibana-plugin-public.pluginsetupcontext.basepath.md)
|
||||
|
||||
## PluginSetupContext.basePath property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) > [chrome](./kibana-plugin-public.pluginsetupcontext.chrome.md)
|
||||
|
||||
## PluginSetupContext.chrome property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) > [fatalErrors](./kibana-plugin-public.pluginsetupcontext.fatalerrors.md)
|
||||
|
||||
## PluginSetupContext.fatalErrors property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) > [i18n](./kibana-plugin-public.pluginsetupcontext.i18n.md)
|
||||
|
||||
## PluginSetupContext.i18n property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md)
|
||||
|
||||
## PluginSetupContext interface
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) > [notifications](./kibana-plugin-public.pluginsetupcontext.notifications.md)
|
||||
|
||||
## PluginSetupContext.notifications property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [PluginSetupContext](./kibana-plugin-public.pluginsetupcontext.md) > [uiSettings](./kibana-plugin-public.pluginsetupcontext.uisettings.md)
|
||||
|
||||
## PluginSetupContext.uiSettings property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastInput](./kibana-plugin-public.toastinput.md)
|
||||
|
||||
## ToastInput type
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md) > [add](./kibana-plugin-public.toastssetup.add.md)
|
||||
|
||||
## ToastsSetup.add() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md) > [addDanger](./kibana-plugin-public.toastssetup.adddanger.md)
|
||||
|
||||
## ToastsSetup.addDanger() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md) > [addSuccess](./kibana-plugin-public.toastssetup.addsuccess.md)
|
||||
|
||||
## ToastsSetup.addSuccess() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md) > [addWarning](./kibana-plugin-public.toastssetup.addwarning.md)
|
||||
|
||||
## ToastsSetup.addWarning() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md) > [get$](./kibana-plugin-public.toastssetup.get$.md)
|
||||
|
||||
## ToastsSetup.get$() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md)
|
||||
|
||||
## ToastsSetup class
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [ToastsSetup](./kibana-plugin-public.toastssetup.md) > [remove](./kibana-plugin-public.toastssetup.remove.md)
|
||||
|
||||
## ToastsSetup.remove() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [get$](./kibana-plugin-public.uisettingsclient.get$.md)
|
||||
|
||||
## UiSettingsClient.get$() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [get](./kibana-plugin-public.uisettingsclient.get.md)
|
||||
|
||||
## UiSettingsClient.get() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [getAll](./kibana-plugin-public.uisettingsclient.getall.md)
|
||||
|
||||
## UiSettingsClient.getAll() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [getSaved$](./kibana-plugin-public.uisettingsclient.getsaved$.md)
|
||||
|
||||
## UiSettingsClient.getSaved$() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [getUpdate$](./kibana-plugin-public.uisettingsclient.getupdate$.md)
|
||||
|
||||
## UiSettingsClient.getUpdate$() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [isCustom](./kibana-plugin-public.uisettingsclient.iscustom.md)
|
||||
|
||||
## UiSettingsClient.isCustom() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [isDeclared](./kibana-plugin-public.uisettingsclient.isdeclared.md)
|
||||
|
||||
## UiSettingsClient.isDeclared() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [isDefault](./kibana-plugin-public.uisettingsclient.isdefault.md)
|
||||
|
||||
## UiSettingsClient.isDefault() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [isOverridden](./kibana-plugin-public.uisettingsclient.isoverridden.md)
|
||||
|
||||
## UiSettingsClient.isOverridden() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md)
|
||||
|
||||
## UiSettingsClient class
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [overrideLocalDefault](./kibana-plugin-public.uisettingsclient.overridelocaldefault.md)
|
||||
|
||||
## UiSettingsClient.overrideLocalDefault() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [params](./kibana-plugin-public.uisettingsclient.params.md)
|
||||
|
||||
## UiSettingsClient.params property
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [remove](./kibana-plugin-public.uisettingsclient.remove.md)
|
||||
|
||||
## UiSettingsClient.remove() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [set](./kibana-plugin-public.uisettingsclient.set.md)
|
||||
|
||||
## UiSettingsClient.set() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) > [stop](./kibana-plugin-public.uisettingsclient.stop.md)
|
||||
|
||||
## UiSettingsClient.stop() method
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md)
|
||||
|
||||
## UiSettingsSetup type
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [UiSettingsState](./kibana-plugin-public.uisettingsstate.md)
|
||||
|
||||
## UiSettingsState interface
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue