github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_unified_field_list.devdocs.json

5768 lines
No EOL
205 KiB
JSON
Raw Blame History

{
"id": "@kbn/unified-field-list",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldIcon",
"type": "Function",
"tags": [],
"label": "FieldIcon",
"description": [],
"signature": [
"<T extends ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListItem",
"text": "FieldListItem"
},
" = ",
{
"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"
},
") => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_icon/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"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": "packages/kbn-unified-field-list/src/components/field_icon/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButton",
"type": "Function",
"tags": [
"constructor"
],
"label": "FieldItemButton",
"description": [
"\nField list item component"
],
"signature": [
"({\n field,\n fieldSearchHighlight,\n isSelected,\n isActive,\n isEmpty,\n infoIcon,\n className,\n getCustomFieldType,\n dataTestSubj,\n size,\n onClick,\n shouldAlwaysShowAction,\n buttonAddFieldToWorkspaceProps,\n buttonRemoveFieldFromWorkspaceProps,\n onAddFieldToWorkspace,\n onRemoveFieldFromWorkspace,\n ...otherProps\n}: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldItemButtonProps",
"text": "FieldItemButtonProps"
},
"<T>) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButton.$1",
"type": "Object",
"tags": [],
"label": "{\n field,\n fieldSearchHighlight,\n isSelected,\n isActive,\n isEmpty,\n infoIcon,\n className,\n getCustomFieldType,\n dataTestSubj,\n size,\n onClick,\n shouldAlwaysShowAction,\n buttonAddFieldToWorkspaceProps,\n buttonRemoveFieldFromWorkspaceProps,\n onAddFieldToWorkspace,\n onRemoveFieldFromWorkspace,\n ...otherProps\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldItemButtonProps",
"text": "FieldItemButtonProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldList",
"type": "Function",
"tags": [
"constructor"
],
"label": "FieldList",
"description": [
"\nA top level wrapper for field list components (filters and field list groups)"
],
"signature": [
"({ \"data-test-subj\": dataTestSubject, isProcessing, prepend, append, className, children, }: React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListProps",
"text": "FieldListProps"
},
">) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldList.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n 'data-test-subj': dataTestSubject = 'fieldList',\n isProcessing,\n prepend,\n append,\n className,\n children,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListProps",
"text": "FieldListProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFilters",
"type": "Function",
"tags": [],
"label": "FieldListFilters",
"description": [],
"signature": [
"<T extends ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListItem",
"text": "FieldListItem"
},
" = ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
">(props: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListFiltersProps",
"text": "FieldListFiltersProps"
},
"<T>) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFilters.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListFiltersProps",
"text": "FieldListFiltersProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGrouped",
"type": "Function",
"tags": [],
"label": "FieldListGrouped",
"description": [],
"signature": [
"<T extends ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListItem",
"text": "FieldListItem"
},
" = ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
">(props: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListGroupedProps",
"text": "FieldListGroupedProps"
},
"<T>) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGrouped.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListGroupedProps",
"text": "FieldListGroupedProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/index.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopover",
"type": "Function",
"tags": [],
"label": "FieldPopover",
"description": [],
"signature": [
"({ isOpen, closePopover, renderHeader, renderContent, ...otherPopoverProps }: React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverProps",
"text": "FieldPopoverProps"
},
">) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopover.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n isOpen,\n closePopover,\n renderHeader,\n renderContent,\n ...otherPopoverProps\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverProps",
"text": "FieldPopoverProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverFooter",
"type": "Function",
"tags": [],
"label": "FieldPopoverFooter",
"description": [],
"signature": [
"(props: React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverFooterProps",
"text": "FieldPopoverFooterProps"
},
">) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_footer.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverFooter.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverFooterProps",
"text": "FieldPopoverFooterProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_footer.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeader",
"type": "Function",
"tags": [],
"label": "FieldPopoverHeader",
"description": [],
"signature": [
"({ field, closePopover, buttonAddFieldToWorkspaceProps, buttonAddFilterProps, buttonEditFieldProps, buttonDeleteFieldProps, onAddFieldToWorkspace, onAddFilter, onEditField, onDeleteField, }: React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverHeaderProps",
"text": "FieldPopoverHeaderProps"
},
">) => JSX.Element | null"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeader.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n field,\n closePopover,\n buttonAddFieldToWorkspaceProps,\n buttonAddFilterProps,\n buttonEditFieldProps,\n buttonDeleteFieldProps,\n onAddFieldToWorkspace,\n onAddFilter,\n onEditField,\n onDeleteField,\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverHeaderProps",
"text": "FieldPopoverHeaderProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStats",
"type": "Function",
"tags": [],
"label": "FieldStats",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldStatsProps",
"text": "FieldStatsProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStats.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStats.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucket",
"type": "Function",
"tags": [],
"label": "FieldTopValuesBucket",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldTopValuesBucketProps",
"text": "FieldTopValuesBucketProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucket.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucket.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButton",
"type": "Function",
"tags": [],
"label": "FieldVisualizeButton",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldVisualizeButtonProps",
"text": "FieldVisualizeButtonProps"
},
">"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButton.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButton.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"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": "packages/kbn-unified-field-list/src/components/field_icon/get_field_icon_props.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getFieldIconProps.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/components/field_icon/get_field_icon_props.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getFieldIconType",
"type": "Function",
"tags": [],
"label": "getFieldIconType",
"description": [
"\nReturns an icon type for a field"
],
"signature": [
"(field: T, getCustomFieldType: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GetCustomFieldType",
"text": "GetCustomFieldType"
},
"<T> | undefined) => string"
],
"path": "packages/kbn-unified-field-list/src/utils/field_types/get_field_icon_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getFieldIconType.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/utils/field_types/get_field_icon_type.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getFieldIconType.$2",
"type": "Function",
"tags": [],
"label": "getCustomFieldType",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GetCustomFieldType",
"text": "GetCustomFieldType"
},
"<T> | undefined"
],
"path": "packages/kbn-unified-field-list/src/utils/field_types/get_field_icon_type.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"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": "packages/kbn-unified-field-list/src/utils/field_types/get_field_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getFieldType.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/utils/field_types/get_field_type.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"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": "packages/kbn-unified-field-list/src/utils/field_types/get_field_type_description.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getFieldTypeDescription.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/utils/field_types/get_field_type_description.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getSearchMode",
"type": "Function",
"tags": [],
"label": "getSearchMode",
"description": [
"\nDetermines current search mode"
],
"signature": [
"(query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined) => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.SearchMode",
"text": "SearchMode"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getSearchMode.$1",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getVisualizeInformation",
"type": "Function",
"tags": [],
"label": "getVisualizeInformation",
"description": [
"\nReturns the field name and potentially href of the field or the first multi-field\nthat has a compatible visualize uiAction."
],
"signature": [
"(uiActions: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
", field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
", dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined, contextualFields: string[], multiFields: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
"[]) => Promise<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.VisualizeInformation",
"text": "VisualizeInformation"
},
" | undefined>"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getVisualizeInformation.$1",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getVisualizeInformation.$2",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getVisualizeInformation.$3",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getVisualizeInformation.$4",
"type": "Array",
"tags": [],
"label": "contextualFields",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.getVisualizeInformation.$5",
"type": "Array",
"tags": [],
"label": "multiFields",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
"[]"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.hasQuerySubscriberData",
"type": "Function",
"tags": [],
"label": "hasQuerySubscriberData",
"description": [
"\nChecks if query result is ready to be used"
],
"signature": [
"(result: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.QuerySubscriberResult",
"text": "QuerySubscriberResult"
},
") => result is { query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
"; filters: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; fromDate: string; toDate: string; searchMode: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.SearchMode",
"text": "SearchMode"
},
"; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.hasQuerySubscriberData.$1",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.QuerySubscriberResult",
"text": "QuerySubscriberResult"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.loadFieldExisting",
"type": "Function",
"tags": [],
"label": "loadFieldExisting",
"description": [],
"signature": [
"(params: FetchFieldExistenceParams) => Promise<{ existingFieldNames: string[]; indexPatternTitle: string; }>"
],
"path": "packages/kbn-unified-field-list/src/services/field_existing/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.loadFieldExisting.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"FetchFieldExistenceParams"
],
"path": "packages/kbn-unified-field-list/src/services/field_existing/index.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.loadFieldStats",
"type": "Function",
"tags": [],
"label": "loadFieldStats",
"description": [],
"signature": [
"(params: FetchFieldStatsParams) => Promise<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldStatsResponse",
"text": "FieldStatsResponse"
},
"<string | number>>"
],
"path": "packages/kbn-unified-field-list/src/services/field_stats/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.loadFieldStats.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"FetchFieldStatsParams"
],
"path": "packages/kbn-unified-field-list/src/services/field_stats/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.resetExistingFieldsCache",
"type": "Function",
"tags": [],
"label": "resetExistingFieldsCache",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActions",
"type": "Function",
"tags": [],
"label": "triggerVisualizeActions",
"description": [],
"signature": [
"(uiActions: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
", field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
", contextualFields: string[], originatingApp: string, dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined) => void"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActions.$1",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActions.$2",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActions.$3",
"type": "Array",
"tags": [],
"label": "contextualFields",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActions.$4",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActions.$5",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActionsTextBasedLanguages",
"type": "Function",
"tags": [],
"label": "triggerVisualizeActionsTextBasedLanguages",
"description": [],
"signature": [
"(uiActions: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
", contextualFields: string[], originatingApp: string, dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined, query: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined) => void"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActionsTextBasedLanguages.$1",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActionsTextBasedLanguages.$2",
"type": "Array",
"tags": [],
"label": "contextualFields",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActionsTextBasedLanguages.$3",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActionsTextBasedLanguages.$4",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.triggerVisualizeActionsTextBasedLanguages.$5",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainer",
"type": "Function",
"tags": [],
"label": "UnifiedFieldListSidebarContainer",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<Omit<",
"UnifiedFieldListSidebarCustomizableProps",
", \"services\"> & { services: Omit<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldStatsServices",
"text": "FieldStatsServices"
},
", \"uiSettings\"> & { core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
"; } & { uiActions?: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
" | undefined; } & { dataViewFieldEditor?: ",
{
"pluginId": "dataViewFieldEditor",
"scope": "public",
"docId": "kibDataViewFieldEditorPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
" | undefined; }; getCreationOptions: () => ",
"UnifiedFieldListSidebarContainerCreationOptions",
"; prependInFlyout?: (() => React.ReactNode) | undefined; variant?: \"responsive\" | \"button-and-flyout-always\" | \"list-always\" | undefined; onSelectedFieldFilter?: ((field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
") => boolean) | undefined; onFieldEdited?: ((options?: { removedFieldName?: string | undefined; editedFieldName?: string | undefined; } | undefined) => Promise<void>) | undefined; } & React.RefAttributes<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.UnifiedFieldListSidebarContainerApi",
"text": "UnifiedFieldListSidebarContainerApi"
},
">>"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainer.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useExistingFieldsFetcher",
"type": "Function",
"tags": [],
"label": "useExistingFieldsFetcher",
"description": [
"\nFetches info whether a field contains data or it's empty.\nCan be used in combination with `useQuerySubscriber` hook for gathering the required params."
],
"signature": [
"(params: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistingFieldsFetcherParams",
"text": "ExistingFieldsFetcherParams"
},
") => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistingFieldsFetcher",
"text": "ExistingFieldsFetcher"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useExistingFieldsFetcher.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistingFieldsFetcherParams",
"text": "ExistingFieldsFetcherParams"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useExistingFieldsReader",
"type": "Function",
"tags": [],
"label": "useExistingFieldsReader",
"description": [],
"signature": [
"() => { hasFieldData: (dataViewId: string, fieldName: string) => boolean; getFieldsExistenceStatus: (dataViewId: string) => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistenceFetchStatus",
"text": "ExistenceFetchStatus"
},
"; isFieldsExistenceInfoUnavailable: (dataViewId: string) => boolean; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useFieldFilters",
"type": "Function",
"tags": [],
"label": "useFieldFilters",
"description": [
"\nA hook for managing field search and filters state"
],
"signature": [
"({\n allFields,\n getCustomFieldType,\n onSupportedFieldFilter,\n services,\n}: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldFiltersParams",
"text": "FieldFiltersParams"
},
"<T>) => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldFiltersResult",
"text": "FieldFiltersResult"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useFieldFilters.$1",
"type": "Object",
"tags": [],
"label": "{\n allFields,\n getCustomFieldType,\n onSupportedFieldFilter,\n services,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldFiltersParams",
"text": "FieldFiltersParams"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useGroupedFields",
"type": "Function",
"tags": [],
"label": "useGroupedFields",
"description": [],
"signature": [
"({\n dataViewId,\n allFields,\n services,\n isAffectedByGlobalFilter = false,\n popularFieldsLimit,\n sortedSelectedFields,\n getCustomFieldType,\n onOverrideFieldGroupDetails,\n onSupportedFieldFilter,\n onSelectedFieldFilter,\n}: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GroupedFieldsParams",
"text": "GroupedFieldsParams"
},
"<T>) => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GroupedFieldsResult",
"text": "GroupedFieldsResult"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useGroupedFields.$1",
"type": "Object",
"tags": [],
"label": "{\n dataViewId,\n allFields,\n services,\n isAffectedByGlobalFilter = false,\n popularFieldsLimit,\n sortedSelectedFields,\n getCustomFieldType,\n onOverrideFieldGroupDetails,\n onSupportedFieldFilter,\n onSelectedFieldFilter,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GroupedFieldsParams",
"text": "GroupedFieldsParams"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useQuerySubscriber",
"type": "Function",
"tags": [],
"label": "useQuerySubscriber",
"description": [
"\nMemorizes current query, filters and absolute date range"
],
"signature": [
"({ data, timeRangeUpdatesType, }: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.QuerySubscriberParams",
"text": "QuerySubscriberParams"
},
") => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.QuerySubscriberResult",
"text": "QuerySubscriberResult"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.useQuerySubscriber.$1",
"type": "Object",
"tags": [],
"label": "{\n data,\n timeRangeUpdatesType = 'search-session',\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.QuerySubscriberParams",
"text": "QuerySubscriberParams"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.BucketedAggregation",
"type": "Interface",
"tags": [],
"label": "BucketedAggregation",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType>"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.BucketedAggregation.buckets",
"type": "Array",
"tags": [],
"label": "buckets",
"description": [],
"signature": [
"{ key: KeyType; count: number; }[]"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcher",
"type": "Interface",
"tags": [],
"label": "ExistingFieldsFetcher",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcher.refetchFieldsExistenceInfo",
"type": "Function",
"tags": [],
"label": "refetchFieldsExistenceInfo",
"description": [],
"signature": [
"(dataViewId?: string | undefined) => Promise<void>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcher.refetchFieldsExistenceInfo.$1",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcher.isProcessing",
"type": "boolean",
"tags": [],
"label": "isProcessing",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams",
"type": "Interface",
"tags": [],
"label": "ExistingFieldsFetcherParams",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.disableAutoFetching",
"type": "CompoundType",
"tags": [],
"label": "disableAutoFetching",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.dataViews",
"type": "Array",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"[]"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.fromDate",
"type": "string",
"tags": [],
"label": "fromDate",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.toDate",
"type": "string",
"tags": [],
"label": "toDate",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.services",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"{ core: Pick<",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", \"analytics\" | \"uiSettings\">; data: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
},
"; dataViews: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewsContract",
"text": "DataViewsContract"
},
"; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.onNoData",
"type": "Function",
"tags": [],
"label": "onNoData",
"description": [],
"signature": [
"((dataViewId: string) => unknown) | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsFetcherParams.onNoData.$1",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsInfo",
"type": "Interface",
"tags": [],
"label": "ExistingFieldsInfo",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsInfo.fetchStatus",
"type": "Enum",
"tags": [],
"label": "fetchStatus",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistenceFetchStatus",
"text": "ExistenceFetchStatus"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsInfo.existingFieldsByFieldNameMap",
"type": "Object",
"tags": [],
"label": "existingFieldsByFieldNameMap",
"description": [],
"signature": [
"{ [x: string]: boolean; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsInfo.numberOfFetches",
"type": "number",
"tags": [],
"label": "numberOfFetches",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsInfo.hasDataViewRestrictions",
"type": "CompoundType",
"tags": [],
"label": "hasDataViewRestrictions",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader",
"type": "Interface",
"tags": [],
"label": "ExistingFieldsReader",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.hasFieldData",
"type": "Function",
"tags": [],
"label": "hasFieldData",
"description": [],
"signature": [
"(dataViewId: string, fieldName: string) => boolean"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.hasFieldData.$1",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.hasFieldData.$2",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.getFieldsExistenceStatus",
"type": "Function",
"tags": [],
"label": "getFieldsExistenceStatus",
"description": [],
"signature": [
"(dataViewId: string) => ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistenceFetchStatus",
"text": "ExistenceFetchStatus"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.getFieldsExistenceStatus.$1",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.isFieldsExistenceInfoUnavailable",
"type": "Function",
"tags": [],
"label": "isFieldsExistenceInfoUnavailable",
"description": [],
"signature": [
"(dataViewId: string) => boolean"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistingFieldsReader.isFieldsExistenceInfoUnavailable.$1",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersParams",
"type": "Interface",
"tags": [],
"label": "FieldFiltersParams",
"description": [
"\nInput params for useFieldFilters hook"
],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldFiltersParams",
"text": "FieldFiltersParams"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersParams.allFields",
"type": "CompoundType",
"tags": [],
"label": "allFields",
"description": [],
"signature": [
"T[] | null"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersParams.getCustomFieldType",
"type": "Function",
"tags": [],
"label": "getCustomFieldType",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GetCustomFieldType",
"text": "GetCustomFieldType"
},
"<T> | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersParams.onSupportedFieldFilter",
"type": "Function",
"tags": [],
"label": "onSupportedFieldFilter",
"description": [],
"signature": [
"((field: T) => boolean) | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersParams.onSupportedFieldFilter.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersParams.services",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"{ core: Pick<",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", \"docLinks\">; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersResult",
"type": "Interface",
"tags": [],
"label": "FieldFiltersResult",
"description": [
"\nOutput of useFieldFilters hook"
],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldFiltersResult",
"text": "FieldFiltersResult"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersResult.fieldSearchHighlight",
"type": "string",
"tags": [],
"label": "fieldSearchHighlight",
"description": [],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersResult.fieldListFiltersProps",
"type": "Object",
"tags": [],
"label": "fieldListFiltersProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListFiltersProps",
"text": "FieldListFiltersProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersResult.onFilterField",
"type": "Function",
"tags": [],
"label": "onFilterField",
"description": [],
"signature": [
"((field: T) => boolean) | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldFiltersResult.onFilterField.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_field_filters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps",
"type": "Interface",
"tags": [],
"label": "FieldItemButtonProps",
"description": [
"\nProps of FieldItemButton component"
],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldItemButtonProps",
"text": "FieldItemButtonProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.field",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.fieldSearchHighlight",
"type": "string",
"tags": [],
"label": "fieldSearchHighlight",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.isSelected",
"type": "boolean",
"tags": [],
"label": "isSelected",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.isActive",
"type": "CompoundType",
"tags": [],
"label": "isActive",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.isEmpty",
"type": "boolean",
"tags": [],
"label": "isEmpty",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.infoIcon",
"type": "CompoundType",
"tags": [],
"label": "infoIcon",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.flush",
"type": "string",
"tags": [],
"label": "flush",
"description": [],
"signature": [
"\"both\" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.dragHandle",
"type": "Object",
"tags": [],
"label": "dragHandle",
"description": [],
"signature": [
"React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.getCustomFieldType",
"type": "Function",
"tags": [],
"label": "getCustomFieldType",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GetCustomFieldType",
"text": "GetCustomFieldType"
},
"<T> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.size",
"type": "CompoundType",
"tags": [],
"label": "size",
"description": [],
"signature": [
"\"s\" | \"xs\" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.onClick",
"type": "Function",
"tags": [],
"label": "onClick",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.shouldAlwaysShowAction",
"type": "CompoundType",
"tags": [],
"label": "shouldAlwaysShowAction",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.buttonAddFieldToWorkspaceProps",
"type": "Object",
"tags": [],
"label": "buttonAddFieldToWorkspaceProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonIconProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.buttonRemoveFieldFromWorkspaceProps",
"type": "Object",
"tags": [],
"label": "buttonRemoveFieldFromWorkspaceProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonIconProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.onAddFieldToWorkspace",
"type": "Function",
"tags": [],
"label": "onAddFieldToWorkspace",
"description": [],
"signature": [
"((field: T) => unknown) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.onAddFieldToWorkspace.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.onRemoveFieldFromWorkspace",
"type": "Function",
"tags": [],
"label": "onRemoveFieldFromWorkspace",
"description": [],
"signature": [
"((field: T) => unknown) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldItemButtonProps.onRemoveFieldFromWorkspace.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/components/field_item_button/field_item_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps",
"type": "Interface",
"tags": [],
"label": "FieldListFiltersProps",
"description": [
"\nProps for FieldListFilters component"
],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListFiltersProps",
"text": "FieldListFiltersProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.docLinks",
"type": "Object",
"tags": [],
"label": "docLinks",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-doc-links-browser",
"scope": "common",
"docId": "kibKbnCoreDocLinksBrowserPluginApi",
"section": "def-common.DocLinksStart",
"text": "DocLinksStart"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.selectedFieldTypes",
"type": "Array",
"tags": [],
"label": "selectedFieldTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.allFields",
"type": "CompoundType",
"tags": [],
"label": "allFields",
"description": [],
"signature": [
"T[] | null | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.getCustomFieldType",
"type": "Function",
"tags": [],
"label": "getCustomFieldType",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GetCustomFieldType",
"text": "GetCustomFieldType"
},
"<T> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.onSupportedFieldFilter",
"type": "Function",
"tags": [],
"label": "onSupportedFieldFilter",
"description": [],
"signature": [
"((field: T) => boolean) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.onChangeFieldTypes",
"type": "Function",
"tags": [],
"label": "onChangeFieldTypes",
"description": [],
"signature": [
"(fieldTypes: string[]) => unknown"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.onChangeFieldTypes.$1",
"type": "Array",
"tags": [],
"label": "fieldTypes",
"description": [],
"signature": [
"string[]"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_type_filter.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.compressed",
"type": "CompoundType",
"tags": [],
"label": "compressed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.nameFilter",
"type": "string",
"tags": [],
"label": "nameFilter",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.screenReaderDescriptionId",
"type": "string",
"tags": [],
"label": "screenReaderDescriptionId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.onChangeNameFilter",
"type": "Function",
"tags": [],
"label": "onChangeNameFilter",
"description": [],
"signature": [
"(nameFilter: string) => unknown"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_list_filters.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListFiltersProps.onChangeNameFilter.$1",
"type": "string",
"tags": [],
"label": "nameFilter",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_list_filters/field_name_search.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps",
"type": "Interface",
"tags": [],
"label": "FieldListGroupedProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListGroupedProps",
"text": "FieldListGroupedProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.fieldGroups",
"type": "Object",
"tags": [],
"label": "fieldGroups",
"description": [],
"signature": [
"{ SpecialFields?: ",
"FieldsGroup",
"<T> | undefined; SelectedFields?: ",
"FieldsGroup",
"<T> | undefined; PopularFields?: ",
"FieldsGroup",
"<T> | undefined; AvailableFields?: ",
"FieldsGroup",
"<T> | undefined; EmptyFields?: ",
"FieldsGroup",
"<T> | undefined; MetaFields?: ",
"FieldsGroup",
"<T> | undefined; UnmappedFields?: ",
"FieldsGroup",
"<T> | undefined; }"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.fieldsExistenceStatus",
"type": "Enum",
"tags": [],
"label": "fieldsExistenceStatus",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistenceFetchStatus",
"text": "ExistenceFetchStatus"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.fieldsExistInIndex",
"type": "boolean",
"tags": [],
"label": "fieldsExistInIndex",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.renderFieldItem",
"type": "Function",
"tags": [],
"label": "renderFieldItem",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.RenderFieldItemParams",
"text": "RenderFieldItemParams"
},
"<T>) => JSX.Element"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.renderFieldItem.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.RenderFieldItemParams",
"text": "RenderFieldItemParams"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/fields_accordion.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.scrollToTopResetCounter",
"type": "number",
"tags": [],
"label": "scrollToTopResetCounter",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.screenReaderDescriptionId",
"type": "string",
"tags": [],
"label": "screenReaderDescriptionId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.localStorageKeyPrefix",
"type": "string",
"tags": [],
"label": "localStorageKeyPrefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroupedProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list_grouped/field_list_grouped.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem",
"type": "Interface",
"tags": [],
"label": "FieldListItem",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.displayName",
"type": "string",
"tags": [],
"label": "displayName",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.timeSeriesMetric",
"type": "CompoundType",
"tags": [],
"label": "timeSeriesMetric",
"description": [],
"signature": [
"MappingTimeSeriesMetricType",
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListItem.scripted",
"type": "CompoundType",
"tags": [],
"label": "scripted",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListProps",
"type": "Interface",
"tags": [],
"label": "FieldListProps",
"description": [
"\nA top level wrapper props"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListProps.isProcessing",
"type": "boolean",
"tags": [],
"label": "isProcessing",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListProps.prepend",
"type": "CompoundType",
"tags": [],
"label": "prepend",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListProps.append",
"type": "CompoundType",
"tags": [],
"label": "append",
"description": [],
"signature": [
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListProps.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_list/field_list.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps",
"type": "Interface",
"tags": [],
"label": "FieldPopoverHeaderProps",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.closePopover",
"type": "Function",
"tags": [],
"label": "closePopover",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.buttonAddFieldToWorkspaceProps",
"type": "Object",
"tags": [],
"label": "buttonAddFieldToWorkspaceProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonIconProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.buttonAddFilterProps",
"type": "Object",
"tags": [],
"label": "buttonAddFilterProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonIconProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.buttonEditFieldProps",
"type": "Object",
"tags": [],
"label": "buttonEditFieldProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonIconProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.buttonDeleteFieldProps",
"type": "Object",
"tags": [],
"label": "buttonDeleteFieldProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonIconProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onAddFieldToWorkspace",
"type": "Function",
"tags": [],
"label": "onAddFieldToWorkspace",
"description": [],
"signature": [
"((field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
") => unknown) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onAddFieldToWorkspace.$1",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onAddFilter",
"type": "Function",
"tags": [],
"label": "onAddFilter",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.AddFieldFilterHandler",
"text": "AddFieldFilterHandler"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onEditField",
"type": "Function",
"tags": [],
"label": "onEditField",
"description": [],
"signature": [
"((fieldName: string) => unknown) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onEditField.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onDeleteField",
"type": "Function",
"tags": [],
"label": "onDeleteField",
"description": [],
"signature": [
"((fieldName: string) => unknown) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverHeaderProps.onDeleteField.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_header.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverProps",
"type": "Interface",
"tags": [],
"label": "FieldPopoverProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldPopoverProps",
"text": "FieldPopoverProps"
},
" extends ",
"EuiPopoverProps"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverProps.renderHeader",
"type": "Function",
"tags": [],
"label": "renderHeader",
"description": [],
"signature": [
"(() => React.ReactNode) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverProps.renderContent",
"type": "Function",
"tags": [],
"label": "renderContent",
"description": [],
"signature": [
"(() => React.ReactNode) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails",
"type": "Interface",
"tags": [],
"label": "FieldsGroupDetails",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.showInAccordion",
"type": "boolean",
"tags": [],
"label": "showInAccordion",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.isInitiallyOpen",
"type": "boolean",
"tags": [],
"label": "isInitiallyOpen",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.helpText",
"type": "string",
"tags": [],
"label": "helpText",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.isAffectedByGlobalFilter",
"type": "boolean",
"tags": [],
"label": "isAffectedByGlobalFilter",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.isAffectedByTimeFilter",
"type": "boolean",
"tags": [],
"label": "isAffectedByTimeFilter",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.hideDetails",
"type": "CompoundType",
"tags": [],
"label": "hideDetails",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.defaultNoFieldsMessage",
"type": "string",
"tags": [],
"label": "defaultNoFieldsMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupDetails.hideIfEmpty",
"type": "CompoundType",
"tags": [],
"label": "hideIfEmpty",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse",
"type": "Interface",
"tags": [],
"label": "FieldStatsResponse",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldStatsResponse",
"text": "FieldStatsResponse"
},
"<KeyType>"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse.totalDocuments",
"type": "number",
"tags": [],
"label": "totalDocuments",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse.sampledDocuments",
"type": "number",
"tags": [],
"label": "sampledDocuments",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse.sampledValues",
"type": "number",
"tags": [],
"label": "sampledValues",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse.histogram",
"type": "Object",
"tags": [],
"label": "histogram",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType> | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse.topValues",
"type": "Object",
"tags": [],
"label": "topValues",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<KeyType> | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsResponse.numberSummary",
"type": "Object",
"tags": [],
"label": "numberSummary",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.NumberSummary",
"text": "NumberSummary"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsServices",
"type": "Interface",
"tags": [],
"label": "FieldStatsServices",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsServices.uiSettings",
"type": "Object",
"tags": [],
"label": "uiSettings",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-ui-settings-browser",
"scope": "common",
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
"section": "def-common.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsServices.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsServices.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsServices.fieldFormats",
"type": "CompoundType",
"tags": [],
"label": "fieldFormats",
"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": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsServices.charts",
"type": "Object",
"tags": [],
"label": "charts",
"description": [],
"signature": [
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ChartsPluginSetup",
"text": "ChartsPluginSetup"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState",
"type": "Interface",
"tags": [],
"label": "FieldStatsState",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.isLoading",
"type": "boolean",
"tags": [],
"label": "isLoading",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.totalDocuments",
"type": "number",
"tags": [],
"label": "totalDocuments",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.sampledDocuments",
"type": "number",
"tags": [],
"label": "sampledDocuments",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.sampledValues",
"type": "number",
"tags": [],
"label": "sampledValues",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.histogram",
"type": "Object",
"tags": [],
"label": "histogram",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<string | number> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.topValues",
"type": "Object",
"tags": [],
"label": "topValues",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.BucketedAggregation",
"text": "BucketedAggregation"
},
"<string | number> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsState.numberSummary",
"type": "Object",
"tags": [],
"label": "numberSummary",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.NumberSummary",
"text": "NumberSummary"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams",
"type": "Interface",
"tags": [],
"label": "FieldTopValuesBucketParams",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.fieldValue",
"type": "Unknown",
"tags": [],
"label": "fieldValue",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.formattedFieldValue",
"type": "string",
"tags": [],
"label": "formattedFieldValue",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.formattedPercentage",
"type": "string",
"tags": [],
"label": "formattedPercentage",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.progressValue",
"type": "number",
"tags": [],
"label": "progressValue",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.color",
"type": "string",
"tags": [],
"label": "color",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketParams.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"other\" | \"normal\" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketProps",
"type": "Interface",
"tags": [],
"label": "FieldTopValuesBucketProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldTopValuesBucketProps",
"text": "FieldTopValuesBucketProps"
},
" extends ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldTopValuesBucketParams",
"text": "FieldTopValuesBucketParams"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketProps.onAddFilter",
"type": "Function",
"tags": [],
"label": "onAddFilter",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.AddFieldFilterHandler",
"text": "AddFieldFilterHandler"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldTopValuesBucketProps.overrideFieldTopValueBar",
"type": "Function",
"tags": [],
"label": "overrideFieldTopValueBar",
"description": [
"\nOptional callback to allow overriding props on bucket level"
],
"signature": [
"OverrideFieldTopValueBarCallback",
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_top_values_bucket.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps",
"type": "Interface",
"tags": [],
"label": "FieldVisualizeButtonProps",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.originatingApp",
"type": "string",
"tags": [],
"label": "originatingApp",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"{ readonly addTriggerAction: (triggerId: string, action: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<any>) => void; readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <Context extends object>(definition: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<Context>) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<Context>; readonly registerTrigger: (trigger: ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
"docId": "kibKbnUiActionsBrowserPluginApi",
"section": "def-common.Trigger",
"text": "Trigger"
},
") => void; readonly unregisterAction: (actionId: string) => void; readonly getTrigger: (triggerId: string) => ",
"TriggerContract",
"<object>; readonly hasAction: (actionId: string) => boolean; readonly getAction: (id: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>; readonly getTriggerActions: (triggerId: string) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]; readonly getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsService",
"text": "UiActionsService"
},
"; }"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.multiFields",
"type": "Array",
"tags": [],
"label": "multiFields",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
"[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.contextualFields",
"type": "Array",
"tags": [],
"label": "contextualFields",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.trackUiMetric",
"type": "Function",
"tags": [],
"label": "trackUiMetric",
"description": [],
"signature": [
"((metricType: string, eventName: string | string[]) => void) | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.trackUiMetric.$1",
"type": "string",
"tags": [],
"label": "metricType",
"description": [],
"signature": [
"string"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.trackUiMetric.$2",
"type": "CompoundType",
"tags": [],
"label": "eventName",
"description": [],
"signature": [
"string | string[]"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.buttonProps",
"type": "Object",
"tags": [],
"label": "buttonProps",
"description": [],
"signature": [
"Partial<",
"EuiButtonProps",
"> | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldVisualizeButtonProps.visualizeInfo",
"type": "Object",
"tags": [],
"label": "visualizeInfo",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.VisualizeInformation",
"text": "VisualizeInformation"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/field_visualize_button.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams",
"type": "Interface",
"tags": [],
"label": "GroupedFieldsParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GroupedFieldsParams",
"text": "GroupedFieldsParams"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.dataViewId",
"type": "CompoundType",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string | null"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.allFields",
"type": "CompoundType",
"tags": [],
"label": "allFields",
"description": [],
"signature": [
"T[] | null"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.services",
"type": "Object",
"tags": [],
"label": "services",
"description": [],
"signature": [
"{ dataViews: ",
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
},
"; core: Pick<",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", \"docLinks\">; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.isAffectedByGlobalFilter",
"type": "CompoundType",
"tags": [],
"label": "isAffectedByGlobalFilter",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.popularFieldsLimit",
"type": "number",
"tags": [],
"label": "popularFieldsLimit",
"description": [],
"signature": [
"number | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.sortedSelectedFields",
"type": "Array",
"tags": [],
"label": "sortedSelectedFields",
"description": [],
"signature": [
"T[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.getCustomFieldType",
"type": "Function",
"tags": [],
"label": "getCustomFieldType",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GetCustomFieldType",
"text": "GetCustomFieldType"
},
"<T> | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.onOverrideFieldGroupDetails",
"type": "Function",
"tags": [],
"label": "onOverrideFieldGroupDetails",
"description": [],
"signature": [
"OverrideFieldGroupDetails",
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.onSupportedFieldFilter",
"type": "Function",
"tags": [],
"label": "onSupportedFieldFilter",
"description": [],
"signature": [
"((field: T) => boolean) | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.onSupportedFieldFilter.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.onSelectedFieldFilter",
"type": "Function",
"tags": [],
"label": "onSelectedFieldFilter",
"description": [],
"signature": [
"((field: T) => boolean) | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsParams.onSelectedFieldFilter.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsResult",
"type": "Interface",
"tags": [],
"label": "GroupedFieldsResult",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.GroupedFieldsResult",
"text": "GroupedFieldsResult"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsResult.fieldListFiltersProps",
"type": "Object",
"tags": [],
"label": "fieldListFiltersProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListFiltersProps",
"text": "FieldListFiltersProps"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GroupedFieldsResult.fieldListGroupedProps",
"type": "Object",
"tags": [],
"label": "fieldListGroupedProps",
"description": [],
"signature": [
"{ fieldGroups: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldListGroups",
"text": "FieldListGroups"
},
"<T>; scrollToTopResetCounter: number; fieldsExistenceStatus: ",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.ExistenceFetchStatus",
"text": "ExistenceFetchStatus"
},
"; fieldsExistInIndex: boolean; screenReaderDescriptionId?: string | undefined; }"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_grouped_fields.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.NumberSummary",
"type": "Interface",
"tags": [],
"label": "NumberSummary",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.NumberSummary.minValue",
"type": "CompoundType",
"tags": [],
"label": "minValue",
"description": [],
"signature": [
"number | null"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.NumberSummary.maxValue",
"type": "CompoundType",
"tags": [],
"label": "maxValue",
"description": [],
"signature": [
"number | null"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberParams",
"type": "Interface",
"tags": [],
"label": "QuerySubscriberParams",
"description": [
"\nHook params"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberParams.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataPluginApi",
"section": "def-public.DataPublicPluginStart",
"text": "DataPublicPluginStart"
}
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberParams.timeRangeUpdatesType",
"type": "CompoundType",
"tags": [],
"label": "timeRangeUpdatesType",
"description": [
"\nPass `timefilter` only if you are not using search sessions for the global search"
],
"signature": [
"TimeRangeUpdatesType",
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberResult",
"type": "Interface",
"tags": [],
"label": "QuerySubscriberResult",
"description": [
"\nResult from the hook"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberResult.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberResult.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberResult.fromDate",
"type": "string",
"tags": [],
"label": "fromDate",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberResult.toDate",
"type": "string",
"tags": [],
"label": "toDate",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.QuerySubscriberResult.searchMode",
"type": "CompoundType",
"tags": [],
"label": "searchMode",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.SearchMode",
"text": "SearchMode"
},
" | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_query_subscriber.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams",
"type": "Interface",
"tags": [],
"label": "RenderFieldItemParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.RenderFieldItemParams",
"text": "RenderFieldItemParams"
},
"<T>"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams.field",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams.hideDetails",
"type": "CompoundType",
"tags": [],
"label": "hideDetails",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams.itemIndex",
"type": "number",
"tags": [],
"label": "itemIndex",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams.groupIndex",
"type": "number",
"tags": [],
"label": "groupIndex",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams.groupName",
"type": "Enum",
"tags": [],
"label": "groupName",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldsGroupNames",
"text": "FieldsGroupNames"
}
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.RenderFieldItemParams.fieldSearchHighlight",
"type": "string",
"tags": [],
"label": "fieldSearchHighlight",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi",
"type": "Interface",
"tags": [],
"label": "UnifiedFieldListSidebarContainerApi",
"description": [],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi.refetchFieldsExistenceInfo",
"type": "Function",
"tags": [],
"label": "refetchFieldsExistenceInfo",
"description": [],
"signature": [
"(dataViewId?: string | undefined) => Promise<void>"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi.refetchFieldsExistenceInfo.$1",
"type": "string",
"tags": [],
"label": "dataViewId",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi.closeFieldListFlyout",
"type": "Function",
"tags": [],
"label": "closeFieldListFlyout",
"description": [],
"signature": [
"() => void"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi.createField",
"type": "Function",
"tags": [],
"label": "createField",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi.editField",
"type": "Function",
"tags": [],
"label": "editField",
"description": [],
"signature": [
"((fieldName: string) => void) | undefined"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerApi.deleteField",
"type": "Function",
"tags": [],
"label": "deleteField",
"description": [],
"signature": [
"((fieldName: string) => void) | undefined"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.VisualizeInformation",
"type": "Interface",
"tags": [],
"label": "VisualizeInformation",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.VisualizeInformation.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
}
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.VisualizeInformation.href",
"type": "string",
"tags": [],
"label": "href",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-unified-field-list/src/components/field_visualize_button/visualize_trigger_utils.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.ExistenceFetchStatus",
"type": "Enum",
"tags": [],
"label": "ExistenceFetchStatus",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldsGroupNames",
"type": "Enum",
"tags": [],
"label": "FieldsGroupNames",
"description": [],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.AddFieldFilterHandler",
"type": "Type",
"tags": [],
"label": "AddFieldFilterHandler",
"description": [],
"signature": [
"(field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
" | \"_exists_\", value: unknown, type: \"+\" | \"-\") => void"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.AddFieldFilterHandler.$1",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
" | \"_exists_\""
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.AddFieldFilterHandler.$2",
"type": "Unknown",
"tags": [],
"label": "value",
"description": [],
"signature": [
"unknown"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.AddFieldFilterHandler.$3",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"+\" | \"-\""
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldIconProps",
"type": "Type",
"tags": [],
"label": "FieldIconProps",
"description": [],
"path": "packages/kbn-unified-field-list/src/components/field_icon/field_icon.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldListGroups",
"type": "Type",
"tags": [],
"label": "FieldListGroups",
"description": [],
"signature": [
"{ SpecialFields?: ",
"FieldsGroup",
"<T> | undefined; SelectedFields?: ",
"FieldsGroup",
"<T> | undefined; PopularFields?: ",
"FieldsGroup",
"<T> | undefined; AvailableFields?: ",
"FieldsGroup",
"<T> | undefined; EmptyFields?: ",
"FieldsGroup",
"<T> | undefined; MetaFields?: ",
"FieldsGroup",
"<T> | undefined; UnmappedFields?: ",
"FieldsGroup",
"<T> | undefined; }"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldPopoverFooterProps",
"type": "Type",
"tags": [],
"label": "FieldPopoverFooterProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldVisualizeButtonProps",
"text": "FieldVisualizeButtonProps"
},
" | ",
"FieldCategorizeButtonProps"
],
"path": "packages/kbn-unified-field-list/src/components/field_popover/field_popover_footer.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.FieldStatsProps",
"type": "Type",
"tags": [],
"label": "FieldStatsProps",
"description": [],
"signature": [
"FieldStatsWithKbnQuery",
" | ",
"FieldStatsWithDslQuery"
],
"path": "packages/kbn-unified-field-list/src/components/field_stats/field_stats.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GetCustomFieldType",
"type": "Type",
"tags": [],
"label": "GetCustomFieldType",
"description": [],
"signature": [
"(field: T) => string"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.GetCustomFieldType.$1",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"T"
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.SearchMode",
"type": "Type",
"tags": [],
"label": "SearchMode",
"description": [],
"signature": [
"\"documents\" | \"text-based\""
],
"path": "packages/kbn-unified-field-list/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-field-list",
"id": "def-common.UnifiedFieldListSidebarContainerProps",
"type": "Type",
"tags": [],
"label": "UnifiedFieldListSidebarContainerProps",
"description": [],
"signature": [
"Omit<",
"UnifiedFieldListSidebarCustomizableProps",
", \"services\"> & { services: Omit<",
{
"pluginId": "@kbn/unified-field-list",
"scope": "common",
"docId": "kibKbnUnifiedFieldListPluginApi",
"section": "def-common.FieldStatsServices",
"text": "FieldStatsServices"
},
", \"uiSettings\"> & { core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
"; } & { uiActions?: ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
" | undefined; } & { dataViewFieldEditor?: ",
{
"pluginId": "dataViewFieldEditor",
"scope": "public",
"docId": "kibDataViewFieldEditorPluginApi",
"section": "def-public.PluginStart",
"text": "PluginStart"
},
" | undefined; }; getCreationOptions: () => ",
"UnifiedFieldListSidebarContainerCreationOptions",
"; prependInFlyout?: (() => React.ReactNode) | undefined; variant?: \"responsive\" | \"button-and-flyout-always\" | \"list-always\" | undefined; onSelectedFieldFilter?: ((field: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField",
"text": "DataViewField"
},
") => boolean) | undefined; onFieldEdited?: ((options?: { removedFieldName?: string | undefined; editedFieldName?: string | undefined; } | undefined) => Promise<void>) | undefined; }"
],
"path": "packages/kbn-unified-field-list/src/containers/unified_field_list_sidebar/field_list_sidebar_container.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink