React Data GridColumn Reference

Attributes and methods available on the Column instance.

Clipboard

isSuppressPaste
Function
Returns true if paste is suppress for this column and row node.

Column Groups

getParent
Function
Returns the parent column group, if column grouping is active.
getOriginalParent
Function
Returns the parent column group, if this column is part of a column group.
getColumnGroupShow
Function
Returns whether this column should be shown when the group is open / closed or undefined if its always shown.
getColumnGroupPaddingInfo
Function
Returns column group padding info.
isEmptyGroup
Function
Returns true if this is an empty group.

Definitions

getColId
Function
Returns the unique ID for the column. Equivalent: getId, getUniqueId
getColDef
Function
Returns the column definition for this column. The column definition will be the result of merging the application provided column definition with any provided defaults (e.g. defaultColDef grid option, or column types. Equivalent: getDefinition
getUserProvidedColDef
Function
Returns the column definition provided by the application. This may not be correct, as items can be superseded by default column options. However it's useful for comparison, eg to know which application column definition matches that column.
isHovered
Function
Returns true when this Column is hovered, otherwise false
isColumn
true
isColumn is always true. Used to distinguish between columns and column groups.

Display

getLeft
Function
Returns the left position of the column.
isVisible
Function
Returns true if the column is visible.

Editing

isCellEditable
Function
Returns true if the cell for this column is editable for the given rowNode, otherwise false.
isSuppressFillHandle
Function
Returns true if the fill handle is suppressed.

Events

addEventListener
Function
Add an event listener to the column.
removeEventListener
Function
Remove event listener from the column.

Filtering

isFilterAllowed
Function
Returns true if column filtering is allowed.
isFilterActive
Function
Returns true if filter is active on the column.

Keyboard

isSuppressNavigable
Function
Returns true if navigation is suppressed for the given column and rowNode.

Menu

isMenuVisible
Function
Returns true if a menu is visible for this column.

Moving

isMoving
Function
Returns true while the column is being moved.

Pinning

getPinned
Function
Returns the pinned state of the column.
isPinned
Function
Returns true if this column is pinned either left of right.
isPinnedLeft
Function
Returns true if this column is pinned left.
isPinnedRight
Function
Returns true if this column is pinned right.
isFirstRightPinned
Function
Returns true if this column is the first right pinned column.
isLastLeftPinned
Function
Returns true if this column is the last left pinned column.

Pivoting

isAllowPivot
Function
Returns true if pivoting is allowed for this column
isPivotActive
Function
Returns true if pivot is currently active for this column.
isPrimary
Function
Returns true if column is a primary column, false if secondary. Secondary columns are used for pivoting.

Row Dragging

isRowDrag
Function
Returns true if this column and row node can be dragged.
isDndSource
Function
Returns true if this column and row node allows dragging for native drag and drop.

Row Grouping

isAllowValue
Function
Returns true if this column can be used as a value column.
isValueActive
Function
Returns true if value (aggregation) is currently active for this column.
isAllowRowGroup
Function
Returns true if this column can be used as a row group column.
isRowGroupActive
Function
Returns true if row group is currently active for this column.
getAggFunc
Function
If aggregation is set for the column, returns the aggregation function.
isRowGroupDisplayed
Function
Returns true if this column group is being used to display a row group value.

Selection

isCellCheckboxSelection
Function
Returns true if this column and row node has checkbox selection.

Sizing

getActualWidth
Function
Returns the current width of the column. If the column is resized, the actual width is the new size.
getMinWidth
Function
Returns the minWidth of the column or the default min width.
getMaxWidth
Function
Returns the max width for the column.
getFlex
Function
Returns the flex value of the column or 0 if not set.
isResizable
Function
Returns true if this group is resizable.
isAutoHeight
Function
Returns true if the column has autoHeight enabled.
isAutoHeaderHeight
Function
Returns true if the column header has autoHeight enabled.
getAutoHeaderHeight
Function
Returns the auto header height.
isSpanHeaderHeight
Function
Returns true if this column spans the header height.

Sorting

getSort
Function
If sorting is active, returns the sort direction e.g. 'asc' or 'desc'.
isSortable
Function
Returns true if sorting is enabled for this column via the sortable property.
getSortIndex
Function
Returns the sort index for this column.

Spanning

getColSpan
Function
Returns the column span for this column and row node.
getRowSpan
Function
Returns the row span for this column and row node.

Tooltip

isTooltipEnabled
Function
Returns true if a tooltip is enabled for this column.