mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
916 lines
No EOL
30 KiB
JSON
916 lines
No EOL
30 KiB
JSON
{
|
|
"id": "@kbn/field-utils",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.comboBoxFieldOptionMatcher",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "comboBoxFieldOptionMatcher",
|
|
"description": [
|
|
"\nAdapts fieldNameWildcardMatcher to combobox props."
|
|
],
|
|
"signature": [
|
|
"({ option: { name, label }, searchValue, }: { option: { name?: string | undefined; label: string; }; searchValue: string; }) => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.comboBoxFieldOptionMatcher.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n option: { name, label },\n searchValue,\n}",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.comboBoxFieldOptionMatcher.$1.option",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "option",
|
|
"description": [],
|
|
"signature": [
|
|
"{ name?: string | undefined; label: string; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.comboBoxFieldOptionMatcher.$1.searchValue",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchValue",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "FieldDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"({ fieldsMetadataService, ...props }: ",
|
|
{
|
|
"pluginId": "@kbn/field-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnFieldUtilsPluginApi",
|
|
"section": "def-common.FieldDescriptionProps",
|
|
"text": "FieldDescriptionProps"
|
|
},
|
|
") => React.JSX.Element"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_description/field_description.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldDescription.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n fieldsMetadataService,\n ...props\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/field-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnFieldUtilsPluginApi",
|
|
"section": "def-common.FieldDescriptionProps",
|
|
"text": "FieldDescriptionProps"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_description/field_description.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldIcon",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "FieldIcon",
|
|
"description": [],
|
|
"signature": [
|
|
"<T extends ",
|
|
{
|
|
"pluginId": "@kbn/field-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnFieldUtilsPluginApi",
|
|
"section": "def-common.FieldBase",
|
|
"text": "FieldBase"
|
|
},
|
|
" = ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewField",
|
|
"text": "DataViewField"
|
|
},
|
|
">(props: ",
|
|
{
|
|
"pluginId": "@kbn/react-field",
|
|
"scope": "common",
|
|
"docId": "kibKbnReactFieldPluginApi",
|
|
"section": "def-common.FieldIconProps",
|
|
"text": "FieldIconProps"
|
|
},
|
|
") => React.JSX.Element"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_icon/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldIcon.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/react-field",
|
|
"scope": "common",
|
|
"docId": "kibKbnReactFieldPluginApi",
|
|
"section": "def-common.FieldIconProps",
|
|
"text": "FieldIconProps"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_icon/index.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldNameWildcardMatcher",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fieldNameWildcardMatcher",
|
|
"description": [
|
|
"\nChecks if field displayName or name matches the provided search string.\nThe search string can have wildcard."
|
|
],
|
|
"signature": [
|
|
"(field: { name: string; displayName?: string | undefined; }, fieldSearchHighlight: string) => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldNameWildcardMatcher.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldNameWildcardMatcher.$1.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldNameWildcardMatcher.$1.displayName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "displayName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldNameWildcardMatcher.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fieldSearchHighlight",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldSupportsBreakdown",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fieldSupportsBreakdown",
|
|
"description": [],
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewField",
|
|
"text": "DataViewField"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_supports_breakdown.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.fieldSupportsBreakdown.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataViewField",
|
|
"text": "DataViewField"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_supports_breakdown.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldIconProps",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldIconProps",
|
|
"description": [],
|
|
"signature": [
|
|
"(field: T) => ",
|
|
{
|
|
"pluginId": "@kbn/react-field",
|
|
"scope": "common",
|
|
"docId": "kibKbnReactFieldPluginApi",
|
|
"section": "def-common.FieldIconProps",
|
|
"text": "FieldIconProps"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_icon/get_field_icon_props.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldIconProps.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_icon/get_field_icon_props.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldIconType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldIconType",
|
|
"description": [
|
|
"\nReturns an icon type for a field"
|
|
],
|
|
"signature": [
|
|
"(field: T, getCustomFieldType: ",
|
|
"GetCustomFieldType",
|
|
"<T> | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_icon_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldIconType.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_icon_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldIconType.$2",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCustomFieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"GetCustomFieldType",
|
|
"<T> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_icon_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldSearchMatchingHighlight",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldSearchMatchingHighlight",
|
|
"description": [
|
|
"\nGet `highlight` string to be used together with `EuiHighlight`"
|
|
],
|
|
"signature": [
|
|
"(displayName: string, fieldSearchHighlight: string | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldSearchMatchingHighlight.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "displayName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldSearchMatchingHighlight.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fieldSearchHighlight",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_name_wildcard_matcher.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldType",
|
|
"description": [
|
|
"\nReturns a field type. Time series metric type will override the original field type."
|
|
],
|
|
"signature": [
|
|
"(field: T) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldType.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldTypeDescription",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldTypeDescription",
|
|
"description": [
|
|
"\nReturns a user-friendly description of a field type"
|
|
],
|
|
"signature": [
|
|
"(type: string | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type_description.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldTypeDescription.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type_description.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldTypeName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getFieldTypeName",
|
|
"description": [
|
|
"\nReturns a user-friendly name of a field type"
|
|
],
|
|
"signature": [
|
|
"(type: string | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getFieldTypeName.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getTextBasedColumnIconType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTextBasedColumnIconType",
|
|
"description": [],
|
|
"signature": [
|
|
"(columnMeta: { type: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumnType",
|
|
"text": "DatatableColumnType"
|
|
},
|
|
"; esType?: string | undefined; } | null | undefined) => string | null"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_text_based_column_icon_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.getTextBasedColumnIconType.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "columnMeta",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumnType",
|
|
"text": "DatatableColumnType"
|
|
},
|
|
"; esType?: string | undefined; } | null | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_text_based_column_icon_type.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.isKnownFieldType",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isKnownFieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"(type?: string | undefined) => type is string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.isKnownFieldType.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldBase",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.displayName",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "displayName",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.customDescription",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "customDescription",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.count",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "count",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.timeSeriesMetric",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "timeSeriesMetric",
|
|
"description": [],
|
|
"signature": [
|
|
"MappingTimeSeriesMetricType",
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.esTypes",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esTypes",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.scripted",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "scripted",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.isNull",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isNull",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldBase.conflictDescriptions",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "conflictDescriptions",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, string[]> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldDescriptionProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "FieldDescriptionProps",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/field-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnFieldUtilsPluginApi",
|
|
"section": "def-common.FieldDescriptionProps",
|
|
"text": "FieldDescriptionProps"
|
|
},
|
|
" extends ",
|
|
"FieldDescriptionContentProps"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_description/field_description.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldDescriptionProps.fieldsMetadataService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "fieldsMetadataService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "fieldsMetadata",
|
|
"scope": "public",
|
|
"docId": "kibFieldsMetadataPluginApi",
|
|
"section": "def-public.FieldsMetadataPublicStart",
|
|
"text": "FieldsMetadataPublicStart"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_description/field_description.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.KNOWN_FIELD_TYPES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "KNOWN_FIELD_TYPES",
|
|
"description": [
|
|
"\nField types for which name and description are defined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldIconProps",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldIconProps",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/components/field_icon/field_icon.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.FieldTypeKnown",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "FieldTypeKnown",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.KNOWN_FIELD_TYPE_LIST",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "KNOWN_FIELD_TYPE_LIST",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/field_types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/field-utils",
|
|
"id": "def-common.UNKNOWN_FIELD_TYPE_MESSAGE",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "UNKNOWN_FIELD_TYPE_MESSAGE",
|
|
"description": [
|
|
"\nA user-friendly name of an unknown field type"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-field-utils/src/utils/get_field_type_name.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |