forked from markbrough/usaid_dca
-
Notifications
You must be signed in to change notification settings - Fork 4
/
aggregator.js
284 lines (255 loc) · 8.57 KB
/
aggregator.js
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
var OpenSpending = OpenSpending || {};
/*
Abstract the OpenSpending data store (accessed via its api).
Sample use:
var datastore = WDMMG.Datastore(other_config);
datastore.list("entries", function(data){...});
datastore.listEntries(function(data){...});
datastore.filterDataset({key: value, foo: bar}, function(data){...});
*/
(function($) {
var defaultConfig = {
'apiUrl': 'http://openspending.org/api',
'dataset': 'cra',
'drilldowns': ['cofog1', 'cofog2', 'cofog3'],
'cuts': ['year:2008'],
'breakdown': 'region',
'rootNodeLabel': 'Grant Total',
'localApiCache': 'aggregate.json',
'callback': function(tree) { }
};
OpenSpending.Aggregator = function(customConfig) {
var d = {
config: customConfig ? customConfig : defaultConfig,
/**
* Call the wdmmg aggregate api function (/api/2/aggregate)
* and build a tree that can be used by for the bubble charts
*
* @public getTree
*
* @param {string} api_url The url to the api,
* e.g. 'http://openspending.org/api'
* @param {string} dataset The name of the dataset, e.g. 'cra'
* @param {array} drilldowns the dimensions to drill down to, e.g.
* ['cofog1', 'cofog2', 'cofog3']
* @param {array} cuts (optional) The array with cuts, each element in the
* format 'key:value', e.g. ['time.from.year:2010']
* @param {function} callback A function that will accept the root node
* and builds the bubble chart.
* @param {object} testDataPath (optional) An object with json (not jsonp)
* test data. For testing only.
**/
getTree: function() {
//api_url, dataset, drilldowns, cuts, callback, testDataPath
//construct the url
var data = {},
dataType = 'jsonp',
url,
config = this.config,
drilldowns;
url = config.apiUrl + '/2/aggregate';
data.dataset = config.dataset;
data.drilldown = config.drilldowns.join('|');
data.order = config.order.join('|');
if (config.cuts !== undefined) {
data.cut = config.cuts.join('|');
}
// add an optional breakdown to drilldowns to query the api
drilldowns = config.drilldowns.slice(); //copy
if (config.breakdown !== undefined) {
drilldowns.push(config.breakdown);
}
drilldowns = $.unique(drilldowns);
data.drilldown = drilldowns.join('|');
if (config.localApiCache !== undefined) {
url = config.localApiCache;
dataType = 'json';
}
$.ajax({
url: url,
data: data,
dataType: dataType,
context: this,
success: this.onJSONTreeLoaded
});
},
/**
*
*
*/
onJSONTreeLoaded: function(data) {
var tree = this.buildTree(data);
if ($.isFunction(this.config.callback)) {
this.config.callback(tree);
}
},
/**
* Build a tree form the drill down entries
*
* @public buildTree
*
* @param {object} data The json object responded from the
* aggregate api.
* @param {array} drilldowns List of drilldown criteria (strings)
* @param {object} rootNode (optional) Pass an object with properties
* for the root node. Maybe you want to set 'color' (default: #555) or
* the 'label' (default: 'Total')
**/
buildTree: function(data) {
var entries = data.drilldown,
config = this.config,
drilldowns = config.drilldowns,
breakdown = config.breakdown,
rootNode = { label: config.rootNodeLabel },
nodes = {},
root = {id: 'root',
label: 'Total',
color: '#555',
amount: 0.0,
children: [],
level: 0,
breakdowns: {}};
if (rootNode !== undefined) {
// extend root with the properties of rootNode
$.extend(true, root, rootNode);
}
nodes.root = root;
for (var i in drilldowns) {
var drilldown = drilldowns[i];
nodes[drilldown] = {};
}
if (data.errors !== undefined) {
throw "Error";
}
for (var index in entries) {
this.processEntry(entries[index], nodes);
}
return nodes.root;
},
processEntry: function(entry, nodes) {
var parent = nodes.root,
level = 0,
drilldown,
drilldowns = this.config.drilldowns,
current,
node,
node_template;
for (var index in drilldowns) {
drilldown = drilldowns[index];
level = level + 1;
current = entry[drilldown];
node_template = this.toNode(current, parent);
node = nodes[node_template.id];
if(node === undefined) {
// Initialize a new node and add it to the parent node
node = node_template;
node.children = [];
node.amount = 0.0;
node.color = current ? current.color : undefined;
node.level = level;
node.breakdowns = {};
parent.children.push(node);
nodes[node.id] = node;
}
node.amount = node.amount + entry.amount;
// Add the current amount and the breakdown to the root node
// to have a total.
if(level === 1) {
nodes.root.amount = nodes.root.amount + entry.amount;
this.addBreakdown(nodes.root, entry);
}
// update the breakdown for the current node
this.addBreakdown(node, entry);
parent = node;
}
},
/**
* Add a node for each drilldown to the 'nodes' object
* Process the nodes to have:
* * The summed up amount
* * A children array
* * A color property
* * An unique id
*
* @method processEntry
* @param {object} entry The entry in the list of drill downs
* @param {object} node The node to which we save the breakdown
* @return {undefined}
*/
addBreakdown: function(node, entry) {
var breakdown = this.config.breakdown;
if (breakdown === undefined) {
return;
}
var breakdown_value,
breakdown_node,
node_template,
nodes = {},
_id;
breakdown_value = entry[breakdown];
node_template = this.toNode(breakdown_value);
_id = node_template.id;
breakdown_node = node.breakdowns[_id];
if (breakdown_node === undefined) {
breakdown_node = node_template;
node.breakdowns[_id] = breakdown_node;
}
breakdown_node.amount = breakdown_node.amount + entry.amount;
},
toNode: function(value, parent) {
var type = typeof(value),
id,
label,
prefix,
taxonomy,
name;
prefix = parent ? parent.id + '__' : '';
if (value === undefined || value === null) {
id = 'others';
label = 'Others';
name = 'others';
} else if (type === 'object') {
if (value.id === undefined) {
id = 'others';
label = 'Others';
name = 'others';
} else {
id = value.id;
label = value.label;
taxonomy = value.taxonomy;
name = value.name;
if (!name) {
if (label) {
name = label.toLowerCase().replace(/\W/g, "-");
} else {
name = id;
}
}
}
} else if ( type === 'boolean' ) {
if (value) {
id = 'yes';
label = 'Yes';
name = 'yes';
} else {
id = 'no';
label = 'No';
name = 'no';
}
} else if ( type === 'string' || type === 'number') {
id = value + '';
label = value + '';
name = id.toLowerCase().replace(/\W/g, "-");
} else {
throw 'unsupported type: ' + type;
}
return {id: prefix + id,
label: label,
name: name,
taxonomy: taxonomy,
amount: 0.0};
}
};
d.getTree();
};
}(jQuery));