Properties Methods Events Config Options Direct Link
Observable
  GridView
    GroupingView

Class Ext.grid.GroupingView

Package:Ext.grid
Defined In:GroupingView.js
Class:GroupingView
Extends:GridView
Adds the ability for single level grouping to the grid. A GroupingStore must be used to enable grouping. Some grouping characteristics may also be configured at the Column level

Sample usage:

var grid = new Ext.grid.GridPanel({
    // A groupingStore is required for a GroupingView
    store: new Ext.data.GroupingStore({
        autoDestroy: true,
        reader: reader,
        data: xg.dummyData,
        sortInfo: {field: 'company', direction: 'ASC'},
        groupOnSort: true,
        remoteGroup: true,
        groupField: 'industry'
    }),
    colModel: new Ext.grid.ColumnModel({
        columns:[
            {id:'company',header: 'Company', width: 60, dataIndex: 'company'},
            // groupable, groupName, groupRender are also configurable at column level
            {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price', groupable: false},
            {header: 'Change', dataIndex: 'change', renderer: Ext.util.Format.usMoney},
            {header: 'Industry', dataIndex: 'industry'},
            {header: 'Last Updated', renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'}
        ],
        defaults: {
            sortable: true,
            menuDisabled: false,
            width: 20
        }
    }),

    view: new Ext.grid.GroupingView({
        forceFit: true,
        // custom grouping text template to display the number of items per group
        groupTextTpl: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
    }),

    frame:true,
    width: 700,
    height: 450,
    collapsible: true,
    animCollapse: false,
    title: 'Grouping Example',
    iconCls: 'icon-grid',
    renderTo: document.body
});

Config Options

Config OptionsDefined By
 cancelEditOnToggle : Boolean
True to cancel any editing when the group header is toggled. Defaults to true.
GroupingView
 cellSelector : String
The selector used to find cells internally (defaults to 'td.x-grid3-cell')
GridView
 cellSelectorDepth : Number
The number of levels to search for cells in event delegation (defaults to 4)
GridView
 columnsText : String
The text displayed in the 'Columns' menu item (defaults to 'Columns')
GridView
 deferEmptyText : Boolean
True to defer emptyText being applied until the store's first load (defaults to true).
GridView
 enableGrouping : Boolean
false to disable grouping functionality (defaults to true)
GroupingView
 enableGroupingMenu : Boolean
true to enable the grouping control in the column menu (defaults to true)
GroupingView
 enableNoGroups : Boolean
true to allow the user to turn off grouping (defaults to true)
GroupingView
 groupByText : String
Text displayed in the grid header menu for grouping by a column (defaults to 'Group By This Field').
GroupingView
 groupRenderer : Function
This property must be configured in the Ext.grid.Column for each column.
GroupingView
 headerMenuOpenCls : String
The CSS class to add to the header cell when its menu is visible. Defaults to 'x-grid3-hd-menu-open'
GridView
 hideGroupedColumn : Boolean
true to hide the column that is currently grouped (defaults to false)
GroupingView
 ignoreAdd : Boolean
true to skip refreshing the view when new rows are added (defaults to false)
GroupingView
 markDirty : Boolean
True to show the dirty cell indicator when a cell has been modified. Defaults to true.
GridView
 rowBodySelector : String
The selector used to find row bodies internally (defaults to 'div.x-grid3-row')
GridView
 rowBodySelectorDepth : Number
The number of levels to search for row bodies in event delegation (defaults to 10)
GridView
 rowOverCls : String
The CSS class added to each row when it is hovered over. Defaults to 'x-grid3-row-over'
GridView
 rowSelector : String
The selector used to find rows internally (defaults to 'div.x-grid3-row')
GridView
 rowSelectorDepth : Number
The number of levels to search for rows in event delegation (defaults to 10)
GridView
 showGroupsText : String
Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').
GroupingView
 sortAscText : String
The text displayed in the 'Sort Ascending' menu item (defaults to 'Sort Ascending')
GridView
 sortClasses : Array
The CSS classes applied to a header when it is sorted. (defaults to ['sort-asc', 'sort-desc'])
GridView
 sortDescText : String
The text displayed in the 'Sort Descending' menu item (defaults to 'Sort Descending')
GridView
 startCollapsed : Boolean
true to start all groups collapsed (defaults to false)
GroupingView

Public Properties

PropertyDefined By
 Ext.Template : masterTpl
The master template to use when rendering the GridView. Has a default template
GridView
 bodyTpl : Ext.Template
The template to use when rendering the body. Has a default template
GridView
 cellTpl : Ext.Template
The template to use to render each cell. Has a default template
GridView
 headerTpl : Ext.Template
The template to use when rendering headers. Has a default template
GridView

Public Methods

MethodDefined By

Public Events

EventDefined By