[7.x] Typescript index pattern field editor (#63495)

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.field.conflictdescriptions.md

@@ -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; [Field](./kibana-plugin-plugins-data-public.field.md) &gt; [conflictDescriptions](./kibana-plugin-plugins-data-public.field.conflictdescriptions.md)
+
+## Field.conflictDescriptions property
+
+<b>Signature:</b>
+
+```typescript
+conflictDescriptions?: Record<string, string[]>;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.field.md

@@ -22,6 +22,7 @@ export declare class Field implements IFieldType
 |  --- | --- | --- | --- |
 |  [$$spec](./kibana-plugin-plugins-data-public.field.__spec.md) |  | <code>FieldSpec</code> |  |
 |  [aggregatable](./kibana-plugin-plugins-data-public.field.aggregatable.md) |  | <code>boolean</code> |  |
+|  [conflictDescriptions](./kibana-plugin-plugins-data-public.field.conflictdescriptions.md) |  | <code>Record&lt;string, string[]&gt;</code> |  |
 |  [count](./kibana-plugin-plugins-data-public.field.count.md) |  | <code>number</code> |  |
 |  [displayName](./kibana-plugin-plugins-data-public.field.displayname.md) |  | <code>string</code> |  |
 |  [esTypes](./kibana-plugin-plugins-data-public.field.estypes.md) |  | <code>string[]</code> |  |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat._constructor_.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.fieldformat._constructor_.md)
+
+## FieldFormat.(constructor)
+
+Constructs a new instance of the `FieldFormat` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(_params?: IFieldFormatMetaParams, getConfig?: FieldFormatsGetConfigFn);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  \_params | <code>IFieldFormatMetaParams</code> |  |
+|  getConfig | <code>FieldFormatsGetConfigFn</code> |  |
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat._params.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [\_params](./kibana-plugin-plugins-data-public.fieldformat._params.md)
+
+## FieldFormat.\_params property
+
+<b>Signature:</b>
+
+```typescript
+protected readonly _params: any;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.convert.md

@@ -0,0 +1,26 @@
+<!-- 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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [convert](./kibana-plugin-plugins-data-public.fieldformat.convert.md)
+
+## FieldFormat.convert() method
+
+Convert a raw value to a formatted string
+
+<b>Signature:</b>
+
+```typescript
+convert(value: any, contentType?: FieldFormatsContentType, options?: HtmlContextTypeOptions | TextContextTypeOptions): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | <code>any</code> |  |
+|  contentType | <code>FieldFormatsContentType</code> |  |
+|  options | <code>HtmlContextTypeOptions &#124; TextContextTypeOptions</code> |  |
+
+<b>Returns:</b>
+
+`string`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.convertobject.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [convertObject](./kibana-plugin-plugins-data-public.fieldformat.convertobject.md)
+
+## FieldFormat.convertObject property
+
+ {<!-- -->FieldFormatConvert<!-- -->}  have to remove the private because of https://github.com/Microsoft/TypeScript/issues/17293
+
+<b>Signature:</b>
+
+```typescript
+convertObject: FieldFormatConvert | undefined;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.fieldtype.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [fieldType](./kibana-plugin-plugins-data-public.fieldformat.fieldtype.md)
+
+## FieldFormat.fieldType property
+
+ {<!-- -->string<!-- -->} - Field Format Type 
+
+<b>Signature:</b>
+
+```typescript
+static fieldType: string | string[];
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.from.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [from](./kibana-plugin-plugins-data-public.fieldformat.from.md)
+
+## FieldFormat.from() method
+
+<b>Signature:</b>
+
+```typescript
+static from(convertFn: FieldFormatConvertFunction): FieldFormatInstanceType;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  convertFn | <code>FieldFormatConvertFunction</code> |  |
+
+<b>Returns:</b>
+
+`FieldFormatInstanceType`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.getconfig.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [getConfig](./kibana-plugin-plugins-data-public.fieldformat.getconfig.md)
+
+## FieldFormat.getConfig property
+
+<b>Signature:</b>
+
+```typescript
+protected getConfig: FieldFormatsGetConfigFn | undefined;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.getconverterfor.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [getConverterFor](./kibana-plugin-plugins-data-public.fieldformat.getconverterfor.md)
+
+## FieldFormat.getConverterFor() method
+
+Get a convert function that is bound to a specific contentType
+
+<b>Signature:</b>
+
+```typescript
+getConverterFor(contentType?: FieldFormatsContentType): FieldFormatConvertFunction;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  contentType | <code>FieldFormatsContentType</code> |  |
+
+<b>Returns:</b>
+
+`FieldFormatConvertFunction`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.getparamdefaults.md

@@ -0,0 +1,17 @@
+<!-- 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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [getParamDefaults](./kibana-plugin-plugins-data-public.fieldformat.getparamdefaults.md)
+
+## FieldFormat.getParamDefaults() method
+
+Get parameter defaults  {<!-- -->object<!-- -->} - parameter defaults
+
+<b>Signature:</b>
+
+```typescript
+getParamDefaults(): Record<string, any>;
+```
+<b>Returns:</b>
+
+`Record<string, any>`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.htmlconvert.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [htmlConvert](./kibana-plugin-plugins-data-public.fieldformat.htmlconvert.md)
+
+## FieldFormat.htmlConvert property
+
+ {<!-- -->htmlConvert<!-- -->}  have to remove the protected because of https://github.com/Microsoft/TypeScript/issues/17293
+
+<b>Signature:</b>
+
+```typescript
+htmlConvert: HtmlContextTypeConvert | undefined;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.id.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [id](./kibana-plugin-plugins-data-public.fieldformat.id.md)
+
+## FieldFormat.id property
+
+ {<!-- -->string<!-- -->} - Field Format Id 
+
+<b>Signature:</b>
+
+```typescript
+static id: string;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.isinstanceoffieldformat.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [isInstanceOfFieldFormat](./kibana-plugin-plugins-data-public.fieldformat.isinstanceoffieldformat.md)
+
+## FieldFormat.isInstanceOfFieldFormat() method
+
+<b>Signature:</b>
+
+```typescript
+static isInstanceOfFieldFormat(fieldFormat: any): fieldFormat is FieldFormat;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fieldFormat | <code>any</code> |  |
+
+<b>Returns:</b>
+
+`fieldFormat is FieldFormat`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.md

@@ -0,0 +1,46 @@
+<!-- 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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md)
+
+## FieldFormat class
+
+<b>Signature:</b>
+
+```typescript
+export declare abstract class FieldFormat 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(\_params, getConfig)](./kibana-plugin-plugins-data-public.fieldformat._constructor_.md) |  | Constructs a new instance of the <code>FieldFormat</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [\_params](./kibana-plugin-plugins-data-public.fieldformat._params.md) |  | <code>any</code> |  |
+|  [convertObject](./kibana-plugin-plugins-data-public.fieldformat.convertobject.md) |  | <code>FieldFormatConvert &#124; undefined</code> |  {<!-- -->FieldFormatConvert<!-- -->}  have to remove the private because of https://github.com/Microsoft/TypeScript/issues/17293 |
+|  [fieldType](./kibana-plugin-plugins-data-public.fieldformat.fieldtype.md) | <code>static</code> | <code>string &#124; string[]</code> |  {<!-- -->string<!-- -->} - Field Format Type  |
+|  [getConfig](./kibana-plugin-plugins-data-public.fieldformat.getconfig.md) |  | <code>FieldFormatsGetConfigFn &#124; undefined</code> |  |
+|  [htmlConvert](./kibana-plugin-plugins-data-public.fieldformat.htmlconvert.md) |  | <code>HtmlContextTypeConvert &#124; undefined</code> |  {<!-- -->htmlConvert<!-- -->}  have to remove the protected because of https://github.com/Microsoft/TypeScript/issues/17293 |
+|  [id](./kibana-plugin-plugins-data-public.fieldformat.id.md) | <code>static</code> | <code>string</code> |  {<!-- -->string<!-- -->} - Field Format Id  |
+|  [textConvert](./kibana-plugin-plugins-data-public.fieldformat.textconvert.md) |  | <code>TextContextTypeConvert &#124; undefined</code> |  {<!-- -->textConvert<!-- -->}  have to remove the protected because of https://github.com/Microsoft/TypeScript/issues/17293 |
+|  [title](./kibana-plugin-plugins-data-public.fieldformat.title.md) | <code>static</code> | <code>string</code> |  {<!-- -->string<!-- -->} - Field Format Title  |
+|  [type](./kibana-plugin-plugins-data-public.fieldformat.type.md) |  | <code>any</code> |  {<!-- -->Function<!-- -->} - ref to child class  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [convert(value, contentType, options)](./kibana-plugin-plugins-data-public.fieldformat.convert.md) |  | Convert a raw value to a formatted string |
+|  [from(convertFn)](./kibana-plugin-plugins-data-public.fieldformat.from.md) | <code>static</code> |  |
+|  [getConverterFor(contentType)](./kibana-plugin-plugins-data-public.fieldformat.getconverterfor.md) |  | Get a convert function that is bound to a specific contentType |
+|  [getParamDefaults()](./kibana-plugin-plugins-data-public.fieldformat.getparamdefaults.md) |  | Get parameter defaults  {<!-- -->object<!-- -->} - parameter defaults |
+|  [isInstanceOfFieldFormat(fieldFormat)](./kibana-plugin-plugins-data-public.fieldformat.isinstanceoffieldformat.md) | <code>static</code> |  |
+|  [param(name)](./kibana-plugin-plugins-data-public.fieldformat.param.md) |  | Get the value of a param. This value may be a default value. |
+|  [params()](./kibana-plugin-plugins-data-public.fieldformat.params.md) |  | Get all of the params in a single object  {<!-- -->object<!-- -->} |
+|  [setupContentType()](./kibana-plugin-plugins-data-public.fieldformat.setupcontenttype.md) |  |  |
+|  [toJSON()](./kibana-plugin-plugins-data-public.fieldformat.tojson.md) |  | Serialize this format to a simple POJO, with only the params that are not default {<!-- -->object<!-- -->} |
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.param.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [param](./kibana-plugin-plugins-data-public.fieldformat.param.md)
+
+## FieldFormat.param() method
+
+Get the value of a param. This value may be a default value.
+
+<b>Signature:</b>
+
+```typescript
+param(name: string): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`any`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.params.md

@@ -0,0 +1,17 @@
+<!-- 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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [params](./kibana-plugin-plugins-data-public.fieldformat.params.md)
+
+## FieldFormat.params() method
+
+Get all of the params in a single object  {<!-- -->object<!-- -->}
+
+<b>Signature:</b>
+
+```typescript
+params(): Record<string, any>;
+```
+<b>Returns:</b>
+
+`Record<string, any>`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.setupcontenttype.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [setupContentType](./kibana-plugin-plugins-data-public.fieldformat.setupcontenttype.md)
+
+## FieldFormat.setupContentType() method
+
+<b>Signature:</b>
+
+```typescript
+setupContentType(): FieldFormatConvert;
+```
+<b>Returns:</b>
+
+`FieldFormatConvert`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.textconvert.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [textConvert](./kibana-plugin-plugins-data-public.fieldformat.textconvert.md)
+
+## FieldFormat.textConvert property
+
+ {<!-- -->textConvert<!-- -->}  have to remove the protected because of https://github.com/Microsoft/TypeScript/issues/17293
+
+<b>Signature:</b>
+
+```typescript
+textConvert: TextContextTypeConvert | undefined;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.title.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [title](./kibana-plugin-plugins-data-public.fieldformat.title.md)
+
+## FieldFormat.title property
+
+ {<!-- -->string<!-- -->} - Field Format Title 
+
+<b>Signature:</b>
+
+```typescript
+static title: string;
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformat.tojson.md

@@ -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; [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) &gt; [toJSON](./kibana-plugin-plugins-data-public.fieldformat.tojson.md)
+
+## FieldFormat.toJSON() method
+
+Serialize this format to a simple POJO, with only the params that are not default
+
+ {<!-- -->object<!-- -->}
+
+<b>Signature:</b>
+
+```typescript
+toJSON(): {
+        id: unknown;
+        params: _.Dictionary<unknown> | undefined;
+    };
+```
+<b>Returns:</b>
+
+`{
+        id: unknown;
+        params: _.Dictionary<unknown> | undefined;
+    }`
+