Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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,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; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [addRuntimeComposite](./kibana-plugin-plugins-data-public.indexpattern.addruntimecomposite.md)

## IndexPattern.addRuntimeComposite() method

Create a runtime composite and add its subFields to the index pattern fields list

<b>Signature:</b>

```typescript
addRuntimeComposite(name: string, runtimeComposite: RuntimeCompositeWithSubFields): IndexPatternField[];
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | The runtime composite name |
| runtimeComposite | <code>RuntimeCompositeWithSubFields</code> | The runtime composite definition |

<b>Returns:</b>

`IndexPatternField[]`

Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Add a runtime field - Appended to existing mapped field or a new field is create
<b>Signature:</b>

```typescript
addRuntimeField(name: string, runtimeField: RuntimeField): void;
addRuntimeField(name: string, enhancedRuntimeField: EnhancedRuntimeField): IndexPatternField;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| runtimeField | <code>RuntimeField</code> | |
| enhancedRuntimeField | <code>EnhancedRuntimeField</code> | |

<b>Returns:</b>

`void`
`IndexPatternField`

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
runtimeFields: {
[x: string]: RuntimeField;
};
};
```
<b>Returns:</b>
Expand All @@ -26,6 +28,8 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
runtimeFields: {
[x: string]: RuntimeField;
};
}`

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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [getRuntimeComposite](./kibana-plugin-plugins-data-public.indexpattern.getruntimecomposite.md)

## IndexPattern.getRuntimeComposite() method

Returns runtime composite if exists

<b>Signature:</b>

```typescript
getRuntimeComposite(name: string): RuntimeComposite | null;
```

## Parameters

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

<b>Returns:</b>

`RuntimeComposite | null`

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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [getRuntimeCompositeWithSubFields](./kibana-plugin-plugins-data-public.indexpattern.getruntimecompositewithsubfields.md)

## IndexPattern.getRuntimeCompositeWithSubFields() method

Returns runtime composite (if exists) with its subFields

<b>Signature:</b>

```typescript
getRuntimeCompositeWithSubFields(name: string): RuntimeCompositeWithSubFields | null;
```

## Parameters

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

<b>Returns:</b>

`RuntimeCompositeWithSubFields | null`

Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export declare class IndexPattern implements IIndexPattern

| Method | Modifiers | Description |
| --- | --- | --- |
| [addRuntimeField(name, runtimeField)](./kibana-plugin-plugins-data-public.indexpattern.addruntimefield.md) | | Add a runtime field - Appended to existing mapped field or a new field is created as appropriate |
| [addRuntimeComposite(name, runtimeComposite)](./kibana-plugin-plugins-data-public.indexpattern.addruntimecomposite.md) | | Create a runtime composite and add its subFields to the index pattern fields list |
| [addRuntimeField(name, enhancedRuntimeField)](./kibana-plugin-plugins-data-public.indexpattern.addruntimefield.md) | | Add a runtime field - Appended to existing mapped field or a new field is created as appropriate |
| [addScriptedField(name, script, fieldType)](./kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md) | | |
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-public.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
Expand All @@ -54,13 +55,16 @@ export declare class IndexPattern implements IIndexPattern
| [getFormatterForField(field)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md) | | Provide a field, get its formatter |
| [getFormatterForFieldNoDefault(fieldname)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfieldnodefault.md) | | Get formatter for a given field name. Return undefined if none exists |
| [getNonScriptedFields()](./kibana-plugin-plugins-data-public.indexpattern.getnonscriptedfields.md) | | |
| [getRuntimeComposite(name)](./kibana-plugin-plugins-data-public.indexpattern.getruntimecomposite.md) | | Returns runtime composite if exists |
| [getRuntimeCompositeWithSubFields(name)](./kibana-plugin-plugins-data-public.indexpattern.getruntimecompositewithsubfields.md) | | Returns runtime composite (if exists) with its subFields |
| [getRuntimeField(name)](./kibana-plugin-plugins-data-public.indexpattern.getruntimefield.md) | | Returns runtime field if exists |
| [getScriptedFields()](./kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md) | | |
| [getSourceFiltering()](./kibana-plugin-plugins-data-public.indexpattern.getsourcefiltering.md) | | Get the source filtering configuration for that index. |
| [getTimeField()](./kibana-plugin-plugins-data-public.indexpattern.gettimefield.md) | | |
| [hasRuntimeField(name)](./kibana-plugin-plugins-data-public.indexpattern.hasruntimefield.md) | | Checks if runtime field exists |
| [isTimeBased()](./kibana-plugin-plugins-data-public.indexpattern.istimebased.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-public.indexpattern.istimenanosbased.md) | | |
| [removeRuntimeComposite(name)](./kibana-plugin-plugins-data-public.indexpattern.removeruntimecomposite.md) | | Remove a runtime composite with its associated subFields |
| [removeRuntimeField(name)](./kibana-plugin-plugins-data-public.indexpattern.removeruntimefield.md) | | Remove a runtime field - removed from mapped field or removed unmapped field as appropriate. Doesn't clear associated field attributes. |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md) | | Remove scripted field from field list |
| [replaceAllRuntimeFields(newFields)](./kibana-plugin-plugins-data-public.indexpattern.replaceallruntimefields.md) | | Replaces all existing runtime fields with new fields |
Expand Down
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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [removeRuntimeComposite](./kibana-plugin-plugins-data-public.indexpattern.removeruntimecomposite.md)

## IndexPattern.removeRuntimeComposite() method

Remove a runtime composite with its associated subFields

<b>Signature:</b>

```typescript
removeRuntimeComposite(name: string): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Runtime composite name to remove |

<b>Returns:</b>

`void`

Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface IndexPatternAttributes
| [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> | |
| [runtimeCompositeMap](./kibana-plugin-plugins-data-public.indexpatternattributes.runtimecompositemap.md) | <code>string</code> | |
| [runtimeFieldMap](./kibana-plugin-plugins-data-public.indexpatternattributes.runtimefieldmap.md) | <code>string</code> | |
| [sourceFilters](./kibana-plugin-plugins-data-public.indexpatternattributes.sourcefilters.md) | <code>string</code> | |
| [timeFieldName](./kibana-plugin-plugins-data-public.indexpatternattributes.timefieldname.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; [runtimeCompositeMap](./kibana-plugin-plugins-data-public.indexpatternattributes.runtimecompositemap.md)

## IndexPatternAttributes.runtimeCompositeMap property

<b>Signature:</b>

```typescript
runtimeCompositeMap?: string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export interface IndexPatternSpec
| [fields](./kibana-plugin-plugins-data-public.indexpatternspec.fields.md) | <code>IndexPatternFieldMap</code> | |
| [id](./kibana-plugin-plugins-data-public.indexpatternspec.id.md) | <code>string</code> | saved object id |
| [intervalName](./kibana-plugin-plugins-data-public.indexpatternspec.intervalname.md) | <code>string</code> | |
| [runtimeCompositeMap](./kibana-plugin-plugins-data-public.indexpatternspec.runtimecompositemap.md) | <code>Record&lt;string, RuntimeComposite&gt;</code> | |
| [runtimeFieldMap](./kibana-plugin-plugins-data-public.indexpatternspec.runtimefieldmap.md) | <code>Record&lt;string, RuntimeField&gt;</code> | |
| [sourceFilters](./kibana-plugin-plugins-data-public.indexpatternspec.sourcefilters.md) | <code>SourceFilter[]</code> | |
| [timeFieldName](./kibana-plugin-plugins-data-public.indexpatternspec.timefieldname.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; [IndexPatternSpec](./kibana-plugin-plugins-data-public.indexpatternspec.md) &gt; [runtimeCompositeMap](./kibana-plugin-plugins-data-public.indexpatternspec.runtimecompositemap.md)

## IndexPatternSpec.runtimeCompositeMap property

<b>Signature:</b>

```typescript
runtimeCompositeMap?: Record<string, RuntimeComposite>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
| [RangeFilterMeta](./kibana-plugin-plugins-data-public.rangefiltermeta.md) | |
| [RangeFilterParams](./kibana-plugin-plugins-data-public.rangefilterparams.md) | |
| [RefreshInterval](./kibana-plugin-plugins-data-public.refreshinterval.md) | |
| [RuntimeType](./kibana-plugin-plugins-data-public.runtimetype.md) | |
| [SavedQueryTimeFilter](./kibana-plugin-plugins-data-public.savedquerytimefilter.md) | |
| [SearchBarProps](./kibana-plugin-plugins-data-public.searchbarprops.md) | |
| [StatefulSearchBarProps](./kibana-plugin-plugins-data-public.statefulsearchbarprops.md) | |
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; [RuntimeType](./kibana-plugin-plugins-data-public.runtimetype.md)

## RuntimeType type

<b>Signature:</b>

```typescript
export declare type RuntimeType = typeof RUNTIME_FIELD_TYPES[number];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- 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; [addRuntimeComposite](./kibana-plugin-plugins-data-server.indexpattern.addruntimecomposite.md)

## IndexPattern.addRuntimeComposite() method

Create a runtime composite and add its subFields to the index pattern fields list

<b>Signature:</b>

```typescript
addRuntimeComposite(name: string, runtimeComposite: RuntimeCompositeWithSubFields): IndexPatternField[];
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | The runtime composite name |
| runtimeComposite | <code>RuntimeCompositeWithSubFields</code> | The runtime composite definition |

<b>Returns:</b>

`IndexPatternField[]`

Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Add a runtime field - Appended to existing mapped field or a new field is create
<b>Signature:</b>

```typescript
addRuntimeField(name: string, runtimeField: RuntimeField): void;
addRuntimeField(name: string, enhancedRuntimeField: EnhancedRuntimeField): IndexPatternField;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| runtimeField | <code>RuntimeField</code> | |
| enhancedRuntimeField | <code>EnhancedRuntimeField</code> | |

<b>Returns:</b>

`void`
`IndexPatternField`

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
runtimeFields: {
[x: string]: RuntimeField;
};
};
```
<b>Returns:</b>
Expand All @@ -26,6 +28,8 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
runtimeFields: {
[x: string]: RuntimeField;
};
}`

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; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [getRuntimeComposite](./kibana-plugin-plugins-data-server.indexpattern.getruntimecomposite.md)

## IndexPattern.getRuntimeComposite() method

Returns runtime composite if exists

<b>Signature:</b>

```typescript
getRuntimeComposite(name: string): RuntimeComposite | null;
```

## Parameters

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

<b>Returns:</b>

`RuntimeComposite | null`

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; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [getRuntimeCompositeWithSubFields](./kibana-plugin-plugins-data-server.indexpattern.getruntimecompositewithsubfields.md)

## IndexPattern.getRuntimeCompositeWithSubFields() method

Returns runtime composite (if exists) with its subFields

<b>Signature:</b>

```typescript
getRuntimeCompositeWithSubFields(name: string): RuntimeCompositeWithSubFields | null;
```

## Parameters

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

<b>Returns:</b>

`RuntimeCompositeWithSubFields | null`

Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export declare class IndexPattern implements IIndexPattern

| Method | Modifiers | Description |
| --- | --- | --- |
| [addRuntimeField(name, runtimeField)](./kibana-plugin-plugins-data-server.indexpattern.addruntimefield.md) | | Add a runtime field - Appended to existing mapped field or a new field is created as appropriate |
| [addRuntimeComposite(name, runtimeComposite)](./kibana-plugin-plugins-data-server.indexpattern.addruntimecomposite.md) | | Create a runtime composite and add its subFields to the index pattern fields list |
| [addRuntimeField(name, enhancedRuntimeField)](./kibana-plugin-plugins-data-server.indexpattern.addruntimefield.md) | | Add a runtime field - Appended to existing mapped field or a new field is created as appropriate |
| [addScriptedField(name, script, fieldType)](./kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md) | | |
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-server.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
Expand All @@ -54,13 +55,16 @@ export declare class IndexPattern implements IIndexPattern
| [getFormatterForField(field)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfield.md) | | Provide a field, get its formatter |
| [getFormatterForFieldNoDefault(fieldname)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfieldnodefault.md) | | Get formatter for a given field name. Return undefined if none exists |
| [getNonScriptedFields()](./kibana-plugin-plugins-data-server.indexpattern.getnonscriptedfields.md) | | |
| [getRuntimeComposite(name)](./kibana-plugin-plugins-data-server.indexpattern.getruntimecomposite.md) | | Returns runtime composite if exists |
| [getRuntimeCompositeWithSubFields(name)](./kibana-plugin-plugins-data-server.indexpattern.getruntimecompositewithsubfields.md) | | Returns runtime composite (if exists) with its subFields |
| [getRuntimeField(name)](./kibana-plugin-plugins-data-server.indexpattern.getruntimefield.md) | | Returns runtime field if exists |
| [getScriptedFields()](./kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md) | | |
| [getSourceFiltering()](./kibana-plugin-plugins-data-server.indexpattern.getsourcefiltering.md) | | Get the source filtering configuration for that index. |
| [getTimeField()](./kibana-plugin-plugins-data-server.indexpattern.gettimefield.md) | | |
| [hasRuntimeField(name)](./kibana-plugin-plugins-data-server.indexpattern.hasruntimefield.md) | | Checks if runtime field exists |
| [isTimeBased()](./kibana-plugin-plugins-data-server.indexpattern.istimebased.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-server.indexpattern.istimenanosbased.md) | | |
| [removeRuntimeComposite(name)](./kibana-plugin-plugins-data-server.indexpattern.removeruntimecomposite.md) | | Remove a runtime composite with its associated subFields |
| [removeRuntimeField(name)](./kibana-plugin-plugins-data-server.indexpattern.removeruntimefield.md) | | Remove a runtime field - removed from mapped field or removed unmapped field as appropriate. Doesn't clear associated field attributes. |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md) | | Remove scripted field from field list |
| [replaceAllRuntimeFields(newFields)](./kibana-plugin-plugins-data-server.indexpattern.replaceallruntimefields.md) | | Replaces all existing runtime fields with new fields |
Expand Down
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; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [removeRuntimeComposite](./kibana-plugin-plugins-data-server.indexpattern.removeruntimecomposite.md)

## IndexPattern.removeRuntimeComposite() method

Remove a runtime composite with its associated subFields

<b>Signature:</b>

```typescript
removeRuntimeComposite(name: string): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Runtime composite name to remove |

<b>Returns:</b>

`void`

Loading