github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_cell_actions.devdocs.json

1070 lines
No EOL
38 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/cell-actions",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActions",
"type": "Function",
"tags": [],
"label": "CellActions",
"description": [],
"signature": [
"({ data, triggerId, children, mode, showActionTooltips, visibleCellActions, disabledActionTypes, metadata, className, extraActionsIconType, extraActionsColor, }: ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsProps",
"text": "CellActionsProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/components/cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActions.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n data,\n triggerId,\n children,\n mode,\n showActionTooltips = true,\n visibleCellActions = 3,\n disabledActionTypes = [],\n metadata,\n className,\n extraActionsIconType,\n extraActionsColor,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsProps",
"text": "CellActionsProps"
}
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/components/cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsProvider",
"type": "Function",
"tags": [],
"label": "CellActionsProvider",
"description": [],
"signature": [
"({ children, getTriggerCompatibleActions, }: ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsProviderProps",
"text": "CellActionsProviderProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/context/cell_actions_context.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n getTriggerCompatibleActions,\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsProviderProps",
"text": "CellActionsProviderProps"
}
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/context/cell_actions_context.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.useDataGridColumnsCellActions",
"type": "Function",
"tags": [],
"label": "useDataGridColumnsCellActions",
"description": [],
"signature": [
"({ fields, getCellValue, triggerId, metadata, dataGridRef, disabledActionTypes, }: ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.UseDataGridColumnsCellActionsProps",
"text": "UseDataGridColumnsCellActionsProps"
},
") => ",
"EuiDataGridColumnCellAction",
"[][]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.useDataGridColumnsCellActions.$1",
"type": "Object",
"tags": [],
"label": "{\n fields,\n getCellValue,\n triggerId,\n metadata,\n dataGridRef,\n disabledActionTypes = [],\n}",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.UseDataGridColumnsCellActionsProps",
"text": "UseDataGridColumnsCellActionsProps"
}
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellAction",
"type": "Interface",
"tags": [],
"label": "CellAction",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellAction",
"text": "CellAction"
},
"<C> extends Omit<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<C>, \"isCompatible\">"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellAction.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [
"\nReturns a promise that resolves to true if this action is compatible given the context,\notherwise resolves to false."
],
"signature": [
"(context: ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionCompatibilityContext",
"text": "CellActionCompatibilityContext"
},
"<C>) => Promise<boolean>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellAction.isCompatible.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionCompatibilityContext",
"text": "CellActionCompatibilityContext"
},
"<C>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionCompatibilityContext",
"type": "Interface",
"tags": [],
"label": "CellActionCompatibilityContext",
"description": [
"\nSubset of `CellActionExecutionContext` used only for the compatibility check in the `isCompatible` function.\nIt omits the references and the `field.value`."
],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionCompatibilityContext",
"text": "CellActionCompatibilityContext"
},
"<C> extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<object>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionCompatibilityContext.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [
"\nCellActionsData containing the field spec but not the value for the compatibility check"
],
"signature": [
"Omit<C[\"data\"][number], \"value\">[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionCompatibilityContext.metadata",
"type": "Uncategorized",
"tags": [],
"label": "metadata",
"description": [
"\nExtra configurations for actions."
],
"signature": [
"C[\"metadata\"] | undefined"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionExecutionContext",
"type": "Interface",
"tags": [],
"label": "CellActionExecutionContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionExecutionContext",
"text": "CellActionExecutionContext"
},
" extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<object>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionExecutionContext.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsData",
"text": "CellActionsData"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionExecutionContext.nodeRef",
"type": "Object",
"tags": [],
"label": "nodeRef",
"description": [
"\nRef to the node where the cell action are rendered."
],
"signature": [
"React.MutableRefObject<HTMLElement | null>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionExecutionContext.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [
"\nExtra configurations for actions."
],
"signature": [
"Metadata | undefined"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionFactory",
"type": "Interface",
"tags": [],
"label": "CellActionFactory",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionFactory",
"text": "CellActionFactory"
},
"<C>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionFactory.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionFactory.combine",
"type": "Function",
"tags": [],
"label": "combine",
"description": [],
"signature": [
"<A extends C = C>(partialActionTemplate: Partial<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionTemplate",
"text": "CellActionTemplate"
},
"<A>>) => ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionFactory",
"text": "CellActionFactory"
},
"<A>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionFactory.combine.$1",
"type": "Object",
"tags": [],
"label": "partialActionTemplate",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionTemplate",
"text": "CellActionTemplate"
},
"<A>>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsData",
"type": "Interface",
"tags": [],
"label": "CellActionsData",
"description": [],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsData.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [
"\nThe field specification"
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.DataViewFieldBase",
"text": "DataViewFieldBase"
},
" & { count?: number | undefined; conflictDescriptions?: Record<string, string[]> | undefined; format?: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.SerializedFieldFormat",
"text": "SerializedFieldFormat"
},
"<{}, ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined; esTypes?: string[] | undefined; searchable: boolean; aggregatable: boolean; isNull?: boolean | undefined; readFromDocValues?: boolean | undefined; indexed?: boolean | undefined; customLabel?: string | undefined; customDescription?: string | undefined; runtimeField?: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.RuntimeFieldSpec",
"text": "RuntimeFieldSpec"
},
" | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: ",
"MappingTimeSeriesMetricType",
" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; defaultFormatter?: string | undefined; }"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsData.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [
"\nCommon set of properties used by most actions."
],
"signature": [
"string[] | undefined[] | boolean[] | number[] | ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
" | null[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.PartitionedActions",
"type": "Interface",
"tags": [],
"label": "PartitionedActions",
"description": [],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.PartitionedActions.extraActions",
"type": "Array",
"tags": [],
"label": "extraActions",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellAction",
"text": "CellAction"
},
"<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionExecutionContext",
"text": "CellActionExecutionContext"
},
">[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.PartitionedActions.visibleActions",
"type": "Array",
"tags": [],
"label": "visibleActions",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellAction",
"text": "CellAction"
},
"<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionExecutionContext",
"text": "CellActionExecutionContext"
},
">[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps",
"type": "Interface",
"tags": [],
"label": "UseDataGridColumnsCellActionsProps",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.UseDataGridColumnsCellActionsProps",
"text": "UseDataGridColumnsCellActionsProps"
},
" extends Pick<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsProps",
"text": "CellActionsProps"
},
", \"metadata\" | \"disabledActionTypes\">"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps.triggerId",
"type": "string",
"tags": [],
"label": "triggerId",
"description": [
"\nOptional trigger ID to used to retrieve the cell actions.\nreturns empty array if not provided"
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [
"\nfields array, used to determine which actions to load.\nreturns empty array if not provided"
],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps.getCellValue",
"type": "Function",
"tags": [],
"label": "getCellValue",
"description": [
"\nFunction to get the cell value for a given field name and row index.\nthe `rowIndex` parameter is absolute, not relative to the current page"
],
"signature": [
"(fieldName: string, rowIndex: number) => ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionFieldValue",
"text": "CellActionFieldValue"
}
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps.getCellValue.$1",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps.getCellValue.$2",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActionsProps.dataGridRef",
"type": "Object",
"tags": [],
"label": "dataGridRef",
"description": [
"\nref to the EuiDataGrid instance"
],
"signature": [
"React.MutableRefObject<",
"EuiDataGridRefProps",
" | null> | undefined"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionExtend",
"type": "Type",
"tags": [],
"label": "CellActionExtend",
"description": [
"\nAction factory extend parameter type,"
],
"signature": [
"Partial<C> & { id: string; }"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionFieldValue",
"type": "Type",
"tags": [],
"label": "CellActionFieldValue",
"description": [],
"signature": [
"string[] | undefined[] | boolean[] | number[] | ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
},
" | null[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsProps",
"type": "Type",
"tags": [],
"label": "CellActionsProps",
"description": [],
"signature": [
"{ data: ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsData",
"text": "CellActionsData"
},
" | ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionsData",
"text": "CellActionsData"
},
"[]; triggerId: string; mode: ",
"CellActionsMode",
"; showActionTooltips?: boolean | undefined; visibleCellActions?: number | undefined; disabledActionTypes?: string[] | undefined; metadata?: Metadata | undefined; className?: string | undefined; extraActionsIconType?: ",
"IconType",
" | undefined; extraActionsColor?: \"text\" | \"warning\" | \"success\" | \"primary\" | \"accent\" | \"accentSecondary\" | \"danger\" | undefined; } & { children?: React.ReactNode; }"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionsProviderProps",
"type": "Type",
"tags": [],
"label": "CellActionsProviderProps",
"description": [],
"signature": [
"{ getTriggerCompatibleActions: (triggerId: string, context: object) => Promise<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<object>[]>; } & { children?: React.ReactNode; }"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.CellActionTemplate",
"type": "Type",
"tags": [],
"label": "CellActionTemplate",
"description": [
"\nCell action factory template with optional `id`.\nThe id override is required when using the action factory so it\ncan be omitted in the original action creator"
],
"signature": [
"{ [P in Exclude<keyof C, \"id\">]: C[P]; }"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.DefaultActionsSupportedValue",
"type": "Type",
"tags": [],
"label": "DefaultActionsSupportedValue",
"description": [],
"signature": [
"string[] | boolean[] | number[]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.GetActions",
"type": "Type",
"tags": [],
"label": "GetActions",
"description": [],
"signature": [
"(context: ",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionCompatibilityContext",
"text": "CellActionCompatibilityContext"
},
"<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionExecutionContext",
"text": "CellActionExecutionContext"
},
">) => Promise<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellAction",
"text": "CellAction"
},
"<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionExecutionContext",
"text": "CellActionExecutionContext"
},
">[]>"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.GetActions.$1",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionCompatibilityContext",
"text": "CellActionCompatibilityContext"
},
"<",
{
"pluginId": "@kbn/cell-actions",
"scope": "common",
"docId": "kibKbnCellActionsPluginApi",
"section": "def-common.CellActionExecutionContext",
"text": "CellActionExecutionContext"
},
">"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.NonNullableSerializable",
"type": "Type",
"tags": [],
"label": "NonNullableSerializable",
"description": [],
"signature": [
"string | number | boolean | ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" | ",
"SerializableArray"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActions",
"type": "Type",
"tags": [],
"label": "UseDataGridColumnsCellActions",
"description": [],
"signature": [
"(props: P) => ",
"EuiDataGridColumnCellAction",
"[][]"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/cell-actions",
"id": "def-common.UseDataGridColumnsCellActions.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "src/platform/packages/shared/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink