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