Sets/gets custom properties provided in additional template context.

Sets/gets whether the column header is included in autosize logic. Useful when template for a column header is sized based on parent, for example a default div. Default value is false.

Sets a conditional class selector of the column cells. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean, like so:

Sets conditional style properties on the column cells. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated. As with cellClasses it accepts a callback function.

Column index where the current field should end. The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field

Allows you to define a custom template for expand/collapse indicator

Column index from which the field is starting.

Sets/gets the data type of the column values. Default value is string.

Gets whether the hiding is disabled.

Gets whether the pinning is disabled.

Emitted when the column expanded or collapsed.

Sets/gets whether the column is filterable. Default value is true.

Sets/gets whether the column filtering should be case sensitive. Default value is true.

Applies display format to cell values in the column. Does not modify the underlying data.

Represents the instance of the parent GridType that contains this column.

Sets/gets the header value.

Sets/gets the class selector of the column header.

Sets/gets the class selector of the column group header.

Sets conditional style properties on the column header group wrapper. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

Sets conditional style properties on the column header. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

Emitted when the column is hidden or shown.

Sets/gets the parent column.

Emitted when the column is pinned/unpinned.

Sets/gets whether the column is resizable. Default value is false.

Row index where the current field should end. The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field

Row index from which the field is starting.

Sets/gets whether the column group is searchable. Default value is true.

Sets/gets whether the column is sortable. Default value is false.

Sets/gets whether the column sorting should be case sensitive. Default value is true.

The summaryFormatter is used to format the display of the column summaries.

In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.

Sets/gets the title value.

Emitted when the column width changes.

Indicated whether the column can be edited. If the value is true, the column can be edited

Sets properties on the default column editors

The internal field name, used in expressions and queries.

Represents a custom template for filtering It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

Optional filtering operands that apply to this field.

Indicates whether a column can be put in a group. If the value is true, the column can be put in a group

Represents a method with custom grouping comparator to determine the members of the group.

The template reference for the custom header of the column It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible

Indicates if the column is currently pinned. If the value is true, the column is pinned

Optional arguments for any pipe applied to the field.

Indicates if the column is currently selected. If the value is true, the column is selected

The sorting strategy used for sorting this column. The interface contains a method sort that sorts the provided data based on the given sorting expressions

The template reference for a summary of the column It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

Autosize the column to the longest currently visible cell value, including the header cell.

Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.

Pins the column in the specified position at the provided index in that pinned area. Defaults to index 0 if not provided, or to the initial index in the pinned area. Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. Column cannot be pinned if:

• Is already pinned
• index argument is out of range

Unpins the column and place it at the provided index in the unpinned area. Defaults to index 0 if not provided, or to the initial index in the unpinned area. Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. Column cannot be unpinned if:

• Is already unpinned
• index argument is out of range