mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
Generate docs from data plugin (#56955)
* Add doc building for data plugin * Added data server md file * index file for suggestion component * Clear out internal imports from public API * Remove FunctionalComponent usage * comment out working docs * Added fixes following @octogonz feedback * new docs * Clean up * Clean up 2 * fix jest * rename docs script file * update tasks * tasks * update docs
This commit is contained in:
Liza Katz
GitHub
parent
35bcb36ee6
commit
28d0cf4485
493 changed files with 10516 additions and 53 deletions
12
docs/development/plugins/data/public/index.md
Normal file
12
docs/development/plugins/data/public/index.md
Normal file
|
|
@ -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) | |
|
||||
|
||||
|
|
@ -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) > [addSearchStrategy](./kibana-plugin-plugins-data-public.addsearchstrategy.md)
|
||||
|
||||
## addSearchStrategy variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
addSearchStrategy: (searchStrategy: SearchStrategyProvider) => void
|
||||
```
|
||||
|
|
@ -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) > [baseFormattersPublic](./kibana-plugin-plugins-data-public.baseformatterspublic.md)
|
||||
|
||||
## baseFormattersPublic variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
baseFormattersPublic: (import("../../common").IFieldFormatType | typeof DateFormat)[]
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [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
|
||||
```
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
<!-- 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) > [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
|
||||
```
|
||||
|
|
@ -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) > [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
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [CustomFilter](./kibana-plugin-plugins-data-public.customfilter.md)
|
||||
|
||||
## CustomFilter type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type CustomFilter = Filter & {
|
||||
query: any;
|
||||
};
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) > [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginsetup.autocomplete.md)
|
||||
|
||||
## DataPublicPluginSetup.autocomplete property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
autocomplete: AutocompleteSetup;
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) > [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginsetup.fieldformats.md)
|
||||
|
||||
## DataPublicPluginSetup.fieldFormats property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
fieldFormats: FieldFormatsSetup;
|
||||
```
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<!-- 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) > [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> | |
|
||||
|
||||
|
|
@ -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) > [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) > [query](./kibana-plugin-plugins-data-public.datapublicpluginsetup.query.md)
|
||||
|
||||
## DataPublicPluginSetup.query property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
query: QuerySetup;
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) > [search](./kibana-plugin-plugins-data-public.datapublicpluginsetup.search.md)
|
||||
|
||||
## DataPublicPluginSetup.search property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
search: ISearchSetup;
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) > [autocomplete](./kibana-plugin-plugins-data-public.datapublicpluginstart.autocomplete.md)
|
||||
|
||||
## DataPublicPluginStart.autocomplete property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
autocomplete: AutocompleteStart;
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) > [fieldFormats](./kibana-plugin-plugins-data-public.datapublicpluginstart.fieldformats.md)
|
||||
|
||||
## DataPublicPluginStart.fieldFormats property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
fieldFormats: FieldFormatsStart;
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) > [indexPatterns](./kibana-plugin-plugins-data-public.datapublicpluginstart.indexpatterns.md)
|
||||
|
||||
## DataPublicPluginStart.indexPatterns property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
indexPatterns: IndexPatternsContract;
|
||||
```
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
<!-- 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) > [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<IndexPatternSelectProps>;</code><br/><code> SearchBar: React.ComponentType<StatefulSearchBarProps>;</code><br/><code> }</code> | |
|
||||
|
||||
|
|
@ -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) > [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) > [query](./kibana-plugin-plugins-data-public.datapublicpluginstart.query.md)
|
||||
|
||||
## DataPublicPluginStart.query property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
query: QueryStart;
|
||||
```
|
||||
|
|
@ -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) > [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) > [search](./kibana-plugin-plugins-data-public.datapublicpluginstart.search.md)
|
||||
|
||||
## DataPublicPluginStart.search property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
search: ISearchStart;
|
||||
```
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<!-- 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) > [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) > [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>;
|
||||
};
|
||||
```
|
||||
|
|
@ -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) > [defaultSearchStrategy](./kibana-plugin-plugins-data-public.defaultsearchstrategy.md)
|
||||
|
||||
## defaultSearchStrategy variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
defaultSearchStrategy: SearchStrategyProvider
|
||||
```
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
<!-- 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) > [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>"_id"</code> | |
|
||||
| \_INDEX | <code>"_index"</code> | |
|
||||
| \_SOURCE | <code>"_source"</code> | |
|
||||
| \_TYPE | <code>"_type"</code> | |
|
||||
| ATTACHMENT | <code>"attachment"</code> | |
|
||||
| BOOLEAN | <code>"boolean"</code> | |
|
||||
| BYTE | <code>"byte"</code> | |
|
||||
| DATE | <code>"date"</code> | |
|
||||
| DATE\_NANOS | <code>"date_nanos"</code> | |
|
||||
| DOUBLE | <code>"double"</code> | |
|
||||
| FLOAT | <code>"float"</code> | |
|
||||
| GEO\_POINT | <code>"geo_point"</code> | |
|
||||
| GEO\_SHAPE | <code>"geo_shape"</code> | |
|
||||
| HALF\_FLOAT | <code>"half_float"</code> | |
|
||||
| INTEGER | <code>"integer"</code> | |
|
||||
| IP | <code>"ip"</code> | |
|
||||
| KEYWORD | <code>"keyword"</code> | |
|
||||
| LONG | <code>"long"</code> | |
|
||||
| MURMUR3 | <code>"murmur3"</code> | |
|
||||
| NESTED | <code>"nested"</code> | |
|
||||
| OBJECT | <code>"object"</code> | |
|
||||
| SCALED\_FLOAT | <code>"scaled_float"</code> | |
|
||||
| SHORT | <code>"short"</code> | |
|
||||
| STRING | <code>"string"</code> | |
|
||||
| TEXT | <code>"text"</code> | |
|
||||
| TOKEN\_COUNT | <code>"token_count"</code> | |
|
||||
|
||||
|
|
@ -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) > [ES\_SEARCH\_STRATEGY](./kibana-plugin-plugins-data-public.es_search_strategy.md)
|
||||
|
||||
## ES\_SEARCH\_STRATEGY variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ES_SEARCH_STRATEGY = "es"
|
||||
```
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
<!-- 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) > [esFilters](./kibana-plugin-plugins-data-public.esfilters.md)
|
||||
|
||||
## esFilters variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
esFilters: {
|
||||
FilterLabel: typeof FilterLabel;
|
||||
FILTERS: typeof FILTERS;
|
||||
FilterStateStore: typeof FilterStateStore;
|
||||
buildEmptyFilter: (isPinned: boolean, index?: string | undefined) => import("../common").Filter;
|
||||
buildPhrasesFilter: (field: import("../common").IFieldType, params: any[], indexPattern: import("../common").IIndexPattern) => import("../common").PhrasesFilter;
|
||||
buildExistsFilter: (field: import("../common").IFieldType, indexPattern: import("../common").IIndexPattern) => import("../common").ExistsFilter;
|
||||
buildPhraseFilter: (field: import("../common").IFieldType, value: any, indexPattern: import("../common").IIndexPattern) => import("../common").PhraseFilter;
|
||||
buildQueryFilter: (query: any, index: string, alias: string) => import("../common").QueryStringFilter;
|
||||
buildRangeFilter: (field: import("../common").IFieldType, params: import("../common").RangeFilterParams, indexPattern: import("../common").IIndexPattern, formattedValue?: string | undefined) => import("../common").RangeFilter;
|
||||
isPhraseFilter: (filter: any) => filter is import("../common").PhraseFilter;
|
||||
isExistsFilter: (filter: any) => filter is import("../common").ExistsFilter;
|
||||
isPhrasesFilter: (filter: any) => filter is import("../common").PhrasesFilter;
|
||||
isRangeFilter: (filter: any) => filter is import("../common").RangeFilter;
|
||||
isMatchAllFilter: (filter: any) => filter is import("../common").MatchAllFilter;
|
||||
isMissingFilter: (filter: any) => filter is import("../common").MissingFilter;
|
||||
isQueryStringFilter: (filter: any) => filter is import("../common").QueryStringFilter;
|
||||
isFilterPinned: (filter: import("../common").Filter) => boolean | undefined;
|
||||
toggleFilterNegated: (filter: import("../common").Filter) => {
|
||||
meta: {
|
||||
negate: boolean;
|
||||
alias: string | null;
|
||||
disabled: boolean;
|
||||
controlledBy?: string | undefined;
|
||||
index?: string | undefined;
|
||||
type?: string | undefined;
|
||||
key?: string | undefined;
|
||||
params?: any;
|
||||
value?: string | ((formatter?: import("../common").FilterValueFormatter | undefined) => string) | undefined;
|
||||
};
|
||||
$state?: import("../common").FilterState | undefined;
|
||||
query?: any;
|
||||
};
|
||||
disableFilter: (filter: import("../common").Filter) => import("../common").Filter;
|
||||
getPhraseFilterField: (filter: import("../common").PhraseFilter) => string;
|
||||
getPhraseFilterValue: (filter: import("../common").PhraseFilter) => string | number | boolean;
|
||||
getDisplayValueFromFilter: typeof getDisplayValueFromFilter;
|
||||
compareFilters: (first: import("../common").Filter | import("../common").Filter[], second: import("../common").Filter | import("../common").Filter[], comparatorOptions?: import("./query/filter_manager/lib/compare_filters").FilterCompareOptions) => boolean;
|
||||
COMPARE_ALL_OPTIONS: import("./query/filter_manager/lib/compare_filters").FilterCompareOptions;
|
||||
generateFilters: typeof generateFilters;
|
||||
onlyDisabledFiltersChanged: (newFilters?: import("../common").Filter[] | undefined, oldFilters?: import("../common").Filter[] | undefined) => boolean;
|
||||
changeTimeFilter: typeof changeTimeFilter;
|
||||
mapAndFlattenFilters: (filters: import("../common").Filter[]) => import("../common").Filter[];
|
||||
extractTimeFilter: typeof extractTimeFilter;
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [esKuery](./kibana-plugin-plugins-data-public.eskuery.md)
|
||||
|
||||
## esKuery variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
esKuery: {
|
||||
nodeTypes: import("../common/es_query/kuery/node_types").NodeTypes;
|
||||
fromKueryExpression: (expression: any, parseOptions?: Partial<import("../common").KueryParseOptions>) => import("../common").KueryNode;
|
||||
toElasticsearchQuery: (node: import("../common").KueryNode, indexPattern?: import("../common").IIndexPattern | undefined, config?: Record<string, any> | undefined, context?: Record<string, any> | undefined) => import("../../kibana_utils/common").JsonObject;
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- 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) > [esQuery](./kibana-plugin-plugins-data-public.esquery.md)
|
||||
|
||||
## esQuery variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
esQuery: {
|
||||
buildEsQuery: typeof buildEsQuery;
|
||||
getEsQueryConfig: typeof getEsQueryConfig;
|
||||
buildQueryFromFilters: (filters: import("../common").Filter[] | undefined, indexPattern: import("../common").IIndexPattern | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => {
|
||||
must: never[];
|
||||
filter: import("../common").Filter[];
|
||||
should: never[];
|
||||
must_not: import("../common").Filter[];
|
||||
};
|
||||
luceneStringToDsl: typeof luceneStringToDsl;
|
||||
decorateQuery: typeof decorateQuery;
|
||||
}
|
||||
```
|
||||
|
|
@ -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) > [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) > [allowLeadingWildcards](./kibana-plugin-plugins-data-public.esqueryconfig.allowleadingwildcards.md)
|
||||
|
||||
## EsQueryConfig.allowLeadingWildcards property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
allowLeadingWildcards: boolean;
|
||||
```
|
||||
|
|
@ -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) > [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) > [dateFormatTZ](./kibana-plugin-plugins-data-public.esqueryconfig.dateformattz.md)
|
||||
|
||||
## EsQueryConfig.dateFormatTZ property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dateFormatTZ?: string;
|
||||
```
|
||||
|
|
@ -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) > [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) > [ignoreFilterIfFieldNotInIndex](./kibana-plugin-plugins-data-public.esqueryconfig.ignorefilteriffieldnotinindex.md)
|
||||
|
||||
## EsQueryConfig.ignoreFilterIfFieldNotInIndex property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ignoreFilterIfFieldNotInIndex: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<!-- 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) > [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md)
|
||||
|
||||
## EsQueryConfig interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface EsQueryConfig
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [allowLeadingWildcards](./kibana-plugin-plugins-data-public.esqueryconfig.allowleadingwildcards.md) | <code>boolean</code> | |
|
||||
| [dateFormatTZ](./kibana-plugin-plugins-data-public.esqueryconfig.dateformattz.md) | <code>string</code> | |
|
||||
| [ignoreFilterIfFieldNotInIndex](./kibana-plugin-plugins-data-public.esqueryconfig.ignorefilteriffieldnotinindex.md) | <code>boolean</code> | |
|
||||
| [queryStringOptions](./kibana-plugin-plugins-data-public.esqueryconfig.querystringoptions.md) | <code>Record<string, any></code> | |
|
||||
|
||||
|
|
@ -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) > [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) > [queryStringOptions](./kibana-plugin-plugins-data-public.esqueryconfig.querystringoptions.md)
|
||||
|
||||
## EsQueryConfig.queryStringOptions property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
queryStringOptions: Record<string, any>;
|
||||
```
|
||||
|
|
@ -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) > [EsQuerySortValue](./kibana-plugin-plugins-data-public.esquerysortvalue.md)
|
||||
|
||||
## EsQuerySortValue type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type EsQuerySortValue = Record<string, SortDirection | SortDirectionNumeric>;
|
||||
```
|
||||
|
|
@ -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) > [esSearchStrategyProvider](./kibana-plugin-plugins-data-public.essearchstrategyprovider.md)
|
||||
|
||||
## esSearchStrategyProvider variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
esSearchStrategyProvider: TSearchStrategyProvider<typeof ES_SEARCH_STRATEGY>
|
||||
```
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<!-- 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) > [ExistsFilter](./kibana-plugin-plugins-data-public.existsfilter.md)
|
||||
|
||||
## ExistsFilter type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type ExistsFilter = Filter & {
|
||||
meta: ExistsFilterMeta;
|
||||
exists?: FilterExistsProperty;
|
||||
};
|
||||
```
|
||||
|
|
@ -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) > [FetchOptions](./kibana-plugin-plugins-data-public.fetchoptions.md) > [abortSignal](./kibana-plugin-plugins-data-public.fetchoptions.abortsignal.md)
|
||||
|
||||
## FetchOptions.abortSignal property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
abortSignal?: AbortSignal;
|
||||
```
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- 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) > [FetchOptions](./kibana-plugin-plugins-data-public.fetchoptions.md)
|
||||
|
||||
## FetchOptions interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface FetchOptions
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [abortSignal](./kibana-plugin-plugins-data-public.fetchoptions.abortsignal.md) | <code>AbortSignal</code> | |
|
||||
| [searchStrategyId](./kibana-plugin-plugins-data-public.fetchoptions.searchstrategyid.md) | <code>string</code> | |
|
||||
|
||||
|
|
@ -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) > [FetchOptions](./kibana-plugin-plugins-data-public.fetchoptions.md) > [searchStrategyId](./kibana-plugin-plugins-data-public.fetchoptions.searchstrategyid.md)
|
||||
|
||||
## FetchOptions.searchStrategyId property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
searchStrategyId?: string;
|
||||
```
|
||||
|
|
@ -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) > [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) > [es](./kibana-plugin-plugins-data-public.fieldformatconfig.es.md)
|
||||
|
||||
## FieldFormatConfig.es property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
es?: boolean;
|
||||
```
|
||||
|
|
@ -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) > [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) > [id](./kibana-plugin-plugins-data-public.fieldformatconfig.id.md)
|
||||
|
||||
## FieldFormatConfig.id property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: FieldFormatId;
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<!-- 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) > [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md)
|
||||
|
||||
## FieldFormatConfig interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface FieldFormatConfig
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [es](./kibana-plugin-plugins-data-public.fieldformatconfig.es.md) | <code>boolean</code> | |
|
||||
| [id](./kibana-plugin-plugins-data-public.fieldformatconfig.id.md) | <code>FieldFormatId</code> | |
|
||||
| [params](./kibana-plugin-plugins-data-public.fieldformatconfig.params.md) | <code>Record<string, any></code> | |
|
||||
|
||||
|
|
@ -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) > [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) > [params](./kibana-plugin-plugins-data-public.fieldformatconfig.params.md)
|
||||
|
||||
## FieldFormatConfig.params property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
params: Record<string, any>;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [FieldFormatId](./kibana-plugin-plugins-data-public.fieldformatid.md)
|
||||
|
||||
## FieldFormatId type
|
||||
|
||||
id type is needed for creating custom converters.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type FieldFormatId = FIELD_FORMAT_IDS | string;
|
||||
```
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
<!-- 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) > [fieldFormats](./kibana-plugin-plugins-data-public.fieldformats.md)
|
||||
|
||||
## fieldFormats variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
fieldFormats: {
|
||||
FieldFormat: typeof FieldFormat;
|
||||
FieldFormatsRegistry: typeof FieldFormatsRegistry;
|
||||
serialize: (agg: import("../../../legacy/core_plugins/data/public/search").AggConfig) => import("../../expressions/common").SerializedFieldFormat<object>;
|
||||
DEFAULT_CONVERTER_COLOR: {
|
||||
range: string;
|
||||
regex: string;
|
||||
text: string;
|
||||
background: string;
|
||||
};
|
||||
HTML_CONTEXT_TYPE: import("../common").FieldFormatsContentType;
|
||||
TEXT_CONTEXT_TYPE: import("../common").FieldFormatsContentType;
|
||||
FIELD_FORMAT_IDS: typeof FIELD_FORMAT_IDS;
|
||||
BoolFormat: typeof BoolFormat;
|
||||
BytesFormat: typeof BytesFormat;
|
||||
ColorFormat: typeof ColorFormat;
|
||||
DateFormat: typeof DateFormat;
|
||||
DateNanosFormat: typeof DateNanosFormat;
|
||||
DurationFormat: typeof DurationFormat;
|
||||
IpFormat: typeof IpFormat;
|
||||
NumberFormat: typeof NumberFormat;
|
||||
PercentFormat: typeof PercentFormat;
|
||||
RelativeDateFormat: typeof RelativeDateFormat;
|
||||
SourceFormat: typeof SourceFormat;
|
||||
StaticLookupFormat: typeof StaticLookupFormat;
|
||||
UrlFormat: typeof UrlFormat;
|
||||
StringFormat: typeof StringFormat;
|
||||
TruncateFormat: typeof TruncateFormat;
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [FieldFormatsContentType](./kibana-plugin-plugins-data-public.fieldformatscontenttype.md)
|
||||
|
||||
## FieldFormatsContentType type
|
||||
|
||||
\*
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type FieldFormatsContentType = 'html' | 'text';
|
||||
```
|
||||
|
|
@ -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) > [FieldFormatsGetConfigFn](./kibana-plugin-plugins-data-public.fieldformatsgetconfigfn.md)
|
||||
|
||||
## FieldFormatsGetConfigFn type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type FieldFormatsGetConfigFn = <T = any>(key: string, defaultOverride?: T) => T;
|
||||
```
|
||||
|
|
@ -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) > [Filter](./kibana-plugin-plugins-data-public.filter.md) > [$state](./kibana-plugin-plugins-data-public.filter._state.md)
|
||||
|
||||
## Filter.$state property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
$state?: FilterState;
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<!-- 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) > [Filter](./kibana-plugin-plugins-data-public.filter.md)
|
||||
|
||||
## Filter interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Filter
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [$state](./kibana-plugin-plugins-data-public.filter._state.md) | <code>FilterState</code> | |
|
||||
| [meta](./kibana-plugin-plugins-data-public.filter.meta.md) | <code>FilterMeta</code> | |
|
||||
| [query](./kibana-plugin-plugins-data-public.filter.query.md) | <code>any</code> | |
|
||||
|
||||
|
|
@ -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) > [Filter](./kibana-plugin-plugins-data-public.filter.md) > [meta](./kibana-plugin-plugins-data-public.filter.meta.md)
|
||||
|
||||
## Filter.meta property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
meta: FilterMeta;
|
||||
```
|
||||
|
|
@ -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) > [Filter](./kibana-plugin-plugins-data-public.filter.md) > [query](./kibana-plugin-plugins-data-public.filter.query.md)
|
||||
|
||||
## Filter.query property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
query?: any;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [FilterBar](./kibana-plugin-plugins-data-public.filterbar.md)
|
||||
|
||||
## FilterBar variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
FilterBar: React.ComponentClass<Pick<Props, "className" | "indexPatterns" | "filters" | "onFiltersUpdated">, any> & {
|
||||
WrappedComponent: React.ComponentType<Props & ReactIntl.InjectedIntlProps>;
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [(constructor)](./kibana-plugin-plugins-data-public.filtermanager._constructor_.md)
|
||||
|
||||
## FilterManager.(constructor)
|
||||
|
||||
Constructs a new instance of the `FilterManager` class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
constructor(uiSettings: IUiSettingsClient);
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| uiSettings | <code>IUiSettingsClient</code> | |
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [addFilters](./kibana-plugin-plugins-data-public.filtermanager.addfilters.md)
|
||||
|
||||
## FilterManager.addFilters() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
addFilters(filters: Filter[] | Filter, pinFilterStatus?: boolean): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| filters | <code>Filter[] | Filter</code> | |
|
||||
| pinFilterStatus | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [getAppFilters](./kibana-plugin-plugins-data-public.filtermanager.getappfilters.md)
|
||||
|
||||
## FilterManager.getAppFilters() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getAppFilters(): Filter[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Filter[]`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [getFetches$](./kibana-plugin-plugins-data-public.filtermanager.getfetches_.md)
|
||||
|
||||
## FilterManager.getFetches$() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getFetches$(): import("rxjs").Observable<void>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`import("rxjs").Observable<void>`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [getFilters](./kibana-plugin-plugins-data-public.filtermanager.getfilters.md)
|
||||
|
||||
## FilterManager.getFilters() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getFilters(): Filter[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Filter[]`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [getGlobalFilters](./kibana-plugin-plugins-data-public.filtermanager.getglobalfilters.md)
|
||||
|
||||
## FilterManager.getGlobalFilters() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getGlobalFilters(): Filter[];
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Filter[]`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [getPartitionedFilters](./kibana-plugin-plugins-data-public.filtermanager.getpartitionedfilters.md)
|
||||
|
||||
## FilterManager.getPartitionedFilters() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getPartitionedFilters(): PartitionedFilters;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`PartitionedFilters`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [getUpdates$](./kibana-plugin-plugins-data-public.filtermanager.getupdates_.md)
|
||||
|
||||
## FilterManager.getUpdates$() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getUpdates$(): import("rxjs").Observable<void>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`import("rxjs").Observable<void>`
|
||||
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md)
|
||||
|
||||
## FilterManager class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class FilterManager
|
||||
```
|
||||
|
||||
## Constructors
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [(constructor)(uiSettings)](./kibana-plugin-plugins-data-public.filtermanager._constructor_.md) | | Constructs a new instance of the <code>FilterManager</code> class |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [addFilters(filters, pinFilterStatus)](./kibana-plugin-plugins-data-public.filtermanager.addfilters.md) | | |
|
||||
| [getAppFilters()](./kibana-plugin-plugins-data-public.filtermanager.getappfilters.md) | | |
|
||||
| [getFetches$()](./kibana-plugin-plugins-data-public.filtermanager.getfetches_.md) | | |
|
||||
| [getFilters()](./kibana-plugin-plugins-data-public.filtermanager.getfilters.md) | | |
|
||||
| [getGlobalFilters()](./kibana-plugin-plugins-data-public.filtermanager.getglobalfilters.md) | | |
|
||||
| [getPartitionedFilters()](./kibana-plugin-plugins-data-public.filtermanager.getpartitionedfilters.md) | | |
|
||||
| [getUpdates$()](./kibana-plugin-plugins-data-public.filtermanager.getupdates_.md) | | |
|
||||
| [removeAll()](./kibana-plugin-plugins-data-public.filtermanager.removeall.md) | | |
|
||||
| [removeFilter(filter)](./kibana-plugin-plugins-data-public.filtermanager.removefilter.md) | | |
|
||||
| [setAppFilters(newAppFilters)](./kibana-plugin-plugins-data-public.filtermanager.setappfilters.md) | | Sets new app filters and leaves global filters untouched, Removes app filters for which there is a duplicate within new global filters |
|
||||
| [setFilters(newFilters, pinFilterStatus)](./kibana-plugin-plugins-data-public.filtermanager.setfilters.md) | | |
|
||||
| [setFiltersStore(filters, store, shouldOverrideStore)](./kibana-plugin-plugins-data-public.filtermanager.setfiltersstore.md) | <code>static</code> | |
|
||||
| [setGlobalFilters(newGlobalFilters)](./kibana-plugin-plugins-data-public.filtermanager.setglobalfilters.md) | | Sets new global filters and leaves app filters untouched, Removes app filters for which there is a duplicate within new global filters |
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [removeAll](./kibana-plugin-plugins-data-public.filtermanager.removeall.md)
|
||||
|
||||
## FilterManager.removeAll() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
removeAll(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [removeFilter](./kibana-plugin-plugins-data-public.filtermanager.removefilter.md)
|
||||
|
||||
## FilterManager.removeFilter() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
removeFilter(filter: Filter): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| filter | <code>Filter</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [setAppFilters](./kibana-plugin-plugins-data-public.filtermanager.setappfilters.md)
|
||||
|
||||
## FilterManager.setAppFilters() method
|
||||
|
||||
Sets new app filters and leaves global filters untouched, Removes app filters for which there is a duplicate within new global filters
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setAppFilters(newAppFilters: Filter[]): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| newAppFilters | <code>Filter[]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [setFilters](./kibana-plugin-plugins-data-public.filtermanager.setfilters.md)
|
||||
|
||||
## FilterManager.setFilters() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setFilters(newFilters: Filter[], pinFilterStatus?: boolean): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| newFilters | <code>Filter[]</code> | |
|
||||
| pinFilterStatus | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [setFiltersStore](./kibana-plugin-plugins-data-public.filtermanager.setfiltersstore.md)
|
||||
|
||||
## FilterManager.setFiltersStore() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
static setFiltersStore(filters: Filter[], store: FilterStateStore, shouldOverrideStore?: boolean): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| filters | <code>Filter[]</code> | |
|
||||
| store | <code>FilterStateStore</code> | |
|
||||
| shouldOverrideStore | <code>boolean</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- 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) > [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) > [setGlobalFilters](./kibana-plugin-plugins-data-public.filtermanager.setglobalfilters.md)
|
||||
|
||||
## FilterManager.setGlobalFilters() method
|
||||
|
||||
Sets new global filters and leaves app filters untouched, Removes app filters for which there is a duplicate within new global filters
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
setGlobalFilters(newGlobalFilters: Filter[]): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| newGlobalFilters | <code>Filter[]</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
<!-- 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) > [getEsPreference](./kibana-plugin-plugins-data-public.getespreference.md)
|
||||
|
||||
## getEsPreference() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getEsPreference(uiSettings: IUiSettingsClient, sessionId?: string): any;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| uiSettings | <code>IUiSettingsClient</code> | |
|
||||
| sessionId | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`any`
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!-- 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) > [getKbnTypeNames](./kibana-plugin-plugins-data-public.getkbntypenames.md)
|
||||
|
||||
## getKbnTypeNames variable
|
||||
|
||||
Get the esTypes known by all kbnFieldTypes
|
||||
|
||||
{<!-- -->Array<string>}
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
getKbnTypeNames: () => string[]
|
||||
```
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<!-- 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) > [getQueryLog](./kibana-plugin-plugins-data-public.getquerylog.md)
|
||||
|
||||
## getQueryLog() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getQueryLog(uiSettings: IUiSettingsClient, storage: IStorageWrapper, appName: string, language: string): PersistedLog<any>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| uiSettings | <code>IUiSettingsClient</code> | |
|
||||
| storage | <code>IStorageWrapper</code> | |
|
||||
| appName | <code>string</code> | |
|
||||
| language | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`PersistedLog<any>`
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- 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) > [getSearchErrorType](./kibana-plugin-plugins-data-public.getsearcherrortype.md)
|
||||
|
||||
## getSearchErrorType() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getSearchErrorType({ message }: Pick<SearchError, 'message'>): "UNSUPPORTED_QUERY" | undefined;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| { message } | <code>Pick<SearchError, 'message'></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`"UNSUPPORTED_QUERY" | undefined`
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- 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) > [getTime](./kibana-plugin-plugins-data-public.gettime.md)
|
||||
|
||||
## getTime() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, forceNow?: Date): import("../..").RangeFilter | undefined;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| indexPattern | <code>IIndexPattern | undefined</code> | |
|
||||
| timeRange | <code>TimeRange</code> | |
|
||||
| forceNow | <code>Date</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`import("../..").RangeFilter | undefined`
|
||||
|
||||
|
|
@ -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) > [hasSearchStategyForIndexPattern](./kibana-plugin-plugins-data-public.hassearchstategyforindexpattern.md)
|
||||
|
||||
## hasSearchStategyForIndexPattern variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hasSearchStategyForIndexPattern: (indexPattern: IndexPattern) => boolean
|
||||
```
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [appName](./kibana-plugin-plugins-data-public.idatapluginservices.appname.md)
|
||||
|
||||
## IDataPluginServices.appName property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
appName: string;
|
||||
```
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [data](./kibana-plugin-plugins-data-public.idatapluginservices.data.md)
|
||||
|
||||
## IDataPluginServices.data property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
data: DataPublicPluginStart;
|
||||
```
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [http](./kibana-plugin-plugins-data-public.idatapluginservices.http.md)
|
||||
|
||||
## IDataPluginServices.http property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
http: CoreStart['http'];
|
||||
```
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- 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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md)
|
||||
|
||||
## IDataPluginServices interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IDataPluginServices extends Partial<CoreStart>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [appName](./kibana-plugin-plugins-data-public.idatapluginservices.appname.md) | <code>string</code> | |
|
||||
| [data](./kibana-plugin-plugins-data-public.idatapluginservices.data.md) | <code>DataPublicPluginStart</code> | |
|
||||
| [http](./kibana-plugin-plugins-data-public.idatapluginservices.http.md) | <code>CoreStart['http']</code> | |
|
||||
| [notifications](./kibana-plugin-plugins-data-public.idatapluginservices.notifications.md) | <code>CoreStart['notifications']</code> | |
|
||||
| [savedObjects](./kibana-plugin-plugins-data-public.idatapluginservices.savedobjects.md) | <code>CoreStart['savedObjects']</code> | |
|
||||
| [storage](./kibana-plugin-plugins-data-public.idatapluginservices.storage.md) | <code>IStorageWrapper</code> | |
|
||||
| [uiSettings](./kibana-plugin-plugins-data-public.idatapluginservices.uisettings.md) | <code>CoreStart['uiSettings']</code> | |
|
||||
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [notifications](./kibana-plugin-plugins-data-public.idatapluginservices.notifications.md)
|
||||
|
||||
## IDataPluginServices.notifications property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
notifications: CoreStart['notifications'];
|
||||
```
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [savedObjects](./kibana-plugin-plugins-data-public.idatapluginservices.savedobjects.md)
|
||||
|
||||
## IDataPluginServices.savedObjects property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
savedObjects: CoreStart['savedObjects'];
|
||||
```
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [storage](./kibana-plugin-plugins-data-public.idatapluginservices.storage.md)
|
||||
|
||||
## IDataPluginServices.storage property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
storage: IStorageWrapper;
|
||||
```
|
||||
|
|
@ -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) > [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) > [uiSettings](./kibana-plugin-plugins-data-public.idatapluginservices.uisettings.md)
|
||||
|
||||
## IDataPluginServices.uiSettings property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
uiSettings: CoreStart['uiSettings'];
|
||||
```
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<!-- 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) > [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md)
|
||||
|
||||
## IEsSearchRequest interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IEsSearchRequest extends IKibanaSearchRequest
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [params](./kibana-plugin-plugins-data-public.iessearchrequest.params.md) | <code>SearchParams</code> | |
|
||||
|
||||
|
|
@ -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) > [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) > [params](./kibana-plugin-plugins-data-public.iessearchrequest.params.md)
|
||||
|
||||
## IEsSearchRequest.params property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
params: SearchParams;
|
||||
```
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<!-- 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) > [IEsSearchResponse](./kibana-plugin-plugins-data-public.iessearchresponse.md)
|
||||
|
||||
## IEsSearchResponse interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IEsSearchResponse<Hits = unknown> extends IKibanaSearchResponse
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [rawResponse](./kibana-plugin-plugins-data-public.iessearchresponse.rawresponse.md) | <code>SearchResponse<Hits></code> | |
|
||||
|
||||
|
|
@ -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) > [IEsSearchResponse](./kibana-plugin-plugins-data-public.iessearchresponse.md) > [rawResponse](./kibana-plugin-plugins-data-public.iessearchresponse.rawresponse.md)
|
||||
|
||||
## IEsSearchResponse.rawResponse property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rawResponse: SearchResponse<Hits>;
|
||||
```
|
||||
|
|
@ -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) > [IFieldFormat](./kibana-plugin-plugins-data-public.ifieldformat.md)
|
||||
|
||||
## IFieldFormat type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type IFieldFormat = PublicMethodsOf<FieldFormat>;
|
||||
```
|
||||
|
|
@ -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) > [IFieldFormatsRegistry](./kibana-plugin-plugins-data-public.ifieldformatsregistry.md)
|
||||
|
||||
## IFieldFormatsRegistry type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
declare type IFieldFormatsRegistry = PublicMethodsOf<FieldFormatsRegistry>;
|
||||
```
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- 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) > [IFieldSubType](./kibana-plugin-plugins-data-public.ifieldsubtype.md)
|
||||
|
||||
## IFieldSubType interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IFieldSubType
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [multi](./kibana-plugin-plugins-data-public.ifieldsubtype.multi.md) | <code>{</code><br/><code> parent: string;</code><br/><code> }</code> | |
|
||||
| [nested](./kibana-plugin-plugins-data-public.ifieldsubtype.nested.md) | <code>{</code><br/><code> path: string;</code><br/><code> }</code> | |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [IFieldSubType](./kibana-plugin-plugins-data-public.ifieldsubtype.md) > [multi](./kibana-plugin-plugins-data-public.ifieldsubtype.multi.md)
|
||||
|
||||
## IFieldSubType.multi property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
multi?: {
|
||||
parent: string;
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- 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) > [IFieldSubType](./kibana-plugin-plugins-data-public.ifieldsubtype.md) > [nested](./kibana-plugin-plugins-data-public.ifieldsubtype.nested.md)
|
||||
|
||||
## IFieldSubType.nested property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nested?: {
|
||||
path: string;
|
||||
};
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [aggregatable](./kibana-plugin-plugins-data-public.ifieldtype.aggregatable.md)
|
||||
|
||||
## IFieldType.aggregatable property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
aggregatable?: boolean;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [count](./kibana-plugin-plugins-data-public.ifieldtype.count.md)
|
||||
|
||||
## IFieldType.count property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
count?: number;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [displayName](./kibana-plugin-plugins-data-public.ifieldtype.displayname.md)
|
||||
|
||||
## IFieldType.displayName property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
displayName?: string;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [esTypes](./kibana-plugin-plugins-data-public.ifieldtype.estypes.md)
|
||||
|
||||
## IFieldType.esTypes property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
esTypes?: string[];
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [filterable](./kibana-plugin-plugins-data-public.ifieldtype.filterable.md)
|
||||
|
||||
## IFieldType.filterable property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
filterable?: boolean;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [format](./kibana-plugin-plugins-data-public.ifieldtype.format.md)
|
||||
|
||||
## IFieldType.format property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
format?: any;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [lang](./kibana-plugin-plugins-data-public.ifieldtype.lang.md)
|
||||
|
||||
## IFieldType.lang property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lang?: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
<!-- 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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md)
|
||||
|
||||
## IFieldType interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IFieldType
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [aggregatable](./kibana-plugin-plugins-data-public.ifieldtype.aggregatable.md) | <code>boolean</code> | |
|
||||
| [count](./kibana-plugin-plugins-data-public.ifieldtype.count.md) | <code>number</code> | |
|
||||
| [displayName](./kibana-plugin-plugins-data-public.ifieldtype.displayname.md) | <code>string</code> | |
|
||||
| [esTypes](./kibana-plugin-plugins-data-public.ifieldtype.estypes.md) | <code>string[]</code> | |
|
||||
| [filterable](./kibana-plugin-plugins-data-public.ifieldtype.filterable.md) | <code>boolean</code> | |
|
||||
| [format](./kibana-plugin-plugins-data-public.ifieldtype.format.md) | <code>any</code> | |
|
||||
| [lang](./kibana-plugin-plugins-data-public.ifieldtype.lang.md) | <code>string</code> | |
|
||||
| [name](./kibana-plugin-plugins-data-public.ifieldtype.name.md) | <code>string</code> | |
|
||||
| [readFromDocValues](./kibana-plugin-plugins-data-public.ifieldtype.readfromdocvalues.md) | <code>boolean</code> | |
|
||||
| [script](./kibana-plugin-plugins-data-public.ifieldtype.script.md) | <code>string</code> | |
|
||||
| [scripted](./kibana-plugin-plugins-data-public.ifieldtype.scripted.md) | <code>boolean</code> | |
|
||||
| [searchable](./kibana-plugin-plugins-data-public.ifieldtype.searchable.md) | <code>boolean</code> | |
|
||||
| [sortable](./kibana-plugin-plugins-data-public.ifieldtype.sortable.md) | <code>boolean</code> | |
|
||||
| [subType](./kibana-plugin-plugins-data-public.ifieldtype.subtype.md) | <code>IFieldSubType</code> | |
|
||||
| [type](./kibana-plugin-plugins-data-public.ifieldtype.type.md) | <code>string</code> | |
|
||||
| [visualizable](./kibana-plugin-plugins-data-public.ifieldtype.visualizable.md) | <code>boolean</code> | |
|
||||
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [name](./kibana-plugin-plugins-data-public.ifieldtype.name.md)
|
||||
|
||||
## IFieldType.name property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [readFromDocValues](./kibana-plugin-plugins-data-public.ifieldtype.readfromdocvalues.md)
|
||||
|
||||
## IFieldType.readFromDocValues property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readFromDocValues?: boolean;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [script](./kibana-plugin-plugins-data-public.ifieldtype.script.md)
|
||||
|
||||
## IFieldType.script property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
script?: string;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [scripted](./kibana-plugin-plugins-data-public.ifieldtype.scripted.md)
|
||||
|
||||
## IFieldType.scripted property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scripted?: boolean;
|
||||
```
|
||||
|
|
@ -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) > [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) > [searchable](./kibana-plugin-plugins-data-public.ifieldtype.searchable.md)
|
||||
|
||||
## IFieldType.searchable property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
searchable?: boolean;
|
||||
```
|
||||
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