Skip to content

Commit

Permalink
Merge branch '7.x' into backport/7.x/pr-77690
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine committed Sep 23, 2020
2 parents 8e95529 + 3b75b1b commit 40ab9c9
Show file tree
Hide file tree
Showing 211 changed files with 4,355 additions and 3,783 deletions.
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; [DuplicateIndexPatternError](./kibana-plugin-plugins-data-public.duplicateindexpatternerror.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.duplicateindexpatternerror._constructor_.md)

## DuplicateIndexPatternError.(constructor)

Constructs a new instance of the `DuplicateIndexPatternError` class

<b>Signature:</b>

```typescript
constructor(message: string);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| message | <code>string</code> | |

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

## DuplicateIndexPatternError class

<b>Signature:</b>

```typescript
export declare class DuplicateIndexPatternError extends Error
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(message)](./kibana-plugin-plugins-data-public.duplicateindexpatternerror._constructor_.md) | | Constructs a new instance of the <code>DuplicateIndexPatternError</code> class |
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,5 @@
<b>Signature:</b>

```typescript
fieldFormatMap?: Record<string, {
id: string;
params: unknown;
}>;
fieldFormatMap?: Record<string, SerializedFieldFormat<unknown> | undefined>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface IIndexPattern

| Property | Type | Description |
| --- | --- | --- |
| [fieldFormatMap](./kibana-plugin-plugins-data-public.iindexpattern.fieldformatmap.md) | <code>Record&lt;string, {</code><br/><code> id: string;</code><br/><code> params: unknown;</code><br/><code> }&gt;</code> | |
| [fieldFormatMap](./kibana-plugin-plugins-data-public.iindexpattern.fieldformatmap.md) | <code>Record&lt;string, SerializedFieldFormat&lt;unknown&gt; &#124; undefined&gt;</code> | |
| [fields](./kibana-plugin-plugins-data-public.iindexpattern.fields.md) | <code>IFieldType[]</code> | |
| [getFormatterForField](./kibana-plugin-plugins-data-public.iindexpattern.getformatterforfield.md) | <code>(field: IndexPatternField &#124; IndexPatternField['spec'] &#124; IFieldType) =&gt; FieldFormat</code> | |
| [id](./kibana-plugin-plugins-data-public.iindexpattern.id.md) | <code>string</code> | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
```typescript
toSpec(options?: {
getFormatterForField?: IndexPattern['getFormatterForField'];
}): FieldSpec[];
}): IndexPatternFieldMap;
```

## Parameters
Expand All @@ -20,5 +20,5 @@ toSpec(options?: {

<b>Returns:</b>

`FieldSpec[]`
`IndexPatternFieldMap`

Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@ Constructs a new instance of the `IndexPattern` class
<b>Signature:</b>

```typescript
constructor(id: string | undefined, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, }: IndexPatternDeps);
constructor({ spec, savedObjectsClient, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | <code>string &#124; undefined</code> | |
| { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, } | <code>IndexPatternDeps</code> | |
| { spec, savedObjectsClient, fieldFormats, shortDotsEnable, metaFields, } | <code>IndexPatternDeps</code> | |

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

## IndexPattern.addScriptedField() method

Add scripted field to field list

<b>Signature:</b>

```typescript
addScriptedField(name: string, script: string, fieldType: string | undefined, lang: string): Promise<void>;
addScriptedField(name: string, script: string, fieldType?: string, lang?: string): Promise<void>;
```

## Parameters
Expand All @@ -16,7 +18,7 @@ addScriptedField(name: string, script: string, fieldType: string | undefined, la
| --- | --- | --- |
| name | <code>string</code> | |
| script | <code>string</code> | |
| fieldType | <code>string &#124; undefined</code> | |
| fieldType | <code>string</code> | |
| lang | <code>string</code> | |

<b>Returns:</b>
Expand Down

This file was deleted.

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

```typescript
fieldFormatMap: any;
fieldFormatMap: Record<string, any>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@

```typescript
fields: IIndexPatternFieldList & {
toSpec: () => FieldSpec[];
toSpec: () => IndexPatternFieldMap;
};
```

This file was deleted.

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

```typescript
flattenHit: any;
flattenHit: (hit: Record<string, any>, deep?: boolean) => Record<string, any>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
formatField: any;
formatField: FormatFieldFn;
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,8 @@
<b>Signature:</b>

```typescript
formatHit: any;
formatHit: {
(hit: Record<string, any>, type?: string): any;
formatField: FormatFieldFn;
};
```
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
<!-- 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; [prepBody](./kibana-plugin-plugins-data-public.indexpattern.prepbody.md)
[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; [getAsSavedObjectBody](./kibana-plugin-plugins-data-public.indexpattern.getassavedobjectbody.md)

## IndexPattern.prepBody() method
## IndexPattern.getAsSavedObjectBody() method

Returns index pattern as saved object body for saving

<b>Signature:</b>

```typescript
prepBody(): {
getAsSavedObjectBody(): {
title: string;
timeFieldName: string | undefined;
intervalName: string | null | undefined;
intervalName: string | undefined;
sourceFilters: string | undefined;
fields: string | undefined;
fieldFormatMap: string | undefined;
Expand All @@ -23,7 +25,7 @@ prepBody(): {
`{
title: string;
timeFieldName: string | undefined;
intervalName: string | null | undefined;
intervalName: string | undefined;
sourceFilters: string | undefined;
fields: string | undefined;
fieldFormatMap: string | undefined;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## IndexPattern.getFormatterForField() method

Provide a field, get its formatter

<b>Signature:</b>

```typescript
Expand Down
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; [getOriginalSavedObjectBody](./kibana-plugin-plugins-data-public.indexpattern.getoriginalsavedobjectbody.md)

## IndexPattern.getOriginalSavedObjectBody property

Get last saved saved object fields

<b>Signature:</b>

```typescript
getOriginalSavedObjectBody: () => {
title?: string | undefined;
timeFieldName?: string | undefined;
intervalName?: string | undefined;
fields?: string | undefined;
sourceFilters?: string | undefined;
fieldFormatMap?: string | undefined;
typeMeta?: string | undefined;
type?: string | undefined;
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## IndexPattern.getSourceFiltering() method

Get the source filtering configuration for that index.

<b>Signature:</b>

```typescript
Expand Down

This file was deleted.

This file was deleted.

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

```typescript
intervalName: string | undefined | null;
intervalName: string | undefined;
```

This file was deleted.

Loading

0 comments on commit 40ab9c9

Please sign in to comment.