GroupSummary

Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as Summary.

This feature is disabled by default.

new Grid({
    features : {
        group        : 'city',
        groupSummary : true
    },
    columns : [
        { text : 'Score', data : 'score', width : 80, sum : 'sum' }
        { text : 'Rank', data : 'rank', width : 80, sum : 'average', summaryRenderer: ({ sum }) => return 'Average rank ' + sum }
    ]
})

Group summary

//<code-header>
fiddle.title = 'Group summary';
//</code-header>
const grid = new Grid({
    appendTo : targetElement,

    // makes grid as high as it needs to be to fit rows
    autoHeight : true,

    features : {
        group        : 'city',
        groupSummary : true
    },

    data : DataGenerator.generateData(10),

    columns : [
        { field : 'name', text : 'Name', flex : 1 },
        { field : 'city', text : 'City', flex : 1, summaries : [{ sum : 'count', label : 'Rows' }] },
        { field : 'score', text : 'Score', flex : 1, summaries : [{ sum : 'avg', label : 'Average' }] }
    ]
});

Configs

Common

disabledInstancePlugin

listenersEvents

Other

collapseToHeader: BooleanAlso a property

Configure as true to have group summaries rendered in the group header when a group is collapsed.

const grid = new Grid({
   features : {
       groupSummary : {
           collapseToHeader : true
       }
   }
});

Only applies when target is 'footer' (the default).

target: header | footer= footerAlso a property

Where to render the group summaries to, either header to display them in the group header or footer to display them in the group footer (the default).

const grid = new Grid({
   features : {
       groupSummary : {
           target : 'header'
       }
   }
});

catchEventHandlerExceptionsEvents

Misc

bubbleEventsEvents

callOnFunctionsEvents

clientInstancePlugin

localeClassLocalizable

localizableLocalizable

localizablePropertiesLocalizable

Properties

Common

disabledInstancePlugin

Class hierarchy

isGroupSummary: Boolean= truereadonly

Identifies an object as an instance of GroupSummary class, or subclass thereof.

isGroupSummary: Boolean= truereadonlystatic

Identifies an object as an instance of GroupSummary class, or subclass thereof.

isEventsEvents

isInstancePluginInstancePlugin

isLocalizableLocalizable

Other

collapseToHeader: BooleanAlso a config

Set to true to have group summaries rendered in the group header when a group is collapsed.

Only applies when target is 'footer' (the default).

target: header | footerAlso a config

Where to render the group summaries to, either header to display them in the group header or footer to display them in the group footer (the default).

catchEventHandlerExceptionsEvents