-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-grid.feature.GroupingSummary'>/**
+<!DOCTYPE html>
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>The source code</title>
+ <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+ <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+ <style type="text/css">
+ .highlight { display: block; background-color: #ddd; }
+ </style>
+ <script type="text/javascript">
+ function highlight() {
+ document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+ }
+ </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+ <pre class="prettyprint lang-js"><span id='Ext-grid-feature-GroupingSummary'>/**
</span> * @class Ext.grid.feature.GroupingSummary
* @extends Ext.grid.feature.Grouping
- *
+ *
* This feature adds an aggregate summary row at the bottom of each group that is provided
- * by the {@link Ext.grid.feature.Grouping} feature. There are 2 aspects to the summary:
- *
+ * by the {@link Ext.grid.feature.Grouping} feature. There are two aspects to the summary:
+ *
* ## Calculation
- *
+ *
* The summary value needs to be calculated for each column in the grid. This is controlled
* by the summaryType option specified on the column. There are several built in summary types,
* which can be specified as a string on the column configuration. These call underlying methods
*
* Alternatively, the summaryType can be a function definition. If this is the case,
* the function is called with an array of records to calculate the summary value.
- *
+ *
* ## Rendering
- *
+ *
* Similar to a column, the summary also supports a summaryRenderer function. This
* summaryRenderer is called before displaying a value. The function is optional, if
* not specified the default calculated value is shown. The summaryRenderer is called with:
*
* - value {Object} - The calculated value.
- * - data {Object} - Contains all raw summary values for the row.
+ * - summaryData {Object} - Contains all raw summary values for the row.
* - field {String} - The name of the field we are calculating
- *
+ *
* ## Example Usage
*
+ * @example
* Ext.define('TestResult', {
* extend: 'Ext.data.Model',
* fields: ['student', 'subject', {
* type: 'int'
* }]
* });
- *
+ *
* Ext.create('Ext.grid.Panel', {
* width: 200,
* height: 240,
* text: 'Name',
* summaryType: 'count',
* summaryRenderer: function(value){
- * return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : '');
+ * return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : '');
* }
* }, {
* dataIndex: 'mark',
* });
*/
Ext.define('Ext.grid.feature.GroupingSummary', {
-
+
/* Begin Definitions */
-
+
extend: 'Ext.grid.feature.Grouping',
-
+
alias: 'feature.groupingsummary',
-
+
mixins: {
summary: 'Ext.grid.feature.AbstractSummary'
},
-
+
/* End Definitions */
-
-<span id='Ext-grid.feature.GroupingSummary-method-getFeatureTpl'> /**
+
+<span id='Ext-grid-feature-GroupingSummary-method-getFeatureTpl'> /**
</span> * Modifies the row template to include the summary row.
* @private
* @return {String} The modified template
*/
getFeatureTpl: function() {
var tpl = this.callParent(arguments);
-
+
if (this.showSummaryRow) {
// lop off the end </tpl> so we can attach it
tpl = tpl.replace('</tpl>', '');
}
return tpl;
},
-
-<span id='Ext-grid.feature.GroupingSummary-method-getFragmentTpl'> /**
+
+<span id='Ext-grid-feature-GroupingSummary-method-getFragmentTpl'> /**
</span> * Gets any fragments needed for the template.
* @private
* @return {Object} The fragments
getFragmentTpl: function() {
var me = this,
fragments = me.callParent();
-
+
Ext.apply(fragments, me.getSummaryFragments());
if (me.showSummaryRow) {
// this gets called before render, so we'll setup the data here.
}
return fragments;
},
-
-<span id='Ext-grid.feature.GroupingSummary-method-getPrintData'> /**
+
+<span id='Ext-grid-feature-GroupingSummary-method-getPrintData'> /**
</span> * Gets the data for printing a template row
* @private
* @param {Number} index The index in the template
name = me.summaryGroups[index - 1].name,
active = me.summaryData[name],
column;
-
+
for (; i < length; ++i) {
column = columns[i];
column.gridSummaryValue = this.getColumnValue(column, active);
}
return data;
},
-
-<span id='Ext-grid.feature.GroupingSummary-method-generateSummaryData'> /**
+
+<span id='Ext-grid-feature-GroupingSummary-method-generateSummaryData'> /**
</span> * Generates all of the summary data to be used when processing the template
* @private
* @return {Object} The summary data
reader = store.proxy.reader,
groups = me.summaryGroups,
columns = me.view.headerCt.getColumnsForTpl(),
+ remote,
i,
length,
fieldData,
root,
key,
comp;
-
+
for (i = 0, length = groups.length; i < length; ++i) {
data[groups[i].name] = {};
}
-
-<span id='Ext-grid.feature.GroupingSummary-cfg-remoteRoot'> /**
-</span> * @cfg {String} remoteRoot. The name of the property
- * which contains the Array of summary objects. Defaults to <tt>undefined</tt>.
- * It allows to use server-side calculated summaries.
- */
+
+<span id='Ext-grid-feature-GroupingSummary-cfg-remoteRoot'> /**
+</span> * @cfg {String} [remoteRoot=undefined] The name of the property which contains the Array of
+ * summary objects. It allows to use server-side calculated summaries.
+ */
if (me.remoteRoot && reader.rawData) {
// reset reader root and rebuild extractors to extract summaries data
root = reader.root;
reader.root = me.remoteRoot;
reader.buildExtractors(true);
Ext.Array.each(reader.getRoot(reader.rawData), function(value) {
- data[value[groupField]] = value;
- data[value[groupField]]._remote = true;
+ remoteData[value[groupField]] = value;
});
// restore initial reader configuration
reader.root = root;
reader.buildExtractors(true);
}
-
+
for (i = 0, length = columns.length; i < length; ++i) {
comp = Ext.getCmp(columns[i].id);
fieldData = me.getSummary(store, comp.summaryType, comp.dataIndex, true);
-
+
for (key in fieldData) {
if (fieldData.hasOwnProperty(key)) {
- if (!data[key]._remote) {
- data[key][comp.dataIndex] = fieldData[key];
+ data[key][comp.id] = fieldData[key];
+ }
+ }
+
+ for (key in remoteData) {
+ if (remoteData.hasOwnProperty(key)) {
+ remote = remoteData[key][comp.dataIndex];
+ if (remote !== undefined && data[key] !== undefined) {
+ data[key][comp.id] = remote;
}
}
}
return data;
}
});
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>