{ "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.addFilterIn", "type": "Function", "tags": [], "label": "addFilterIn", "description": [], "signature": [ "({ filterManager, fieldName, value, }: { filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, " | undefined; fieldName: string; value: ", "DefaultActionsSupportedValue", "; }) => void" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterIn.$1", "type": "Object", "tags": [], "label": "{\n filterManager,\n fieldName,\n value,\n}", "description": [], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterIn.$1.filterManager", "type": "Object", "tags": [], "label": "filterManager", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, " | undefined" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterIn.$1.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterIn.$1.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ "string[] | boolean[] | number[]" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterOut", "type": "Function", "tags": [], "label": "addFilterOut", "description": [], "signature": [ "({ filterManager, fieldName, value, }: { filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, " | undefined; fieldName: string; value: ", "DefaultActionsSupportedValue", "; }) => void" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterOut.$1", "type": "Object", "tags": [], "label": "{\n filterManager,\n fieldName,\n value,\n}", "description": [], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterOut.$1.filterManager", "type": "Object", "tags": [], "label": "filterManager", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, " | undefined" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterOut.$1.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.addFilterOut.$1.value", "type": "CompoundType", "tags": [], "label": "value", "description": [], "signature": [ "string[] | boolean[] | number[]" ], "path": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActions", "type": "Function", "tags": [], "label": "CellActions", "description": [], "signature": [ "({ data, triggerId, children, mode, showActionTooltips, visibleCellActions, disabledActionTypes, metadata, className, }: React.PropsWithChildren<", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionsProps", "text": "CellActionsProps" }, ">) => JSX.Element" ], "path": "packages/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}", "description": [], "signature": [ "React.PropsWithChildren<", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionsProps", "text": "CellActionsProps" }, ">" ], "path": "packages/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, }: React.PropsWithChildren<", "CellActionsProviderProps", ">) => JSX.Element" ], "path": "packages/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": [ "React.PropsWithChildren<", "CellActionsProviderProps", ">" ], "path": "packages/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.createCellActionFactory", "type": "Function", "tags": [], "label": "createCellActionFactory", "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" }, ">, P = void>(actionCreator: (params: P) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionTemplate", "text": "CellActionTemplate" }, ") => (params: P) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionFactory", "text": "CellActionFactory" }, "" ], "path": "packages/kbn-cell-actions/src/actions/factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createCellActionFactory.$1", "type": "Function", "tags": [], "label": "actionCreator", "description": [], "signature": [ "(params: P) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionTemplate", "text": "CellActionTemplate" }, "" ], "path": "packages/kbn-cell-actions/src/actions/factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createCopyToClipboardActionFactory", "type": "Function", "tags": [], "label": "createCopyToClipboardActionFactory", "description": [], "signature": [ "(params: { notifications: ", { "pluginId": "@kbn/core-notifications-browser", "scope": "common", "docId": "kibKbnCoreNotificationsBrowserPluginApi", "section": "def-common.NotificationsStart", "text": "NotificationsStart" }, "; }) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionFactory", "text": "CellActionFactory" }, "<", { "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": "packages/kbn-cell-actions/src/actions/copy_to_clipboard/copy_to_clipboard.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createCopyToClipboardActionFactory.$1", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "P" ], "path": "packages/kbn-cell-actions/src/actions/factory.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createFilterInActionFactory", "type": "Function", "tags": [], "label": "createFilterInActionFactory", "description": [], "signature": [ "(params: { filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, "; notifications: ", { "pluginId": "@kbn/core-notifications-browser", "scope": "common", "docId": "kibKbnCoreNotificationsBrowserPluginApi", "section": "def-common.NotificationsStart", "text": "NotificationsStart" }, "; }) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionFactory", "text": "CellActionFactory" }, "<", { "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": "packages/kbn-cell-actions/src/actions/filter/filter_in.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createFilterInActionFactory.$1", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "P" ], "path": "packages/kbn-cell-actions/src/actions/factory.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createFilterOutActionFactory", "type": "Function", "tags": [], "label": "createFilterOutActionFactory", "description": [], "signature": [ "(params: { filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" }, "; notifications: ", { "pluginId": "@kbn/core-notifications-browser", "scope": "common", "docId": "kibKbnCoreNotificationsBrowserPluginApi", "section": "def-common.NotificationsStart", "text": "NotificationsStart" }, "; }) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionFactory", "text": "CellActionFactory" }, "<", { "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": "packages/kbn-cell-actions/src/actions/filter/filter_out.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.createFilterOutActionFactory.$1", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "P" ], "path": "packages/kbn-cell-actions/src/actions/factory.ts", "deprecated": false, "trackAdoption": false } ], "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": "packages/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": "packages/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" }, " extends Omit<", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.Action", "text": "Action" }, ", \"isCompatible\">" ], "path": "packages/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" }, ") => Promise" ], "path": "packages/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" }, "" ], "path": "packages/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" }, " extends ", { "pluginId": "uiActions", "scope": "public", "docId": "kibUiActionsPluginApi", "section": "def-public.ActionExecutionContext", "text": "ActionExecutionContext" }, "" ], "path": "packages/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[]" ], "path": "packages/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": "packages/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" }, "" ], "path": "packages/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": [ "CellActionsData", "[]" ], "path": "packages/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" ], "path": "packages/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": "packages/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" }, "" ], "path": "packages/kbn-cell-actions/src/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": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionFactory.combine", "type": "Function", "tags": [], "label": "combine", "description": [], "signature": [ "(partialActionTemplate: Partial<", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionTemplate", "text": "CellActionTemplate" }, ">) => ", { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionFactory", "text": "CellActionFactory" }, "" ], "path": "packages/kbn-cell-actions/src/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" }, ">" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps", "type": "Interface", "tags": [], "label": "CellActionsProps", "description": [], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.data", "type": "CompoundType", "tags": [], "label": "data", "description": [], "signature": [ "CellActionsData", " | ", "CellActionsData", "[]" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.triggerId", "type": "string", "tags": [], "label": "triggerId", "description": [ "\nThe trigger in which the actions are registered." ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.mode", "type": "Enum", "tags": [], "label": "mode", "description": [ "\nUI configuration. Possible options are `HOVER` and `INLINE`.\n\n`HOVER` shows the actions when the children component is hovered.\n\n`INLINE` always shows the actions." ], "signature": [ { "pluginId": "@kbn/cell-actions", "scope": "common", "docId": "kibKbnCellActionsPluginApi", "section": "def-common.CellActionsMode", "text": "CellActionsMode" } ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.showActionTooltips", "type": "CompoundType", "tags": [], "label": "showActionTooltips", "description": [ "\nIt displays a tooltip for every action button when `true`." ], "signature": [ "boolean | undefined" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.visibleCellActions", "type": "number", "tags": [], "label": "visibleCellActions", "description": [ "\nIt shows 'more actions' button when the number of actions is bigger than this parameter." ], "signature": [ "number | undefined" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.disabledActionTypes", "type": "Array", "tags": [], "label": "disabledActionTypes", "description": [ "\nList of Actions ids that shouldn't be displayed inside cell actions." ], "signature": [ "string[] | undefined" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.metadata", "type": "Object", "tags": [], "label": "metadata", "description": [ "\nCustom set of properties used by some actions.\nAn action might require a specific set of metadata properties to render.\nThis data is sent directly to actions." ], "signature": [ "Metadata | undefined" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsProps.className", "type": "string", "tags": [], "label": "className", "description": [], "signature": [ "string | undefined" ], "path": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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>" ], "path": "packages/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionsMode", "type": "Enum", "tags": [], "label": "CellActionsMode", "description": [], "path": "packages/kbn-cell-actions/src/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "@kbn/cell-actions", "id": "def-common.CellActionExtend", "type": "Type", "tags": [], "label": "CellActionExtend", "description": [ "\nAction factory extend parameter type," ], "signature": [ "Partial & { id: string; }" ], "path": "packages/kbn-cell-actions/src/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": "packages/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]: C[P]; }" ], "path": "packages/kbn-cell-actions/src/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.COPY_CELL_ACTION_TYPE", "type": "string", "tags": [], "label": "COPY_CELL_ACTION_TYPE", "description": [], "signature": [ "\"cellAction-copy\"" ], "path": "packages/kbn-cell-actions/src/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/cell-actions", "id": "def-common.FILTER_CELL_ACTION_TYPE", "type": "string", "tags": [], "label": "FILTER_CELL_ACTION_TYPE", "description": [], "signature": [ "\"cellAction-filter\"" ], "path": "packages/kbn-cell-actions/src/constants.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": "packages/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": "packages/kbn-cell-actions/src/hooks/use_data_grid_column_cell_actions.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "objects": [] } }