-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:elastic/kibana into import-timeli…
…ne-fix
- Loading branch information
Showing
247 changed files
with
5,248 additions
and
891 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 0 additions & 13 deletions
13
docs/development/core/server/kibana-plugin-core-server.coresetup.metrics.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
docs/development/core/server/kibana-plugin-core-server.corestart.metrics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [metrics](./kibana-plugin-core-server.corestart.metrics.md) | ||
|
||
## CoreStart.metrics property | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
metrics: MetricsServiceStart; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 0 additions & 24 deletions
24
...ent/core/server/kibana-plugin-core-server.metricsservicesetup.getopsmetrics_.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isfilter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [isFilter](./kibana-plugin-plugins-data-public.isfilter.md) | ||
|
||
## isFilter variable | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isFilter: (x: unknown) => x is Filter | ||
``` |
11 changes: 11 additions & 0 deletions
11
.../development/plugins/data/public/kibana-plugin-plugins-data-public.isfilters.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [isFilters](./kibana-plugin-plugins-data-public.isfilters.md) | ||
|
||
## isFilters variable | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isFilters: (x: unknown) => x is Filter[] | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isquery.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [isQuery](./kibana-plugin-plugins-data-public.isquery.md) | ||
|
||
## isQuery variable | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isQuery: (x: unknown) => x is Query | ||
``` |
11 changes: 11 additions & 0 deletions
11
...evelopment/plugins/data/public/kibana-plugin-plugins-data-public.istimerange.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [isTimeRange](./kibana-plugin-plugins-data-public.istimerange.md) | ||
|
||
## isTimeRange variable | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isTimeRange: (x: unknown) => x is TimeRange | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
docs/development/plugins/kibana_utils/common/state_containers/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) | ||
|
||
## API Reference | ||
|
||
## Packages | ||
|
||
| Package | Description | | ||
| --- | --- | | ||
| [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) | State containers are Redux-store-like objects meant to help you manage state in your services or apps. Refer to [guides and examples](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_containers) for more info | | ||
|
13 changes: 13 additions & 0 deletions
13
...tainers/kibana-plugin-plugins-kibana_utils-common-state_containers.basestate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [BaseState](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestate.md) | ||
|
||
## BaseState type | ||
|
||
Base [StateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.statecontainer.md) state shape | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type BaseState = object; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...a-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.get.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md) > [get](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.get.md) | ||
|
||
## BaseStateContainer.get property | ||
|
||
Retrieves current state from the container | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get: () => State; | ||
``` |
22 changes: 22 additions & 0 deletions
22
...ibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md) | ||
|
||
## BaseStateContainer interface | ||
|
||
Base state container shape without transitions or selectors | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface BaseStateContainer<State extends BaseState> | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [get](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.get.md) | <code>() => State</code> | Retrieves current state from the container | | ||
| [set](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.set.md) | <code>(state: State) => void</code> | Sets state into container | | ||
| [state$](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.state_.md) | <code>Observable<State></code> | of state | | ||
|
13 changes: 13 additions & 0 deletions
13
...a-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.set.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md) > [set](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.set.md) | ||
|
||
## BaseStateContainer.set property | ||
|
||
Sets state into container | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
set: (state: State) => void; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...lugin-plugins-kibana_utils-common-state_containers.basestatecontainer.state_.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [BaseStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.md) > [state$](./kibana-plugin-plugins-kibana_utils-common-state_containers.basestatecontainer.state_.md) | ||
|
||
## BaseStateContainer.state$ property | ||
|
||
of state | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
state$: Observable<State>; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...ainers/kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [Comparator](./kibana-plugin-plugins-kibana_utils-common-state_containers.comparator.md) | ||
|
||
## Comparator type | ||
|
||
Used to compare state. see [useContainerSelector](./kibana-plugin-plugins-kibana_utils-common-state_containers.usecontainerselector.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type Comparator<Result> = (previous: Result, current: Result) => boolean; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...ontainers/kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [Connect](./kibana-plugin-plugins-kibana_utils-common-state_containers.connect.md) | ||
|
||
## Connect type | ||
|
||
Similar to `connect` from react-redux, allows to map state from state container to component's props | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type Connect<State extends BaseState> = <Props extends object, StatePropKeys extends keyof Props>(mapStateToProp: MapStateToProps<State, Pick<Props, StatePropKeys>>) => (component: ComponentType<Props>) => FC<Omit<Props, StatePropKeys>>; | ||
``` |
24 changes: 24 additions & 0 deletions
24
...ana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [createStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer.md) | ||
|
||
## createStateContainer() function | ||
|
||
Creates a state container without transitions and without selectors. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function createStateContainer<State extends BaseState>(defaultState: State): ReduxLikeStateContainer<State>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| defaultState | <code>State</code> | initial state | | ||
|
||
<b>Returns:</b> | ||
|
||
`ReduxLikeStateContainer<State>` | ||
|
25 changes: 25 additions & 0 deletions
25
...a-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [createStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_1.md) | ||
|
||
## createStateContainer() function | ||
|
||
Creates a state container with transitions, but without selectors | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function createStateContainer<State extends BaseState, PureTransitions extends object>(defaultState: State, pureTransitions: PureTransitions): ReduxLikeStateContainer<State, PureTransitions>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| defaultState | <code>State</code> | initial state | | ||
| pureTransitions | <code>PureTransitions</code> | state transitions configuration object. Map of . | | ||
|
||
<b>Returns:</b> | ||
|
||
`ReduxLikeStateContainer<State, PureTransitions>` | ||
|
27 changes: 27 additions & 0 deletions
27
...a-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [createStateContainer](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontainer_2.md) | ||
|
||
## createStateContainer() function | ||
|
||
Creates a state container with transitions and selectors | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function createStateContainer<State extends BaseState, PureTransitions extends object, PureSelectors extends object>(defaultState: State, pureTransitions: PureTransitions, pureSelectors: PureSelectors, options?: CreateStateContainerOptions): ReduxLikeStateContainer<State, PureTransitions, PureSelectors>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| defaultState | <code>State</code> | initial state | | ||
| pureTransitions | <code>PureTransitions</code> | state transitions configuration object. Map of . | | ||
| pureSelectors | <code>PureSelectors</code> | state selectors configuration object. Map of . | | ||
| options | <code>CreateStateContainerOptions</code> | state container options [CreateStateContainerOptions](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md) | | ||
|
||
<b>Returns:</b> | ||
|
||
`ReduxLikeStateContainer<State, PureTransitions, PureSelectors>` | ||
|
25 changes: 25 additions & 0 deletions
25
...gins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [CreateStateContainerOptions](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md) > [freeze](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md) | ||
|
||
## CreateStateContainerOptions.freeze property | ||
|
||
Function to use when freezing state. Supply identity function. If not provided, default deepFreeze is use. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
freeze?: <T>(state: T) => T; | ||
``` | ||
|
||
## Example | ||
|
||
If you expect that your state will be mutated externally an you cannot prevent that | ||
|
||
```ts | ||
{ | ||
freeze: state => state, | ||
} | ||
|
||
``` | ||
|
20 changes: 20 additions & 0 deletions
20
...gin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-plugins-kibana\_utils-common-state\_containers](./kibana-plugin-plugins-kibana_utils-common-state_containers.md) > [CreateStateContainerOptions](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.md) | ||
|
||
## CreateStateContainerOptions interface | ||
|
||
State container options | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface CreateStateContainerOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [freeze](./kibana-plugin-plugins-kibana_utils-common-state_containers.createstatecontaineroptions.freeze.md) | <code><T>(state: T) => T</code> | Function to use when freezing state. Supply identity function. If not provided, default deepFreeze is use. | | ||
|
Oops, something went wrong.