20202f7e7d
* Write plugin directory doc as part of api docs build. * Replace service folder with the new name for index patterns * Updated docs * small update * update docs
65 lines
1.7 KiB
Plaintext
65 lines
1.7 KiB
Plaintext
---
|
|
id: kibFieldFormatsPluginApi
|
|
slug: /kibana-dev-docs/fieldFormatsPluginApi
|
|
title: fieldFormats
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the fieldFormats plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
|
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
|
|
---
|
|
import fieldFormatsObj from './field_formats.json';
|
|
|
|
Index pattern fields and ambiguous values formatters
|
|
|
|
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 288 | 7 | 250 | 3 |
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[fieldFormatsObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[fieldFormatsObj.client.start]}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={fieldFormatsObj.client.classes}/>
|
|
|
|
## Server
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[fieldFormatsObj.server.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[fieldFormatsObj.server.start]}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={fieldFormatsObj.server.classes}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={fieldFormatsObj.common.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={fieldFormatsObj.common.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={fieldFormatsObj.common.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={fieldFormatsObj.common.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={fieldFormatsObj.common.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={fieldFormatsObj.common.misc}/>
|
|
|