1 /*---------------------------------------------------------
3 *---------------------------------------------------------*/
5 /* jshint undef: false */
8 openerp.web_graph = function (instance) {
11 var _lt = instance.web._lt;
12 var _t = instance.web._t;
13 var QWeb = instance.web.qweb;
15 instance.web.views.add('graph', 'instance.web_graph.GraphView');
18 * GraphView view. It mostly contains two widgets (PivotTable and ChartView)
21 instance.web_graph.GraphView = instance.web.View.extend({
22 template: 'GraphView',
23 display_name: _lt('Graph'),
25 mode: 'pivot', // pivot => display pivot table, chart => display chart
28 'click .graph_mode_selection li' : function (event) {
29 event.preventDefault();
30 var view_mode = event.target.attributes['data-mode'].nodeValue;
31 if (view_mode === 'data') {
35 this.chart_view.set_mode(view_mode);
39 'click .graph_clear_groups' : function (event) {
40 this.pivot_table.clear_groups();
44 view_loading: function (fields_view_get) {
46 var model = new instance.web.Model(fields_view_get.model, {group_by_no_leaf: true});
49 options.col_groupby = [];
51 // get the default groupbys and measure defined in the field view
52 options.measure = null;
53 options.row_groupby = [];
54 _.each(fields_view_get.arch.children, function (field) {
55 if ('name' in field.attrs) {
56 if ('operator' in field.attrs) {
57 options.measure = field.attrs.name;
59 options.row_groupby.push(field.attrs.name);
64 // get the most important fields (of the model) by looking at the
65 // groupby filters defined in the search view
66 options.important_fields = [];
67 var load_view = instance.web.fields_view_get({
72 var important_fields_def = $.when(load_view).then(function (search_view) {
73 var groups = _.select(search_view.arch.children, function (c) {
74 return (c.tag == 'group') && (c.attrs.string != 'Display');
77 _.each(groups, function(g) {
78 _.each(g.children, function (g) {
79 if (g.attrs.context) {
80 var field_id = py.eval(g.attrs.context).group_by;
81 options.important_fields.push(field_id);
87 // get the fields descriptions from the model
88 var field_descr_def = model.call('fields_get', [])
89 .then(function (fields) { options.fields = fields; });
92 return $.when(important_fields_def, field_descr_def)
94 self.pivot_table = new PivotTable(model, options);
95 self.chart_view = new ChartView(model, options);
98 return self.pivot_table.appendTo('.graph_main_content');
101 return self.chart_view.appendTo('.graph_main_content');
105 display_data : function () {
106 if (this.mode === 'pivot') {
107 this.chart_view.hide();
108 this.pivot_table.show();
110 this.pivot_table.hide();
111 this.chart_view.show();
115 do_search: function (domain, context, group_by) {
116 this.domain = new instance.web.CompoundDomain(domain);
117 this.pivot_table.set_domain(domain);
118 this.chart_view.set_domain(domain);
122 do_show: function () {
123 this.do_push_state({});
124 return this._super();
130 * BasicDataView widget. Basic widget to manage show/hide functionality
131 * and to initialize some attributes. It is inherited by PivotTable
132 * and ChartView widget.
134 var BasicDataView = instance.web.Widget.extend({
139 // model: model to display
140 // fields: dictionary returned by field_get on model (desc of model)
141 // domain: constraints on model records
142 // row_groupby: groubys on rows (so, row headers in the pivot table)
143 // col_groupby: idem, but on col
144 // measure: quantity to display. either a field from the model, or
145 // null, in which case we use the "count" measure
146 init: function (model, options) {
148 this.fields = options.fields;
149 this.domain = options.domain;
150 this.row_groupby = options.row_groupby;
151 this.col_groupby = options.col_groupby;
152 this.measure = options.measure;
153 this.measure_label = options.measure ? options.fields[options.measure].string : 'Quantity';
155 this.need_redraw = true;
156 this.important_fields = options.important_fields;
159 get_descr: function (field_id) {
160 return this.fields[field_id].string;
163 set_domain: function (domain) {
164 this.domain = domain;
165 this.need_redraw = true;
168 set_row_groupby: function (row_groupby) {
169 this.row_groupby = row_groupby;
170 this.need_redraw = true;
173 set_col_groupby: function (col_groupby) {
174 this.col_groupby = col_groupby;
175 this.need_redraw = true;
178 set_measure: function (measure) {
179 this.measure = measure;
180 this.need_redraw = true;
184 if (this.need_redraw) {
186 this.need_redraw = false;
188 this.$el.css('display', 'block');
192 this.$el.css('display', 'none');
198 get_data: function (groupby) {
199 var view_fields = this.row_groupby.concat(this.measure, this.col_groupby);
200 return query_groups(this.model, view_fields, this.domain, groupby);
206 * PivotTable widget. It displays the data in tabular data and allows the
207 * user to drill down and up in the table
209 var PivotTable = BasicDataView.extend({
210 template: 'pivot_table',
216 'click .graph_border > a' : function (event) {
218 event.preventDefault();
219 var row_id = event.target.attributes['data-row-id'].nodeValue;
221 var row = this.get_row(row_id);
223 this.fold_row(row_id);
225 if (row.path.length < this.row_groupby.length) {
226 var field_to_expand = this.row_groupby[row.path.length];
227 this.expand_row(row_id, field_to_expand);
229 var already_grouped = self.row_groupby.concat(self.col_groupby);
230 var possible_groups = _.difference(self.important_fields, already_grouped);
231 var dropdown_options = {
232 fields: _.map(possible_groups, function (field) {
233 return {id: field, value: self.get_descr(field)};
237 this.dropdown = $(QWeb.render('field_selection', dropdown_options));
238 $(event.target).after(this.dropdown);
239 $('.field-selection').next('.dropdown-menu').toggle();
245 'click a.field-selection' : function (event) {
246 event.preventDefault();
247 this.dropdown.remove();
248 var row_id = event.target.attributes['data-row-id'].nodeValue;
249 var field_id = event.target.attributes['data-field-id'].nodeValue;
250 this.expand_row(row_id, field_id);
254 clear_groups: function () {
255 this.row_groupby = [];
256 this.col_groupby = [];
262 init: function (model, options) {
263 this._super(model, options);
266 generate_id: function () {
267 this.current_row_id += 1;
268 return this.current_row_id - 1;
271 get_row: function (id) {
272 return _.find(this.rows, function(row) {
273 return (row.id == id);
277 make_cell: function (content, options) {
279 if (options && options.is_border) {
280 attrs.push('class="graph_border"');
284 if (options && options.indent) {
285 _.each(_.range(options.indent), function () {
286 attrs.push('<span class="web_graph_indent"></span>');
289 if (options && options.foldable) {
290 attrs.push('<a data-row-id="'+ options.row_id + '" href="#" class="icon-plus-sign"> </a>');
292 return attrs.join(' ') + content + '</td>';
295 make_row: function (data, parent_id) {
296 var has_parent = (parent_id !== undefined);
297 var parent = has_parent ? this.get_row(parent_id) : null;
300 path = parent.path.concat(data.attributes.grouped_on);
301 } else if (data.attributes.grouped_on !== undefined) {
302 path = [data.attributes.grouped_on];
307 var indent_level = has_parent ? parent.path.length : 0;
308 var value = (this.row_groupby.length > 0) ? data.attributes.value[1] : 'Total';
311 var jquery_row = $('<tr></tr>');
312 var row_id = this.generate_id();
314 var header = $(this.make_cell(value, {is_border:true, indent: indent_level, foldable:true, row_id: row_id}));
315 jquery_row.html(header);
316 jquery_row.append(this.make_cell(data.attributes.aggregates[this.measure]));
326 domain: data.model._domain,
328 // rows.splice(index of parent if any,0,row);
329 this.rows.push(row); // to do, insert it properly
331 if (this.row_groupby.length === 0) {
332 row.remove_when_expanded = true;
333 row.domain = this.domain;
336 parent.children.push(row.id);
341 expand_row: function (row_id, field_id) {
343 var row = this.get_row(row_id);
345 if (row.path.length == this.row_groupby.length) {
346 this.row_groupby.push(field_id);
349 var visible_fields = this.row_groupby.concat(this.col_groupby, this.measure);
351 if (row.remove_when_expanded) {
355 row.html_tr.find('.icon-plus-sign')
356 .removeClass('icon-plus-sign')
357 .addClass('icon-minus-sign');
360 query_groups(this.model, visible_fields, row.domain, [field_id])
361 .then(function (data) {
362 _.each(data.reverse(), function (datapt) {
364 if (row.remove_when_expanded) {
365 new_row = self.make_row(datapt);
366 self.$('tr.graph_table_header').after(new_row.html_tr);
368 new_row = self.make_row(datapt, row_id);
369 row.html_tr.after(new_row.html_tr);
372 if (row.remove_when_expanded) {
373 row.html_tr.remove();
379 fold_row: function (row_id) {
381 var row = this.get_row(row_id);
383 _.each(row.children, function (child_row) {
384 self.remove_row(child_row);
388 row.expanded = false;
389 row.html_tr.find('.icon-minus-sign')
390 .removeClass('icon-minus-sign')
391 .addClass('icon-plus-sign');;
395 remove_row: function (row_id) {
397 var row = this.get_row(row_id);
399 _.each(row.children, function (child_row) {
400 self.remove_row(child_row);
403 row.html_tr.remove();
407 this.get_data(this.row_groupby)
408 .then(this.proxy('build_table'))
409 .done(this.proxy('_draw'));
412 build_table: function (data) {
417 value: this.measure_label,
423 header: $(this.make_cell(this.measure_label, {is_border:true})),
426 _.each(data, function (datapt) {
427 self.make_row(datapt);
437 if (this.row_groupby.length > 0) {
438 header = '<tr><td class="graph_border">' +
439 this.fields[this.row_groupby[0]].string +
440 '</td><td class="graph_border">' +
444 header = '<tr class="graph_table_header"><td class="graph_border">' +
445 '</td><td class="graph_border">' +
449 this.$el.append(header);
451 _.each(this.rows, function (row) {
452 self.$el.append(row.html_tr);
459 * ChartView widget. It displays the data in chart form, using the nvd3
460 * library. Various modes include bar charts, pie charts or line charts.
462 var ChartView = BasicDataView.extend({
463 template: 'chart_view',
465 set_mode: function (mode) {
466 this.render = this['render_' + mode];
467 this.need_redraw = true;
473 this.$el.append('<svg></svg>');
474 this.get_data(this.row_groupby).done(function (data) {
479 format_data: function (datapt) {
480 var val = datapt.attributes;
482 x: datapt.attributes.value[1],
483 y: this.measure ? val.aggregates[this.measure] : val.length,
487 render_bar_chart: function (data) {
488 var formatted_data = [{
490 values: _.map(data, this.proxy('format_data')),
493 nv.addGraph(function () {
494 var chart = nv.models.discreteBarChart()
501 d3.select('.graph_chart svg')
502 .datum(formatted_data)
507 nv.utils.windowResize(chart.update);
512 render_line_chart: function (data) {
513 var formatted_data = [{
514 key: this.measure_label,
515 values: _.map(data, this.proxy('format_data'))
518 nv.addGraph(function () {
519 var chart = nv.models.lineChart()
520 .x(function (d,u) { return u; })
523 .margin({top: 30, right: 20, bottom: 20, left: 60});
525 d3.select('.graph_chart svg')
528 .datum(formatted_data)
535 render_pie_chart: function (data) {
536 var formatted_data = _.map(data, this.proxy('format_data'));
538 nv.addGraph(function () {
539 var chart = nv.models.pieChart()
540 .color(d3.scale.category10().range())
544 d3.select('.graph_chart svg')
545 .datum(formatted_data)
546 .transition().duration(1200)
551 nv.utils.windowResize(chart.update);
559 * Query the server and return a deferred which will return the data
560 * with all the groupbys applied (this is done for now, but the goal
561 * is to modify read_group in order to allow eager and lazy groupbys
563 function query_groups (model, fields, domain, groupbys) {
564 return model.query(fields)
567 .then(function (results) {
568 var non_empty_results = _.filter(results, function (group) {
569 return group.attributes.length > 0;
571 if (groupbys.length <= 1) {
572 return non_empty_results;
574 var get_subgroups = $.when.apply(null, _.map(non_empty_results, function (result) {
575 var new_domain = result.model._domain;
576 var new_groupings = groupbys.slice(1);
577 return query_groups(model, fields,new_domain, new_groupings).then(function (subgroups) {
578 result.subgroups_data = subgroups;
581 return get_subgroups.then(function () {
582 return non_empty_results;