Docs
API
  • select

    Select column type

    Select column. It enables checkbox row selection.
    Another solution to reach similiar functionality to use property select for column.

    Example

    
    columns: [{
    ...
    },{
      type: 'select',
      locked: true
    },{
    ...
    

    cls

    String

    Column css className.

    
    .my-select {
      background-color: #ccc;
    }
    ...
    columns: [{
      type: 'select',
      cls: 'my-select'
    },{
    ...
    

    columnMenu

    Boolean

    Enable/disable column for menu.

    
    columns: [{
      title: 'Company',
      index: 'name',
      columnMenu: false,
      type: 'string',
      width: 200,
    }, {
      text: 'Stock Price',
      columns: [{
        title: 'Price',
        index: 'price'
      }, {
        title: 'Change',
        index: 'change',
        render: renderChangesFn
      }, {
        title: '% Change',
        index: 'pctChange',
        render: renderChangesFn
      }]
    }, {
      title: 'Last Updated',
      index: 'lastChange',
      type: 'string',
      width: 97
    }]
    ...
    
    undefined

    draggable

    Boolean

    Allows column to be dragged.

    
    draggable: true,
    
    false

    id

    String

    Column id was added to solve cases when column does not have data index or data index is repeated on several columns.
    If column id is not provided that it will be auto generated on base of column data index or random value.

    
    columns: [{
      type: 'string',
      title: 'Name',
      index: 'name',
      id: 'name',
      width: 80,
      align: 'center'
    },{
        
    Auto generation.

    headerCheckBox

    Boolean

    Configure as true to display a checkbox below the header text.
    Clicking the checkbox will check/uncheck all records.

    
    selModel: {
      type: 'rows'
    },
    columns: [{
      type: 'select',
      headerCheckBox: false
    },{
    

    For select column type if selModel type is rows

    true

    headerCls

    String

    It is used only for checkbox column type.
    Configure as true to display a checkbox below the header text.
    Clicking the checkbox will check/uncheck all records.

    
    {
      index: 'company',
      type: 'string',
      title: 'Company',
      headerCls: 'header-cell-company'
    }
    
    undefined

    hidden

    Boolean

    Hide column on start.

    
    {
      index: 'married',
      resizable: true,
      type: 'checkbox',
      title: 'Married',
      width: 100,
      hidden: true
    }
    
    false

    lockable

    Boolean

    Enable/disable column locking.

    
    locked: false,
    
    true

    locked

    Boolean

    Locking column.

    
    {
      type: 'select',
      width: 65,
      locked: true
    }
    
    False

    maxWidth

    Number

    The maximum width of column.

    
    maxWidth: 150,
    

    menu

    Mixed

    Enables column menu.

    
    menu: true,
    

    Example: Custom Default menu

    
    menu: ['sort', '-', 'columns', '-', 'lock'],
    

    Example: Custom menu

    
    menu: ['columns', '-', {
      text: 'Hi',
      handler: function(){
    	alert('Hi');
      }
    }],
    

    Example: One menu with columns only

    
    menu: 'columns',
    
    false

    minWidth

    Number

    The minimum width of column.

    
    minWidth: 80,
    

    resizable

    Boolean

    Enable resizing of column.

    
    resizable: true,
    
    False

    rightLocked

    Boolean

    Locking column to right side.

    
    {
      type: 'select',
      width: 65,
      rightLocked: true
    }
    
    False

    type

    String

    Column type.

    
    {
      type: 'select'
    }
    

    width

    Number

    column width.

    
    {
      type: 'select',
      width: 65
    }