mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
1651 lines
No EOL
61 KiB
JSON
1651 lines
No EOL
61 KiB
JSON
{
|
|
"id": "@kbn/unified-data-table",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.getDisplayedColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getDisplayedColumns",
|
|
"description": [
|
|
"\nFunction to provide fallback when\n1) no columns are given\n2) Just one column is given, which is the configured timefields"
|
|
],
|
|
"signature": [
|
|
"(stateColumns: string[], dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
") => string[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/columns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.getDisplayedColumns.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "stateColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/columns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.getDisplayedColumns.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataView",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/columns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.getRowsPerPageOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRowsPerPageOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"(currentRowsPerPage?: number | undefined) => number[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/rows_per_page.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.getRowsPerPageOptions.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "currentRowsPerPage",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/rows_per_page.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.JSONCodeEditorCommonMemoized",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "JSONCodeEditorCommonMemoized",
|
|
"description": [],
|
|
"signature": [
|
|
"React.NamedExoticComponent<JsonCodeEditorCommonProps> & { readonly type: (props: JsonCodeEditorCommonProps) => JSX.Element; }"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/json_code_editor/json_code_editor_common.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.JSONCodeEditorCommonMemoized.$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-data-table",
|
|
"id": "def-common.popularizeField",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "popularizeField",
|
|
"description": [],
|
|
"signature": [
|
|
"(dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
", fieldName: string, DataViewsService: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.DataViewsServicePublic",
|
|
"text": "DataViewsServicePublic"
|
|
},
|
|
", capabilities: ",
|
|
{
|
|
"pluginId": "@kbn/core-capabilities-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreCapabilitiesCommonPluginApi",
|
|
"section": "def-common.Capabilities",
|
|
"text": "Capabilities"
|
|
},
|
|
") => Promise<void>"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/popularize_field.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.popularizeField.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataView",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/popularize_field.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.popularizeField.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fieldName",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/popularize_field.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.popularizeField.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "DataViewsService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.DataViewsServicePublic",
|
|
"text": "DataViewsServicePublic"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/popularize_field.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.popularizeField.$4",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "capabilities",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-capabilities-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreCapabilitiesCommonPluginApi",
|
|
"section": "def-common.Capabilities",
|
|
"text": "Capabilities"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/utils/popularize_field.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UnifiedDataTable",
|
|
"description": [],
|
|
"signature": [
|
|
"({ ariaLabelledBy, columns, controlColumnIds, dataView, loadingState, onFilter, onResize, onSetColumns, onSort, rows, sampleSize, searchDescription, searchTitle, settings, showTimeCol, showFullScreenButton, sort, useNewFieldsApi, isSortEnabled, isPaginationEnabled, cellActionsTriggerId, className, rowHeightState, onUpdateRowHeight, isPlainRecord, rowsPerPageState, onUpdateRowsPerPage, onFieldEdited, services, renderCustomGridBody, trailingControlColumns, totalHits, onFetchMoreRecords, renderDocumentView, setExpandedDoc, expandedDoc, configRowHeight, showMultiFields, maxDocFieldsDisplayed, externalControlColumns, externalAdditionalControls, rowsPerPageOptions, visibleCellActions, externalCustomRenderers, consumer, componentsTourSteps, gridStyleOverride, }: ",
|
|
{
|
|
"pluginId": "@kbn/unified-data-table",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDataTablePluginApi",
|
|
"section": "def-common.UnifiedDataTableProps",
|
|
"text": "UnifiedDataTableProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n ariaLabelledBy,\n columns,\n controlColumnIds = CONTROL_COLUMN_IDS_DEFAULT,\n dataView,\n loadingState,\n onFilter,\n onResize,\n onSetColumns,\n onSort,\n rows,\n sampleSize,\n searchDescription,\n searchTitle,\n settings,\n showTimeCol,\n showFullScreenButton = true,\n sort,\n useNewFieldsApi,\n isSortEnabled = true,\n isPaginationEnabled = true,\n cellActionsTriggerId,\n className,\n rowHeightState,\n onUpdateRowHeight,\n isPlainRecord = false,\n rowsPerPageState,\n onUpdateRowsPerPage,\n onFieldEdited,\n services,\n renderCustomGridBody,\n trailingControlColumns,\n totalHits,\n onFetchMoreRecords,\n renderDocumentView,\n setExpandedDoc,\n expandedDoc,\n configRowHeight,\n showMultiFields = true,\n maxDocFieldsDisplayed = 50,\n externalControlColumns,\n externalAdditionalControls,\n rowsPerPageOptions,\n visibleCellActions,\n externalCustomRenderers,\n consumer = 'discover',\n componentsTourSteps,\n gridStyleOverride,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/unified-data-table",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDataTablePluginApi",
|
|
"section": "def-common.UnifiedDataTableProps",
|
|
"text": "UnifiedDataTableProps"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.useColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"({ capabilities, dataView, dataViews, setAppState, useNewFieldsApi, columns, sort, defaultOrder, }: UseColumnsProps) => { columns: string[]; onAddColumn: (columnName: string) => void; onRemoveColumn: (columnName: string) => void; onMoveColumn: (columnName: string, newIndex: number) => void; onSetColumns: (nextColumns: string[], hideTimeColumn: boolean) => void; }"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.useColumns.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n capabilities,\n dataView,\n dataViews,\n setAppState,\n useNewFieldsApi,\n columns,\n sort,\n defaultOrder = 'desc',\n}",
|
|
"description": [],
|
|
"signature": [
|
|
"UseColumnsProps"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedDataTableProps",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.ariaLabelledBy",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ariaLabelledBy",
|
|
"description": [
|
|
"\nDetermines which element labels the grid for ARIA"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [
|
|
"\nOptional class name to apply"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.columns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "columns",
|
|
"description": [
|
|
"\nDetermines ids of the columns which are displayed"
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.expandedDoc",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "expandedDoc",
|
|
"description": [
|
|
"\nIf set, the given document is displayed in a flyout"
|
|
],
|
|
"signature": [
|
|
"DataTableRecord",
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.dataView",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataView",
|
|
"description": [
|
|
"\nThe used data view"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.loadingState",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "loadingState",
|
|
"description": [
|
|
"\nDetermines if data is currently loaded"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/unified-data-table",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDataTablePluginApi",
|
|
"section": "def-common.DataLoadingState",
|
|
"text": "DataLoadingState"
|
|
}
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onFilter",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFilter",
|
|
"description": [
|
|
"\nFunction to add a filter in the grid cell or document flyout"
|
|
],
|
|
"signature": [
|
|
"(mapping: string | ",
|
|
"FieldMapping",
|
|
" | undefined, value: unknown, mode: \"+\" | \"-\") => void"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onFilter.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mapping",
|
|
"description": [],
|
|
"signature": [
|
|
"string | ",
|
|
"FieldMapping",
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-doc-viewer/src/services/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onFilter.$2",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "packages/kbn-unified-doc-viewer/src/services/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onFilter.$3",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "mode",
|
|
"description": [],
|
|
"signature": [
|
|
"\"+\" | \"-\""
|
|
],
|
|
"path": "packages/kbn-unified-doc-viewer/src/services/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onResize",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onResize",
|
|
"description": [
|
|
"\nFunction triggered when a column is resized by the user"
|
|
],
|
|
"signature": [
|
|
"((colSettings: { columnId: string; width: number; }) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onResize.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "colSettings",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onResize.$1.columnId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "columnId",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onResize.$1.width",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "width",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onSetColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onSetColumns",
|
|
"description": [
|
|
"\nFunction to set all columns"
|
|
],
|
|
"signature": [
|
|
"(columns: string[], hideTimeColumn: boolean) => void"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onSetColumns.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "columns",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onSetColumns.$2",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "hideTimeColumn",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onSort",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onSort",
|
|
"description": [
|
|
"\nfunction to change sorting of the documents, skipped when isSortEnabled is set to false"
|
|
],
|
|
"signature": [
|
|
"((sort: string[][]) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onSort.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "sort",
|
|
"description": [],
|
|
"signature": [
|
|
"string[][]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.rows",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "rows",
|
|
"description": [
|
|
"\nArray of documents provided by Elasticsearch"
|
|
],
|
|
"signature": [
|
|
"DataTableRecord",
|
|
"[] | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.sampleSize",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "sampleSize",
|
|
"description": [
|
|
"\nThe max size of the documents returned by Elasticsearch"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.setExpandedDoc",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setExpandedDoc",
|
|
"description": [
|
|
"\nFunction to set the expanded document, which is displayed in a flyout"
|
|
],
|
|
"signature": [
|
|
"((doc?: ",
|
|
"DataTableRecord",
|
|
" | undefined) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.setExpandedDoc.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "doc",
|
|
"description": [],
|
|
"signature": [
|
|
"DataTableRecord",
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.settings",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "settings",
|
|
"description": [
|
|
"\nGrid display settings persisted in Elasticsearch (e.g. column width)"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/unified-data-table",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDataTablePluginApi",
|
|
"section": "def-common.UnifiedDataTableSettings",
|
|
"text": "UnifiedDataTableSettings"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.searchDescription",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchDescription",
|
|
"description": [
|
|
"\nSearch description"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.searchTitle",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchTitle",
|
|
"description": [
|
|
"\nSearch title"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.showTimeCol",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "showTimeCol",
|
|
"description": [
|
|
"\nDetermines whether the time columns should be displayed (legacy settings)"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.showFullScreenButton",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "showFullScreenButton",
|
|
"description": [
|
|
"\nDetermines whether the full screen button should be displayed"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.isSortEnabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isSortEnabled",
|
|
"description": [
|
|
"\nManage user sorting control"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.sort",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "sort",
|
|
"description": [
|
|
"\nCurrent sort setting"
|
|
],
|
|
"signature": [
|
|
"SortOrder",
|
|
"[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.useNewFieldsApi",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "useNewFieldsApi",
|
|
"description": [
|
|
"\nHow the data is fetched"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.isPaginationEnabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isPaginationEnabled",
|
|
"description": [
|
|
"\nManage pagination control"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.controlColumnIds",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "controlColumnIds",
|
|
"description": [
|
|
"\nList of used control columns (available: 'openDetails', 'select')"
|
|
],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.rowHeightState",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "rowHeightState",
|
|
"description": [
|
|
"\nRow height from state"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onUpdateRowHeight",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onUpdateRowHeight",
|
|
"description": [
|
|
"\nUpdate row height state"
|
|
],
|
|
"signature": [
|
|
"((rowHeight: number) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onUpdateRowHeight.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "rowHeight",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.isPlainRecord",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isPlainRecord",
|
|
"description": [
|
|
"\nIs text base lang mode enabled"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.rowsPerPageState",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "rowsPerPageState",
|
|
"description": [
|
|
"\nCurrent state value for rowsPerPage"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onUpdateRowsPerPage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onUpdateRowsPerPage",
|
|
"description": [
|
|
"\nUpdate rows per page state"
|
|
],
|
|
"signature": [
|
|
"((rowsPerPage: number) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onUpdateRowsPerPage.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "rowsPerPage",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onFieldEdited",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFieldEdited",
|
|
"description": [
|
|
"\nCallback to execute on edit runtime field"
|
|
],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.cellActionsTriggerId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "cellActionsTriggerId",
|
|
"description": [
|
|
"\nOptional triggerId to retrieve the column cell actions that will override the default ones"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.services",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [
|
|
"\nService dependencies"
|
|
],
|
|
"signature": [
|
|
"{ theme: ",
|
|
{
|
|
"pluginId": "@kbn/react-kibana-context-common",
|
|
"scope": "common",
|
|
"docId": "kibKbnReactKibanaContextCommonPluginApi",
|
|
"section": "def-common.ThemeServiceStart",
|
|
"text": "ThemeServiceStart"
|
|
},
|
|
"; fieldFormats: ",
|
|
{
|
|
"pluginId": "fieldFormats",
|
|
"scope": "public",
|
|
"docId": "kibFieldFormatsPluginApi",
|
|
"section": "def-public.FieldFormatsStart",
|
|
"text": "FieldFormatsStart"
|
|
},
|
|
"; uiSettings: ",
|
|
{
|
|
"pluginId": "@kbn/core-ui-settings-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreUiSettingsBrowserPluginApi",
|
|
"section": "def-common.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
"; dataViewFieldEditor: ",
|
|
{
|
|
"pluginId": "dataViewFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibDataViewFieldEditorPluginApi",
|
|
"section": "def-public.PluginStart",
|
|
"text": "PluginStart"
|
|
},
|
|
"; toastNotifications: ",
|
|
{
|
|
"pluginId": "@kbn/core-notifications-browser",
|
|
"scope": "common",
|
|
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
|
|
"section": "def-common.IToasts",
|
|
"text": "IToasts"
|
|
},
|
|
"; storage: ",
|
|
{
|
|
"pluginId": "kibanaUtils",
|
|
"scope": "public",
|
|
"docId": "kibKibanaUtilsPluginApi",
|
|
"section": "def-public.Storage",
|
|
"text": "Storage"
|
|
},
|
|
"; data: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataPluginApi",
|
|
"section": "def-public.DataPublicPluginStart",
|
|
"text": "DataPublicPluginStart"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.renderDocumentView",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderDocumentView",
|
|
"description": [
|
|
"\nCallback to render DocumentView when the document is expanded"
|
|
],
|
|
"signature": [
|
|
"((hit: ",
|
|
"DataTableRecord",
|
|
", displayedRows: ",
|
|
"DataTableRecord",
|
|
"[], displayedColumns: string[]) => JSX.Element | undefined) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.renderDocumentView.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hit",
|
|
"description": [],
|
|
"signature": [
|
|
"DataTableRecord"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.renderDocumentView.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "displayedRows",
|
|
"description": [],
|
|
"signature": [
|
|
"DataTableRecord",
|
|
"[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.renderDocumentView.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "displayedColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.configRowHeight",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "configRowHeight",
|
|
"description": [
|
|
"\nOptional value for providing configuration setting for UnifiedDataTable rows height"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.showMultiFields",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "showMultiFields",
|
|
"description": [
|
|
"\nOptional value for providing configuration setting for enabling to display the complex fields in the table. Default is true."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.maxDocFieldsDisplayed",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "maxDocFieldsDisplayed",
|
|
"description": [
|
|
"\nOptional value for providing configuration setting for maximum number of document fields to display in the table. Default is 50."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.externalControlColumns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "externalControlColumns",
|
|
"description": [
|
|
"\nOptional value for providing EuiDataGridControlColumn list of the additional leading control columns. UnifiedDataTable includes two control columns: Open Details and Select."
|
|
],
|
|
"signature": [
|
|
"EuiDataGridControlColumn",
|
|
"[] | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.totalHits",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "totalHits",
|
|
"description": [
|
|
"\nNumber total hits from ES"
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.onFetchMoreRecords",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onFetchMoreRecords",
|
|
"description": [
|
|
"\nTo fetch more"
|
|
],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.externalAdditionalControls",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "externalAdditionalControls",
|
|
"description": [
|
|
"\nOptional value for providing the additional controls available in the UnifiedDataTable toolbar to manage it's records or state. UnifiedDataTable includes Columns, Sorting and Bulk Actions."
|
|
],
|
|
"signature": [
|
|
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.rowsPerPageOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "rowsPerPageOptions",
|
|
"description": [
|
|
"\nOptional list of number type values to set custom UnifiedDataTable paging options to display the records per page."
|
|
],
|
|
"signature": [
|
|
"number[] | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.renderCustomGridBody",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "renderCustomGridBody",
|
|
"description": [
|
|
"\nAn optional function called to completely customize and control the rendering of\nEuiDataGrid's body and cell placement. This can be used to, e.g. remove EuiDataGrid's\nvirtualization library, or roll your own.\n\nThis component is **only** meant as an escape hatch for extremely custom use cases.\n\nBehind the scenes, this function is treated as a React component,\nallowing hooks, context, and other React concepts to be used.\nIt receives #EuiDataGridCustomBodyProps as its only argument."
|
|
],
|
|
"signature": [
|
|
"((args: ",
|
|
"EuiDataGridCustomBodyProps",
|
|
") => React.ReactNode) | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.renderCustomGridBody.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiDataGridCustomBodyProps"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.trailingControlColumns",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "trailingControlColumns",
|
|
"description": [
|
|
"\nAn optional list of the EuiDataGridControlColumn type for setting trailing control columns standard for EuiDataGrid."
|
|
],
|
|
"signature": [
|
|
"EuiDataGridControlColumn",
|
|
"[] | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.visibleCellActions",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "visibleCellActions",
|
|
"description": [
|
|
"\nAn optional value for a custom number of the visible cell actions in the table. By default is up to 3."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.externalCustomRenderers",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "externalCustomRenderers",
|
|
"description": [
|
|
"\nAn optional settings for a specified fields rendering like links. Applied only for the listed fields rendering."
|
|
],
|
|
"signature": [
|
|
"Record<string, (props: ",
|
|
"EuiDataGridCellValueElementProps",
|
|
") => React.ReactNode> | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.consumer",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "consumer",
|
|
"description": [
|
|
"\nName of the UnifiedDataTable consumer component or application"
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.componentsTourSteps",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "componentsTourSteps",
|
|
"description": [
|
|
"\nOptional key/value pairs to set guided onboarding steps ids for a data table components included to guided tour."
|
|
],
|
|
"signature": [
|
|
"Record<string, string> | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableProps.gridStyleOverride",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "gridStyleOverride",
|
|
"description": [
|
|
"\nOptional gridStyle override."
|
|
],
|
|
"signature": [
|
|
"EuiDataGridStyle",
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableSettings",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedDataTableSettings",
|
|
"description": [
|
|
"\nUser configurable state of data grid, persisted in saved search"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableSettings.columns",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "columns",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "@kbn/unified-data-table",
|
|
"scope": "common",
|
|
"docId": "kibKbnUnifiedDataTablePluginApi",
|
|
"section": "def-common.UnifiedDataTableSettingsColumn",
|
|
"text": "UnifiedDataTableSettingsColumn"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableSettingsColumn",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UnifiedDataTableSettingsColumn",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.UnifiedDataTableSettingsColumn.width",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "width",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.DataLoadingState",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "DataLoadingState",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/components/data_table.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ValueToStringConverter",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ValueToStringConverter",
|
|
"description": [],
|
|
"signature": [
|
|
"(rowIndex: number, columnId: string, options?: { compatibleWithCSV?: boolean | undefined; } | undefined) => { formattedString: string; withFormula: boolean; }"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ValueToStringConverter.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "rowIndex",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ValueToStringConverter.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "columnId",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ValueToStringConverter.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"{ compatibleWithCSV?: boolean | undefined; } | undefined"
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ROWS_HEIGHT_OPTIONS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ROWS_HEIGHT_OPTIONS",
|
|
"description": [
|
|
"\nRow height might be a value from -1 to 20\nA value of -1 automatically adjusts the row height to fit the contents.\nA value of 0 displays the content in a single line.\nA value from 1 to 20 represents number of lines of Document explorer row to display."
|
|
],
|
|
"path": "packages/kbn-unified-data-table/src/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ROWS_HEIGHT_OPTIONS.auto",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "auto",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ROWS_HEIGHT_OPTIONS.single",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "single",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/unified-data-table",
|
|
"id": "def-common.ROWS_HEIGHT_OPTIONS.default",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "default",
|
|
"description": [],
|
|
"path": "packages/kbn-unified-data-table/src/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |