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

Cutover aggs to the new platform #59605

Merged
merged 15 commits into from
Mar 13, 2020
  •  
  •  
  •  
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; [AggGroupNames](./kibana-plugin-plugins-data-public.agggroupnames.md)

## AggGroupNames variable

<b>Signature:</b>

```typescript
AggGroupNames: Readonly<{
Buckets: "buckets";
Metrics: "metrics";
None: "none";
}>
```
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; [AggParam](./kibana-plugin-plugins-data-public.aggparam.md)

## AggParam type

<b>Signature:</b>

```typescript
export declare type AggParam = BaseParamType;
```
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; [AggParamOption](./kibana-plugin-plugins-data-public.aggparamoption.md) &gt; [display](./kibana-plugin-plugins-data-public.aggparamoption.display.md)

## AggParamOption.display property

<b>Signature:</b>

```typescript
display: string;
```
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; [AggParamOption](./kibana-plugin-plugins-data-public.aggparamoption.md) &gt; [enabled](./kibana-plugin-plugins-data-public.aggparamoption.enabled.md)

## AggParamOption.enabled() method

<b>Signature:</b>

```typescript
enabled?(agg: AggConfig): boolean;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| agg | <code>AggConfig</code> | |

<b>Returns:</b>

`boolean`

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

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

## AggParamOption interface

<b>Signature:</b>

```typescript
export interface AggParamOption
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [display](./kibana-plugin-plugins-data-public.aggparamoption.display.md) | <code>string</code> | |
| [val](./kibana-plugin-plugins-data-public.aggparamoption.val.md) | <code>string</code> | |

## Methods

| Method | Description |
| --- | --- |
| [enabled(agg)](./kibana-plugin-plugins-data-public.aggparamoption.enabled.md) | |

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggParamOption](./kibana-plugin-plugins-data-public.aggparamoption.md) &gt; [val](./kibana-plugin-plugins-data-public.aggparamoption.val.md)

## AggParamOption.val property

<b>Signature:</b>

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggParamType](./kibana-plugin-plugins-data-public.aggparamtype.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.aggparamtype._constructor_.md)

## AggParamType.(constructor)

Constructs a new instance of the `AggParamType` class

<b>Signature:</b>

```typescript
constructor(config: Record<string, any>);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | <code>Record&lt;string, any&gt;</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; [AggParamType](./kibana-plugin-plugins-data-public.aggparamtype.md) &gt; [allowedAggs](./kibana-plugin-plugins-data-public.aggparamtype.allowedaggs.md)

## AggParamType.allowedAggs property

<b>Signature:</b>

```typescript
allowedAggs: string[];
```
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; [AggParamType](./kibana-plugin-plugins-data-public.aggparamtype.md) &gt; [makeAgg](./kibana-plugin-plugins-data-public.aggparamtype.makeagg.md)

## AggParamType.makeAgg property

<b>Signature:</b>

```typescript
makeAgg: (agg: TAggConfig, state?: any) => TAggConfig;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## AggParamType class

<b>Signature:</b>

```typescript
export declare class AggParamType<TAggConfig extends IAggConfig = IAggConfig> extends BaseParamType<TAggConfig>
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(config)](./kibana-plugin-plugins-data-public.aggparamtype._constructor_.md) | | Constructs a new instance of the <code>AggParamType</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [allowedAggs](./kibana-plugin-plugins-data-public.aggparamtype.allowedaggs.md) | | <code>string[]</code> | |
| [makeAgg](./kibana-plugin-plugins-data-public.aggparamtype.makeagg.md) | | <code>(agg: TAggConfig, state?: any) =&gt; TAggConfig</code> | |

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; [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md) &gt; [addFilter](./kibana-plugin-plugins-data-public.aggtypefieldfilters.addfilter.md)

## AggTypeFieldFilters.addFilter() method

Register a new with this registry. This will be used by the .

<b>Signature:</b>

```typescript
addFilter(filter: AggTypeFieldFilter): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| filter | <code>AggTypeFieldFilter</code> | |

<b>Returns:</b>

`void`

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md) &gt; [filter](./kibana-plugin-plugins-data-public.aggtypefieldfilters.filter.md)

## AggTypeFieldFilters.filter() method

Returns the filtered by all registered filters.

<b>Signature:</b>

```typescript
filter(fields: IndexPatternField[], aggConfig: IAggConfig): IndexPatternField[];
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| fields | <code>IndexPatternField[]</code> | |
| aggConfig | <code>IAggConfig</code> | |

<b>Returns:</b>

`IndexPatternField[]`

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; [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md)

## AggTypeFieldFilters class

A registry to store which are used to filter down available fields for a specific visualization and .

<b>Signature:</b>

```typescript
declare class AggTypeFieldFilters
```

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [addFilter(filter)](./kibana-plugin-plugins-data-public.aggtypefieldfilters.addfilter.md) | | Register a new with this registry. This will be used by the . |
| [filter(fields, aggConfig)](./kibana-plugin-plugins-data-public.aggtypefieldfilters.filter.md) | | Returns the filtered by all registered filters. |

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; [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md) &gt; [addFilter](./kibana-plugin-plugins-data-public.aggtypefilters.addfilter.md)

## AggTypeFilters.addFilter() method

Register a new with this registry.

<b>Signature:</b>

```typescript
addFilter(filter: AggTypeFilter): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| filter | <code>AggTypeFilter</code> | |

<b>Returns:</b>

`void`

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md) &gt; [filter](./kibana-plugin-plugins-data-public.aggtypefilters.filter.md)

## AggTypeFilters.filter() method

Returns the filtered by all registered filters.

<b>Signature:</b>

```typescript
filter(aggTypes: IAggType[], indexPattern: IndexPattern, aggConfig: IAggConfig, aggFilter: string[]): IAggType[];
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| aggTypes | <code>IAggType[]</code> | |
| indexPattern | <code>IndexPattern</code> | |
| aggConfig | <code>IAggConfig</code> | |
| aggFilter | <code>string[]</code> | |

<b>Returns:</b>

`IAggType[]`

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; [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md)

## AggTypeFilters class

A registry to store which are used to filter down available aggregations for a specific visualization and .

<b>Signature:</b>

```typescript
declare class AggTypeFilters
```

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [addFilter(filter)](./kibana-plugin-plugins-data-public.aggtypefilters.addfilter.md) | | Register a new with this registry. |
| [filter(aggTypes, indexPattern, aggConfig, aggFilter)](./kibana-plugin-plugins-data-public.aggtypefilters.filter.md) | | Returns the filtered by all registered filters. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- 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; [BUCKET\_TYPES](./kibana-plugin-plugins-data-public.bucket_types.md)

## BUCKET\_TYPES enum

<b>Signature:</b>

```typescript
export declare enum BUCKET_TYPES
```

## Enumeration Members

| Member | Value | Description |
| --- | --- | --- |
| DATE\_HISTOGRAM | <code>&quot;date_histogram&quot;</code> | |
| DATE\_RANGE | <code>&quot;date_range&quot;</code> | |
| FILTER | <code>&quot;filter&quot;</code> | |
| FILTERS | <code>&quot;filters&quot;</code> | |
| GEOHASH\_GRID | <code>&quot;geohash_grid&quot;</code> | |
| GEOTILE\_GRID | <code>&quot;geotile_grid&quot;</code> | |
| HISTOGRAM | <code>&quot;histogram&quot;</code> | |
| IP\_RANGE | <code>&quot;ip_range&quot;</code> | |
| RANGE | <code>&quot;range&quot;</code> | |
| SIGNIFICANT\_TERMS | <code>&quot;significant_terms&quot;</code> | |
| TERMS | <code>&quot;terms&quot;</code> | |

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

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

## DataPublicPluginStart.actions property

<b>Signature:</b>

```typescript
actions: {
createFiltersFromEvent: typeof createFiltersFromEvent;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export interface DataPublicPluginStart

| Property | Type | Description |
| --- | --- | --- |
| [actions](./kibana-plugin-plugins-data-public.datapublicpluginstart.actions.md) | <code>{</code><br/><code> createFiltersFromEvent: typeof createFiltersFromEvent;</code><br/><code> }</code> | |
| [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> | |
Expand Down
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; [DateRangeKey](./kibana-plugin-plugins-data-public.daterangekey.md) &gt; [from](./kibana-plugin-plugins-data-public.daterangekey.from.md)

## DateRangeKey.from property

<b>Signature:</b>

```typescript
from: number;
```
Loading