ContextMenuContext

Provides full details about current cell (and selected cells) where the Context Menu will appear

TypeScript
export interface ContextMenuContext<TData = any> extends
Extends

BaseContext

Properties

PropertyTypeDescription
adaptableColumnAdaptableColumn<TData>Current AdapTable Column
agGridColumnColumnCurrent AG Grid Column
gridCellGridCell<TData>Cell that has been clicked; contains cell value
isGroupedNodebooleanWhether current AG Grid row node is grouped
isRowGroupColumnbooleanWhether current Column is Row Grouped
isSelectedCellbooleanWhether cell that was clicked is also currently selected
isSelectedRowbooleanWhether cell that was clicked is in a Row that is currently selected
isSingleSelectedCellbooleanWhether the clicked cell is the only selected cell
isSingleSelectedColumnbooleanWhether Column that was clicked is only column with selected cells
primaryKeyValueanyValue of Primary Key column in current row
rowNodeIRowNode<TData>Current AG Grid row node
selectedCellInfoSelectedCellInfo<TData>Currently selected cells in the grid
selectedRowInfoSelectedRowInfo<TData>Currently selected rows in the grid
adaptableContextanyCustom application Context provided in AdaptableOptions.adaptableContext

Property Details

adaptableColumn

Current AdapTable Column

TypeScript
adaptableColumn: AdaptableColumn<TData>;
Property Value

AdaptableColumn<TData>

agGridColumn

Current AG Grid Column

TypeScript
agGridColumn: Column;
Property Value

Column

gridCell

Cell that has been clicked; contains cell value

TypeScript
gridCell: GridCell<TData>;
Property Value

GridCell<TData>

isGroupedNode

Whether current AG Grid row node is grouped

TypeScript
isGroupedNode: boolean;
Property Value

boolean

isRowGroupColumn

Whether current Column is Row Grouped

TypeScript
isRowGroupColumn: boolean;
Property Value

boolean

isSelectedCell

Whether cell that was clicked is also currently selected

TypeScript
isSelectedCell: boolean;
Property Value

boolean

isSelectedRow

Whether cell that was clicked is in a Row that is currently selected

TypeScript
isSelectedRow: boolean;
Property Value

boolean

isSingleSelectedCell

Whether the clicked cell is the only selected cell

TypeScript
isSingleSelectedCell: boolean;
Property Value

boolean

isSingleSelectedColumn

Whether Column that was clicked is only column with selected cells

TypeScript
isSingleSelectedColumn: boolean;
Property Value

boolean

primaryKeyValue

Value of Primary Key column in current row

TypeScript
primaryKeyValue: any;
Property Value

any

rowNode

Current AG Grid row node

TypeScript
rowNode: IRowNode<TData>;
Property Value

IRowNode<TData>

selectedCellInfo

Currently selected cells in the grid

TypeScript
selectedCellInfo: SelectedCellInfo<TData>;
Property Value

SelectedCellInfo<TData>

selectedRowInfo

Currently selected rows in the grid

TypeScript
selectedRowInfo: SelectedRowInfo<TData>;
Property Value

SelectedRowInfo<TData>

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript
adaptableContext: any;
Property Value

any