github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iindexpattern.md
Matthew Kime b95586f0f4
[index patterns] deprecate IIndexPattern and IFieldType interfaces (#100013) 
* deprecate IIndexPattern and IFieldType

* update api docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-05-14 15:38:20 -05:00

1.7 KiB
Raw Blame History

Home > kibana-plugin-plugins-data-public > IIndexPattern

IIndexPattern interface

Warning: This API is now obsolete.

IIndexPattern allows for an IndexPattern OR an index pattern saved object Use IndexPattern or IndexPatternSpec instead

Signature:

export interface IIndexPattern

Properties

Property Type Description
fieldFormatMap Record<string, SerializedFieldFormat<unknown> | undefined>
fields IFieldType[]
getFormatterForField (field: IndexPatternField | IndexPatternField['spec'] | IFieldType) => FieldFormat Look up a formatter for a given field
id string
timeFieldName string
title string
type string Type is used for identifying rollup indices, otherwise left undefined

Methods

Method Description
getTimeField()