maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/data_field_formats.json
Wylie Conlon c33987d929
Support for number, date and IP range data types (#76971) 
* Support for number, date and IP ranges

* Update tests

* Ranges don't work with range agg

* Fix test case

* Allow Discover to create range filters

* Supports ranges in Visualize, KQL, remove Lens support

* Fix test mappings

* Bring back field cache to work around bug

* Fix some tests

* Fix test expectation

* Respond to review comments

* Fix type error

* Remove added sample data

* Fix api_docs

* Fix test
2021-03-08 15:50:36 -05:00

4104 lines
128 KiB
JSON
Raw Blame History

{
"id": "data.fieldFormats",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-public.baseFormattersPublic",
"type": "Array",
"label": "baseFormattersPublic",
"description": [],
"source": {
"path": "src/plugins/data/public/field_formats/constants.ts",
"lineNumber": 12
},
"signature": [
"(typeof ",
"DateFormat",
" | typeof ",
"DateNanosFormat",
" | ",
"FieldFormatInstanceType",
")[]"
],
"initialIsOpen": false
},
{
"id": "def-public.FieldFormatsStart",
"type": "Type",
"label": "FieldFormatsStart",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/public/field_formats/field_formats_service.ts",
"lineNumber": 55
},
"signature": [
"Pick<FieldFormatsRegistry, \"init\" | \"register\" | \"deserialize\" | \"getDefaultConfig\" | \"getType\" | \"getTypeWithoutMetaParams\" | \"getDefaultType\" | \"getTypeNameByEsTypes\" | \"getDefaultTypeName\" | \"getInstance\" | \"getDefaultInstancePlain\" | \"getDefaultInstanceCacheResolver\" | \"getByFieldType\" | \"getDefaultInstance\" | \"parseDefaultTypeMap\"> & { deserialize: FormatFactory; }"
],
"initialIsOpen": false
}
],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"id": "def-common.BoolFormat",
"type": "Class",
"tags": [],
"label": "BoolFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.BoolFormat",
"text": "BoolFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.BoolFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/boolean.ts",
"lineNumber": 16
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.BoolFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/boolean.ts",
"lineNumber": 17
}
},
{
"tags": [],
"id": "def-common.BoolFormat.fieldType",
"type": "Array",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/boolean.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
"[]"
]
},
{
"id": "def-common.BoolFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/boolean.ts",
"lineNumber": 22
}
}
],
"signature": [
"(value: any) => string"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/boolean.ts",
"lineNumber": 22
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/boolean.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"id": "def-common.BytesFormat",
"type": "Class",
"tags": [],
"label": "BytesFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.BytesFormat",
"text": "BytesFormat"
},
" extends ",
"NumeralFormat"
],
"children": [
{
"tags": [],
"id": "def-common.BytesFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/bytes.ts",
"lineNumber": 14
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.BytesFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/bytes.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.BytesFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/bytes.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.BytesFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/bytes.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.BytesFormat.allowsNumericalAggregations",
"type": "boolean",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/bytes.ts",
"lineNumber": 21
}
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/bytes.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.ColorFormat",
"type": "Class",
"tags": [],
"label": "ColorFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.ColorFormat",
"text": "ColorFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.ColorFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.ColorFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-common.ColorFormat.fieldType",
"type": "Array",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 24
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
"[]"
]
},
{
"id": "def-common.ColorFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => { fieldType: null; colors: { range: string; regex: string; text: string; background: string; }[]; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 26
}
},
{
"id": "def-common.ColorFormat.findColorRuleForVal",
"type": "Function",
"label": "findColorRuleForVal",
"signature": [
"(val: any) => any"
],
"description": [],
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 33
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 33
}
},
{
"id": "def-common.ColorFormat.htmlConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 52
}
}
],
"signature": [
"(val: any) => string"
],
"description": [],
"label": "htmlConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 52
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/color.ts",
"lineNumber": 19
},
"initialIsOpen": false
},
{
"id": "def-common.DurationFormat",
"type": "Class",
"tags": [],
"label": "DurationFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.DurationFormat",
"text": "DurationFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.DurationFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 158
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.DurationFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 159
}
},
{
"tags": [],
"id": "def-common.DurationFormat.fieldType",
"type": "Enum",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 162
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
]
},
{
"tags": [],
"id": "def-common.DurationFormat.inputFormats",
"type": "Array",
"label": "inputFormats",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 163
},
"signature": [
"{ text: string; kind: string; }[]"
]
},
{
"tags": [],
"id": "def-common.DurationFormat.outputFormats",
"type": "Array",
"label": "outputFormats",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 164
},
"signature": [
"{ text: string; method: string; }[]"
]
},
{
"tags": [],
"id": "def-common.DurationFormat.allowsNumericalAggregations",
"type": "boolean",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 165
}
},
{
"id": "def-common.DurationFormat.isHuman",
"type": "Function",
"label": "isHuman",
"signature": [
"() => boolean"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 167
}
},
{
"id": "def-common.DurationFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => { inputFormat: string; outputFormat: string; outputPrecision: number; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 170
}
},
{
"id": "def-common.DurationFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 178
}
}
],
"signature": [
"(val: any) => string"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 178
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 157
},
"initialIsOpen": false
},
{
"id": "def-common.FieldFormat",
"type": "Class",
"tags": [],
"label": "FieldFormat",
"description": [],
"children": [
{
"tags": [
"property",
"static",
"public"
],
"id": "def-common.FieldFormat.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 32
}
},
{
"tags": [
"property",
"static",
"public"
],
"id": "def-common.FieldFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 38
}
},
{
"tags": [
"property",
"private"
],
"id": "def-common.FieldFormat.fieldType",
"type": "CompoundType",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 44
},
"signature": [
"string | string[]"
]
},
{
"tags": [
"property",
"private"
],
"id": "def-common.FieldFormat.convertObject",
"type": "Object",
"label": "convertObject",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatConvert",
"text": "FieldFormatConvert"
},
" | undefined"
]
},
{
"tags": [
"property",
"protected"
],
"id": "def-common.FieldFormat.htmlConvert",
"type": "Function",
"label": "htmlConvert",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 60
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeConvert",
"text": "HtmlContextTypeConvert"
},
" | undefined"
]
},
{
"tags": [
"property",
"protected"
],
"id": "def-common.FieldFormat.textConvert",
"type": "Function",
"label": "textConvert",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 68
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.TextContextTypeConvert",
"text": "TextContextTypeConvert"
},
" | undefined"
]
},
{
"tags": [
"property",
"private"
],
"id": "def-common.FieldFormat.type",
"type": "Any",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 74
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.FieldFormat.allowsNumericalAggregations",
"type": "CompoundType",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 75
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-common.FieldFormat._params",
"type": "Any",
"label": "_params",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 77
},
"signature": [
"any"
]
},
{
"tags": [],
"id": "def-common.FieldFormat.getConfig",
"type": "Function",
"label": "getConfig",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 78
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
" | undefined"
]
},
{
"id": "def-common.FieldFormat.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "_params",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.IFieldFormatMetaParams",
"text": "IFieldFormatMetaParams"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 80
}
},
{
"type": "Function",
"label": "getConfig",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 80
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 80
}
},
{
"id": "def-common.FieldFormat.convert",
"type": "Function",
"label": "convert",
"signature": [
"(value: any, contentType?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
},
", options?: Record<string, any> | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined) => string"
],
"description": [
"\nConvert a raw value to a formatted string"
],
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 99
}
},
{
"type": "CompoundType",
"label": "contentType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
],
"description": [
"- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 100
}
},
{
"type": "CompoundType",
"label": "options",
"isRequired": false,
"signature": [
"Record<string, any> | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 101
}
}
],
"tags": [
"return",
"public"
],
"returnComment": [
"- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 98
}
},
{
"id": "def-common.FieldFormat.getConverterFor",
"type": "Function",
"label": "getConverterFor",
"signature": [
"(contentType?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatConvertFunction",
"text": "FieldFormatConvertFunction"
}
],
"description": [
"\nGet a convert function that is bound to a specific contentType"
],
"children": [
{
"type": "CompoundType",
"label": "contentType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 119
}
}
],
"tags": [
"return",
"public"
],
"returnComment": [
"- a bound converter function"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 118
}
},
{
"id": "def-common.FieldFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => Record<string, any>"
],
"description": [
"\nGet parameter defaults"
],
"children": [],
"tags": [
"return",
"public"
],
"returnComment": [
"- parameter defaults"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 133
}
},
{
"id": "def-common.FieldFormat.param",
"type": "Function",
"label": "param",
"signature": [
"(name: string) => any"
],
"description": [
"\nGet the value of a param. This value may be a default value.\n"
],
"children": [
{
"type": "string",
"label": "name",
"isRequired": true,
"signature": [
"string"
],
"description": [
"- the param name to fetch"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 144
}
}
],
"tags": [
"return",
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 144
}
},
{
"id": "def-common.FieldFormat.params",
"type": "Function",
"label": "params",
"signature": [
"() => Record<string, any>"
],
"description": [
"\nGet all of the params in a single object"
],
"children": [],
"tags": [
"return",
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 161
}
},
{
"id": "def-common.FieldFormat.toJSON",
"type": "Function",
"label": "toJSON",
"signature": [
"() => { id: any; params: any; }"
],
"description": [
"\nSerialize this format to a simple POJO, with only the params\nthat are not default\n"
],
"children": [],
"tags": [
"return",
"public"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 172
}
},
{
"id": "def-common.FieldFormat.from",
"type": "Function",
"label": "from",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
".from"
],
"description": [],
"children": [
{
"type": "Function",
"label": "convertFn",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatConvertFunction",
"text": "FieldFormatConvertFunction"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 193
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 193
}
},
{
"id": "def-common.FieldFormat.setupContentType",
"type": "Function",
"label": "setupContentType",
"signature": [
"() => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatConvert",
"text": "FieldFormatConvert"
}
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 197
}
},
{
"id": "def-common.FieldFormat.isInstanceOfFieldFormat",
"type": "Function",
"label": "isInstanceOfFieldFormat",
"signature": [
"typeof ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
".isInstanceOfFieldFormat"
],
"description": [],
"children": [
{
"type": "Any",
"label": "fieldFormat",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 204
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 204
}
}
],
"source": {
"path": "src/plugins/data/common/field_formats/field_format.ts",
"lineNumber": 26
},
"initialIsOpen": false
},
{
"id": "def-common.FieldFormatNotFoundError",
"type": "Class",
"tags": [],
"label": "FieldFormatNotFoundError",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatNotFoundError",
"text": "FieldFormatNotFoundError"
},
" extends Error"
],
"children": [
{
"tags": [],
"id": "def-common.FieldFormatNotFoundError.formatId",
"type": "string",
"label": "formatId",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/errors.ts",
"lineNumber": 10
}
},
{
"id": "def-common.FieldFormatNotFoundError.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "string",
"label": "message",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/errors.ts",
"lineNumber": 11
}
},
{
"type": "string",
"label": "formatId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/errors.ts",
"lineNumber": 11
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/errors.ts",
"lineNumber": 11
}
}
],
"source": {
"path": "src/plugins/data/common/field_formats/errors.ts",
"lineNumber": 9
},
"initialIsOpen": false
},
{
"id": "def-common.FieldFormatsRegistry",
"type": "Class",
"tags": [],
"label": "FieldFormatsRegistry",
"description": [],
"children": [
{
"tags": [],
"id": "def-common.FieldFormatsRegistry.fieldFormats",
"type": "Object",
"label": "fieldFormats",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 29
},
"signature": [
"Map<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
">"
]
},
{
"id": "def-common.FieldFormatsRegistry.defaultMap",
"type": "Object",
"tags": [],
"children": [],
"description": [],
"label": "defaultMap",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 30
}
},
{
"id": "def-common.FieldFormatsRegistry.metaParamsOptions",
"type": "Object",
"tags": [],
"children": [],
"description": [],
"label": "metaParamsOptions",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 31
}
},
{
"tags": [],
"id": "def-common.FieldFormatsRegistry.getConfig",
"type": "Function",
"label": "getConfig",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 32
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
" | undefined"
]
},
{
"id": "def-common.FieldFormatsRegistry.deserialize",
"type": "Function",
"children": [
{
"type": "Object",
"label": "mapping",
"isRequired": false,
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>> | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 34
}
}
],
"signature": [
"(mapping?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<Record<string, any>> | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"description": [],
"label": "deserialize",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 34
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.init",
"type": "Function",
"label": "init",
"signature": [
"(getConfig: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
", metaParamsOptions?: Record<string, any>, defaultFieldConverters?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]) => void"
],
"description": [],
"children": [
{
"type": "Function",
"label": "getConfig",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 52
}
},
{
"type": "Object",
"label": "metaParamsOptions",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 53
}
},
{
"type": "Array",
"label": "defaultFieldConverters",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 54
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 51
}
},
{
"id": "def-common.FieldFormatsRegistry.getDefaultConfig",
"type": "Function",
"children": [
{
"type": "Enum",
"label": "fieldType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 72
}
},
{
"type": "Array",
"label": "esTypes",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 73
}
}
],
"signature": [
"(fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatConfig",
"text": "FieldFormatConfig"
}
],
"description": [
"\nGet the id of the default type for this field type\nusing the format:defaultTypeMap config map\n"
],
"label": "getDefaultConfig",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 71
},
"tags": [
"return"
],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.getType",
"type": "Function",
"children": [
{
"type": "string",
"label": "formatId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 88
}
}
],
"signature": [
"(formatId: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
" | undefined"
],
"description": [
"\nGet a derived FieldFormat class by its id.\n"
],
"label": "getType",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 88
},
"tags": [
"return"
],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams",
"type": "Function",
"children": [
{
"type": "string",
"label": "formatId",
"isRequired": true,
"signature": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 102
}
}
],
"signature": [
"(formatId: string) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
" | undefined"
],
"description": [],
"label": "getTypeWithoutMetaParams",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 102
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.getDefaultType",
"type": "Function",
"children": [
{
"type": "Enum",
"label": "fieldType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 116
}
},
{
"type": "Array",
"label": "esTypes",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 117
}
}
],
"signature": [
"(fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
" | undefined"
],
"description": [
"\nGet the default FieldFormat type (class) for\na field type, using the format:defaultTypeMap.\nused by the field editor\n"
],
"label": "getDefaultType",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 115
},
"tags": [
"return"
],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes",
"type": "Function",
"children": [
{
"type": "Array",
"label": "esTypes",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 131
}
}
],
"signature": [
"(esTypes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
" | undefined"
],
"description": [
"\nGet the name of the default type for ES types like date_nanos\nusing the format:defaultTypeMap config map\n"
],
"label": "getTypeNameByEsTypes",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 131
},
"tags": [
"return"
],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.getDefaultTypeName",
"type": "Function",
"children": [
{
"type": "Enum",
"label": "fieldType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 148
}
},
{
"type": "Array",
"label": "esTypes",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 149
}
}
],
"signature": [
"(fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
" | ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
}
],
"description": [
"\nGet the default FieldFormat type name for\na field type, using the format:defaultTypeMap.\n"
],
"label": "getDefaultTypeName",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 147
},
"tags": [
"return"
],
"returnComment": []
},
{
"tags": [
"return"
],
"id": "def-common.FieldFormatsRegistry.getInstance",
"type": "Function",
"label": "getInstance",
"description": [
"\nGet the singleton instance of the FieldFormat type by its id.\n"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 162
},
"signature": [
"((formatId: string, params?: Record<string, any>) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") & _.MemoizedFunction"
]
},
{
"id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain",
"type": "Function",
"children": [
{
"type": "Enum",
"label": "fieldType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 187
}
},
{
"type": "Array",
"label": "esTypes",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 188
}
},
{
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
"Record<string, any>"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 189
}
}
],
"signature": [
"(fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined, params?: Record<string, any>) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"description": [
"\nGet the default fieldFormat instance for a field format.\n"
],
"label": "getDefaultInstancePlain",
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 186
},
"tags": [
"return"
],
"returnComment": []
},
{
"id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver",
"type": "Function",
"label": "getDefaultInstanceCacheResolver",
"signature": [
"(fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[]) => string"
],
"description": [
"\nReturns a cache key built by the given variables for caching in memoized\nWhere esType contains fieldType, fieldType is returned\n-> kibana types have a higher priority in that case\n-> would lead to failing tests that match e.g. date format with/without esTypes\nhttps://lodash.com/docs#memoize\n"
],
"children": [
{
"type": "Enum",
"label": "fieldType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 210
}
},
{
"type": "Array",
"label": "esTypes",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 210
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 210
}
},
{
"id": "def-common.FieldFormatsRegistry.getByFieldType",
"type": "Function",
"label": "getByFieldType",
"signature": [
"(fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
") => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]"
],
"description": [
"\nGet filtered list of field formats by format type\n"
],
"children": [
{
"type": "Enum",
"label": "fieldType",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 223
}
}
],
"tags": [
"return"
],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 223
}
},
{
"tags": [
"return"
],
"id": "def-common.FieldFormatsRegistry.getDefaultInstance",
"type": "Function",
"label": "getDefaultInstance",
"description": [
"\nGet the default fieldFormat instance for a field format.\nIt's a memoized function that builds and reads a cache\n"
],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 242
},
"signature": [
"((fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined, params?: Record<string, any>) => ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
},
") & _.MemoizedFunction"
]
},
{
"id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap",
"type": "Function",
"label": "parseDefaultTypeMap",
"signature": [
"(value: any) => void"
],
"description": [],
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 244
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 244
}
},
{
"id": "def-common.FieldFormatsRegistry.register",
"type": "Function",
"label": "register",
"signature": [
"(fieldFormats: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]) => void"
],
"description": [],
"children": [
{
"type": "Array",
"label": "fieldFormats",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 255
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 255
}
}
],
"source": {
"path": "src/plugins/data/common/field_formats/field_formats_registry.ts",
"lineNumber": 28
},
"initialIsOpen": false
},
{
"id": "def-common.HistogramFormat",
"type": "Class",
"tags": [],
"label": "HistogramFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HistogramFormat",
"text": "HistogramFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.HistogramFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 18
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.HistogramFormat.fieldType",
"type": "Enum",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
]
},
{
"tags": [],
"id": "def-common.HistogramFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.HistogramFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 24
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.HistogramFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 25
}
},
{
"tags": [],
"id": "def-common.HistogramFormat.allowsNumericalAggregations",
"type": "boolean",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 26
}
},
{
"id": "def-common.HistogramFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => { id: string; params: {}; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 29
}
},
{
"id": "def-common.HistogramFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 36
}
}
],
"signature": [
"(val: any) => string"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 36
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/histogram.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-common.IpFormat",
"type": "Class",
"tags": [],
"label": "IpFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.IpFormat",
"text": "IpFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.IpFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/ip.ts",
"lineNumber": 15
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.IpFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/ip.ts",
"lineNumber": 16
}
},
{
"tags": [],
"id": "def-common.IpFormat.fieldType",
"type": "Enum",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/ip.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
]
},
{
"id": "def-common.IpFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/ip.ts",
"lineNumber": 21
}
}
],
"signature": [
"(val: any) => any"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/ip.ts",
"lineNumber": 21
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/ip.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.NumberFormat",
"type": "Class",
"tags": [],
"label": "NumberFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.NumberFormat",
"text": "NumberFormat"
},
" extends ",
"NumeralFormat"
],
"children": [
{
"tags": [],
"id": "def-common.NumberFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/number.ts",
"lineNumber": 14
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.NumberFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/number.ts",
"lineNumber": 15
}
},
{
"tags": [],
"id": "def-common.NumberFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/number.ts",
"lineNumber": 19
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.NumberFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/number.ts",
"lineNumber": 20
}
},
{
"tags": [],
"id": "def-common.NumberFormat.allowsNumericalAggregations",
"type": "boolean",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/number.ts",
"lineNumber": 21
}
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/number.ts",
"lineNumber": 13
},
"initialIsOpen": false
},
{
"id": "def-common.PercentFormat",
"type": "Class",
"tags": [],
"label": "PercentFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.PercentFormat",
"text": "PercentFormat"
},
" extends ",
"NumeralFormat"
],
"children": [
{
"tags": [],
"id": "def-common.PercentFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 15
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.PercentFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 16
}
},
{
"tags": [],
"id": "def-common.PercentFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.PercentFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 21
}
},
{
"tags": [],
"id": "def-common.PercentFormat.allowsNumericalAggregations",
"type": "boolean",
"label": "allowsNumericalAggregations",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 22
}
},
{
"id": "def-common.PercentFormat.getParamDefaults",
"type": "Function",
"children": [],
"signature": [
"() => { pattern: any; fractional: boolean; }"
],
"description": [],
"label": "getParamDefaults",
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 24
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.PercentFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 29
}
}
],
"signature": [
"(val: any) => string"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 29
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/percent.ts",
"lineNumber": 14
},
"initialIsOpen": false
},
{
"id": "def-common.RelativeDateFormat",
"type": "Class",
"tags": [],
"label": "RelativeDateFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.RelativeDateFormat",
"text": "RelativeDateFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.RelativeDateFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/relative_date.ts",
"lineNumber": 16
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.RelativeDateFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/relative_date.ts",
"lineNumber": 17
}
},
{
"tags": [],
"id": "def-common.RelativeDateFormat.fieldType",
"type": "Enum",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/relative_date.ts",
"lineNumber": 20
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
]
},
{
"id": "def-common.RelativeDateFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/relative_date.ts",
"lineNumber": 22
}
}
],
"signature": [
"(val: any) => any"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/relative_date.ts",
"lineNumber": 22
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/relative_date.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"id": "def-common.SourceFormat",
"type": "Class",
"tags": [],
"label": "SourceFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.SourceFormat",
"text": "SourceFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.SourceFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 45
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.SourceFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 46
}
},
{
"tags": [],
"id": "def-common.SourceFormat.fieldType",
"type": "Enum",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 47
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
]
},
{
"id": "def-common.SourceFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 49
}
}
],
"signature": [
"(value: any) => string"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 49
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.SourceFormat.htmlConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 51
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 51
}
}
],
"signature": [
"(value: any, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined) => string"
],
"description": [],
"label": "htmlConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 51
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/source.ts",
"lineNumber": 44
},
"initialIsOpen": false
},
{
"id": "def-common.StaticLookupFormat",
"type": "Class",
"tags": [],
"label": "StaticLookupFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.StaticLookupFormat",
"text": "StaticLookupFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.StaticLookupFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 25
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.StaticLookupFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 26
}
},
{
"tags": [],
"id": "def-common.StaticLookupFormat.fieldType",
"type": "Array",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 29
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
"[]"
]
},
{
"id": "def-common.StaticLookupFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => { lookupEntries: {}[]; unknownKeyValue: null; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 36
}
},
{
"id": "def-common.StaticLookupFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 43
}
}
],
"signature": [
"(val: any) => any"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 43
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/static_lookup.ts",
"lineNumber": 24
},
"initialIsOpen": false
},
{
"id": "def-common.StringFormat",
"type": "Class",
"tags": [],
"label": "StringFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.StringFormat",
"text": "StringFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.StringFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 63
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.StringFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 64
}
},
{
"tags": [],
"id": "def-common.StringFormat.fieldType",
"type": "Array",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 67
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.StringFormat.transformOptions",
"type": "Array",
"label": "transformOptions",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 83
},
"signature": [
"({ kind: boolean; text: string; } | { kind: string; text: string; })[]"
]
},
{
"id": "def-common.StringFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => { transform: boolean; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 85
}
},
{
"id": "def-common.StringFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 105
}
}
],
"signature": [
"(val: any) => any"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 105
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/string.ts",
"lineNumber": 62
},
"initialIsOpen": false
},
{
"id": "def-common.TruncateFormat",
"type": "Class",
"tags": [],
"label": "TruncateFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.TruncateFormat",
"text": "TruncateFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.TruncateFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/truncate.ts",
"lineNumber": 18
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.TruncateFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/truncate.ts",
"lineNumber": 19
}
},
{
"tags": [],
"id": "def-common.TruncateFormat.fieldType",
"type": "Enum",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/truncate.ts",
"lineNumber": 22
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
]
},
{
"id": "def-common.TruncateFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "val",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/truncate.ts",
"lineNumber": 24
}
}
],
"signature": [
"(val: any) => any"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/truncate.ts",
"lineNumber": 24
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/truncate.ts",
"lineNumber": 17
},
"initialIsOpen": false
},
{
"id": "def-common.UrlFormat",
"type": "Class",
"tags": [],
"label": "UrlFormat",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.UrlFormat",
"text": "UrlFormat"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"children": [
{
"tags": [],
"id": "def-common.UrlFormat.id",
"type": "Enum",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 47
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FIELD_FORMAT_IDS",
"text": "FIELD_FORMAT_IDS"
}
]
},
{
"tags": [],
"id": "def-common.UrlFormat.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 48
}
},
{
"tags": [],
"id": "def-common.UrlFormat.fieldType",
"type": "Array",
"label": "fieldType",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 51
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.UrlFormat.urlTypes",
"type": "Array",
"label": "urlTypes",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 61
},
"signature": [
"{ kind: string; text: string; }[]"
]
},
{
"id": "def-common.UrlFormat.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "params",
"isRequired": true,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.IFieldFormatMetaParams",
"text": "IFieldFormatMetaParams"
}
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 63
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 63
}
},
{
"id": "def-common.UrlFormat.getParamDefaults",
"type": "Function",
"label": "getParamDefaults",
"signature": [
"() => { type: string; urlTemplate: null; labelTemplate: null; width: null; height: null; }"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 68
}
},
{
"id": "def-common.UrlFormat.textConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "value",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 131
}
}
],
"signature": [
"(value: any) => string"
],
"description": [],
"label": "textConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 131
},
"tags": [],
"returnComment": []
},
{
"id": "def-common.UrlFormat.htmlConvert",
"type": "Function",
"children": [
{
"type": "Any",
"label": "rawValue",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 133
}
},
{
"type": "Object",
"label": "options",
"isRequired": false,
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 133
}
}
],
"signature": [
"(rawValue: any, options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.HtmlContextTypeOptions",
"text": "HtmlContextTypeOptions"
},
" | undefined) => string"
],
"description": [],
"label": "htmlConvert",
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 133
},
"tags": [],
"returnComment": []
}
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/url.ts",
"lineNumber": 46
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-common.getHighlightRequest",
"type": "Function",
"label": "getHighlightRequest",
"signature": [
"(query: any, shouldHighlight: boolean) => { pre_tags: string[]; post_tags: string[]; fields: { '*': {}; }; fragment_size: number; } | undefined"
],
"description": [],
"children": [
{
"type": "Any",
"label": "query",
"isRequired": true,
"signature": [
"any"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts",
"lineNumber": 13
}
},
{
"type": "boolean",
"label": "shouldHighlight",
"isRequired": true,
"signature": [
"boolean"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts",
"lineNumber": 13
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts",
"lineNumber": 13
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-common.FieldFormatConfig",
"type": "Interface",
"label": "FieldFormatConfig",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.FieldFormatConfig.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 63
}
},
{
"tags": [],
"id": "def-common.FieldFormatConfig.params",
"type": "Object",
"label": "params",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 64
},
"signature": [
"Record<string, any>"
]
},
{
"tags": [],
"id": "def-common.FieldFormatConfig.es",
"type": "CompoundType",
"label": "es",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 65
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 62
},
"initialIsOpen": false
}
],
"enums": [
{
"id": "def-common.FIELD_FORMAT_IDS",
"type": "Enum",
"label": "FIELD_FORMAT_IDS",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 42
},
"initialIsOpen": false
}
],
"misc": [
{
"tags": [],
"id": "def-common.baseFormatters",
"type": "Array",
"label": "baseFormatters",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/constants/base_formatters.ts",
"lineNumber": 28
},
"signature": [
"FieldFormatInstanceType",
"[]"
],
"initialIsOpen": false
},
{
"id": "def-common.FieldFormatId",
"type": "Type",
"label": "FieldFormatId",
"tags": [
"string"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 75
},
"signature": [
"string"
],
"initialIsOpen": false
},
{
"id": "def-common.FieldFormatsContentType",
"type": "Type",
"label": "FieldFormatsContentType",
"tags": [
"public"
],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 14
},
"signature": [
"\"html\" | \"text\""
],
"initialIsOpen": false
},
{
"id": "def-common.FieldFormatsGetConfigFn",
"type": "Type",
"label": "FieldFormatsGetConfigFn",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 68
},
"signature": [
"(key: string, defaultOverride: T | undefined) => T"
],
"initialIsOpen": false
},
{
"id": "def-common.FieldFormatsStartCommon",
"type": "Type",
"label": "FieldFormatsStartCommon",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 97
},
"signature": [
"{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record<string, any>, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ",
"FormatFactory",
"; getDefaultConfig: (fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
"[] | undefined) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
},
", esTypes?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
}
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.HTML_CONTEXT_TYPE",
"type": "CompoundType",
"label": "HTML_CONTEXT_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/content_types/html_content_type.ts",
"lineNumber": 13
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
],
"initialIsOpen": false
},
{
"id": "def-common.IFieldFormat",
"type": "Type",
"label": "IFieldFormat",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/types.ts",
"lineNumber": 70
},
"signature": [
"FieldFormat"
],
"initialIsOpen": false
},
{
"id": "def-common.IFieldFormatsRegistry",
"type": "Type",
"label": "IFieldFormatsRegistry",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/index.ts",
"lineNumber": 11
},
"signature": [
"{ init: (getConfig: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.GetConfigFn",
"text": "GetConfigFn"
},
", metaParamsOptions?: Record<string, any>, defaultFieldConverters?: ",
"FieldFormatInstanceType",
"[]) => void; register: (fieldFormats: ",
"FieldFormatInstanceType",
"[]) => void; deserialize: ",
"FormatFactory",
"; getDefaultConfig: (fieldType: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataPluginApi",
"section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES"
}
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.TEXT_CONTEXT_TYPE",
"type": "CompoundType",
"label": "TEXT_CONTEXT_TYPE",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/content_types/text_content_type.ts",
"lineNumber": 13
},
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataFieldFormatsPluginApi",
"section": "def-common.FieldFormatsContentType",
"text": "FieldFormatsContentType"
}
],
"initialIsOpen": false
}
],
"objects": [
{
"id": "def-common.DEFAULT_CONVERTER_COLOR",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.DEFAULT_CONVERTER_COLOR.range",
"type": "string",
"label": "range",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/constants/color_default.ts",
"lineNumber": 10
}
},
{
"tags": [],
"id": "def-common.DEFAULT_CONVERTER_COLOR.regex",
"type": "string",
"label": "regex",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/constants/color_default.ts",
"lineNumber": 11
}
},
{
"tags": [],
"id": "def-common.DEFAULT_CONVERTER_COLOR.text",
"type": "string",
"label": "text",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/constants/color_default.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-common.DEFAULT_CONVERTER_COLOR.background",
"type": "string",
"label": "background",
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/constants/color_default.ts",
"lineNumber": 13
}
}
],
"description": [],
"label": "DEFAULT_CONVERTER_COLOR",
"source": {
"path": "src/plugins/data/common/field_formats/constants/color_default.ts",
"lineNumber": 9
},
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink