docs/source/Summary.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-grid-feature-Summary'>/**
  19 </span> * @class Ext.grid.feature.Summary
  20  * @extends Ext.grid.feature.AbstractSummary
  21  *
  22  * This feature is used to place a summary row at the bottom of the grid. If using a grouping,
  23  * see {@link Ext.grid.feature.GroupingSummary}. There are 2 aspects to calculating the summaries,
  24  * calculation and rendering.
  25  *
  26  * ## Calculation
  27  * The summary value needs to be calculated for each column in the grid. This is controlled
  28  * by the summaryType option specified on the column. There are several built in summary types,
  29  * which can be specified as a string on the column configuration. These call underlying methods
  30  * on the store:
  31  *
  32  *  - {@link Ext.data.Store#count count}
  33  *  - {@link Ext.data.Store#sum sum}
  34  *  - {@link Ext.data.Store#min min}
  35  *  - {@link Ext.data.Store#max max}
  36  *  - {@link Ext.data.Store#average average}
  37  *
  38  * Alternatively, the summaryType can be a function definition. If this is the case,
  39  * the function is called with an array of records to calculate the summary value.
  40  *
  41  * ## Rendering
  42  * Similar to a column, the summary also supports a summaryRenderer function. This
  43  * summaryRenderer is called before displaying a value. The function is optional, if
  44  * not specified the default calculated value is shown. The summaryRenderer is called with:
  45  *
  46  *  - value {Object} - The calculated value.
  47  *  - summaryData {Object} - Contains all raw summary values for the row.
  48  *  - field {String} - The name of the field we are calculating
  49  *
  50  * ## Example Usage
  51  *
  52  *     Ext.define('TestResult', {
  53  *         extend: 'Ext.data.Model',
  54  *         fields: ['student', {
  55  *             name: 'mark',
  56  *             type: 'int'
  57  *         }]
  58  *     });
  59  *
  60  *     Ext.create('Ext.grid.Panel', {
  61  *         width: 200,
  62  *         height: 140,
  63  *         renderTo: document.body,
  64  *         features: [{
  65  *             ftype: 'summary'
  66  *         }],
  67  *         store: {
  68  *             model: 'TestResult',
  69  *             data: [{
  70  *                 student: 'Student 1',
  71  *                 mark: 84
  72  *             },{
  73  *                 student: 'Student 2',
  74  *                 mark: 72
  75  *             },{
  76  *                 student: 'Student 3',
  77  *                 mark: 96
  78  *             },{
  79  *                 student: 'Student 4',
  80  *                 mark: 68
  81  *             }]
  82  *         },
  83  *         columns: [{
  84  *             dataIndex: 'student',
  85  *             text: 'Name',
  86  *             summaryType: 'count',
  87  *             summaryRenderer: function(value, summaryData, dataIndex) {
  88  *                 return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : '');
  89  *             }
  90  *         }, {
  91  *             dataIndex: 'mark',
  92  *             text: 'Mark',
  93  *             summaryType: 'average'
  94  *         }]
  95  *     });
  96  */
  97 Ext.define('Ext.grid.feature.Summary', {
  98
  99     /* Begin Definitions */
 100
 101     extend: 'Ext.grid.feature.AbstractSummary',
 102
 103     alias: 'feature.summary',
 104
 105     /* End Definitions */
 106
 107 <span id='Ext-grid-feature-Summary-method-getFragmentTpl'>    /**
 108 </span>     * Gets any fragments needed for the template.
 109      * @private
 110      * @return {Object} The fragments
 111      */
 112     getFragmentTpl: function() {
 113         // this gets called before render, so we'll setup the data here.
 114         this.summaryData = this.generateSummaryData();
 115         return this.getSummaryFragments();
 116     },
 117
 118 <span id='Ext-grid-feature-Summary-method-getTableFragments'>    /**
 119 </span>     * Overrides the closeRows method on the template so we can include our own custom
 120      * footer.
 121      * @private
 122      * @return {Object} The custom fragments
 123      */
 124     getTableFragments: function(){
 125         if (this.showSummaryRow) {
 126             return {
 127                 closeRows: this.closeRows
 128             };
 129         }
 130     },
 131
 132 <span id='Ext-grid-feature-Summary-method-closeRows'>    /**
 133 </span>     * Provide our own custom footer for the grid.
 134      * @private
 135      * @return {String} The custom footer
 136      */
 137     closeRows: function() {
 138         return '&lt;/tpl&gt;{[this.printSummaryRow()]}';
 139     },
 140
 141 <span id='Ext-grid-feature-Summary-method-getPrintData'>    /**
 142 </span>     * Gets the data for printing a template row
 143      * @private
 144      * @param {Number} index The index in the template
 145      * @return {Array} The template values
 146      */
 147     getPrintData: function(index){
 148         var me = this,
 149             columns = me.view.headerCt.getColumnsForTpl(),
 150             i = 0,
 151             length = columns.length,
 152             data = [],
 153             active = me.summaryData,
 154             column;
 155
 156         for (; i &lt; length; ++i) {
 157             column = columns[i];
 158             column.gridSummaryValue = this.getColumnValue(column, active);
 159             data.push(column);
 160         }
 161         return data;
 162     },
 163
 164 <span id='Ext-grid-feature-Summary-method-generateSummaryData'>    /**
 165 </span>     * Generates all of the summary data to be used when processing the template
 166      * @private
 167      * @return {Object} The summary data
 168      */
 169     generateSummaryData: function(){
 170         var me = this,
 171             data = {},
 172             store = me.view.store,
 173             columns = me.view.headerCt.getColumnsForTpl(),
 174             i = 0,
 175             length = columns.length,
 176             fieldData,
 177             key,
 178             comp;
 179
 180         for (i = 0, length = columns.length; i &lt; length; ++i) {
 181             comp = Ext.getCmp(columns[i].id);
 182             data[comp.id] = me.getSummary(store, comp.summaryType, comp.dataIndex, false);
 183         }
 184         return data;
 185     }
 186 });</pre>
 187 </body>
 188 </html>