Skip to main content
Version: 1.x

@microsoft/fast-foundation > ColumnDefinition

ColumnDefinition interface

Defines a column in the grid

Signature:
export interface ColumnDefinition 

Properties

PropertyTypeDescription
cellFocusTargetCallback(cell: DataGridCell) => HTMLElementCallback 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
cellInternalFocusQueuebooleanWhether the cell has an internal focus queue
cellTemplateViewTemplatecell template
columnDataKeystringIdentifies the data item to be displayed in this column (i.e. how the data item is labelled in each row)
gridColumnstringSets 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) => HTMLElementCallback 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
headerCellInternalFocusQueuebooleanWhether the header cell has an internal focus queue
headerCellTemplateViewTemplateHeader cell template
isRowHeaderbooleanWhether this column is the row header
titlestringColumn title, if not provided columnDataKey is used as title