ColumnComponent
Represents a column in the TreeList. Use this component to define a data-bound column.
Definition
Package:@progress/kendo-angular-treelist
Selector:kendo-treelist-column
Syntax:
<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>Inputs
autoSize
boolean
Indicates whether the column is automatically resized during initialization to fit its header and row content.
class
string | string[] | Set<string> | { [key: string]: any }
Sets custom CSS classes to the column cells. Uses the NgClass directive. To customize header and footer column cells, use the headerClass and footerClass inputs.
columnMenu
boolean
Specifies if the column menu is shown for the column.
true
editable
boolean
Specifies if the column is editable.
true
editor
"boolean" | "text" | "numeric" | "date"
Sets the editor type (see example). Used when the column enters edit mode.
'text'
expandable
boolean
Specifies if the expanded indicator appears in the column.
field
string
Sets the field to which the column is bound.
filter
"boolean" | "text" | "numeric" | "date"
Sets the filter type displayed inside the filter row.
'text'
filterable
boolean
Specifies if a filter UI appears for this column.
true
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 custom styles for the footer cell of the column. Uses the NgStyle directive. See example.
format
any
Sets the format applied to the value before display. For supported date and number formats, see the Column Formats article.
headerClass
string | string[] | Set<string> | { [key: string]: any }
Sets custom CSS classes to the column header cell. Uses the NgClass directive. See example.
headerStyle
{ [key: string]: string }
Sets custom styles for the header cell of the column. Uses the NgStyle directive. See example.
hidden
boolean
Sets the visibility of the column (see example).
false
includeInChooser
boolean
Specifies if the column is included in the column-chooser list.
true
lockable
boolean
Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
true
locked
boolean
Toggles the locked (frozen) state of the columns (more information and example).
false
media
string
Sets the condition that must be satisfied for a column to remain visible (see example).
If you set the hidden property, the behavior of media is overridden.
minResizableWidth
number
Sets the minimum width (in pixels) for resizing the column using the UI.
10
reorderable
boolean
Indicates whether the column is reorderable.
true
resizable
boolean
Indicates whether the column is resizable.
true
resizeStep
number
Sets the distance in pixels by which the column width is adjusted during keyboard navigation resizing.
Used when resizing columns with Alt/Option + Left/Right Arrow keyboard shortcuts.
10
Allows the column headers to be clicked and the sortChange event emitted. You must handle the sortChange event and sort the data.
true
style
{ [key: string]: string }
Sets custom styles for the table cells (excluding the footer and header) of the column. Uses the NgStyle directive. See example.
tableCellsRole
string
Sets the role attribute for the table cells (excluding the footer and header) of the column.
'gridcell'
title
string
Sets the title of the column.
width
number
Sets the width of the column (in pixels).
Fields
orderIndex
number
The column index after reordering. The orderIndex` is a read-only property. Setting this field does not affect column order.
0