Skip to content

Commit

Permalink
Remove [key: string]: any; from IIndexPattern (elastic#77968)
Browse files Browse the repository at this point in the history
* Remove [key: string]: any; from IIndexPattern
# Conflicts:
#	docs/development/plugins/data/server/kibana-plugin-plugins-data-server.iindexpattern.md
#	src/plugins/data/server/server.api.md
#	src/plugins/index_pattern_management/public/components/edit_index_pattern/indexed_fields_table/indexed_fields_table.tsx
#	x-pack/plugins/reporting/server/export_types/csv_from_savedobject/lib/get_csv_job.ts
  • Loading branch information
mattkime committed Sep 22, 2020
1 parent 4870680 commit 278d037
Show file tree
Hide file tree
Showing 89 changed files with 1,021 additions and 395 deletions.
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; [IIndexPattern](./kibana-plugin-plugins-data-public.iindexpattern.md) &gt; [getFormatterForField](./kibana-plugin-plugins-data-public.iindexpattern.getformatterforfield.md)

## IIndexPattern.getFormatterForField property

<b>Signature:</b>

```typescript
getFormatterForField?: (field: IndexPatternField | IndexPatternField['spec'] | IFieldType) => FieldFormat;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface IIndexPattern
| --- | --- | --- |
| [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> | |
| [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> | |
| [intervalName](./kibana-plugin-plugins-data-public.iindexpattern.intervalname.md) | <code>string &#124; null</code> | |
| [timeFieldName](./kibana-plugin-plugins-data-public.iindexpattern.timefieldname.md) | <code>string</code> | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

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

## Parameters

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

<b>Returns:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,7 @@
```typescript
toSpec({ getFormatterForField, }?: {
getFormatterForField?: IndexPattern['getFormatterForField'];
}): {
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: {
id: any;
params: any;
} | undefined;
};
}): FieldSpec;
```

## Parameters
Expand All @@ -37,22 +20,5 @@ toSpec({ getFormatterForField, }?: {

<b>Returns:</b>

`{
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: {
id: any;
params: any;
} | undefined;
}`
`FieldSpec`

Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@
| [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) | |
| [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) | |
| [FieldMappingSpec](./kibana-plugin-plugins-data-public.fieldmappingspec.md) | |
| [Filter](./kibana-plugin-plugins-data-public.filter.md) | |
| [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) | |
| [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) | |
| [IEsSearchResponse](./kibana-plugin-plugins-data-public.iessearchresponse.md) | |
Expand All @@ -75,7 +74,6 @@
| [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) | high level search service |
| [KueryNode](./kibana-plugin-plugins-data-public.kuerynode.md) | |
| [OptionedValueProp](./kibana-plugin-plugins-data-public.optionedvalueprop.md) | |
| [Query](./kibana-plugin-plugins-data-public.query.md) | |
| [QueryState](./kibana-plugin-plugins-data-public.querystate.md) | All query state service state |
| [QueryStateChange](./kibana-plugin-plugins-data-public.querystatechange.md) | |
| [QuerySuggestionBasic](./kibana-plugin-plugins-data-public.querysuggestionbasic.md) | \* |
Expand All @@ -90,7 +88,6 @@
| [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) | search source fields |
| [TabbedAggColumn](./kibana-plugin-plugins-data-public.tabbedaggcolumn.md) | \* |
| [TabbedTable](./kibana-plugin-plugins-data-public.tabbedtable.md) | \* |
| [TimeRange](./kibana-plugin-plugins-data-public.timerange.md) | |

## Variables

Expand Down Expand Up @@ -145,6 +142,7 @@
| [FieldFormatsContentType](./kibana-plugin-plugins-data-public.fieldformatscontenttype.md) | \* |
| [FieldFormatsGetConfigFn](./kibana-plugin-plugins-data-public.fieldformatsgetconfigfn.md) | |
| [FieldFormatsStart](./kibana-plugin-plugins-data-public.fieldformatsstart.md) | |
| [Filter](./kibana-plugin-plugins-data-public.filter.md) | |
| [IAggConfig](./kibana-plugin-plugins-data-public.iaggconfig.md) | AggConfig This class represents an aggregation, which is displayed in the left-hand nav of the Visualize app. |
| [IAggType](./kibana-plugin-plugins-data-public.iaggtype.md) | |
| [IFieldFormat](./kibana-plugin-plugins-data-public.ifieldformat.md) | |
Expand All @@ -162,6 +160,7 @@
| [ParsedInterval](./kibana-plugin-plugins-data-public.parsedinterval.md) | |
| [PhraseFilter](./kibana-plugin-plugins-data-public.phrasefilter.md) | |
| [PhrasesFilter](./kibana-plugin-plugins-data-public.phrasesfilter.md) | |
| [Query](./kibana-plugin-plugins-data-public.query.md) | |
| [QueryStart](./kibana-plugin-plugins-data-public.querystart.md) | |
| [QuerySuggestion](./kibana-plugin-plugins-data-public.querysuggestion.md) | \* |
| [QuerySuggestionGetFn](./kibana-plugin-plugins-data-public.querysuggestiongetfn.md) | |
Expand All @@ -173,4 +172,5 @@
| [TabbedAggRow](./kibana-plugin-plugins-data-public.tabbedaggrow.md) | \* |
| [TimefilterContract](./kibana-plugin-plugins-data-public.timefiltercontract.md) | |
| [TimeHistoryContract](./kibana-plugin-plugins-data-public.timehistorycontract.md) | |
| [TimeRange](./kibana-plugin-plugins-data-public.timerange.md) | |

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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [aggregatable](./kibana-plugin-plugins-data-server.fielddescriptor.aggregatable.md)

## FieldDescriptor.aggregatable property

<b>Signature:</b>

```typescript
aggregatable: boolean;
```
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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [esTypes](./kibana-plugin-plugins-data-server.fielddescriptor.estypes.md)

## FieldDescriptor.esTypes property

<b>Signature:</b>

```typescript
esTypes: string[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- 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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md)

## FieldDescriptor interface

<b>Signature:</b>

```typescript
export interface FieldDescriptor
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [aggregatable](./kibana-plugin-plugins-data-server.fielddescriptor.aggregatable.md) | <code>boolean</code> | |
| [esTypes](./kibana-plugin-plugins-data-server.fielddescriptor.estypes.md) | <code>string[]</code> | |
| [name](./kibana-plugin-plugins-data-server.fielddescriptor.name.md) | <code>string</code> | |
| [readFromDocValues](./kibana-plugin-plugins-data-server.fielddescriptor.readfromdocvalues.md) | <code>boolean</code> | |
| [searchable](./kibana-plugin-plugins-data-server.fielddescriptor.searchable.md) | <code>boolean</code> | |
| [subType](./kibana-plugin-plugins-data-server.fielddescriptor.subtype.md) | <code>FieldSubType</code> | |
| [type](./kibana-plugin-plugins-data-server.fielddescriptor.type.md) | <code>string</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-server](./kibana-plugin-plugins-data-server.md) &gt; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [name](./kibana-plugin-plugins-data-server.fielddescriptor.name.md)

## FieldDescriptor.name property

<b>Signature:</b>

```typescript
name: string;
```
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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [readFromDocValues](./kibana-plugin-plugins-data-server.fielddescriptor.readfromdocvalues.md)

## FieldDescriptor.readFromDocValues property

<b>Signature:</b>

```typescript
readFromDocValues: boolean;
```
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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [searchable](./kibana-plugin-plugins-data-server.fielddescriptor.searchable.md)

## FieldDescriptor.searchable property

<b>Signature:</b>

```typescript
searchable: boolean;
```
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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [subType](./kibana-plugin-plugins-data-server.fielddescriptor.subtype.md)

## FieldDescriptor.subType property

<b>Signature:</b>

```typescript
subType?: FieldSubType;
```
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; [FieldDescriptor](./kibana-plugin-plugins-data-server.fielddescriptor.md) &gt; [type](./kibana-plugin-plugins-data-server.fielddescriptor.type.md)

## FieldDescriptor.type property

<b>Signature:</b>

```typescript
type: string;
```

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- 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; [(constructor)](./kibana-plugin-plugins-data-server.indexpattern._constructor_.md)

## IndexPattern.(constructor)

Constructs a new instance of the `IndexPattern` class

<b>Signature:</b>

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

## Parameters

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

Loading

0 comments on commit 278d037

Please sign in to comment.