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

[Discover] Allow custom label for fields via index pattern field management #70039

Merged
Merged
Show file tree
Hide file tree
Changes from 117 commits
Commits
Show all changes
122 commits
Select commit Hold shift + click to select a range
34843e5
Initial draft impolementation
kertal Jun 25, 2020
68c6bf3
Merge remote-tracking branch 'upstream/master' into kertal-pr-2020-06…
kertal Jun 26, 2020
66978e7
Merge remote-tracking branch 'upstream/master' into kertal-pr-2020-06…
kertal Jul 21, 2020
43aefda
Fix type errors
kertal Jul 21, 2020
12c7706
update API doc
kertal Jul 21, 2020
2b52790
update API doc II
kertal Jul 21, 2020
4eb0a73
Adapt tests
kertal Jul 22, 2020
b37fc77
Merge remote-tracking branch 'upstream/master' into kertal-pr-2020-06…
kertal Jul 31, 2020
02a73ec
Improve field filter
kertal Jul 31, 2020
86da931
Fix jest test
kertal Aug 3, 2020
f4a7fb2
Merge remote-tracking branch 'upstream/master' into kertal-pr-2020-06…
kertal Aug 3, 2020
7bc0790
Improve jest tests
kertal Aug 3, 2020
82e2154
Switche persisted field from 'label' to 'displayName'
kertal Aug 3, 2020
da17dc9
Adapt index fields table
kertal Aug 3, 2020
9fb25d8
Cleanup
kertal Aug 3, 2020
caf109b
Cleanup Nr2
kertal Aug 3, 2020
8356055
Remove invalid EuiBadge attribute
kertal Aug 3, 2020
38e23b0
Fix tests
kertal Aug 4, 2020
62c70e9
Add functional test
kertal Aug 4, 2020
e244116
using indexPatternService
mbondyra Aug 10, 2020
e9d2ee1
types
mbondyra Aug 10, 2020
0f6d445
fix removed docField
mbondyra Aug 13, 2020
78e42e9
displayName implemented
mbondyra Aug 13, 2020
b3f0c65
tests
mbondyra Aug 13, 2020
66027c5
id
mbondyra Aug 13, 2020
a9e30ba
typescript last mistake
mbondyra Aug 13, 2020
d8f6d6d
special cases
mbondyra Aug 13, 2020
eba40d7
tests
mbondyra Aug 14, 2020
23a785d
Update mocks.ts
mbondyra Aug 14, 2020
8be86a4
Merge branch 'master' into lens/indexPatternFromIPService
elasticmachine Aug 17, 2020
77f9f3e
Merge master/fix conflicts
kertal Aug 17, 2020
beff279
Fix types
kertal Aug 18, 2020
464751e
Fix snapshots
kertal Aug 18, 2020
e9c91c4
Generate API docs
kertal Aug 18, 2020
e86ea30
Generate API docs, again
kertal Aug 18, 2020
f589e2e
Update snapshots
kertal Aug 18, 2020
f46eeb2
Update snapshots II
kertal Aug 18, 2020
fcd423f
fix rollup index
mbondyra Aug 18, 2020
f01ce2d
fix types
mbondyra Aug 18, 2020
ff6f69f
test: reuse mocks
mbondyra Aug 18, 2020
3dd9bb3
Fix tests
kertal Aug 18, 2020
e6c1715
Fix functional test
kertal Aug 18, 2020
9085848
Merge commit 'de4b502cb31855b2c9c062ae97f99228138af27e' into lens/ind…
mbondyra Aug 19, 2020
b5efc13
Fix tests, different implementation of setting the displayName
kertal Aug 20, 2020
f605970
Add discover es_archiver file
kertal Aug 20, 2020
1f6b9c6
Improve types
kertal Aug 20, 2020
69d3b02
Update core API
kertal Aug 20, 2020
0eeed29
Merge branch 'master' into lens/indexPatternFromIPService
elasticmachine Aug 20, 2020
b4ef09f
Merge branch 'master' into lens/indexPatternFromIPService
elasticmachine Aug 21, 2020
80ed664
Refactor code to address code review
kertal Aug 21, 2020
de78568
Merge remote-tracking branch 'upstream/master' into kertal-pr-2020-06…
kertal Aug 21, 2020
3c1c293
Merge branch 'lens/indexPatternFromIPService' of https://github.com/m…
kertal Aug 21, 2020
1052450
Refactoring, merge with code by @mattkime
kertal Aug 25, 2020
15ff529
Merge master/fix conflicts
kertal Aug 25, 2020
710b2e4
Fix api error
kertal Aug 25, 2020
6f119ec
Merge master/fix conflicts
kertal Aug 27, 2020
c6e991c
Refactor to use customLabel, fix tests
kertal Aug 27, 2020
1982838
Fix tests
kertal Aug 27, 2020
5a51d0f
Fix jest test
kertal Aug 31, 2020
0403a34
Merge master/fix conflicts
kertal Aug 31, 2020
d925c57
Fix functional test
kertal Aug 31, 2020
335a662
Adapt field editor with more information
kertal Aug 31, 2020
af0af37
Fix test
kertal Aug 31, 2020
0c96e93
Update doc
kertal Aug 31, 2020
578d3aa
Refactor customLabel to customName
kertal Sep 2, 2020
673449f
Update tests
kertal Sep 3, 2020
bc7288b
Merge master/fix conflicts
kertal Sep 3, 2020
2b003d2
Fix types
kertal Sep 3, 2020
acbde6d
Modify title and popovers to contain "original name (Custom name)"
kertal Sep 4, 2020
11a64bd
Update snapshots
kertal Sep 4, 2020
604d57f
Improve doc table view sorting
kertal Sep 4, 2020
315a47e
Adapt hint test
kertal Sep 4, 2020
03d7858
Merge master/fix conflicts
kertal Sep 4, 2020
cdd04fc
Update snapshot
kertal Sep 4, 2020
63c2508
Merge master / fix conflicts
kertal Sep 17, 2020
02e3479
Merge master / fix conflicts
kertal Sep 21, 2020
cad5967
Re-enable shortDotsEnable
kertal Sep 21, 2020
5a2cec9
Add snapshot
kertal Sep 22, 2020
ef447ad
Merge master / fix conflicts
kertal Sep 25, 2020
b67540c
Merge and fix conflicts
kertal Oct 20, 2020
633ddc3
Fix editor and linter
kertal Oct 21, 2020
c5158aa
Generate API
kertal Oct 21, 2020
5fcd730
Merge and fix conflicts
kertal Oct 21, 2020
7160ff6
Generate API
kertal Oct 21, 2020
735e147
Merge and fix conflicts
kertal Oct 22, 2020
d8d473e
Fix jest test
kertal Oct 22, 2020
9f7280a
Generate API
kertal Oct 22, 2020
e8e4ff6
Refactor saving
kertal Oct 24, 2020
c59dc1f
Fix types
kertal Oct 30, 2020
ba8200d
Merge upstream, fix conflicts
kertal Nov 2, 2020
1b74add
Fix test
kertal Nov 2, 2020
a1c2a33
Improve test
kertal Nov 2, 2020
899a7ef
displayName as string
mattkime Nov 2, 2020
7691679
Merge branch 'master' into kertal-pr-2020-06-25-index-pattern-field-l…
mattkime Nov 3, 2020
bbd65b0
hide index pattern attributes field
mattkime Nov 3, 2020
70d183f
hide index pattern attributes field
mattkime Nov 3, 2020
76f920e
Merge remote-tracking branch 'upstream/master' into kertal-pr-2020-06…
kertal Nov 3, 2020
3c717b1
Merge branch 'mattk-index-pattern-field-label' of https://github.com/…
kertal Nov 3, 2020
90ef96f
Merge and fix conflicts
kertal Nov 5, 2020
91bef01
Add visualize text
kertal Nov 5, 2020
1528014
Merge branch 'master' into mattk-index-pattern-field-label_b
mattkime Nov 8, 2020
a4a32dc
simplify saved object
mattkime Nov 8, 2020
af3ad3b
Merge branch 'master' into kertal-pr-2020-06-25-index-pattern-field-l…
kibanamachine Nov 8, 2020
dca9075
fix fieldAttrs
mattkime Nov 9, 2020
6f1b09b
update snapshot
mattkime Nov 9, 2020
0c77b1b
fix test data mapping
mattkime Nov 9, 2020
7809578
Update test/functional/apps/visualize/_data_table.js
mattkime Nov 9, 2020
93c2fe2
Merge branch 'master' into mattk-index-pattern-field-label_b
mattkime Nov 9, 2020
28ade81
Merge branch 'mattk-index-pattern-field-label_b' of github.com:mattki…
mattkime Nov 9, 2020
2d6862f
Merge branch 'kertal-pr-2020-06-25-index-pattern-field-label' of gith…
kertal Nov 10, 2020
368a06c
Update index_pattern.ts
mattkime Nov 10, 2020
d5f9fd5
Update index_patterns.ts
mattkime Nov 10, 2020
62f34ed
Revert "Update index_pattern.ts"
mattkime Nov 10, 2020
19a4a11
Revert "Update index_patterns.ts"
mattkime Nov 10, 2020
8890129
remove commented code
mattkime Nov 10, 2020
1197f09
Merge branch 'master' into kertal-pr-2020-06-25-index-pattern-field-l…
kibanamachine Nov 11, 2020
711eeac
Address review comments
kertal Nov 11, 2020
eb273cd
Merge and fix conflicts
kertal Nov 16, 2020
a5790f9
Adapt field editor help text
kertal Nov 16, 2020
fce60ec
Fix x-pack mappings
kertal Nov 16, 2020
2a95782
Restore accidentally deleted file
kertal Nov 17, 2020
3678dcb
Undo redundant mappings change
kertal Nov 17, 2020
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,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; [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) &gt; [customName](./kibana-plugin-plugins-data-public.ifieldtype.customname.md)

## IFieldType.customName property

<b>Signature:</b>

```typescript
customName?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface IFieldType
| --- | --- | --- |
| [aggregatable](./kibana-plugin-plugins-data-public.ifieldtype.aggregatable.md) | <code>boolean</code> | |
| [count](./kibana-plugin-plugins-data-public.ifieldtype.count.md) | <code>number</code> | |
| [customName](./kibana-plugin-plugins-data-public.ifieldtype.customname.md) | <code>string</code> | |
| [displayName](./kibana-plugin-plugins-data-public.ifieldtype.displayname.md) | <code>string</code> | |
| [esTypes](./kibana-plugin-plugins-data-public.ifieldtype.estypes.md) | <code>string[]</code> | |
| [filterable](./kibana-plugin-plugins-data-public.ifieldtype.filterable.md) | <code>boolean</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; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [fieldAttrs](./kibana-plugin-plugins-data-public.indexpattern.fieldattrs.md)

## IndexPattern.fieldAttrs property

<b>Signature:</b>

```typescript
fieldAttrs: FieldAttrs;
```
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Returns index pattern as saved object body for saving

```typescript
getAsSavedObjectBody(): {
fieldAttrs: string | undefined;
title: string;
timeFieldName: string | undefined;
intervalName: string | undefined;
Expand All @@ -23,6 +24,7 @@ getAsSavedObjectBody(): {
<b>Returns:</b>

`{
fieldAttrs: string | undefined;
title: string;
timeFieldName: string | undefined;
intervalName: string | undefined;
Expand Down
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; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [getFieldAttrs](./kibana-plugin-plugins-data-public.indexpattern.getfieldattrs.md)

## IndexPattern.getFieldAttrs property

<b>Signature:</b>

```typescript
getFieldAttrs: () => {
[x: string]: {
customName: string;
};
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Get last saved saved object fields

```typescript
getOriginalSavedObjectBody: () => {
fieldAttrs?: string | undefined;
title?: string | undefined;
timeFieldName?: string | undefined;
intervalName?: string | undefined;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ export declare class IndexPattern implements IIndexPattern
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [deleteFieldFormat](./kibana-plugin-plugins-data-public.indexpattern.deletefieldformat.md) | | <code>(fieldName: string) =&gt; void</code> | |
| [fieldAttrs](./kibana-plugin-plugins-data-public.indexpattern.fieldattrs.md) | | <code>FieldAttrs</code> | |
| [fieldFormatMap](./kibana-plugin-plugins-data-public.indexpattern.fieldformatmap.md) | | <code>Record&lt;string, any&gt;</code> | |
| [fields](./kibana-plugin-plugins-data-public.indexpattern.fields.md) | | <code>IIndexPatternFieldList &amp; {</code><br/><code> toSpec: () =&gt; IndexPatternFieldMap;</code><br/><code> }</code> | |
| [flattenHit](./kibana-plugin-plugins-data-public.indexpattern.flattenhit.md) | | <code>(hit: Record&lt;string, any&gt;, deep?: boolean) =&gt; Record&lt;string, any&gt;</code> | |
| [formatField](./kibana-plugin-plugins-data-public.indexpattern.formatfield.md) | | <code>FormatFieldFn</code> | |
| [formatHit](./kibana-plugin-plugins-data-public.indexpattern.formathit.md) | | <code>{</code><br/><code> (hit: Record&lt;string, any&gt;, type?: string): any;</code><br/><code> formatField: FormatFieldFn;</code><br/><code> }</code> | |
| [getOriginalSavedObjectBody](./kibana-plugin-plugins-data-public.indexpattern.getoriginalsavedobjectbody.md) | | <code>() =&gt; {</code><br/><code> title?: string &#124; undefined;</code><br/><code> timeFieldName?: string &#124; undefined;</code><br/><code> intervalName?: string &#124; undefined;</code><br/><code> fields?: string &#124; undefined;</code><br/><code> sourceFilters?: string &#124; undefined;</code><br/><code> fieldFormatMap?: string &#124; undefined;</code><br/><code> typeMeta?: string &#124; undefined;</code><br/><code> type?: string &#124; undefined;</code><br/><code> }</code> | Get last saved saved object fields |
| [getFieldAttrs](./kibana-plugin-plugins-data-public.indexpattern.getfieldattrs.md) | | <code>() =&gt; {</code><br/><code> [x: string]: {</code><br/><code> customName: string;</code><br/><code> };</code><br/><code> }</code> | |
| [getOriginalSavedObjectBody](./kibana-plugin-plugins-data-public.indexpattern.getoriginalsavedobjectbody.md) | | <code>() =&gt; {</code><br/><code> fieldAttrs?: string &#124; undefined;</code><br/><code> title?: string &#124; undefined;</code><br/><code> timeFieldName?: string &#124; undefined;</code><br/><code> intervalName?: string &#124; undefined;</code><br/><code> fields?: string &#124; undefined;</code><br/><code> sourceFilters?: string &#124; undefined;</code><br/><code> fieldFormatMap?: string &#124; undefined;</code><br/><code> typeMeta?: string &#124; undefined;</code><br/><code> type?: string &#124; undefined;</code><br/><code> }</code> | Get last saved saved object fields |
| [id](./kibana-plugin-plugins-data-public.indexpattern.id.md) | | <code>string</code> | |
| [intervalName](./kibana-plugin-plugins-data-public.indexpattern.intervalname.md) | | <code>string &#124; undefined</code> | |
| [metaFields](./kibana-plugin-plugins-data-public.indexpattern.metafields.md) | | <code>string[]</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; [IndexPatternAttributes](./kibana-plugin-plugins-data-public.indexpatternattributes.md) &gt; [fieldAttrs](./kibana-plugin-plugins-data-public.indexpatternattributes.fieldattrs.md)

## IndexPatternAttributes.fieldAttrs property

<b>Signature:</b>

```typescript
fieldAttrs?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export interface IndexPatternAttributes

| Property | Type | Description |
| --- | --- | --- |
| [fieldAttrs](./kibana-plugin-plugins-data-public.indexpatternattributes.fieldattrs.md) | <code>string</code> | |
| [fieldFormatMap](./kibana-plugin-plugins-data-public.indexpatternattributes.fieldformatmap.md) | <code>string</code> | |
| [fields](./kibana-plugin-plugins-data-public.indexpatternattributes.fields.md) | <code>string</code> | |
| [intervalName](./kibana-plugin-plugins-data-public.indexpatternattributes.intervalname.md) | <code>string</code> | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@ Constructs a new instance of the `IndexPatternField` class
<b>Signature:</b>

```typescript
constructor(spec: FieldSpec, displayName: string);
constructor(spec: FieldSpec);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| spec | <code>FieldSpec</code> | |
| displayName | <code>string</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; [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) &gt; [customName](./kibana-plugin-plugins-data-public.indexpatternfield.customname.md)

## IndexPatternField.customName property

<b>Signature:</b>

```typescript
get customName(): string | undefined;

set customName(label: string | undefined);
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
readonly displayName: string;
get displayName(): string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export declare class IndexPatternField implements IFieldType

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(spec, displayName)](./kibana-plugin-plugins-data-public.indexpatternfield._constructor_.md) | | Constructs a new instance of the <code>IndexPatternField</code> class |
| [(constructor)(spec)](./kibana-plugin-plugins-data-public.indexpatternfield._constructor_.md) | | Constructs a new instance of the <code>IndexPatternField</code> class |

## Properties

Expand All @@ -23,6 +23,7 @@ export declare class IndexPatternField implements IFieldType
| [aggregatable](./kibana-plugin-plugins-data-public.indexpatternfield.aggregatable.md) | | <code>boolean</code> | |
| [conflictDescriptions](./kibana-plugin-plugins-data-public.indexpatternfield.conflictdescriptions.md) | | <code>Record&lt;string, string[]&gt; &#124; undefined</code> | Description of field type conflicts across different indices in the same index pattern |
| [count](./kibana-plugin-plugins-data-public.indexpatternfield.count.md) | | <code>number</code> | Count is used for field popularity |
| [customName](./kibana-plugin-plugins-data-public.indexpatternfield.customname.md) | | <code>string &#124; undefined</code> | |
| [displayName](./kibana-plugin-plugins-data-public.indexpatternfield.displayname.md) | | <code>string</code> | |
| [esTypes](./kibana-plugin-plugins-data-public.indexpatternfield.estypes.md) | | <code>string[] &#124; undefined</code> | |
| [filterable](./kibana-plugin-plugins-data-public.indexpatternfield.filterable.md) | | <code>boolean</code> | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ toJSON(): {
aggregatable: boolean;
readFromDocValues: boolean;
subType: import("../types").IFieldSubType | undefined;
customName: string | undefined;
};
```
<b>Returns:</b>
Expand All @@ -37,5 +38,6 @@ toJSON(): {
aggregatable: boolean;
readFromDocValues: boolean;
subType: import("../types").IFieldSubType | undefined;
customName: string | 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; [IndexPatternSpec](./kibana-plugin-plugins-data-public.indexpatternspec.md) &gt; [fieldAttrs](./kibana-plugin-plugins-data-public.indexpatternspec.fieldattrs.md)

## IndexPatternSpec.fieldAttrs property

<b>Signature:</b>

```typescript
fieldAttrs?: FieldAttrs;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export interface IndexPatternSpec

| Property | Type | Description |
| --- | --- | --- |
| [fieldAttrs](./kibana-plugin-plugins-data-public.indexpatternspec.fieldattrs.md) | <code>FieldAttrs</code> | |
| [fieldFormats](./kibana-plugin-plugins-data-public.indexpatternspec.fieldformats.md) | <code>Record&lt;string, SerializedFieldFormat&gt;</code> | |
| [fields](./kibana-plugin-plugins-data-public.indexpatternspec.fields.md) | <code>IndexPatternFieldMap</code> | |
| [id](./kibana-plugin-plugins-data-public.indexpatternspec.id.md) | <code>string</code> | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Converts field array to map
<b>Signature:</b>

```typescript
fieldArrayToMap: (fields: FieldSpec[]) => Record<string, FieldSpec>;
fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record<string, FieldSpec>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export declare class IndexPatternsService
| --- | --- | --- | --- |
| [clearCache](./kibana-plugin-plugins-data-public.indexpatternsservice.clearcache.md) | | <code>(id?: string &#124; undefined) =&gt; void</code> | Clear index pattern list cache |
| [ensureDefaultIndexPattern](./kibana-plugin-plugins-data-public.indexpatternsservice.ensuredefaultindexpattern.md) | | <code>EnsureDefaultIndexPattern</code> | |
| [fieldArrayToMap](./kibana-plugin-plugins-data-public.indexpatternsservice.fieldarraytomap.md) | | <code>(fields: FieldSpec[]) =&gt; Record&lt;string, FieldSpec&gt;</code> | Converts field array to map |
| [fieldArrayToMap](./kibana-plugin-plugins-data-public.indexpatternsservice.fieldarraytomap.md) | | <code>(fields: FieldSpec[], fieldAttrs?: FieldAttrs &#124; undefined) =&gt; Record&lt;string, FieldSpec&gt;</code> | Converts field array to map |
| [get](./kibana-plugin-plugins-data-public.indexpatternsservice.get.md) | | <code>(id: string) =&gt; Promise&lt;IndexPattern&gt;</code> | Get an index pattern by id. Cache optimized |
| [getCache](./kibana-plugin-plugins-data-public.indexpatternsservice.getcache.md) | | <code>() =&gt; Promise&lt;SavedObject&lt;IndexPatternSavedObjectAttrs&gt;[] &#124; null &#124; undefined&gt;</code> | |
| [getDefault](./kibana-plugin-plugins-data-public.indexpatternsservice.getdefault.md) | | <code>() =&gt; Promise&lt;IndexPattern &#124; null&gt;</code> | Get default index pattern |
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-server](./kibana-plugin-plugins-data-server.md) &gt; [IFieldType](./kibana-plugin-plugins-data-server.ifieldtype.md) &gt; [customName](./kibana-plugin-plugins-data-server.ifieldtype.customname.md)

## IFieldType.customName property

<b>Signature:</b>

```typescript
customName?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface IFieldType
| --- | --- | --- |
| [aggregatable](./kibana-plugin-plugins-data-server.ifieldtype.aggregatable.md) | <code>boolean</code> | |
| [count](./kibana-plugin-plugins-data-server.ifieldtype.count.md) | <code>number</code> | |
| [customName](./kibana-plugin-plugins-data-server.ifieldtype.customname.md) | <code>string</code> | |
| [displayName](./kibana-plugin-plugins-data-server.ifieldtype.displayname.md) | <code>string</code> | |
| [esTypes](./kibana-plugin-plugins-data-server.ifieldtype.estypes.md) | <code>string[]</code> | |
| [filterable](./kibana-plugin-plugins-data-server.ifieldtype.filterable.md) | <code>boolean</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-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [fieldAttrs](./kibana-plugin-plugins-data-server.indexpattern.fieldattrs.md)

## IndexPattern.fieldAttrs property

<b>Signature:</b>

```typescript
fieldAttrs: FieldAttrs;
```
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Returns index pattern as saved object body for saving

```typescript
getAsSavedObjectBody(): {
fieldAttrs: string | undefined;
title: string;
timeFieldName: string | undefined;
intervalName: string | undefined;
Expand All @@ -23,6 +24,7 @@ getAsSavedObjectBody(): {
<b>Returns:</b>

`{
fieldAttrs: string | undefined;
title: string;
timeFieldName: string | undefined;
intervalName: string | undefined;
Expand Down
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-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [getFieldAttrs](./kibana-plugin-plugins-data-server.indexpattern.getfieldattrs.md)

## IndexPattern.getFieldAttrs property

<b>Signature:</b>

```typescript
getFieldAttrs: () => {
[x: string]: {
customName: string;
};
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Get last saved saved object fields

```typescript
getOriginalSavedObjectBody: () => {
fieldAttrs?: string | undefined;
title?: string | undefined;
timeFieldName?: string | undefined;
intervalName?: string | undefined;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ export declare class IndexPattern implements IIndexPattern
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [deleteFieldFormat](./kibana-plugin-plugins-data-server.indexpattern.deletefieldformat.md) | | <code>(fieldName: string) =&gt; void</code> | |
| [fieldAttrs](./kibana-plugin-plugins-data-server.indexpattern.fieldattrs.md) | | <code>FieldAttrs</code> | |
| [fieldFormatMap](./kibana-plugin-plugins-data-server.indexpattern.fieldformatmap.md) | | <code>Record&lt;string, any&gt;</code> | |
| [fields](./kibana-plugin-plugins-data-server.indexpattern.fields.md) | | <code>IIndexPatternFieldList &amp; {</code><br/><code> toSpec: () =&gt; IndexPatternFieldMap;</code><br/><code> }</code> | |
| [flattenHit](./kibana-plugin-plugins-data-server.indexpattern.flattenhit.md) | | <code>(hit: Record&lt;string, any&gt;, deep?: boolean) =&gt; Record&lt;string, any&gt;</code> | |
| [formatField](./kibana-plugin-plugins-data-server.indexpattern.formatfield.md) | | <code>FormatFieldFn</code> | |
| [formatHit](./kibana-plugin-plugins-data-server.indexpattern.formathit.md) | | <code>{</code><br/><code> (hit: Record&lt;string, any&gt;, type?: string): any;</code><br/><code> formatField: FormatFieldFn;</code><br/><code> }</code> | |
| [getOriginalSavedObjectBody](./kibana-plugin-plugins-data-server.indexpattern.getoriginalsavedobjectbody.md) | | <code>() =&gt; {</code><br/><code> title?: string &#124; undefined;</code><br/><code> timeFieldName?: string &#124; undefined;</code><br/><code> intervalName?: string &#124; undefined;</code><br/><code> fields?: string &#124; undefined;</code><br/><code> sourceFilters?: string &#124; undefined;</code><br/><code> fieldFormatMap?: string &#124; undefined;</code><br/><code> typeMeta?: string &#124; undefined;</code><br/><code> type?: string &#124; undefined;</code><br/><code> }</code> | Get last saved saved object fields |
| [getFieldAttrs](./kibana-plugin-plugins-data-server.indexpattern.getfieldattrs.md) | | <code>() =&gt; {</code><br/><code> [x: string]: {</code><br/><code> customName: string;</code><br/><code> };</code><br/><code> }</code> | |
| [getOriginalSavedObjectBody](./kibana-plugin-plugins-data-server.indexpattern.getoriginalsavedobjectbody.md) | | <code>() =&gt; {</code><br/><code> fieldAttrs?: string &#124; undefined;</code><br/><code> title?: string &#124; undefined;</code><br/><code> timeFieldName?: string &#124; undefined;</code><br/><code> intervalName?: string &#124; undefined;</code><br/><code> fields?: string &#124; undefined;</code><br/><code> sourceFilters?: string &#124; undefined;</code><br/><code> fieldFormatMap?: string &#124; undefined;</code><br/><code> typeMeta?: string &#124; undefined;</code><br/><code> type?: string &#124; undefined;</code><br/><code> }</code> | Get last saved saved object fields |
| [id](./kibana-plugin-plugins-data-server.indexpattern.id.md) | | <code>string</code> | |
| [intervalName](./kibana-plugin-plugins-data-server.indexpattern.intervalname.md) | | <code>string &#124; undefined</code> | |
| [metaFields](./kibana-plugin-plugins-data-server.indexpattern.metafields.md) | | <code>string[]</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-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPatternAttributes](./kibana-plugin-plugins-data-server.indexpatternattributes.md) &gt; [fieldAttrs](./kibana-plugin-plugins-data-server.indexpatternattributes.fieldattrs.md)

## IndexPatternAttributes.fieldAttrs property

<b>Signature:</b>

```typescript
fieldAttrs?: string;
```
Loading