Components / Grid / API

ColumnComponent

Represents the columns of the Grid.

@Component({
   selector: 'my-app',
   template: `
       <kendo-grid [data]="gridData">
         <kendo-grid-column field="ProductID" title="Product ID" width="120">
         </kendo-grid-column>
         <kendo-grid-column field="ProductName" title="Product Name">
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
         <kendo-grid-column field="Discontinued" width="120">
             <ng-template kendoGridCellTemplate let-dataItem>
                 <input type="checkbox" [checked]="dataItem.Discontinued" disabled/>
             </ng-template>
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = products;
   }
}

const products = [{
   "ProductID": 1,
   "ProductName": "Chai",
   "UnitPrice": 18.0000,
   "Discontinued": true
 }, {
   "ProductID": 2,
   "ProductName": "Chang",
   "UnitPrice": 19.0000,
   "Discontinued": false
 }
];

Selector

kendo-grid-column

Inputs

columnMenu boolean

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

class string | string[] | Set | {[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.

import { Component, ViewEncapsulation } from '@angular/core';

@Component({
   selector: 'my-app',
   encapsulation: ViewEncapsulation.None,
   styles: [`
       tr .myClass {
           text-align: right
      }
   `],
   template: `
       <kendo-grid [data]="gridData" style="height: 200px">
         <kendo-grid-column field="ProductName" title="Product Name" width="200" [class]="{'myClass': true}">
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = [{
           "ProductID": 1,
           "ProductName": "Chai",
           "UnitPrice": 18.0000,
           "Discontinued": true
         }, {
           "ProductID": 2,
           "ProductName": "Chang",
           "UnitPrice": 19.0000,
           "Discontinued": false
         }];
   }
}

editable boolean

Defines whether the column is editable. The default value is true.

<kendo-grid>
   <kendo-grid-column field="UnitPrice" [editable]="false">
   </kendo-grid-column>
</kendo-grid>

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

Defines the editor type (see example).
Used when the column enters the edit mode. The default value is text.

<kendo-grid>
   <kendo-grid-column field="UnitPrice" [editor]="'numeric'">
   </kendo-grid-column>
</kendo-grid>

field string

The field to which the column is bound.

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

Defines the filter type that is displayed inside the filter row. The default value is text.

<kendo-grid>
   <kendo-grid-column field="UnitPrice" [filter]="'numeric'">
   </kendo-grid-column>
</kendo-grid>

filterable boolean

Defines if a filter UI will be displayed for this column. The default value is true.

<kendo-grid>
   <kendo-grid-column field="UnitPrice" [filterable]="false">
   </kendo-grid-column>
</kendo-grid>

footerClass string | string[] | Set | {[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.

import { Component, ViewEncapsulation } from '@angular/core';

@Component({
   selector: 'my-app',
   encapsulation: ViewEncapsulation.None,
   styles: [`
       tr .myClass {
           text-align: right
      }
   `],
   template: `
       <kendo-grid [data]="gridData" style="height: 200px">
         <kendo-grid-column field="ProductName" title="Product Name" width="200" [footerClass]="{'myClass': true}">
             <ng-template kendoGridFooterTemplate>
                 footer text
             </ng-template>
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = [{
           "ProductID": 1,
           "ProductName": "Chai",
           "UnitPrice": 18.0000,
           "Discontinued": true
         }, {
           "ProductID": 2,
           "ProductName": "Chang",
           "UnitPrice": 19.0000,
           "Discontinued": false
         }];
   }
}

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.

@Component({
   selector: 'my-app',
   template: `
       <kendo-grid [data]="gridData" style="height: 200px">
         <kendo-grid-column field="ProductName" title="Product Name" width="200" [footerStyle]="{'text-align': 'right'}">
             <ng-template kendoGridFooterTemplate>
                 footer text
             </ng-template>
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = [{
           "ProductID": 1,
           "ProductName": "Chai",
           "UnitPrice": 18.0000,
           "Discontinued": true
         }, {
           "ProductID": 2,
           "ProductName": "Chang",
           "UnitPrice": 19.0000,
           "Discontinued": false
         }];
   }
}

format any

The format that is applied to the value before it is displayed.
Takes the {0:format} form where format is a standard number format, a custom number format,
a standard date format, a custom date format or a format object. For more information on the supported date and number formats,
refer to the kendo-intl documentation.

Standard format:

<kendo-grid>
   <kendo-grid-column field="UnitPrice" format="{0:c}">
   </kendo-grid-column>
</kendo-grid>

Format object for currency:

<kendo-grid>
   <kendo-grid-column field="UnitPrice" [format]="{ style: 'currency', currency: 'EUR' }">
   </kendo-grid-column>
</kendo-grid>

Format object for dates:

<kendo-grid>
   <kendo-grid-column field="FirstOrderedOn" [format]="{ date: 'short' }">
   </kendo-grid-column>
</kendo-grid>

groupable boolean

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

headerClass string | string[] | Set | {[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.

import { Component, ViewEncapsulation } from '@angular/core';

@Component({
   selector: 'my-app',
   encapsulation: ViewEncapsulation.None,
   styles: [`
       tr .myClass {
           text-align: right
      }
   `],
   template: `
       <kendo-grid [data]="gridData" style="height: 200px">
         <kendo-grid-column field="ProductName" title="Product Name" width="200" [headerClass]="{'myClass': true}">
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = [{
           "ProductID": 1,
           "ProductName": "Chai",
           "UnitPrice": 18.0000,
           "Discontinued": true
         }, {
           "ProductID": 2,
           "ProductName": "Chang",
           "UnitPrice": 19.0000,
           "Discontinued": false
         }];
   }
}

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.

@Component({
   selector: 'my-app',
   template: `
       <kendo-grid [data]="gridData" style="height: 200px">
         <kendo-grid-column field="ProductName" title="Product Name" width="200" [headerStyle]="{'text-align': 'right'}">
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = [{
           "ProductID": 1,
           "ProductName": "Chai",
           "UnitPrice": 18.0000,
           "Discontinued": true
         }, {
           "ProductID": 2,
           "ProductName": "Chang",
           "UnitPrice": 19.0000,
           "Discontinued": false
         }];
   }
}

hidden boolean (default: false)

Sets the visibility of the column (see example).

includeInChooser boolean

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

lockable boolean

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

locked boolean (default: false)

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

@Component({
   selector: 'my-app',
   template: `
       <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
         <kendo-grid-column field="ProductID" title="Product ID" width="120" [locked]="true">
         </kendo-grid-column>
         <kendo-grid-column field="ProductName" title="Product Name" width="200">
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = products;
   }
}

const products = [{
   "ProductID": 1,
   "ProductName": "Chai",
   "UnitPrice": 18.0000,
   "Discontinued": true
 }, {
   "ProductID": 2,
   "ProductName": "Chang",
   "UnitPrice": 19.0000,
   "Discontinued": false
 }
];

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.

<kendo-grid>
   <kendo-grid-column field="UnitPrice" [media]="'(min-width: 320px)'">
   </kendo-grid-column>
</kendo-grid>

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

  • "xs"—Equivalent to "(max-width: 576px)".
  • "sm"—Equivalent to "(min-width: 576px)".
  • "md"—Equivalent to "(min-width: 768px)".
  • "lg"—Equivalent to "(min-width: 992px)".
  • "xl"—Equivalent to "(min-width: 1200px)".
<kendo-grid>
   <kendo-grid-column field="UnitPrice" [media]="'md'">
   </kendo-grid-column>
</kendo-grid>

minResizableWidth number

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

reorderable boolean (default: true)

Indicates whether the column is reorderable.

resizable boolean (default: true)

Indicates whether the column is resizable.

sortable boolean | 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.

@Component({
   selector: 'my-app',
   template: `
       <kendo-grid [data]="gridData" style="height: 200px">
         <kendo-grid-column field="ProductName" title="Product Name" width="200" [style]="{'text-align': 'right'}">
         </kendo-grid-column>
         <kendo-grid-column field="UnitPrice" title="Unit Price" width="230">
         </kendo-grid-column>
       </kendo-grid>
   `
})

class AppComponent {
   public gridData: any[];

   constructor() {
       this.gridData = [{
           "ProductID": 1,
           "ProductName": "Chai",
           "UnitPrice": 18.0000,
           "Discontinued": true
         }, {
           "ProductID": 2,
           "ProductName": "Chang",
           "UnitPrice": 19.0000,
           "Discontinued": false
         }];
   }
}

title string

The title of the column.

width number

The width of the column (in pixels).

Fields

orderIndex number

The column index after reordering.

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