-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[7.x] Index Pattern Field class - factor out copy_field code for futu…
…re typescripting (#63083) (#63461) * Index Pattern Field class - factor out copy_field code for future typescripting (#63083)
- Loading branch information
Showing
55 changed files
with
324 additions
and
479 deletions.
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
...velopment/plugins/data/public/kibana-plugin-plugins-data-public.field.__spec.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [$$spec](./kibana-plugin-plugins-data-public.field.__spec.md) | ||
|
||
## Field.$$spec property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
$$spec: FieldSpec; | ||
``` |
4 changes: 2 additions & 2 deletions
4
...public.indexpatternfield._constructor_.md → ...lugins-data-public.field._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
11 changes: 11 additions & 0 deletions
11
...ent/plugins/data/public/kibana-plugin-plugins-data-public.field.aggregatable.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [aggregatable](./kibana-plugin-plugins-data-public.field.aggregatable.md) | ||
|
||
## Field.aggregatable property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
aggregatable?: boolean; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...evelopment/plugins/data/public/kibana-plugin-plugins-data-public.field.count.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [count](./kibana-plugin-plugins-data-public.field.count.md) | ||
|
||
## Field.count property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
count?: number; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...ment/plugins/data/public/kibana-plugin-plugins-data-public.field.displayname.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [displayName](./kibana-plugin-plugins-data-public.field.displayname.md) | ||
|
||
## Field.displayName property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
displayName?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...elopment/plugins/data/public/kibana-plugin-plugins-data-public.field.estypes.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [esTypes](./kibana-plugin-plugins-data-public.field.estypes.md) | ||
|
||
## Field.esTypes property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
esTypes?: string[]; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...pment/plugins/data/public/kibana-plugin-plugins-data-public.field.filterable.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [filterable](./kibana-plugin-plugins-data-public.field.filterable.md) | ||
|
||
## Field.filterable property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
filterable?: boolean; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...velopment/plugins/data/public/kibana-plugin-plugins-data-public.field.format.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [format](./kibana-plugin-plugins-data-public.field.format.md) | ||
|
||
## Field.format property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
format: any; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...ent/plugins/data/public/kibana-plugin-plugins-data-public.field.indexpattern.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [indexPattern](./kibana-plugin-plugins-data-public.field.indexpattern.md) | ||
|
||
## Field.indexPattern property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
indexPattern?: IndexPattern; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...development/plugins/data/public/kibana-plugin-plugins-data-public.field.lang.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [lang](./kibana-plugin-plugins-data-public.field.lang.md) | ||
|
||
## Field.lang property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
lang?: string; | ||
``` |
40 changes: 40 additions & 0 deletions
40
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.field.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,40 @@ | ||
<!-- 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) > [Field](./kibana-plugin-plugins-data-public.field.md) | ||
|
||
## Field class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class Field implements IFieldType | ||
``` | ||
## Constructors | ||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)(indexPattern, spec, shortDotsEnable)](./kibana-plugin-plugins-data-public.field._constructor_.md) | | Constructs a new instance of the <code>Field</code> class | | ||
## Properties | ||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [$$spec](./kibana-plugin-plugins-data-public.field.__spec.md) | | <code>FieldSpec</code> | | | ||
| [aggregatable](./kibana-plugin-plugins-data-public.field.aggregatable.md) | | <code>boolean</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> | | | ||
| [filterable](./kibana-plugin-plugins-data-public.field.filterable.md) | | <code>boolean</code> | | | ||
| [format](./kibana-plugin-plugins-data-public.field.format.md) | | <code>any</code> | | | ||
| [indexPattern](./kibana-plugin-plugins-data-public.field.indexpattern.md) | | <code>IndexPattern</code> | | | ||
| [lang](./kibana-plugin-plugins-data-public.field.lang.md) | | <code>string</code> | | | ||
| [name](./kibana-plugin-plugins-data-public.field.name.md) | | <code>string</code> | | | ||
| [script](./kibana-plugin-plugins-data-public.field.script.md) | | <code>string</code> | | | ||
| [scripted](./kibana-plugin-plugins-data-public.field.scripted.md) | | <code>boolean</code> | | | ||
| [searchable](./kibana-plugin-plugins-data-public.field.searchable.md) | | <code>boolean</code> | | | ||
| [sortable](./kibana-plugin-plugins-data-public.field.sortable.md) | | <code>boolean</code> | | | ||
| [subType](./kibana-plugin-plugins-data-public.field.subtype.md) | | <code>IFieldSubType</code> | | | ||
| [type](./kibana-plugin-plugins-data-public.field.type.md) | | <code>string</code> | | | ||
| [visualizable](./kibana-plugin-plugins-data-public.field.visualizable.md) | | <code>boolean</code> | | | ||
11 changes: 11 additions & 0 deletions
11
...development/plugins/data/public/kibana-plugin-plugins-data-public.field.name.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [name](./kibana-plugin-plugins-data-public.field.name.md) | ||
|
||
## Field.name property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
name: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...velopment/plugins/data/public/kibana-plugin-plugins-data-public.field.script.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [script](./kibana-plugin-plugins-data-public.field.script.md) | ||
|
||
## Field.script property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
script?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...lopment/plugins/data/public/kibana-plugin-plugins-data-public.field.scripted.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [scripted](./kibana-plugin-plugins-data-public.field.scripted.md) | ||
|
||
## Field.scripted property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
scripted?: boolean; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...pment/plugins/data/public/kibana-plugin-plugins-data-public.field.searchable.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [searchable](./kibana-plugin-plugins-data-public.field.searchable.md) | ||
|
||
## Field.searchable property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
searchable?: boolean; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...lopment/plugins/data/public/kibana-plugin-plugins-data-public.field.sortable.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [sortable](./kibana-plugin-plugins-data-public.field.sortable.md) | ||
|
||
## Field.sortable property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
sortable?: boolean; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...elopment/plugins/data/public/kibana-plugin-plugins-data-public.field.subtype.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [subType](./kibana-plugin-plugins-data-public.field.subtype.md) | ||
|
||
## Field.subType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
subType?: IFieldSubType; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...development/plugins/data/public/kibana-plugin-plugins-data-public.field.type.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [type](./kibana-plugin-plugins-data-public.field.type.md) | ||
|
||
## Field.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...ent/plugins/data/public/kibana-plugin-plugins-data-public.field.visualizable.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) > [Field](./kibana-plugin-plugins-data-public.field.md) > [visualizable](./kibana-plugin-plugins-data-public.field.visualizable.md) | ||
|
||
## Field.visualizable property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
visualizable?: boolean; | ||
``` |
11 changes: 0 additions & 11 deletions
11
...ugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.__spec.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...data/public/kibana-plugin-plugins-data-public.indexpatternfield.aggregatable.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...lugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.count.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
.../data/public/kibana-plugin-plugins-data-public.indexpatternfield.displayname.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...gins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.estypes.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...s/data/public/kibana-plugin-plugins-data-public.indexpatternfield.filterable.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...ugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.format.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...data/public/kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
...plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.lang.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.