1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
<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>
</head>
<body onload="prettyPrint();">
<pre class="prettyprint lang-js">/*!
* Ext JS Library 3.4.0
* Copyright(c) 2006-2011 Sencha Inc.
* licensing@sencha.com
* http://www.sencha.com/license
*/
<div id="cls-Ext.grid.PivotGrid"></div>/**
* @class Ext.grid.PivotGrid
* @extends Ext.grid.GridPanel
* <p>The PivotGrid component enables rapid summarization of large data sets. It provides a way to reduce a large set of
* data down into a format where trends and insights become more apparent. A classic example is in sales data; a company
* will often have a record of all sales it makes for a given period - this will often encompass thousands of rows of
* data. The PivotGrid allows you to see how well each salesperson performed, which cities generate the most revenue,
* how products perform between cities and so on.</p>
* <p>A PivotGrid is composed of two axes (left and top), one {@link #measure} and one {@link #aggregator aggregation}
* function. Each axis can contain one or more {@link #dimension}, which are ordered into a hierarchy. Dimensions on the
* left axis can also specify a width. Each dimension in each axis can specify its sort ordering, defaulting to "ASC",
* and must specify one of the fields in the {@link Ext.data.Record Record} used by the PivotGrid's
* {@link Ext.data.Store Store}.</p>
<pre><code>
// This is the record representing a single sale
var SaleRecord = Ext.data.Record.create([
{name: 'person', type: 'string'},
{name: 'product', type: 'string'},
{name: 'city', type: 'string'},
{name: 'state', type: 'string'},
{name: 'year', type: 'int'},
{name: 'value', type: 'int'}
]);
// A simple store that loads SaleRecord data from a url
var myStore = new Ext.data.Store({
url: 'data.json',
autoLoad: true,
reader: new Ext.data.JsonReader({
root: 'rows',
idProperty: 'id'
}, SaleRecord)
});
// Create the PivotGrid itself, referencing the store
var pivot = new Ext.grid.PivotGrid({
store : myStore,
aggregator: 'sum',
measure : 'value',
leftAxis: [
{
width: 60,
dataIndex: 'product'
},
{
width: 120,
dataIndex: 'person',
direction: 'DESC'
}
],
topAxis: [
{
dataIndex: 'year'
}
]
});
</code></pre>
* <p>The specified {@link #measure} is the field from SaleRecord that is extracted from each combination
* of product and person (on the left axis) and year on the top axis. There may be several SaleRecords in the
* data set that share this combination, so an array of measure fields is produced. This array is then
* aggregated using the {@link #aggregator} function.</p>
* <p>The default aggregator function is sum, which simply adds up all of the extracted measure values. Other
* built-in aggregator functions are count, avg, min and max. In addition, you can specify your own function.
* In this example we show the code used to sum the measures, but you can return any value you like. See
* {@link #aggregator} for more details.</p>
<pre><code>
new Ext.grid.PivotGrid({
aggregator: function(records, measure) {
var length = records.length,
total = 0,
i;
for (i = 0; i < length; i++) {
total += records[i].get(measure);
}
return total;
},
renderer: function(value) {
return Math.round(value);
},
//your normal config here
});
</code></pre>
* <p><u>Renderers</u></p>
* <p>PivotGrid optionally accepts a {@link #renderer} function which can modify the data in each cell before it
* is rendered. The renderer is passed the value that would usually be placed in the cell and is expected to return
* the new value. For example let's imagine we had height data expressed as a decimal - here's how we might use a
* renderer to display the data in feet and inches notation:</p>
<pre><code>
new Ext.grid.PivotGrid({
//in each case the value is a decimal number of feet
renderer : function(value) {
var feet = Math.floor(value),
inches = Math.round((value - feet) * 12);
return String.format("{0}' {1}\"", feet, inches);
},
//normal config here
});
</code></pre>
* <p><u>Reconfiguring</u></p>
* <p>All aspects PivotGrid's configuration can be updated at runtime. It is easy to change the {@link #setMeasure measure},
* {@link #setAggregator aggregation function}, {@link #setLeftAxis left} and {@link #setTopAxis top} axes and refresh the grid.</p>
* <p>In this case we reconfigure the PivotGrid to have city and year as the top axis dimensions, rendering the average sale
* value into the cells:</p>
<pre><code>
//the left axis can also be changed
pivot.topAxis.setDimensions([
{dataIndex: 'city', direction: 'DESC'},
{dataIndex: 'year', direction: 'ASC'}
]);
pivot.setMeasure('value');
pivot.setAggregator('avg');
pivot.view.refresh(true);
</code></pre>
* <p>See the {@link Ext.grid.PivotAxis PivotAxis} documentation for further detail on reconfiguring axes.</p>
*/
Ext.grid.PivotGrid = Ext.extend(Ext.grid.GridPanel, {
<div id="cfg-Ext.grid.PivotGrid-aggregator"></div>/**
* @cfg {String|Function} aggregator The aggregation function to use to combine the measures extracted
* for each dimension combination. Can be any of the built-in aggregators (sum, count, avg, min, max).
* Can also be a function which accepts two arguments (an array of Records to aggregate, and the measure
* to aggregate them on) and should return a String.
*/
aggregator: 'sum',
<div id="cfg-Ext.grid.PivotGrid-renderer"></div>/**
* @cfg {Function} renderer Optional renderer to pass values through before they are rendered to the dom. This
* gives an opportunity to modify cell contents after the value has been computed.
*/
renderer: undefined,
<div id="cfg-Ext.grid.PivotGrid-measure"></div>/**
* @cfg {String} measure The field to extract from each Record when pivoting around the two axes. See the class
* introduction docs for usage
*/
<div id="cfg-Ext.grid.PivotGrid-leftAxis"></div>/**
* @cfg {Array|Ext.grid.PivotAxis} leftAxis Either and array of {@link #dimension} to use on the left axis, or
* a {@link Ext.grid.PivotAxis} instance. If an array is passed, it is turned into a PivotAxis internally.
*/
<div id="cfg-Ext.grid.PivotGrid-topAxis"></div>/**
* @cfg {Array|Ext.grid.PivotAxis} topAxis Either and array of {@link #dimension} to use on the top axis, or
* a {@link Ext.grid.PivotAxis} instance. If an array is passed, it is turned into a PivotAxis internally.
*/
//inherit docs
initComponent: function() {
Ext.grid.PivotGrid.superclass.initComponent.apply(this, arguments);
this.initAxes();
//no resizing of columns is allowed yet in PivotGrid
this.enableColumnResize = false;
this.viewConfig = Ext.apply(this.viewConfig || {}, {
forceFit: true
});
//TODO: dummy col model that is never used - GridView is too tightly integrated with ColumnModel
//in 3.x to remove this altogether.
this.colModel = new Ext.grid.ColumnModel({});
},
<div id="method-Ext.grid.PivotGrid-getAggregator"></div>/**
* Returns the function currently used to aggregate the records in each Pivot cell
* @return {Function} The current aggregator function
*/
getAggregator: function() {
if (typeof this.aggregator == 'string') {
return Ext.grid.PivotAggregatorMgr.types[this.aggregator];
} else {
return this.aggregator;
}
},
<div id="method-Ext.grid.PivotGrid-setAggregator"></div>/**
* Sets the function to use when aggregating data for each cell.
* @param {String|Function} aggregator The new aggregator function or named function string
*/
setAggregator: function(aggregator) {
this.aggregator = aggregator;
},
<div id="method-Ext.grid.PivotGrid-setMeasure"></div>/**
* Sets the field name to use as the Measure in this Pivot Grid
* @param {String} measure The field to make the measure
*/
setMeasure: function(measure) {
this.measure = measure;
},
<div id="method-Ext.grid.PivotGrid-setLeftAxis"></div>/**
* Sets the left axis of this pivot grid. Optionally refreshes the grid afterwards.
* @param {Ext.grid.PivotAxis} axis The pivot axis
* @param {Boolean} refresh True to immediately refresh the grid and its axes (defaults to false)
*/
setLeftAxis: function(axis, refresh) {
<div id="prop-Ext.grid.PivotGrid-leftAxis"></div>/**
* The configured {@link Ext.grid.PivotAxis} used as the left Axis for this Pivot Grid
* @property leftAxis
* @type Ext.grid.PivotAxis
*/
this.leftAxis = axis;
if (refresh) {
this.view.refresh();
}
},
<div id="method-Ext.grid.PivotGrid-setTopAxis"></div>/**
* Sets the top axis of this pivot grid. Optionally refreshes the grid afterwards.
* @param {Ext.grid.PivotAxis} axis The pivot axis
* @param {Boolean} refresh True to immediately refresh the grid and its axes (defaults to false)
*/
setTopAxis: function(axis, refresh) {
<div id="prop-Ext.grid.PivotGrid-topAxis"></div>/**
* The configured {@link Ext.grid.PivotAxis} used as the top Axis for this Pivot Grid
* @property topAxis
* @type Ext.grid.PivotAxis
*/
this.topAxis = axis;
if (refresh) {
this.view.refresh();
}
},
/**
* @private
* Creates the top and left axes. Should usually only need to be called once from initComponent
*/
initAxes: function() {
var PivotAxis = Ext.grid.PivotAxis;
if (!(this.leftAxis instanceof PivotAxis)) {
this.setLeftAxis(new PivotAxis({
orientation: 'vertical',
dimensions : this.leftAxis || [],
store : this.store
}));
};
if (!(this.topAxis instanceof PivotAxis)) {
this.setTopAxis(new PivotAxis({
orientation: 'horizontal',
dimensions : this.topAxis || [],
store : this.store
}));
};
},
/**
* @private
* @return {Array} 2-dimensional array of cell data
*/
extractData: function() {
var records = this.store.data.items,
recCount = records.length,
cells = [],
record, i, j, k;
if (recCount == 0) {
return [];
}
var leftTuples = this.leftAxis.getTuples(),
leftCount = leftTuples.length,
topTuples = this.topAxis.getTuples(),
topCount = topTuples.length,
aggregator = this.getAggregator();
for (i = 0; i < recCount; i++) {
record = records[i];
for (j = 0; j < leftCount; j++) {
cells[j] = cells[j] || [];
if (leftTuples[j].matcher(record) === true) {
for (k = 0; k < topCount; k++) {
cells[j][k] = cells[j][k] || [];
if (topTuples[k].matcher(record)) {
cells[j][k].push(record);
}
}
}
}
}
var rowCount = cells.length,
colCount, row;
for (i = 0; i < rowCount; i++) {
row = cells[i];
colCount = row.length;
for (j = 0; j < colCount; j++) {
cells[i][j] = aggregator(cells[i][j], this.measure);
}
}
return cells;
},
<div id="method-Ext.grid.PivotGrid-getView"></div>/**
* Returns the grid's GridView object.
* @return {Ext.grid.PivotGridView} The grid view
*/
getView: function() {
if (!this.view) {
this.view = new Ext.grid.PivotGridView(this.viewConfig);
}
return this.view;
}
});
Ext.reg('pivotgrid', Ext.grid.PivotGrid);
Ext.grid.PivotAggregatorMgr = new Ext.AbstractManager();
Ext.grid.PivotAggregatorMgr.registerType('sum', function(records, measure) {
var length = records.length,
total = 0,
i;
for (i = 0; i < length; i++) {
total += records[i].get(measure);
}
return total;
});
Ext.grid.PivotAggregatorMgr.registerType('avg', function(records, measure) {
var length = records.length,
total = 0,
i;
for (i = 0; i < length; i++) {
total += records[i].get(measure);
}
return (total / length) || 'n/a';
});
Ext.grid.PivotAggregatorMgr.registerType('min', function(records, measure) {
var data = [],
length = records.length,
i;
for (i = 0; i < length; i++) {
data.push(records[i].get(measure));
}
return Math.min.apply(this, data) || 'n/a';
});
Ext.grid.PivotAggregatorMgr.registerType('max', function(records, measure) {
var data = [],
length = records.length,
i;
for (i = 0; i < length; i++) {
data.push(records[i].get(measure));
}
return Math.max.apply(this, data) || 'n/a';
});
Ext.grid.PivotAggregatorMgr.registerType('count', function(records, measure) {
return records.length;
});</pre>
</body>
</html>
|
