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_data_table.devdocs.json

1887 lines
No EOL
70 KiB
JSON
Raw Blame History

{
"id": "@kbn/unified-data-table",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getDataGridDensity",
"type": "Function",
"tags": [],
"label": "getDataGridDensity",
"description": [],
"signature": [
"(storage: ",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
},
", consumer: string) => ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.DataGridDensity",
"text": "DataGridDensity"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_density.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getDataGridDensity.$1",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Storage",
"text": "Storage"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_density.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getDataGridDensity.$2",
"type": "string",
"tags": [],
"label": "consumer",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_density.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.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": "src/platform/packages/shared/kbn-unified-data-table/src/utils/columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getDisplayedColumns.$1",
"type": "Array",
"tags": [],
"label": "stateColumns",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getDisplayedColumns.$2",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/columns.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRenderCustomToolbarWithElements",
"type": "Function",
"tags": [],
"label": "getRenderCustomToolbarWithElements",
"description": [
"\nRender custom element on the left side and all controls to the right"
],
"signature": [
"({ leftSide, bottomSection, }: { leftSide?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; bottomSection?: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined; }) => ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRenderCustomToolbar",
"text": "UnifiedDataTableRenderCustomToolbar"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRenderCustomToolbarWithElements.$1",
"type": "Object",
"tags": [],
"label": "{\n leftSide,\n bottomSection,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRenderCustomToolbarWithElements.$1.leftSide",
"type": "Object",
"tags": [],
"label": "leftSide",
"description": [],
"signature": [
"React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRenderCustomToolbarWithElements.$1.bottomSection",
"type": "Object",
"tags": [],
"label": "bottomSection",
"description": [],
"signature": [
"React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRowHeight",
"type": "Function",
"tags": [],
"label": "getRowHeight",
"description": [],
"signature": [
"({ storage, consumer, rowHeightState, configRowHeight, }: Pick<ResolveRowHeightParams, \"consumer\" | \"storage\" | \"rowHeightState\"> & { configRowHeight?: number | undefined; }) => number"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_row_height.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRowHeight.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n storage,\n consumer,\n rowHeightState,\n configRowHeight,\n}",
"description": [],
"signature": [
"Pick<ResolveRowHeightParams, \"consumer\" | \"storage\" | \"rowHeightState\"> & { configRowHeight?: number | undefined; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_row_height.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRowsPerPageOptions",
"type": "Function",
"tags": [],
"label": "getRowsPerPageOptions",
"description": [],
"signature": [
"(currentRowsPerPage?: number | undefined) => number[]"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/rows_per_page.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getRowsPerPageOptions.$1",
"type": "number",
"tags": [],
"label": "currentRowsPerPage",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/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-public.getTextBasedColumnsMeta",
"type": "Function",
"tags": [],
"label": "getTextBasedColumnsMeta",
"description": [
"\nColumns meta for text based searches"
],
"signature": [
"(textBasedColumns: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"[]) => TextBasedColumnTypes"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/get_columns_meta.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.getTextBasedColumnsMeta.$1",
"type": "Array",
"tags": [],
"label": "textBasedColumns",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumn",
"text": "DatatableColumn"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/get_columns_meta.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.JSONCodeEditorCommonMemoized",
"type": "Function",
"tags": [],
"label": "JSONCodeEditorCommonMemoized",
"description": [],
"signature": [
"React.NamedExoticComponent<JsonCodeEditorCommonProps> & { readonly type: (props: JsonCodeEditorCommonProps) => React.JSX.Element; }"
],
"path": "src/platform/packages/shared/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-public.JSONCodeEditorCommonMemoized.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.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: ",
"Capabilities",
") => Promise<void>"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/popularize_field.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.popularizeField.$1",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/popularize_field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.popularizeField.$2",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/popularize_field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.popularizeField.$3",
"type": "Object",
"tags": [],
"label": "DataViewsService",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/popularize_field.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.popularizeField.$4",
"type": "CompoundType",
"tags": [],
"label": "capabilities",
"description": [],
"signature": [
"Capabilities"
],
"path": "src/platform/packages/shared/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-public.renderCustomToolbar",
"type": "Function",
"tags": [],
"label": "renderCustomToolbar",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRenderCustomToolbarProps",
"text": "UnifiedDataTableRenderCustomToolbarProps"
},
") => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.renderCustomToolbar.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRenderCustomToolbarProps",
"text": "UnifiedDataTableRenderCustomToolbarProps"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettings",
"type": "Function",
"tags": [],
"label": "RowHeightSettings",
"description": [],
"signature": [
"({\n lineCountInput,\n label,\n rowHeight,\n onChangeRowHeight,\n onChangeLineCountInput,\n maxRowHeight,\n ['data-test-subj']: dataTestSubj,\n}: ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.RowHeightSettingsProps",
"text": "RowHeightSettingsProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettings.$1",
"type": "Object",
"tags": [],
"label": "{\n lineCountInput,\n label,\n rowHeight,\n onChangeRowHeight,\n onChangeLineCountInput,\n maxRowHeight,\n ['data-test-subj']: dataTestSubj,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.RowHeightSettingsProps",
"text": "RowHeightSettingsProps"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument",
"type": "Function",
"tags": [],
"label": "SourceDocument",
"description": [],
"signature": [
"({\n useTopLevelObjectColumns,\n row,\n columnId,\n dataView,\n shouldShowFieldHandler,\n maxEntries,\n isPlainRecord,\n fieldFormats,\n dataTestSubj = 'discoverCellDescriptionList',\n className,\n isCompressed = true,\n}: { useTopLevelObjectColumns: boolean; row: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
"; columnId: string; dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"; shouldShowFieldHandler: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.ShouldShowFieldInTableHandler",
"text": "ShouldShowFieldInTableHandler"
},
"; maxEntries: number; isPlainRecord?: boolean | undefined; fieldFormats: ",
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
},
"; dataTestSubj?: string | undefined; className?: string | undefined; isCompressed?: boolean | undefined; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1",
"type": "Object",
"tags": [],
"label": "{\n useTopLevelObjectColumns,\n row,\n columnId,\n dataView,\n shouldShowFieldHandler,\n maxEntries,\n isPlainRecord,\n fieldFormats,\n dataTestSubj = 'discoverCellDescriptionList',\n className,\n isCompressed = true,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.useTopLevelObjectColumns",
"type": "boolean",
"tags": [],
"label": "useTopLevelObjectColumns",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.row",
"type": "Object",
"tags": [],
"label": "row",
"description": [],
"signature": [
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.columnId",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.shouldShowFieldHandler",
"type": "Function",
"tags": [],
"label": "shouldShowFieldHandler",
"description": [],
"signature": [
"(fieldName: string) => boolean"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.shouldShowFieldHandler.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"path": "src/platform/packages/shared/kbn-discover-utils/src/utils/get_should_show_field_handler.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.maxEntries",
"type": "number",
"tags": [],
"label": "maxEntries",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.isPlainRecord",
"type": "CompoundType",
"tags": [],
"label": "isPlainRecord",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.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": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SourceDocument.$1.isCompressed",
"type": "CompoundType",
"tags": [],
"label": "isCompressed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/source_document.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTable",
"type": "Function",
"tags": [],
"label": "UnifiedDataTable",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<InternalUnifiedDataTableProps & ",
{
"pluginId": "@kbn/restorable-state",
"scope": "public",
"docId": "kibKbnRestorableStatePluginApi",
"section": "def-public.RestorableStateProviderProps",
"text": "RestorableStateProviderProps"
},
"<",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRestorableState",
"text": "UnifiedDataTableRestorableState"
},
"> & React.RefAttributes<",
{
"pluginId": "@kbn/restorable-state",
"scope": "public",
"docId": "kibKbnRestorableStatePluginApi",
"section": "def-public.RestorableStateProviderApi",
"text": "RestorableStateProviderApi"
},
">>"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/data_table.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTable.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.useColumns",
"type": "Function",
"tags": [],
"label": "useColumns",
"description": [],
"signature": [
"({ capabilities, dataView, dataViews, setAppState, columns, sort, defaultOrder, settings, }: ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UseColumnsProps",
"text": "UseColumnsProps"
},
") => { columns: string[]; onAddColumn: (columnName: string) => void; onRemoveColumn: (columnName: string) => void; onMoveColumn: (columnName: string, newIndex: number) => void; onSetColumns: (nextColumns: string[], hideTimeColumn: boolean) => void; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.useColumns.$1",
"type": "Object",
"tags": [],
"label": "{\n capabilities,\n dataView,\n dataViews,\n setAppState,\n columns,\n sort,\n defaultOrder = 'desc',\n settings,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UseColumnsProps",
"text": "UseColumnsProps"
}
],
"path": "src/platform/packages/shared/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-public.CustomGridColumnProps",
"type": "Interface",
"tags": [],
"label": "CustomGridColumnProps",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.CustomGridColumnProps.column",
"type": "Object",
"tags": [],
"label": "column",
"description": [],
"signature": [
"EuiDataGridColumn"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.CustomGridColumnProps.headerRowHeight",
"type": "number",
"tags": [],
"label": "headerRowHeight",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps",
"type": "Interface",
"tags": [],
"label": "RowHeightSettingsProps",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.lineCountInput",
"type": "number",
"tags": [],
"label": "lineCountInput",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.rowHeight",
"type": "CompoundType",
"tags": [],
"label": "rowHeight",
"description": [],
"signature": [
"RowHeightMode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.maxRowHeight",
"type": "number",
"tags": [],
"label": "maxRowHeight",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.onChangeRowHeight",
"type": "Function",
"tags": [],
"label": "onChangeRowHeight",
"description": [],
"signature": [
"(newHeightMode: ",
"RowHeightMode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.onChangeRowHeight.$1",
"type": "CompoundType",
"tags": [],
"label": "newHeightMode",
"description": [],
"signature": [
"RowHeightMode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.onChangeLineCountInput",
"type": "Function",
"tags": [],
"label": "onChangeLineCountInput",
"description": [],
"signature": [
"(newRowHeightLines: number) => void"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.onChangeLineCountInput.$1",
"type": "number",
"tags": [],
"label": "newRowHeightLines",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.RowHeightSettingsProps.datatestsubj",
"type": "string",
"tags": [],
"label": "'data-test-subj'",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/row_height_settings.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRenderCustomToolbarProps",
"type": "Interface",
"tags": [],
"label": "UnifiedDataTableRenderCustomToolbarProps",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRenderCustomToolbarProps.toolbarProps",
"type": "Object",
"tags": [],
"label": "toolbarProps",
"description": [],
"signature": [
"EuiDataGridCustomToolbarProps"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRenderCustomToolbarProps.gridProps",
"type": "Object",
"tags": [],
"label": "gridProps",
"description": [],
"signature": [
"{ additionalControls?: React.ReactNode; inTableSearchControl?: React.ReactNode; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRestorableState",
"type": "Interface",
"tags": [],
"label": "UnifiedDataTableRestorableState",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/restorable_state.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRestorableState.selectedDocsMap",
"type": "Object",
"tags": [],
"label": "selectedDocsMap",
"description": [],
"signature": [
"{ [x: string]: boolean; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/restorable_state.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRestorableState.isCompareActive",
"type": "boolean",
"tags": [],
"label": "isCompareActive",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/restorable_state.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableSettings",
"type": "Interface",
"tags": [],
"label": "UnifiedDataTableSettings",
"description": [
"\nUser configurable state of data grid, persisted in saved search"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableSettings.columns",
"type": "Object",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableSettingsColumn",
"text": "UnifiedDataTableSettingsColumn"
},
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableSettingsColumn",
"type": "Interface",
"tags": [],
"label": "UnifiedDataTableSettingsColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableSettingsColumn.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableSettingsColumn.display",
"type": "string",
"tags": [],
"label": "display",
"description": [
"\n Optional props passed to Columns to display provided labels as column names instead of field names.\n This object maps column field names to their corresponding display labels.\n These labels will take precedence over the data view field names."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps",
"type": "Interface",
"tags": [],
"label": "UseColumnsProps",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.capabilities",
"type": "CompoundType",
"tags": [],
"label": "capabilities",
"description": [],
"signature": [
"{ [key: string]: Record<string, boolean | Record<string, boolean>>; navLinks: Record<string, boolean>; management: { [sectionId: string]: Record<string, boolean>; }; catalogue: Record<string, boolean>; } & { discover?: {} | undefined; dashboard?: {} | undefined; maps?: {} | undefined; visualize?: {} | undefined; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.dataView",
"type": "Object",
"tags": [],
"label": "dataView",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.dataViews",
"type": "Object",
"tags": [],
"label": "dataViews",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "public",
"docId": "kibDataViewsPluginApi",
"section": "def-public.DataViewsServicePublic",
"text": "DataViewsServicePublic"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.setAppState",
"type": "Function",
"tags": [],
"label": "setAppState",
"description": [],
"signature": [
"(state: { columns: string[]; sort?: string[][] | undefined; settings?: ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableSettings",
"text": "UnifiedDataTableSettings"
},
" | undefined; }) => void"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.setAppState.$1",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.setAppState.$1.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.setAppState.$1.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"string[][] | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.setAppState.$1.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableSettings",
"text": "UnifiedDataTableSettings"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"string[][] | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.defaultOrder",
"type": "string",
"tags": [],
"label": "defaultOrder",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UseColumnsProps.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableSettings",
"text": "UnifiedDataTableSettings"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/hooks/use_data_grid_columns.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.DataGridDensity",
"type": "Enum",
"tags": [],
"label": "DataGridDensity",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.DataLoadingState",
"type": "Enum",
"tags": [],
"label": "DataLoadingState",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/data_table.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.CustomCellRenderer",
"type": "Type",
"tags": [],
"label": "CustomCellRenderer",
"description": [],
"signature": [
"{ [x: string]: React.FunctionComponent<",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.DataGridCellValueElementProps",
"text": "DataGridCellValueElementProps"
},
">; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.CustomGridColumnsConfiguration",
"type": "Type",
"tags": [],
"label": "CustomGridColumnsConfiguration",
"description": [],
"signature": [
"{ [x: string]: (props: ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.CustomGridColumnProps",
"text": "CustomGridColumnProps"
},
") => ",
"EuiDataGridColumn",
"; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.DataGridCellValueElementProps",
"type": "Type",
"tags": [],
"label": "DataGridCellValueElementProps",
"description": [],
"signature": [
"EuiDataGridCellValueElementProps",
" & { row: ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
"; dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
"; fieldFormats: ",
{
"pluginId": "fieldFormats",
"scope": "public",
"docId": "kibFieldFormatsPluginApi",
"section": "def-public.FieldFormatsStart",
"text": "FieldFormatsStart"
},
"; closePopover: () => void; isCompressed?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.DataGridPaginationMode",
"type": "Type",
"tags": [],
"label": "DataGridPaginationMode",
"description": [],
"signature": [
"\"multiPage\" | \"singlePage\" | \"infinite\""
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.DataTableColumnsMeta",
"type": "Type",
"tags": [],
"label": "DataTableColumnsMeta",
"description": [
"\nCustom column types per column name"
],
"signature": [
"{ [x: string]: { type: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumnType",
"text": "DatatableColumnType"
},
"; esType?: string | undefined; }; }"
],
"path": "src/platform/packages/shared/kbn-discover-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.DEFAULT_PAGINATION_MODE",
"type": "string",
"tags": [],
"label": "DEFAULT_PAGINATION_MODE",
"description": [],
"signature": [
"\"multiPage\""
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.OPEN_DETAILS",
"type": "string",
"tags": [],
"label": "OPEN_DETAILS",
"description": [],
"signature": [
"\"openDetails\""
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/data_table_columns.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SELECT_ROW",
"type": "string",
"tags": [],
"label": "SELECT_ROW",
"description": [],
"signature": [
"\"select\""
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/data_table_columns.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SortOrder",
"type": "Type",
"tags": [],
"label": "SortOrder",
"description": [],
"signature": [
"[string, string]"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/data_table.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.SOURCE_COLUMN",
"type": "string",
"tags": [],
"label": "SOURCE_COLUMN",
"description": [],
"signature": [
"\"_source\""
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/utils/columns.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableProps",
"type": "Type",
"tags": [],
"label": "UnifiedDataTableProps",
"description": [],
"signature": [
"InternalUnifiedDataTableProps & ",
{
"pluginId": "@kbn/restorable-state",
"scope": "public",
"docId": "kibKbnRestorableStatePluginApi",
"section": "def-public.RestorableStateProviderProps",
"text": "RestorableStateProviderProps"
},
"<",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRestorableState",
"text": "UnifiedDataTableRestorableState"
},
"> & React.RefAttributes<",
{
"pluginId": "@kbn/restorable-state",
"scope": "public",
"docId": "kibKbnRestorableStatePluginApi",
"section": "def-public.RestorableStateProviderApi",
"text": "RestorableStateProviderApi"
},
">"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/data_table.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRenderCustomToolbar",
"type": "Type",
"tags": [],
"label": "UnifiedDataTableRenderCustomToolbar",
"description": [],
"signature": [
"(props: ",
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRenderCustomToolbarProps",
"text": "UnifiedDataTableRenderCustomToolbarProps"
},
") => React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.UnifiedDataTableRenderCustomToolbar.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "public",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-public.UnifiedDataTableRenderCustomToolbarProps",
"text": "UnifiedDataTableRenderCustomToolbarProps"
}
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/components/custom_toolbar/render_custom_toolbar.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.ValueToStringConverter",
"type": "Type",
"tags": [],
"label": "ValueToStringConverter",
"description": [],
"signature": [
"(rowIndex: number, columnId: string, options?: { compatibleWithCSV?: boolean | undefined; } | undefined) => { formattedString: string; withFormula: boolean; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.ValueToStringConverter.$1",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.ValueToStringConverter.$2",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.ValueToStringConverter.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ compatibleWithCSV?: boolean | undefined; } | undefined"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/unified-data-table",
"id": "def-public.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 from 1 to 20 represents number of lines of Document explorer row to display."
],
"signature": [
"{ readonly auto: -1; readonly default: 3; }"
],
"path": "src/platform/packages/shared/kbn-unified-data-table/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink