Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] Generate docs from data plugin (#56955) #59729

Merged
merged 1 commit into from
Mar 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions docs/development/plugins/data/public/index.md
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-data-public](./kibana-plugin-plugins-data-public.md) | |

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [addSearchStrategy](./kibana-plugin-plugins-data-public.addsearchstrategy.md)

## addSearchStrategy variable

<b>Signature:</b>

```typescript
addSearchStrategy: (searchStrategy: SearchStrategyProvider) => void
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [baseFormattersPublic](./kibana-plugin-plugins-data-public.baseformatterspublic.md)

## baseFormattersPublic variable

<b>Signature:</b>

```typescript
baseFormattersPublic: (import("../../common").IFieldFormatType | typeof DateFormat)[]
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [castEsToKbnFieldTypeName](./kibana-plugin-plugins-data-public.castestokbnfieldtypename.md)

## castEsToKbnFieldTypeName variable

Get the KbnFieldType name for an esType string

<b>Signature:</b>

```typescript
castEsToKbnFieldTypeName: (esType: string) => KBN_FIELD_TYPES
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [connectToQueryState](./kibana-plugin-plugins-data-public.connecttoquerystate.md)

## connectToQueryState variable

Helper to setup two-way syncing of global data and a state container

<b>Signature:</b>

```typescript
connectToQueryState: <S extends QueryState>({ timefilter: { timefilter }, filterManager, state$, }: Pick<{
filterManager: import("..").FilterManager;
timefilter: import("..").TimefilterSetup;
state$: import("rxjs").Observable<{
changes: QueryStateChange;
state: QueryState;
}>;
savedQueries: import("..").SavedQueryService;
} | {
filterManager: import("..").FilterManager;
timefilter: import("..").TimefilterSetup;
state$: import("rxjs").Observable<{
changes: QueryStateChange;
state: QueryState;
}>;
}, "state$" | "timefilter" | "filterManager">, stateContainer: BaseStateContainer<S>, syncConfig: {
time?: boolean | undefined;
refreshInterval?: boolean | undefined;
filters?: boolean | FilterStateStore | undefined;
}) => () => void
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [createSavedQueryService](./kibana-plugin-plugins-data-public.createsavedqueryservice.md)

## createSavedQueryService variable

<b>Signature:</b>

```typescript
createSavedQueryService: (savedObjectsClient: Pick<import("../../../../../core/public").SavedObjectsClient, "update" | "find" | "get" | "delete" | "create" | "bulkCreate" | "bulkGet" | "bulkUpdate">) => SavedQueryService
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [CustomFilter](./kibana-plugin-plugins-data-public.customfilter.md)

## CustomFilter type

<b>Signature:</b>

```typescript
export declare type CustomFilter = Filter & {
query: any;
};
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) &gt; [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginsetup.autocomplete.md)

## DataPublicPluginSetup.autocomplete property

<b>Signature:</b>

```typescript
autocomplete: AutocompleteSetup;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) &gt; [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginsetup.fieldformats.md)

## DataPublicPluginSetup.fieldFormats property

<b>Signature:</b>

```typescript
fieldFormats: FieldFormatsSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md)

## DataPublicPluginSetup interface

<b>Signature:</b>

```typescript
export interface DataPublicPluginSetup
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginsetup.autocomplete.md) | <code>AutocompleteSetup</code> | |
| [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginsetup.fieldformats.md) | <code>FieldFormatsSetup</code> | |
| [query](./kibana-plugin-plugins-data-public.datapublicpluginsetup.query.md) | <code>QuerySetup</code> | |
| [search](./kibana-plugin-plugins-data-public.datapublicpluginsetup.search.md) | <code>ISearchSetup</code> | |

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) &gt; [query](./kibana-plugin-plugins-data-public.datapublicpluginsetup.query.md)

## DataPublicPluginSetup.query property

<b>Signature:</b>

```typescript
query: QuerySetup;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) &gt; [search](./kibana-plugin-plugins-data-public.datapublicpluginsetup.search.md)

## DataPublicPluginSetup.search property

<b>Signature:</b>

```typescript
search: ISearchSetup;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) &gt; [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginstart.autocomplete.md)

## DataPublicPluginStart.autocomplete property

<b>Signature:</b>

```typescript
autocomplete: AutocompleteStart;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) &gt; [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginstart.fieldformats.md)

## DataPublicPluginStart.fieldFormats property

<b>Signature:</b>

```typescript
fieldFormats: FieldFormatsStart;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) &gt; [indexPatterns](./kibana-plugin-plugins-data-public.datapublicpluginstart.indexpatterns.md)

## DataPublicPluginStart.indexPatterns property

<b>Signature:</b>

```typescript
indexPatterns: IndexPatternsContract;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md)

## DataPublicPluginStart interface

<b>Signature:</b>

```typescript
export interface DataPublicPluginStart
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginstart.autocomplete.md) | <code>AutocompleteStart</code> | |
| [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginstart.fieldformats.md) | <code>FieldFormatsStart</code> | |
| [indexPatterns](./kibana-plugin-plugins-data-public.datapublicpluginstart.indexpatterns.md) | <code>IndexPatternsContract</code> | |
| [query](./kibana-plugin-plugins-data-public.datapublicpluginstart.query.md) | <code>QueryStart</code> | |
| [search](./kibana-plugin-plugins-data-public.datapublicpluginstart.search.md) | <code>ISearchStart</code> | |
| [ui](./kibana-plugin-plugins-data-public.datapublicpluginstart.ui.md) | <code>{</code><br/><code> IndexPatternSelect: React.ComponentType&lt;IndexPatternSelectProps&gt;;</code><br/><code> SearchBar: React.ComponentType&lt;StatefulSearchBarProps&gt;;</code><br/><code> }</code> | |

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) &gt; [query](./kibana-plugin-plugins-data-public.datapublicpluginstart.query.md)

## DataPublicPluginStart.query property

<b>Signature:</b>

```typescript
query: QueryStart;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) &gt; [search](./kibana-plugin-plugins-data-public.datapublicpluginstart.search.md)

## DataPublicPluginStart.search property

<b>Signature:</b>

```typescript
search: ISearchStart;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) &gt; [ui](./kibana-plugin-plugins-data-public.datapublicpluginstart.ui.md)

## DataPublicPluginStart.ui property

<b>Signature:</b>

```typescript
ui: {
IndexPatternSelect: React.ComponentType<IndexPatternSelectProps>;
SearchBar: React.ComponentType<StatefulSearchBarProps>;
};
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [defaultSearchStrategy](./kibana-plugin-plugins-data-public.defaultsearchstrategy.md)

## defaultSearchStrategy variable

<b>Signature:</b>

```typescript
defaultSearchStrategy: SearchStrategyProvider
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ES\_FIELD\_TYPES](./kibana-plugin-plugins-data-public.es_field_types.md)

## ES\_FIELD\_TYPES enum

\*

<b>Signature:</b>

```typescript
export declare enum ES_FIELD_TYPES
```

## Enumeration Members

| Member | Value | Description |
| --- | --- | --- |
| \_ID | <code>&quot;_id&quot;</code> | |
| \_INDEX | <code>&quot;_index&quot;</code> | |
| \_SOURCE | <code>&quot;_source&quot;</code> | |
| \_TYPE | <code>&quot;_type&quot;</code> | |
| ATTACHMENT | <code>&quot;attachment&quot;</code> | |
| BOOLEAN | <code>&quot;boolean&quot;</code> | |
| BYTE | <code>&quot;byte&quot;</code> | |
| DATE | <code>&quot;date&quot;</code> | |
| DATE\_NANOS | <code>&quot;date_nanos&quot;</code> | |
| DOUBLE | <code>&quot;double&quot;</code> | |
| FLOAT | <code>&quot;float&quot;</code> | |
| GEO\_POINT | <code>&quot;geo_point&quot;</code> | |
| GEO\_SHAPE | <code>&quot;geo_shape&quot;</code> | |
| HALF\_FLOAT | <code>&quot;half_float&quot;</code> | |
| INTEGER | <code>&quot;integer&quot;</code> | |
| IP | <code>&quot;ip&quot;</code> | |
| KEYWORD | <code>&quot;keyword&quot;</code> | |
| LONG | <code>&quot;long&quot;</code> | |
| MURMUR3 | <code>&quot;murmur3&quot;</code> | |
| NESTED | <code>&quot;nested&quot;</code> | |
| OBJECT | <code>&quot;object&quot;</code> | |
| SCALED\_FLOAT | <code>&quot;scaled_float&quot;</code> | |
| SHORT | <code>&quot;short&quot;</code> | |
| STRING | <code>&quot;string&quot;</code> | |
| TEXT | <code>&quot;text&quot;</code> | |
| TOKEN\_COUNT | <code>&quot;token_count&quot;</code> | |

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ES\_SEARCH\_STRATEGY](./kibana-plugin-plugins-data-public.es_search_strategy.md)

## ES\_SEARCH\_STRATEGY variable

<b>Signature:</b>

```typescript
ES_SEARCH_STRATEGY = "es"
```
Loading