Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Docs] some basic searchsource api docs #77038

Merged
merged 5 commits into from
Sep 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [(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> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [aggConfigs](./kibana-plugin-plugins-data-public.aggconfig.aggconfigs.md)

## AggConfig.aggConfigs property

<b>Signature:</b>

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [brandNew](./kibana-plugin-plugins-data-public.aggconfig.brandnew.md)

## AggConfig.brandNew property

<b>Signature:</b>

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [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`

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [enabled](./kibana-plugin-plugins-data-public.aggconfig.enabled.md)

## AggConfig.enabled property

<b>Signature:</b>

```typescript
enabled: boolean;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [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[]`

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [fieldIsTimeField](./kibana-plugin-plugins-data-public.aggconfig.fieldistimefield.md)

## AggConfig.fieldIsTimeField() method

<b>Signature:</b>

```typescript
fieldIsTimeField(): boolean | "" | undefined;
```
<b>Returns:</b>

`boolean | "" | undefined`

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [fieldName](./kibana-plugin-plugins-data-public.aggconfig.fieldname.md)

## AggConfig.fieldName() method

<b>Signature:</b>

```typescript
fieldName(): any;
```
<b>Returns:</b>

`any`

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

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getField](./kibana-plugin-plugins-data-public.aggconfig.getfield.md)

## AggConfig.getField() method

<b>Signature:</b>

```typescript
getField(): any;
```
<b>Returns:</b>

`any`

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getFieldDisplayName](./kibana-plugin-plugins-data-public.aggconfig.getfielddisplayname.md)

## AggConfig.getFieldDisplayName() method

<b>Signature:</b>

```typescript
getFieldDisplayName(): any;
```
<b>Returns:</b>

`any`

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

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [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`

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

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getRequestAggs](./kibana-plugin-plugins-data-public.aggconfig.getrequestaggs.md)

## AggConfig.getRequestAggs() method

<b>Signature:</b>

```typescript
getRequestAggs(): AggConfig[];
```
<b>Returns:</b>

`AggConfig[]`

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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getResponseAggs](./kibana-plugin-plugins-data-public.aggconfig.getresponseaggs.md)

## AggConfig.getResponseAggs() method

<b>Signature:</b>

```typescript
getResponseAggs(): AggConfig[];
```
<b>Returns:</b>

`AggConfig[]`

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

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

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [id](./kibana-plugin-plugins-data-public.aggconfig.id.md)

## AggConfig.id property

<b>Signature:</b>

```typescript
id: string;
```
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) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [isFilterable](./kibana-plugin-plugins-data-public.aggconfig.isfilterable.md)

## AggConfig.isFilterable() method

<b>Signature:</b>

```typescript
isFilterable(): boolean;
```
<b>Returns:</b>

`boolean`

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

Loading