@microsoft/fast-foundation > ColumnDefinition
ColumnDefinition interface
Defines a column in the grid
Signature:export interface ColumnDefinition
Properties
Property | Type | Description |
---|---|---|
cellFocusTargetCallback | (cell: DataGridCell) => HTMLElement | Callback function that returns the element to focus in a custom cell. When cellInternalFocusQueue is false this function is called when the cell is first focused to immediately move focus to a cell element, for example a cell that is a checkbox could move focus directly to the checkbox. When cellInternalFocusQueue is true this function is called when the user hits Enter or F2 |
cellInternalFocusQueue | boolean | Whether the cell has an internal focus queue |
cellTemplate | ViewTemplate | cell template |
columnDataKey | string | Identifies the data item to be displayed in this column (i.e. how the data item is labelled in each row) |
gridColumn | string | Sets the css grid-column property on the cell which controls its placement in the parent row. If left unset the cells will set this value to match the index of their column in the parent collection of ColumnDefinitions. |
headerCellFocusTargetCallback | (cell: DataGridCell) => HTMLElement | Callback function that returns the element to focus in a custom cell. When headerCellInternalFocusQueue is false this function is called when the cell is first focused to immediately move focus to a cell element, for example a cell that is a checkbox could move focus directly to the checkbox. When headerCellInternalFocusQueue is true this function is called when the user hits Enter or F2 |
headerCellInternalFocusQueue | boolean | Whether the header cell has an internal focus queue |
headerCellTemplate | ViewTemplate | Header cell template |
isRowHeader | boolean | Whether this column is the row header |
title | string | Column title, if not provided columnDataKey is used as title |