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

Index pattern field class refactor #73180

Merged
merged 20 commits into from
Aug 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
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,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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.fieldlist._constructor_.md)

## FieldList.(constructor)

Constructs a new instance of the `FieldList` class

<b>Signature:</b>

```typescript
constructor(indexPattern: IndexPattern, specs?: FieldSpec[], shortDotsEnable?: boolean, onNotification?: () => void);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| indexPattern | <code>IndexPattern</code> | |
| specs | <code>FieldSpec[]</code> | |
| shortDotsEnable | <code>boolean</code> | |
| onNotification | <code>() =&gt; void</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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [add](./kibana-plugin-plugins-data-public.fieldlist.add.md)

## FieldList.add property

<b>Signature:</b>

```typescript
readonly add: (field: FieldSpec) => void;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [getByName](./kibana-plugin-plugins-data-public.fieldlist.getbyname.md)

## FieldList.getByName property

<b>Signature:</b>

```typescript
readonly getByName: (name: IndexPatternField['name']) => IndexPatternField | undefined;
```
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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [getByType](./kibana-plugin-plugins-data-public.fieldlist.getbytype.md)

## FieldList.getByType property

<b>Signature:</b>

```typescript
readonly getByType: (type: IndexPatternField['type']) => any[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- 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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md)

## FieldList class

<b>Signature:</b>

```typescript
export declare class FieldList extends Array<IndexPatternField> implements IIndexPatternFieldList
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(indexPattern, specs, shortDotsEnable, onNotification)](./kibana-plugin-plugins-data-public.fieldlist._constructor_.md) | | Constructs a new instance of the <code>FieldList</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [add](./kibana-plugin-plugins-data-public.fieldlist.add.md) | | <code>(field: FieldSpec) =&gt; void</code> | |
| [getByName](./kibana-plugin-plugins-data-public.fieldlist.getbyname.md) | | <code>(name: IndexPatternField['name']) =&gt; IndexPatternField &#124; undefined</code> | |
| [getByType](./kibana-plugin-plugins-data-public.fieldlist.getbytype.md) | | <code>(type: IndexPatternField['type']) =&gt; any[]</code> | |
| [remove](./kibana-plugin-plugins-data-public.fieldlist.remove.md) | | <code>(field: IFieldType) =&gt; void</code> | |
| [removeAll](./kibana-plugin-plugins-data-public.fieldlist.removeall.md) | | <code>() =&gt; void</code> | |
| [replaceAll](./kibana-plugin-plugins-data-public.fieldlist.replaceall.md) | | <code>(specs: FieldSpec[]) =&gt; void</code> | |
| [toSpec](./kibana-plugin-plugins-data-public.fieldlist.tospec.md) | | <code>() =&gt; {</code><br/><code> count: number;</code><br/><code> script: string &#124; undefined;</code><br/><code> lang: string &#124; undefined;</code><br/><code> conflictDescriptions: Record&lt;string, string[]&gt; &#124; undefined;</code><br/><code> name: string;</code><br/><code> type: string;</code><br/><code> esTypes: string[] &#124; undefined;</code><br/><code> scripted: boolean;</code><br/><code> searchable: boolean;</code><br/><code> aggregatable: boolean;</code><br/><code> readFromDocValues: boolean;</code><br/><code> subType: import(&quot;../types&quot;).IFieldSubType &#124; undefined;</code><br/><code> format: any;</code><br/><code> }[]</code> | |
| [update](./kibana-plugin-plugins-data-public.fieldlist.update.md) | | <code>(field: FieldSpec) =&gt; void</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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [remove](./kibana-plugin-plugins-data-public.fieldlist.remove.md)

## FieldList.remove property

<b>Signature:</b>

```typescript
readonly remove: (field: IFieldType) => void;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [removeAll](./kibana-plugin-plugins-data-public.fieldlist.removeall.md)

## FieldList.removeAll property

<b>Signature:</b>

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

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [replaceAll](./kibana-plugin-plugins-data-public.fieldlist.replaceall.md)

## FieldList.replaceAll property

<b>Signature:</b>

```typescript
readonly replaceAll: (specs: FieldSpec[]) => 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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [toSpec](./kibana-plugin-plugins-data-public.fieldlist.tospec.md)

## FieldList.toSpec property

<b>Signature:</b>

```typescript
readonly toSpec: () => {
count: number;
script: string | undefined;
lang: string | undefined;
conflictDescriptions: Record<string, string[]> | undefined;
name: string;
type: string;
esTypes: string[] | undefined;
scripted: boolean;
searchable: boolean;
aggregatable: boolean;
readFromDocValues: boolean;
subType: import("../types").IFieldSubType | undefined;
format: 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; [FieldList](./kibana-plugin-plugins-data-public.fieldlist.md) &gt; [update](./kibana-plugin-plugins-data-public.fieldlist.update.md)

## FieldList.update property

<b>Signature:</b>

```typescript
readonly update: (field: FieldSpec) => void;
```

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@
<b>Signature:</b>

```typescript
getByName(name: Field['name']): Field | undefined;
getByName(name: IndexPatternField['name']): IndexPatternField | undefined;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>Field['name']</code> | |
| name | <code>IndexPatternField['name']</code> | |

<b>Returns:</b>

`Field | undefined`
`IndexPatternField | undefined`

Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@
<b>Signature:</b>

```typescript
getByType(type: Field['type']): Field[];
getByType(type: IndexPatternField['type']): IndexPatternField[];
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | <code>Field['type']</code> | |
| type | <code>IndexPatternField['type']</code> | |

<b>Returns:</b>

`Field[]`
`IndexPatternField[]`

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
export interface IIndexPatternFieldList extends Array<Field>
export interface IIndexPatternFieldList extends Array<IndexPatternField>
```

## Methods
Expand All @@ -18,5 +18,7 @@ export interface IIndexPatternFieldList extends Array<Field>
| [getByName(name)](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.getbyname.md) | |
| [getByType(type)](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.getbytype.md) | |
| [remove(field)](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.remove.md) | |
| [removeAll()](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.removeall.md) | |
| [replaceAll(specs)](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.replaceall.md) | |
| [update(field)](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.update.md) | |

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; [IIndexPatternFieldList](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.md) &gt; [removeAll](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.removeall.md)

## IIndexPatternFieldList.removeAll() method

<b>Signature:</b>

```typescript
removeAll(): void;
```
<b>Returns:</b>

`void`

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; [IIndexPatternFieldList](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.md) &gt; [replaceAll](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.replaceall.md)

## IIndexPatternFieldList.replaceAll() method

<b>Signature:</b>

```typescript
replaceAll(specs: FieldSpec[]): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| specs | <code>FieldSpec[]</code> | |

<b>Returns:</b>

`void`

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
getFieldByName(name: string): Field | void;
getFieldByName(name: string): IndexPatternField | undefined;
```

## Parameters
Expand All @@ -18,5 +18,5 @@ getFieldByName(name: string): Field | void;

<b>Returns:</b>

`Field | void`
`IndexPatternField | 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; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [getFormatterForField](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md)

## IndexPattern.getFormatterForField() method

<b>Signature:</b>

```typescript
getFormatterForField(field: IndexPatternField | IndexPatternField['spec']): FieldFormat;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| field | <code>IndexPatternField &#124; IndexPatternField['spec']</code> | |

<b>Returns:</b>

`FieldFormat`

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<b>Signature:</b>

```typescript
getNonScriptedFields(): Field[];
getNonScriptedFields(): IndexPatternField[];
```
<b>Returns:</b>

`Field[]`
`IndexPatternField[]`

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<b>Signature:</b>

```typescript
getScriptedFields(): Field[];
getScriptedFields(): IndexPatternField[];
```
<b>Returns:</b>

`Field[]`
`IndexPatternField[]`

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<b>Signature:</b>

```typescript
getTimeField(): Field | undefined;
getTimeField(): IndexPatternField | undefined;
```
<b>Returns:</b>

`Field | undefined`
`IndexPatternField | undefined`

Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export declare class IndexPattern implements IIndexPattern
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md) | | |
| [getComputedFields()](./kibana-plugin-plugins-data-public.indexpattern.getcomputedfields.md) | | |
| [getFieldByName(name)](./kibana-plugin-plugins-data-public.indexpattern.getfieldbyname.md) | | |
| [getFormatterForField(field)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md) | | |
| [getNonScriptedFields()](./kibana-plugin-plugins-data-public.indexpattern.getnonscriptedfields.md) | | |
| [getScriptedFields()](./kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md) | | |
| [getSourceFiltering()](./kibana-plugin-plugins-data-public.indexpattern.getsourcefiltering.md) | | |
Expand All @@ -55,7 +56,7 @@ export declare class IndexPattern implements IIndexPattern
| [popularizeField(fieldName, unit)](./kibana-plugin-plugins-data-public.indexpattern.popularizefield.md) | | |
| [prepBody()](./kibana-plugin-plugins-data-public.indexpattern.prepbody.md) | | |
| [refreshFields()](./kibana-plugin-plugins-data-public.indexpattern.refreshfields.md) | | |
| [removeScriptedField(field)](./kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md) | | |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md) | | |
| [save(saveAttempts)](./kibana-plugin-plugins-data-public.indexpattern.save.md) | | |
| [toJSON()](./kibana-plugin-plugins-data-public.indexpattern.tojson.md) | | |
| [toSpec()](./kibana-plugin-plugins-data-public.indexpattern.tospec.md) | | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

```typescript
removeScriptedField(field: IFieldType): Promise<void | Error>;
removeScriptedField(fieldName: string): Promise<void | Error>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| field | <code>IFieldType</code> | |
| fieldName | <code>string</code> | |

<b>Returns:</b>

Expand Down
Loading