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

ColumnComponent

Represents the columns of the TreeList.

<kendo-treelist [kendoTreeListFlatBinding]="data" ...>
  <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
  <kendo-treelist-column field="title"title="Title"></kendo-treelist-column>
</kendo-treelist>

Selector

kendo-treelist-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. To customize header and footer column cells, use the headerClass and footerClass inputs.

editable

boolean

true

Defines whether the column is editable.

editor

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

'text'

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

expandable

boolean

false

Defines whether the expanded indicator should be rendered in the column.

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.

filterable

boolean

true

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

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.

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).

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.

minResizableWidth

number

10

The width (in pixels) below which the user is not able to resize the column by using the UI.

reorderable

boolean

true

Indicates whether the column is reorderable.

resizable

boolean

true

Indicates whether the column is resizable.

sortable

ColumnSortSettings

Allows the column headers to be clicked and the sortChange event emitted. You have to handle the sortChange event yourself and sort the data.

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