Components / Grid / API / ColumnComponent / 
New to Kendo UI for Angular? Start a free 30-day trial

ColumnComponent

Represents the column of the Grid. See example

<kendo-grid [data]="gridData">
  <kendo-grid-column field="ProductID" title="Product ID"></kendo-grid-column>
  <kendo-grid-column field="ProductName" title="Product Name"></kendo-grid-column>
  <kendo-grid-column field="UnitPrice" title="Unit Price"></kendo-grid-column>
</kendo-grid>

Selector

kendo-grid-column

Inputs

NameTypeDefaultDescription

autoSize

boolean

Indicates whether the column will be resized during initialization so that it fits its header and row content.

columnMenu

boolean

true

Specifies if the column menu will be shown for the column.

class

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the column cells. Under the hood, to apply the property, the class option uses the NgClass directive. See example. To customize header and footer column cells, use the headerClass and footerClass inputs.

editable

boolean

true

Defines whether the column is editable. See example.

editor

"boolean" | "text" | "numeric" | "date"

'text'

Defines the editor type. See example. Used when the column enters the edit mode.

field

string

The field to which the column is bound.

filter

"boolean" | "text" | "numeric" | "date"

'text'

Defines the filter type that is displayed inside the filter row. See example.

filterable

boolean

true

Defines if a filter UI will be displayed for this column. See example.

filterClass

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the filter row cell. Under the hood, to apply the property, the filterClass option uses the NgClass directive. See example.

filterStyle

{[key: string]: string}

Sets the custom styles for the filter row cell. Under the hood, to apply the property, the filterStyle option uses the NgStyle directive. See example.

footerClass

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the column footer cell. Under the hood, to apply the property, the footerClass option uses the NgClass directive. See example.

footerStyle

{[key: string]: string}

Sets the custom styles for the footer cell of the column. Under the hood, to apply the property, the footerStyle option uses the NgStyle directive. See example.

format

any

The format that is applied to the value before it is displayed. For more information on the supported date and number formats, refer to the Column Formats documentation article.

groupable

boolean

true

Determines if the column can be dragged to the group panel. If set to false, you can group the columns by the column field by using the API of the Grid.

headerClass

string | string[] | Set<string> | {[key: string]: any}

Sets the custom CSS classes to the column header cell. Under the hood, to apply the property, the headerClass option uses the NgClass directive. See example.

headerStyle

{[key: string]: string}

Sets the custom styles for the header cell of the column. Under the hood, to apply the property, the headerStyle option uses the NgStyle directive. See example.

hidden

boolean

false

Sets the visibility of the column (see example).

includeInChooser

boolean

true

Specifies if the column will be included in the column-chooser list.

lockable

boolean

true

Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.

locked

boolean

false

Toggles the locked (frozen) state of the columns (more information and example).

maxResizableWidth

number

The width (in pixels) above which the user is not able to resize the column by using the UI (see example). By default, the maximum width is not restricted. The autoFitColumn and autoFitColumns methods have higher priority.

media

string

Sets the condition that needs to be satisfied for a column to remain visible (see example). If you set the hidden property, the behavior of media is overridden.

Accepts the device identifiers that are available in Bootstrap 4 (see example):

minResizableWidth

number

10

The width (in pixels) below which the user is not able to resize the column by using the UI (see example). The autoFitColumn and autoFitColumns methods have higher priority.

reorderable

boolean

true

Indicates whether the column is reorderable.

resizable

boolean

true

Indicates whether the column is resizable.

sortable

boolean | ColumnSortSettings

true

Allows the user to click the column headers and emits the sortChange event. See example.

stickable

boolean

true

Specifies if the column can be stuck or unstuck from the column menu.

sticky

boolean

false

Determines whether the column will be always visible when scrolling the Grid horizontally.

style

{[key: string]: string}

Sets the custom styles for the table cells (excluding the footer and header ones) of the column. Under the hood, to apply the property, the style option uses the NgStyle directive. See example.

tableCellsRole

string

"gridcell"

Allows setting the role attribute for the table cells (excluding the footer and header ones) of the column.

title

string

The title of the column.

width

number

The width of the column (in pixels).

Fields

NameTypeDefaultDescription

orderIndex

number

0

The column index after reordering. The orderIndex is a read-only property. Setting this field does not affect column order.

In this article

Not finding the help you need?

Contact Support