forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] some basic searchsource api docs (elastic#77038)
- Loading branch information
Showing
126 changed files
with
2,544 additions
and
143 deletions.
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
...lugins/data/public/kibana-plugin-plugins-data-public.aggconfig._constructor_.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [(constructor)](./kibana-plugin-plugins-data-public.aggconfig._constructor_.md) | ||
|
||
## AggConfig.(constructor) | ||
|
||
Constructs a new instance of the `AggConfig` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
constructor(aggConfigs: IAggConfigs, opts: AggConfigOptions); | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| aggConfigs | <code>IAggConfigs</code> | | | ||
| opts | <code>AggConfigOptions</code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
...t/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.aggconfigs.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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [aggConfigs](./kibana-plugin-plugins-data-public.aggconfig.aggconfigs.md) | ||
|
||
## AggConfig.aggConfigs property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
aggConfigs: IAggConfigs; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...ent/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.brandnew.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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [brandNew](./kibana-plugin-plugins-data-public.aggconfig.brandnew.md) | ||
|
||
## AggConfig.brandNew property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
brandNew?: boolean; | ||
``` |
23 changes: 23 additions & 0 deletions
23
...plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.createfilter.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [createFilter](./kibana-plugin-plugins-data-public.aggconfig.createfilter.md) | ||
|
||
## AggConfig.createFilter() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
createFilter(key: string, params?: {}): any; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| key | <code>string</code> | | | ||
| params | <code>{}</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`any` | ||
|
11 changes: 11 additions & 0 deletions
11
...ment/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.enabled.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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [enabled](./kibana-plugin-plugins-data-public.aggconfig.enabled.md) | ||
|
||
## AggConfig.enabled property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
enabled: boolean; | ||
``` |
24 changes: 24 additions & 0 deletions
24
...nt/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.ensureids.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-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [ensureIds](./kibana-plugin-plugins-data-public.aggconfig.ensureids.md) | ||
|
||
## AggConfig.ensureIds() method | ||
|
||
Ensure that all of the objects in the list have ids, the objects and list are modified by reference. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static ensureIds(list: any[]): any[]; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| list | <code>any[]</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`any[]` | ||
|
15 changes: 15 additions & 0 deletions
15
...ins/data/public/kibana-plugin-plugins-data-public.aggconfig.fieldistimefield.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [fieldIsTimeField](./kibana-plugin-plugins-data-public.aggconfig.fieldistimefield.md) | ||
|
||
## AggConfig.fieldIsTimeField() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldIsTimeField(): boolean | "" | undefined; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`boolean | "" | undefined` | ||
|
15 changes: 15 additions & 0 deletions
15
...nt/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.fieldname.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [fieldName](./kibana-plugin-plugins-data-public.aggconfig.fieldname.md) | ||
|
||
## AggConfig.fieldName() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldName(): any; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`any` | ||
|
15 changes: 15 additions & 0 deletions
15
...plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getaggparams.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getAggParams](./kibana-plugin-plugins-data-public.aggconfig.getaggparams.md) | ||
|
||
## AggConfig.getAggParams() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getAggParams(): import("./param_types/agg").AggParamType<AggConfig>[]; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`import("./param_types/agg").AggParamType<AggConfig>[]` | ||
|
15 changes: 15 additions & 0 deletions
15
...ent/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getfield.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getField](./kibana-plugin-plugins-data-public.aggconfig.getfield.md) | ||
|
||
## AggConfig.getField() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getField(): any; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`any` | ||
|
15 changes: 15 additions & 0 deletions
15
.../data/public/kibana-plugin-plugins-data-public.aggconfig.getfielddisplayname.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getFieldDisplayName](./kibana-plugin-plugins-data-public.aggconfig.getfielddisplayname.md) | ||
|
||
## AggConfig.getFieldDisplayName() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getFieldDisplayName(): any; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`any` | ||
|
15 changes: 15 additions & 0 deletions
15
...gins/data/public/kibana-plugin-plugins-data-public.aggconfig.getindexpattern.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getIndexPattern](./kibana-plugin-plugins-data-public.aggconfig.getindexpattern.md) | ||
|
||
## AggConfig.getIndexPattern() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getIndexPattern(): import("../../../public").IndexPattern; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`import("../../../public").IndexPattern` | ||
|
23 changes: 23 additions & 0 deletions
23
...pment/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getkey.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getKey](./kibana-plugin-plugins-data-public.aggconfig.getkey.md) | ||
|
||
## AggConfig.getKey() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getKey(bucket: any, key?: string): any; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| bucket | <code>any</code> | | | ||
| key | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`any` | ||
|
22 changes: 22 additions & 0 deletions
22
...ent/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getparam.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-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getParam](./kibana-plugin-plugins-data-public.aggconfig.getparam.md) | ||
|
||
## AggConfig.getParam() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getParam(key: string): any; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| key | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`any` | ||
|
15 changes: 15 additions & 0 deletions
15
...ugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getrequestaggs.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getRequestAggs](./kibana-plugin-plugins-data-public.aggconfig.getrequestaggs.md) | ||
|
||
## AggConfig.getRequestAggs() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getRequestAggs(): AggConfig[]; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`AggConfig[]` | ||
|
15 changes: 15 additions & 0 deletions
15
...gins/data/public/kibana-plugin-plugins-data-public.aggconfig.getresponseaggs.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getResponseAggs](./kibana-plugin-plugins-data-public.aggconfig.getresponseaggs.md) | ||
|
||
## AggConfig.getResponseAggs() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getResponseAggs(): AggConfig[]; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`AggConfig[]` | ||
|
15 changes: 15 additions & 0 deletions
15
...plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.gettimerange.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getTimeRange](./kibana-plugin-plugins-data-public.aggconfig.gettimerange.md) | ||
|
||
## AggConfig.getTimeRange() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getTimeRange(): import("../../../public").TimeRange | undefined; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`import("../../../public").TimeRange | undefined` | ||
|
22 changes: 22 additions & 0 deletions
22
...ent/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getvalue.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-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [getValue](./kibana-plugin-plugins-data-public.aggconfig.getvalue.md) | ||
|
||
## AggConfig.getValue() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getValue(bucket: any): any; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| bucket | <code>any</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`any` | ||
|
11 changes: 11 additions & 0 deletions
11
...velopment/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.id.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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [id](./kibana-plugin-plugins-data-public.aggconfig.id.md) | ||
|
||
## AggConfig.id property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
id: string; | ||
``` |
15 changes: 15 additions & 0 deletions
15
...plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.isfilterable.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,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) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [isFilterable](./kibana-plugin-plugins-data-public.aggconfig.isfilterable.md) | ||
|
||
## AggConfig.isFilterable() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isFilterable(): boolean; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`boolean` | ||
|
22 changes: 22 additions & 0 deletions
22
...nt/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.makelabel.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-data-public](./kibana-plugin-plugins-data-public.md) > [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) > [makeLabel](./kibana-plugin-plugins-data-public.aggconfig.makelabel.md) | ||
|
||
## AggConfig.makeLabel() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
makeLabel(percentageMode?: boolean): any; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| percentageMode | <code>boolean</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`any` | ||
|
Oops, something went wrong.