mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
2d982c0070
* Support the docs scripts knowing which json files are specifically for dev docs. * Update jest snapshot docs * Update api docs
5502 lines
No EOL
185 KiB
JSON
5502 lines
No EOL
185 KiB
JSON
{
|
|
"id": "fieldFormats",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DateFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "public",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-public.DateFormat",
|
|
"text": "DateFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { pattern: unknown; timezone: unknown; }"
|
|
],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/public/lib/converters/date.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DateNanosFormat",
|
|
"description": [],
|
|
"signature": [
|
|
"DateNanosFormat",
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.memoizedConverter",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "memoizedConverter",
|
|
"description": [],
|
|
"signature": [
|
|
"Function"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.memoizedPattern",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "memoizedPattern",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.timeZone",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "timeZone",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { pattern: unknown; fallbackPattern: unknown; timezone: unknown; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.DateNanosFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/date_nanos_shared.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.FieldFormatsSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatsSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"{ register: (fieldFormats: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]) => void; has: (id: string) => boolean; }"
|
|
],
|
|
"path": "src/plugins/field_formats/public/plugin.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-public.FieldFormatsStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatsStart",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsRegistry",
|
|
"text": "FieldFormatsRegistry"
|
|
},
|
|
", \"init\" | \"register\"> & { deserialize: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FormatFactory",
|
|
"text": "FormatFactory"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/plugins/field_formats/public/plugin.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DateFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "server",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-server.DateFormat",
|
|
"text": "DateFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.Unnamed.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"(",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
},
|
|
") | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.Unnamed.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { pattern: unknown; timezone: unknown; }"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_server.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateNanosFormatServer",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DateNanosFormatServer",
|
|
"description": [],
|
|
"signature": [
|
|
"DateNanosFormat",
|
|
" extends ",
|
|
"DateNanosFormat"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateNanosFormatServer.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.DateNanosFormatServer.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.FieldFormatsSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldFormatsSetup",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.FieldFormatsSetup.register",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "register",
|
|
"description": [
|
|
"\nRegister a server side field formatter"
|
|
],
|
|
"signature": [
|
|
"(fieldFormat: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "src/plugins/field_formats/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.FieldFormatsSetup.register.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "fieldFormat",
|
|
"description": [
|
|
"{@link FieldFormatInstanceType }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.FieldFormatsStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldFormatsStart",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.FieldFormatsStart.fieldFormatServiceFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fieldFormatServiceFactory",
|
|
"description": [
|
|
"\nCreate a field format registry"
|
|
],
|
|
"signature": [
|
|
"(uiSettings: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsRegistry",
|
|
"text": "FieldFormatsRegistry"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/field_formats/server/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-server.FieldFormatsStart.fieldFormatServiceFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "uiSettings",
|
|
"description": [
|
|
"- {@link IUiSettingsClient }"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/server/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BoolFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "BoolFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.BoolFormat",
|
|
"text": "BoolFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/boolean.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BoolFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/boolean.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BoolFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/boolean.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BoolFormat.fieldType",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/boolean.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BoolFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: string | number | boolean) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/boolean.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BoolFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number | boolean"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/boolean.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BytesFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "BytesFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.BytesFormat",
|
|
"text": "BytesFormat"
|
|
},
|
|
" extends ",
|
|
"NumeralFormat"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/bytes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BytesFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/bytes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BytesFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/bytes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BytesFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/bytes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BytesFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/bytes.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.BytesFormat.allowsNumericalAggregations",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowsNumericalAggregations",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/bytes.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ColorFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.ColorFormat",
|
|
"text": "ColorFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.fieldType",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { fieldType: null; colors: { range: string; regex: string; text: string; background: string; }[]; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.findColorRuleForVal",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "findColorRuleForVal",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.findColorRuleForVal.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.htmlConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "htmlConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.ColorFormat.htmlConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/color.tsx",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DurationFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.DurationFormat",
|
|
"text": "DurationFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.inputFormats",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "inputFormats",
|
|
"description": [],
|
|
"signature": [
|
|
"{ text: string; kind: string; }[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.outputFormats",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "outputFormats",
|
|
"description": [],
|
|
"signature": [
|
|
"({ text: string; method: string; shortText?: undefined; } | { text: string; shortText: string; method: string; })[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.allowsNumericalAggregations",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowsNumericalAggregations",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.isHuman",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isHuman",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.isHumanPrecise",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isHumanPrecise",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { inputFormat: string; outputFormat: string; outputPrecision: number; includeSpaceWithSuffix: boolean; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: number) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DurationFormat.textConvert.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/duration.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "FieldFormat",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.id",
|
|
"type": "string",
|
|
"tags": [
|
|
"property",
|
|
"static"
|
|
],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.hidden",
|
|
"type": "boolean",
|
|
"tags": [
|
|
"property",
|
|
"static"
|
|
],
|
|
"label": "hidden",
|
|
"description": [
|
|
"\nHidden field formats can only be accessed directly by id,\nThey won't appear in field format editor UI,\nBut they can be accessed and used from code internally.\n"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.title",
|
|
"type": "string",
|
|
"tags": [
|
|
"property",
|
|
"static"
|
|
],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.fieldType",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"property",
|
|
"private"
|
|
],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"string | string[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.convertObject",
|
|
"type": "Object",
|
|
"tags": [
|
|
"property",
|
|
"private"
|
|
],
|
|
"label": "convertObject",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConvert",
|
|
"text": "FieldFormatConvert"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.htmlConvert",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"protected"
|
|
],
|
|
"label": "htmlConvert",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeConvert",
|
|
"text": "HtmlContextTypeConvert"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [
|
|
"property",
|
|
"protected"
|
|
],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.TextContextTypeConvert",
|
|
"text": "TextContextTypeConvert"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.type",
|
|
"type": "Object",
|
|
"tags": [
|
|
"property",
|
|
"private"
|
|
],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.allowsNumericalAggregations",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "allowsNumericalAggregations",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat._params",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "_params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.Unnamed.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "_params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.Unnamed.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.convert",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "convert",
|
|
"description": [
|
|
"\nConvert a raw value to a formatted string"
|
|
],
|
|
"signature": [
|
|
"(value: unknown, contentType?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsContentType",
|
|
"text": "FieldFormatsContentType"
|
|
},
|
|
", options?: object | ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.convert.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsContentType",
|
|
"text": "FieldFormatsContentType"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.convert.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"object | ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"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": "fieldFormats",
|
|
"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": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsContentType",
|
|
"text": "FieldFormatsContentType"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConvertFunction",
|
|
"text": "FieldFormatConvertFunction"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.getConverterFor.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "contentType",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsContentType",
|
|
"text": "FieldFormatsContentType"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"- a bound converter function"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getParamDefaults",
|
|
"description": [
|
|
"\nGet parameter defaults"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": [
|
|
"- parameter defaults"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.param.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"- the param name to fetch"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"TODO: https://github.com/elastic/kibana/issues/108158"
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.params",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "params",
|
|
"description": [
|
|
"\nGet all of the params in a single object"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: string; params: (",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
},
|
|
") | undefined; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.from",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "from",
|
|
"description": [],
|
|
"signature": [
|
|
"(convertFn: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConvertFunction",
|
|
"text": "FieldFormatConvertFunction"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.from.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "convertFn",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConvertFunction",
|
|
"text": "FieldFormatConvertFunction"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.setupContentType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setupContentType",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConvert",
|
|
"text": "FieldFormatConvert"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.isInstanceOfFieldFormat",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isInstanceOfFieldFormat",
|
|
"description": [],
|
|
"signature": [
|
|
"(fieldFormat: unknown) => fieldFormat is ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormat.isInstanceOfFieldFormat.$1",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "fieldFormat",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_format.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "FieldFormatsRegistry",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.fieldFormats",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldFormats",
|
|
"description": [],
|
|
"signature": [
|
|
"Map<string, ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.defaultMap",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "defaultMap",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.metaParamsOptions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metaParamsOptions",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown> | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.deserialize",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "deserialize",
|
|
"description": [],
|
|
"signature": [
|
|
"(mapping?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
"> | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.deserialize.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mapping",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.init",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "init",
|
|
"description": [],
|
|
"signature": [
|
|
"(getConfig: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown>, metaParamsOptions?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
},
|
|
", defaultFieldConverters?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]) => void"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.init.$1",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.init.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "metaParamsOptions",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.init.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "defaultFieldConverters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultConfig.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [
|
|
"- the field type"
|
|
],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultConfig.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [
|
|
"- Array of ES data types"
|
|
],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getType",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getType",
|
|
"description": [
|
|
"\nGet a derived FieldFormat class by its id.\n"
|
|
],
|
|
"signature": [
|
|
"(formatId: string) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "formatId",
|
|
"description": [
|
|
"- the format id"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTypeWithoutMetaParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(formatId: string) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getTypeWithoutMetaParams.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "formatId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultType.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultType.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [
|
|
"- Array of ES data types"
|
|
],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
"ES_FIELD_TYPES",
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getTypeNameByEsTypes.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [
|
|
"- Array of ES data types"
|
|
],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
"ES_FIELD_TYPES",
|
|
" | ",
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultTypeName.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultTypeName.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getInstance.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "formatId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getInstance.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getDefaultInstancePlain",
|
|
"description": [
|
|
"\nGet the default fieldFormat instance for a field format.\n"
|
|
],
|
|
"signature": [
|
|
"(fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstancePlain.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getByFieldType",
|
|
"type": "Function",
|
|
"tags": [
|
|
"return"
|
|
],
|
|
"label": "getByFieldType",
|
|
"description": [
|
|
"\nGet filtered list of field formats by format type,\nSkips hidden field formats\n"
|
|
],
|
|
"signature": [
|
|
"(fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getByFieldType.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"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: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstance.$1",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstance.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.getDefaultInstance.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "parseDefaultTypeMap",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: Record<string, ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
},
|
|
">) => void"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.parseDefaultTypeMap.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.register",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "register",
|
|
"description": [],
|
|
"signature": [
|
|
"(fieldFormats: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]) => void"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.register.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldFormats",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.has",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "has",
|
|
"description": [
|
|
"\nChecks if field format with id already registered"
|
|
],
|
|
"signature": [
|
|
"(id: string) => boolean"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsRegistry.has.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/field_formats_registry.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "GeoPointFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.GeoPointFormat",
|
|
"text": "GeoPointFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.fieldType",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.transformOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "transformOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kind: string; text: string; }[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { transform: string; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | GeoJSON.Point | { lat: number; lon: number; }) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.GeoPointFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | GeoJSON.Point | { lat: number; lon: number; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/geo_point.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "HistogramFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HistogramFormat",
|
|
"text": "HistogramFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.allowsNumericalAggregations",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowsNumericalAggregations",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { id: string; params: {}; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: number) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HistogramFormat.textConvert.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/histogram.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IpFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "IpFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.IpFormat",
|
|
"text": "IpFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/ip.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IpFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/ip.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IpFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/ip.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IpFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/ip.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IpFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: number) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/ip.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IpFormat.textConvert.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/ip.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.NumberFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "NumberFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.NumberFormat",
|
|
"text": "NumberFormat"
|
|
},
|
|
" extends ",
|
|
"NumeralFormat"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/number.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.NumberFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/number.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.NumberFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/number.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.NumberFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/number.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.NumberFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/number.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.NumberFormat.allowsNumericalAggregations",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowsNumericalAggregations",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/number.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "PercentFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.PercentFormat",
|
|
"text": "PercentFormat"
|
|
},
|
|
" extends ",
|
|
"NumeralFormat"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.allowsNumericalAggregations",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowsNumericalAggregations",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { pattern: unknown; fractional: boolean; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.PercentFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/percent.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.RelativeDateFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "RelativeDateFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.RelativeDateFormat",
|
|
"text": "RelativeDateFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/relative_date.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.RelativeDateFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/relative_date.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.RelativeDateFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/relative_date.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.RelativeDateFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/relative_date.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.RelativeDateFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/relative_date.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.RelativeDateFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/relative_date.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "StaticLookupFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.StaticLookupFormat",
|
|
"text": "StaticLookupFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat.fieldType",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { lookupEntries: {}[]; unknownKeyValue: null; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string) => any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StaticLookupFormat.textConvert.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/static_lookup.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "StringFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.StringFormat",
|
|
"text": "StringFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.fieldType",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.transformOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "transformOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"({ kind: boolean; text: string; } | { kind: string; text: string; })[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { transform: boolean; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string | number) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.textConvert.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string | number"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.htmlConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "htmlConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: any, { hit, field }?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.htmlConvert.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.StringFormat.htmlConvert.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ hit, field }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/string.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TruncateFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "TruncateFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.TruncateFormat",
|
|
"text": "TruncateFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/truncate.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TruncateFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/truncate.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TruncateFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/truncate.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TruncateFormat.fieldType",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/truncate.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TruncateFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(val: string) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/truncate.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TruncateFormat.textConvert.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "val",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/truncate.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "UrlFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.UrlFormat",
|
|
"text": "UrlFormat"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.id",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FIELD_FORMAT_IDS",
|
|
"text": "FIELD_FORMAT_IDS"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.fieldType",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"KBN_FIELD_TYPES",
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.urlTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "urlTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"{ kind: string; text: string; }[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.Unnamed",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "Constructor",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.Unnamed.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" & ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.getParamDefaults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getParamDefaults",
|
|
"description": [],
|
|
"signature": [
|
|
"() => { type: string; urlTemplate: null; labelTemplate: null; width: null; height: null; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.textConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "textConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: string) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.textConvert.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.htmlConvert",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "htmlConvert",
|
|
"description": [],
|
|
"signature": [
|
|
"(rawValue: string, options?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.htmlConvert.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "rawValue",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.UrlFormat.htmlConvert.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/converters/url.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.getHighlightRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getHighlightRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(shouldHighlight: boolean) => { pre_tags: string[]; post_tags: string[]; fields: { '*': {}; }; fragment_size: number; } | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/utils/highlight/highlight_request.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.getHighlightRequest.$1",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "shouldHighlight",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/plugins/field_formats/common/utils/highlight/highlight_request.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldFormatConfig",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConfig.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConfig.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConfig.es",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "es",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldFormatConvert",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert.text",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "text",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: any, options?: object | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert.text.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert.text.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"object | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert.html",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "html",
|
|
"description": [],
|
|
"signature": [
|
|
"(value: any, options?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert.html.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvert.html.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatMetaParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldFormatMetaParams",
|
|
"description": [
|
|
"\nParams provided by the registry to every field formatter\n"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatMetaParams.parsedUrl",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "parsedUrl",
|
|
"description": [],
|
|
"signature": [
|
|
"{ origin: string; pathname?: string | undefined; basePath?: string | undefined; } | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldFormatParams",
|
|
"description": [
|
|
"\nParams provided when creating a formatter.\nParams are vary per formatter\n\nTODO: support strict typing for params depending on format type\nhttps://github.com/elastic/kibana/issues/108158"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatParams.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[param: string]: any",
|
|
"description": [],
|
|
"signature": [
|
|
"[param: string]: any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HtmlContextTypeOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "HtmlContextTypeOptions",
|
|
"description": [
|
|
"\nHtml converter options"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HtmlContextTypeOptions.field",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name: string; } | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HtmlContextTypeOptions.hit",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hit",
|
|
"description": [],
|
|
"signature": [
|
|
"{ highlight: Record<string, string[]>; } | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.SerializedFieldFormat",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SerializedFieldFormat",
|
|
"description": [
|
|
"\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<TParams>"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.SerializedFieldFormat.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.SerializedFieldFormat.params",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"TParams | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FIELD_FORMAT_IDS",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "FIELD_FORMAT_IDS",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.baseFormatters",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "baseFormatters",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/plugins/field_formats/common/constants/base_formatters.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvertFunction",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatConvertFunction",
|
|
"description": [
|
|
"\nConverter function"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeConvert",
|
|
"text": "HtmlContextTypeConvert"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.TextContextTypeConvert",
|
|
"text": "TextContextTypeConvert"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvertFunction.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatConvertFunction.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatId",
|
|
"type": "Type",
|
|
"tags": [
|
|
"string"
|
|
],
|
|
"label": "FieldFormatId",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatInstanceType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatInstanceType",
|
|
"description": [
|
|
"\nAlternative to typeof {@link FieldFormat} but with specified ids"
|
|
],
|
|
"signature": [
|
|
"(new (params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
" | undefined, getConfig?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown> | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
") & { id: string; title: string; hidden?: boolean | undefined; fieldType: string | string[]; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsContentType",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatsContentType",
|
|
"description": [],
|
|
"signature": [
|
|
"\"text\" | \"html\""
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsGetConfigFn",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatsGetConfigFn",
|
|
"description": [
|
|
"\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible.\n"
|
|
],
|
|
"signature": [
|
|
"(key: string, defaultOverride?: T | undefined) => T"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsGetConfigFn.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsGetConfigFn.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "defaultOverride",
|
|
"description": [],
|
|
"signature": [
|
|
"T | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FieldFormatsStartCommon",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldFormatsStartCommon",
|
|
"description": [],
|
|
"signature": [
|
|
"{ deserialize: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FormatFactory",
|
|
"text": "FormatFactory"
|
|
},
|
|
"; getDefaultConfig: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
},
|
|
"; getType: (formatId: string) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined; getTypeWithoutMetaParams: (formatId: string) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined; getDefaultType: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined; getTypeNameByEsTypes: (esTypes: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
"ES_FIELD_TYPES",
|
|
" | undefined; getDefaultTypeName: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
"ES_FIELD_TYPES",
|
|
" | ",
|
|
"KBN_FIELD_TYPES",
|
|
"; getInstance: (formatId: string, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
"; getDefaultInstancePlain: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
"; getDefaultInstanceCacheResolver: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => string; getByFieldType: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]; getDefaultInstance: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
"; parseDefaultTypeMap: (value: Record<string, ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
},
|
|
">) => void; has: (id: string) => boolean; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FormatFactory",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FormatFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"(mapping?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
"> | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FormatFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "mapping",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.SerializedFieldFormat",
|
|
"text": "SerializedFieldFormat"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HTML_CONTEXT_TYPE",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "HTML_CONTEXT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"text\" | \"html\""
|
|
],
|
|
"path": "src/plugins/field_formats/common/content_types/html_content_type.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HtmlContextTypeConvert",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "HtmlContextTypeConvert",
|
|
"description": [
|
|
"\nTo html converter function"
|
|
],
|
|
"signature": [
|
|
"(value: any, options?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HtmlContextTypeConvert.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.HtmlContextTypeConvert.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.HtmlContextTypeOptions",
|
|
"text": "HtmlContextTypeOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IFieldFormat",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IFieldFormat",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
}
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.IFieldFormatsRegistry",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IFieldFormatsRegistry",
|
|
"description": [],
|
|
"signature": [
|
|
"{ init: (getConfig: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatsGetConfigFn",
|
|
"text": "FieldFormatsGetConfigFn"
|
|
},
|
|
"<unknown>, metaParamsOptions?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatMetaParams",
|
|
"text": "FieldFormatMetaParams"
|
|
},
|
|
", defaultFieldConverters?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]) => void; register: (fieldFormats: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]) => void; deserialize: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FormatFactory",
|
|
"text": "FormatFactory"
|
|
},
|
|
"; getDefaultConfig: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
},
|
|
"; getType: (formatId: string) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined; getTypeWithoutMetaParams: (formatId: string) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined; getDefaultType: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
" | undefined; getTypeNameByEsTypes: (esTypes: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
"ES_FIELD_TYPES",
|
|
" | undefined; getDefaultTypeName: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => ",
|
|
"ES_FIELD_TYPES",
|
|
" | ",
|
|
"KBN_FIELD_TYPES",
|
|
"; getInstance: (formatId: string, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
"; getDefaultInstancePlain: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
"; getDefaultInstanceCacheResolver: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined) => string; getByFieldType: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatInstanceType",
|
|
"text": "FieldFormatInstanceType"
|
|
},
|
|
"[]; getDefaultInstance: (fieldType: ",
|
|
"KBN_FIELD_TYPES",
|
|
", esTypes?: ",
|
|
"ES_FIELD_TYPES",
|
|
"[] | undefined, params?: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatParams",
|
|
"text": "FieldFormatParams"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormat",
|
|
"text": "FieldFormat"
|
|
},
|
|
"; parseDefaultTypeMap: (value: Record<string, ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "common",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-common.FieldFormatConfig",
|
|
"text": "FieldFormatConfig"
|
|
},
|
|
">) => void; has: (id: string) => boolean; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/index.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TEXT_CONTEXT_TYPE",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "TEXT_CONTEXT_TYPE",
|
|
"description": [],
|
|
"signature": [
|
|
"\"text\" | \"html\""
|
|
],
|
|
"path": "src/plugins/field_formats/common/content_types/text_content_type.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TextContextTypeConvert",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TextContextTypeConvert",
|
|
"description": [
|
|
"\nTo plain text converter function"
|
|
],
|
|
"signature": [
|
|
"(value: any, options?: object | undefined) => string"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TextContextTypeConvert.$1",
|
|
"type": "Any",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TextContextTypeConvert.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"object | undefined"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.TextContextTypeOptions",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "TextContextTypeOptions",
|
|
"description": [
|
|
"\nPlain text converter options"
|
|
],
|
|
"signature": [
|
|
"object"
|
|
],
|
|
"path": "src/plugins/field_formats/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DEFAULT_CONVERTER_COLOR",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DEFAULT_CONVERTER_COLOR",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/constants/color_default.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DEFAULT_CONVERTER_COLOR.range",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "range",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/constants/color_default.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DEFAULT_CONVERTER_COLOR.regex",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "regex",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/constants/color_default.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DEFAULT_CONVERTER_COLOR.text",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "text",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/constants/color_default.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.DEFAULT_CONVERTER_COLOR.background",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "background",
|
|
"description": [],
|
|
"path": "src/plugins/field_formats/common/constants/color_default.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "fieldFormats",
|
|
"id": "def-common.FORMATS_UI_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "FORMATS_UI_SETTINGS",
|
|
"description": [],
|
|
"signature": [
|
|
"{ readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; }"
|
|
],
|
|
"path": "src/plugins/field_formats/common/constants/ui_settings.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |