Skip to content

Commit a539cde

Browse files
committed
doc changes
1 parent 12f8b8c commit a539cde

8 files changed

+16
-12
lines changed

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ Provide a field, get its formatter
99
<b>Signature:</b>
1010

1111
```typescript
12-
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat;
12+
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType, params?: Record<string, any>): FieldFormat;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
1919
| field | <code>IndexPatternField &#124; IndexPatternField['spec'] &#124; IFieldType</code> | |
20+
| params | <code>Record&lt;string, any&gt;</code> | |
2021

2122
<b>Returns:</b>
2223

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.getformatterforfieldnodefault.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ Get formatter for a given field name. Return undefined if none exists
99
<b>Signature:</b>
1010

1111
```typescript
12-
getFormatterForFieldNoDefault(fieldname: string): FieldFormat | undefined;
12+
getFormatterForFieldNoDefault(fieldname: string, params?: Record<string, any>): FieldFormat | undefined;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
1919
| fieldname | <code>string</code> | |
20+
| params | <code>Record&lt;string, any&gt;</code> | |
2021

2122
<b>Returns:</b>
2223

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ export declare class IndexPattern implements IIndexPattern
5151
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-public.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
5252
| [getComputedFields()](./kibana-plugin-plugins-data-public.indexpattern.getcomputedfields.md) | | |
5353
| [getFieldByName(name)](./kibana-plugin-plugins-data-public.indexpattern.getfieldbyname.md) | | |
54-
| [getFormatterForField(field)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md) | | Provide a field, get its formatter |
55-
| [getFormatterForFieldNoDefault(fieldname)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfieldnodefault.md) | | Get formatter for a given field name. Return undefined if none exists |
54+
| [getFormatterForField(field, params)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md) | | Provide a field, get its formatter |
55+
| [getFormatterForFieldNoDefault(fieldname, params)](./kibana-plugin-plugins-data-public.indexpattern.getformatterforfieldnodefault.md) | | Get formatter for a given field name. Return undefined if none exists |
5656
| [getNonScriptedFields()](./kibana-plugin-plugins-data-public.indexpattern.getnonscriptedfields.md) | | |
5757
| [getScriptedFields()](./kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md) | | |
5858
| [getSourceFiltering()](./kibana-plugin-plugins-data-public.indexpattern.getsourcefiltering.md) | | Get the source filtering configuration for that index. |

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getformatterforfield.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ Provide a field, get its formatter
99
<b>Signature:</b>
1010

1111
```typescript
12-
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat;
12+
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType, params?: Record<string, any>): FieldFormat;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
1919
| field | <code>IndexPatternField &#124; IndexPatternField['spec'] &#124; IFieldType</code> | |
20+
| params | <code>Record&lt;string, any&gt;</code> | |
2021

2122
<b>Returns:</b>
2223

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.getformatterforfieldnodefault.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ Get formatter for a given field name. Return undefined if none exists
99
<b>Signature:</b>
1010

1111
```typescript
12-
getFormatterForFieldNoDefault(fieldname: string): FieldFormat | undefined;
12+
getFormatterForFieldNoDefault(fieldname: string, params?: Record<string, any>): FieldFormat | undefined;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
1919
| fieldname | <code>string</code> | |
20+
| params | <code>Record&lt;string, any&gt;</code> | |
2021

2122
<b>Returns:</b>
2223

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ export declare class IndexPattern implements IIndexPattern
5151
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-server.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
5252
| [getComputedFields()](./kibana-plugin-plugins-data-server.indexpattern.getcomputedfields.md) | | |
5353
| [getFieldByName(name)](./kibana-plugin-plugins-data-server.indexpattern.getfieldbyname.md) | | |
54-
| [getFormatterForField(field)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfield.md) | | Provide a field, get its formatter |
55-
| [getFormatterForFieldNoDefault(fieldname)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfieldnodefault.md) | | Get formatter for a given field name. Return undefined if none exists |
54+
| [getFormatterForField(field, params)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfield.md) | | Provide a field, get its formatter |
55+
| [getFormatterForFieldNoDefault(fieldname, params)](./kibana-plugin-plugins-data-server.indexpattern.getformatterforfieldnodefault.md) | | Get formatter for a given field name. Return undefined if none exists |
5656
| [getNonScriptedFields()](./kibana-plugin-plugins-data-server.indexpattern.getnonscriptedfields.md) | | |
5757
| [getScriptedFields()](./kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md) | | |
5858
| [getSourceFiltering()](./kibana-plugin-plugins-data-server.indexpattern.getsourcefiltering.md) | | Get the source filtering configuration for that index. |

src/plugins/data/public/public.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1323,8 +1323,8 @@ export class IndexPattern implements IIndexPattern {
13231323
};
13241324
// (undocumented)
13251325
getFieldByName(name: string): IndexPatternField | undefined;
1326-
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat;
1327-
getFormatterForFieldNoDefault(fieldname: string): FieldFormat | undefined;
1326+
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType, params?: Record<string, any>): FieldFormat;
1327+
getFormatterForFieldNoDefault(fieldname: string, params?: Record<string, any>): FieldFormat | undefined;
13281328
// (undocumented)
13291329
getNonScriptedFields(): IndexPatternField[];
13301330
getOriginalSavedObjectBody: () => {

src/plugins/data/server/server.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -758,8 +758,8 @@ export class IndexPattern implements IIndexPattern {
758758
};
759759
// (undocumented)
760760
getFieldByName(name: string): IndexPatternField | undefined;
761-
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat;
762-
getFormatterForFieldNoDefault(fieldname: string): FieldFormat | undefined;
761+
getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType, params?: Record<string, any>): FieldFormat;
762+
getFormatterForFieldNoDefault(fieldname: string, params?: Record<string, any>): FieldFormat | undefined;
763763
// Warning: (ae-forgotten-export) The symbol "IndexPatternField" needs to be exported by the entry point index.d.ts
764764
//
765765
// (undocumented)

0 commit comments

Comments
 (0)