addons/web_graph/static/src/js/graph.js

   1 /*---------------------------------------------------------
   2  * OpenERP web_graph
   3  *---------------------------------------------------------*/
   4
   5 /* jshint undef: false  */
   6
   7 openerp.web_graph = function (instance) {
   8 'use strict';
   9
  10 var _lt = instance.web._lt;
  11 var _t = instance.web._t;
  12 var QWeb = instance.web.qweb;
  13
  14 instance.web.views.add('graph', 'instance.web_graph.GraphView');
  15
  16 instance.web_graph.GraphView = instance.web.View.extend({
  17     display_name: _lt('Graph'),
  18     view_type: 'graph',
  19
  20     init: function(parent, dataset, view_id, options) {
  21         this._super(parent, dataset, view_id, options);
  22         this.dataset = dataset;
  23         this.model = new instance.web.Model(dataset.model, {group_by_no_leaf: true});
  24         this.search_view = parent.searchview;
  25         this.search_view_groupby = [];
  26         this.groupby_mode = 'default';  // 'default' or 'manual'
  27         this.default_row_groupby = [];
  28         this.default_col_groupby = [];
  29         this.search_field = {
  30             get_context: this.proxy('get_context'),
  31             get_domain: function () {},
  32             get_groupby: function () { },
  33         };
  34     },
  35
  36     get_context: function (facet) {
  37         var col_group_by = _.map(facet.values.models, function (model) {
  38             return model.attributes.value.attrs.context.col_group_by;
  39         });
  40         return {col_group_by : col_group_by};
  41     },
  42
  43     start: function () {
  44         var options = {enabled:false};
  45         this.graph_widget = new openerp.web_graph.Graph(this, this.model, options);
  46         this.graph_widget.appendTo(this.$el);
  47         this.graph_widget.pivot.on('groupby_changed', this, this.proxy('register_groupby'));
  48         return this.load_view();
  49     },
  50
  51     view_loading: function (fields_view_get) {
  52         var self = this,
  53             arch = fields_view_get.arch,
  54             measure = null,
  55             stacked = false;
  56
  57         if (arch.attrs.type === 'bar' || !_.has(arch.attrs, 'type')) {
  58             this.graph_widget.mode = 'bar_chart';
  59         }
  60         if (arch.attrs.stacked === 'True') {
  61             stacked = true;
  62         }
  63
  64         _.each(arch.children, function (field) {
  65             if (_.has(field.attrs, 'type')) {
  66                 switch (field.attrs.type) {
  67                     case 'row':
  68                         self.default_row_groupby.push(field.attrs.name);
  69                         break;
  70                     case 'col':
  71                         self.default_col_groupby.push(field.attrs.name);
  72                         break;
  73                     case 'measure':
  74                         measure = field.attrs.name;
  75                         break;
  76                 }
  77             } else {  // old style, kept for backward compatibility
  78                 if ('operator' in field.attrs) {
  79                     measure = (measure) ? measure : field.attrs.name;
  80                 } else {
  81                     self.default_row_groupby.push(field.attrs.name);
  82                 }
  83             }
  84         });
  85         this.graph_widget.config({
  86             measure:measure,
  87             update:false,
  88             bar_ui: (stacked) ? 'stack' : 'group'
  89         });
  90     },
  91
  92     do_search: function (domain, context, group_by) {
  93         var col_groupby = context.col_group_by || [],
  94             options = {domain:domain};
  95
  96         this.search_view_groupby = group_by;
  97
  98         if (group_by.length && this.groupby_mode !== 'manual') {
  99             if (_.isEqual(col_groupby, [])) {
 100                 col_groupby = this.default_col_groupby;
 101             }
 102         }
 103         if (group_by.length || col_groupby.length) {
 104             this.groupby_mode = 'manual';
 105         }
 106         if (!this.graph_widget.enabled) {
 107             options.update = false;
 108             options.silent = true;
 109         }
 110
 111         if (this.groupby_mode === 'manual') {
 112             options.row_groupby = group_by;
 113             options.col_groupby = col_groupby;
 114         } else {
 115             options.row_groupby = _.toArray(this.default_row_groupby);
 116             options.col_groupby = _.toArray(this.default_col_groupby);
 117         }
 118         this.graph_widget.pivot.config(options);
 119
 120         if (!this.graph_widget.enabled) {
 121             this.graph_widget.activate_display();
 122             this.ViewManager.on('switch_mode', this, function () {this.graph_widget.pivot.update_data(); });
 123         }
 124     },
 125
 126     do_show: function () {
 127         this.do_push_state({});
 128         return this._super();
 129     },
 130
 131     register_groupby: function() {
 132         var self = this,
 133             query = this.search_view.query;
 134
 135         this.groupby_mode = 'manual';
 136         if (_.isEqual(this.search_view_groupby, this.graph_widget.pivot.rows.groupby) ||
 137             (!_.has(this.search_view, '_s_groupby'))) {
 138             return;
 139         }
 140         var rows = _.map(this.graph_widget.pivot.rows.groupby, function (group) {
 141             return make_facet('GroupBy', group);
 142         });
 143         var cols = _.map(this.graph_widget.pivot.cols.groupby, function (group) {
 144             return make_facet('ColGroupBy', group);
 145         });
 146
 147         query.reset(rows.concat(cols));
 148
 149         function make_facet (category, fields) {
 150             var values,
 151                 icon,
 152                 backbone_field,
 153                 cat_name;
 154             if (!(fields instanceof Array)) { fields = [fields]; }
 155             if (category === 'GroupBy') {
 156                 cat_name = 'group_by';
 157                 icon = 'w';
 158                 backbone_field = self.search_view._s_groupby;
 159             } else {
 160                 cat_name = 'col_group_by';
 161                 icon = 'f';
 162                 backbone_field = self.search_field;
 163             }
 164             values =  _.map(fields, function (field) {
 165                 var context = {};
 166                 context[cat_name] = field;
 167                 return {label: self.graph_widget.fields[field].string, value: {attrs:{domain: [], context: context}}};
 168             });
 169             return {category:category, values: values, icon:icon, field: backbone_field};
 170         }
 171     },
 172 });
 173
 174 instance.web_graph.Graph = instance.web.Widget.extend({
 175     template: 'GraphWidget',
 176
 177     events: {
 178         'click .graph_mode_selection li' : 'mode_selection',
 179         'click .graph_measure_selection li' : 'measure_selection',
 180         'click .graph_options_selection li' : 'option_selection',
 181         'click .web_graph_click' : 'header_cell_clicked',
 182         'click a.field-selection' : 'field_selection',
 183     },
 184
 185     init: function(parent, model, options) {
 186         this._super(parent);
 187         this.model = model;
 188         this.important_fields = [];
 189         this.measure_list = [];
 190         this.fields = [];
 191         this.pivot = new openerp.web_graph.PivotTable(model, []);
 192         this.mode = 'pivot';
 193         if (_.has(options, 'mode')) { this.mode = mode; }
 194         this.enabled = true;
 195         if (_.has(options, 'enabled')) { this.enabled = options.enabled; }
 196         this.visible_ui = true;
 197         this.bar_ui = 'group'; // group or stack
 198         this.config(options || {});
 199     },
 200
 201     // hide ui/show, stacked/grouped
 202     config: function (options) {
 203         if (_.has(options, 'visible_ui')) {
 204             this.visible_ui = options.visible_ui;
 205         }
 206         if (_.has(options, 'bar_ui')) {
 207             this.bar_ui = options.bar_ui;
 208         }
 209         this.pivot.config(options);
 210     },
 211
 212     start: function() {
 213         var self = this;
 214         this.table = $('<table></table>');
 215         this.$('.graph_main_content').append(this.table);
 216         // get the most important fields (of the model) by looking at the
 217         // groupby filters defined in the search view
 218         var options = {model:this.model, view_type: 'search'},
 219             deferred1 = instance.web.fields_view_get(options).then(function (search_view) {
 220                 var groups = _.select(search_view.arch.children, function (c) {
 221                     return (c.tag == 'group') && (c.attrs.string != 'Display');
 222                 });
 223                 _.each(groups, function(g) {
 224                     _.each(g.children, function (g) {
 225                         if (g.attrs.context) {
 226                             var field_id = py.eval(g.attrs.context).group_by;
 227                             self.important_fields.push(field_id);
 228                         }
 229                     });
 230                 });
 231             });
 232
 233         // get the fields descriptions and measure list from the model
 234         var deferred2 = this.model.call('fields_get', []).then(function (fs) {
 235             self.fields = fs;
 236             var temp = _.map(fs, function (field, name) {
 237                 return {name:name, type: field.type};
 238             });
 239             temp = _.filter(temp, function (field) {
 240                 return (((field.type === 'integer') || (field.type === 'float')) && (field.name !== 'id'));
 241             });
 242             self.measure_list = _.map(temp, function (field) {
 243                 return field.name;
 244             });
 245
 246             var measure_selection = self.$('.graph_measure_selection');
 247             _.each(self.measure_list, function (measure) {
 248                 var choice = $('<a></a>').attr('data-choice', measure)
 249                                          .attr('href', '#')
 250                                          .append(self.fields[measure].string);
 251                 measure_selection.append($('<li></li>').append(choice));
 252             });
 253         });
 254
 255         return $.when(deferred1, deferred2).then(function () {
 256             if (this.enabled) {
 257                 this.activate_display();
 258             }
 259         });
 260     },
 261
 262     activate_display: function () {
 263         this.pivot.on('redraw_required', this, this.proxy('display_data'));
 264         this.pivot.update_data();
 265         this.enabled = true;
 266         instance.web.bus.on('click', this, function () {
 267             if (this.dropdown) {
 268                 this.dropdown.remove();
 269                 this.dropdown = null;
 270             }
 271         });
 272     },
 273
 274     display_data: function () {
 275         this.$('.graph_main_content svg').remove();
 276         this.$('.graph_main_content div').remove();
 277         this.table.empty();
 278
 279         if (this.visible_ui) {
 280             this.$('.graph_header').css('display', 'block');
 281         } else {
 282             this.$('.graph_header').css('display', 'none');
 283         }
 284         if (this.pivot.no_data) {
 285             this.$('.graph_main_content').append($(QWeb.render('graph_no_data')));
 286         } else {
 287             var table_modes = ['pivot', 'heatmap', 'row_heatmap', 'col_heatmap'];
 288             if (_.contains(table_modes, this.mode)) {
 289                 this.draw_table();
 290             } else {
 291                 this.$('.graph_main_content').append($('<div><svg></svg></div>'));
 292                 this.svg = this.$('.graph_main_content svg')[0];
 293                 this.width = this.$el.width();
 294                 this.height = Math.min(Math.max(document.documentElement.clientHeight - 116 - 60, 250), Math.round(0.8*this.$el.width()));
 295                 this[this.mode]();
 296             }
 297         }
 298     },
 299
 300     mode_selection: function (event) {
 301         event.preventDefault();
 302         var mode = event.target.attributes['data-mode'].nodeValue;
 303         this.mode = mode;
 304         this.display_data();
 305     },
 306
 307     measure_selection: function (event) {
 308         event.preventDefault();
 309         var measure = event.target.attributes['data-choice'].nodeValue;
 310         var actual_measure = (measure === '__count') ? null : measure;
 311         this.pivot.config({measure:actual_measure});
 312     },
 313
 314     option_selection: function (event) {
 315         event.preventDefault();
 316         switch (event.target.attributes['data-choice'].nodeValue) {
 317             case 'swap_axis':
 318                 this.pivot.swap_axis();
 319                 break;
 320             case 'expand_all':
 321                 this.pivot.rows.headers = null;
 322                 this.pivot.cols.headers = null;
 323                 this.pivot.update_data();
 324                 break;
 325             case 'update_values':
 326                 this.pivot.update_data();
 327                 break;
 328             case 'export_data':
 329                 // Export code...  To do...
 330                 break;
 331         }
 332     },
 333
 334     header_cell_clicked: function (event) {
 335         event.preventDefault();
 336         event.stopPropagation();
 337         var id = event.target.attributes['data-id'].nodeValue,
 338             header = this.pivot.get_header(id),
 339             self = this;
 340
 341         if (header.is_expanded) {
 342             this.pivot.fold(header);
 343         } else {
 344             if (header.path.length < header.root.groupby.length) {
 345                 var field = header.root.groupby[header.path.length];
 346                 this.pivot.expand(id, field);
 347             } else {
 348                 if (!this.important_fields.length) {
 349                     return;
 350                 }
 351                 var fields = _.map(this.important_fields, function (field) {
 352                         return {id: field, value: self.fields[field].string};
 353                 });
 354                 this.dropdown = $(QWeb.render('field_selection', {fields:fields, header_id:id}));
 355                 $(event.target).after(this.dropdown);
 356                 this.dropdown.css({position:'absolute',
 357                                    left:event.pageX,
 358                                    top:event.pageY});
 359                 this.$('.field-selection').next('.dropdown-menu').toggle();
 360             }
 361         }
 362     },
 363
 364     field_selection: function (event) {
 365         var id = event.target.attributes['data-id'].nodeValue,
 366             field_id = event.target.attributes['data-field-id'].nodeValue;
 367         event.preventDefault();
 368         this.pivot.expand(id, field_id);
 369     },
 370
 371 /******************************************************************************
 372  * Drawing pivot table methods...
 373  ******************************************************************************/
 374     draw_table: function () {
 375         this.pivot.rows.main.title = 'Total';
 376         this.pivot.cols.main.title = this.measure_label();
 377         this.draw_top_headers();
 378         _.each(this.pivot.rows.headers, this.proxy('draw_row'));
 379     },
 380
 381     measure_label: function () {
 382         return (this.pivot.measure) ? this.fields[this.pivot.measure].string : 'Quantity';
 383     },
 384
 385     make_border_cell: function (colspan, rowspan) {
 386         return $('<td></td>').addClass('graph_border')
 387                              .attr('colspan', colspan)
 388                              .attr('rowspan', rowspan);
 389     },
 390
 391     make_header_title: function (header) {
 392         return $('<span> </span>')
 393             .addClass('web_graph_click')
 394             .attr('href', '#')
 395             .addClass((header.is_expanded) ? 'fa fa-minus-square' : 'fa fa-plus-square')
 396             .append((header.title !== undefined) ? header.title : 'Undefined');
 397     },
 398
 399     draw_top_headers: function () {
 400         var self = this,
 401             pivot = this.pivot,
 402             height = _.max(_.map(pivot.cols.headers, function(g) {return g.path.length;})),
 403             header_cells = [[this.make_border_cell(1, height)]];
 404
 405         function set_dim (cols) {
 406             _.each(cols.children, set_dim);
 407             if (cols.children.length === 0) {
 408                 cols.height = height - cols.path.length + 1;
 409                 cols.width = 1;
 410             } else {
 411                 cols.height = 1;
 412                 cols.width = _.reduce(cols.children, function (sum,c) { return sum + c.width;}, 0);
 413             }
 414         }
 415
 416         function make_col_header (col) {
 417             var cell = self.make_border_cell(col.width, col.height);
 418             return cell.append(self.make_header_title(col).attr('data-id', col.id));
 419         }
 420
 421         function make_cells (queue, level) {
 422             var col = queue[0];
 423             queue = _.rest(queue).concat(col.children);
 424             if (col.path.length == level) {
 425                 _.last(header_cells).push(make_col_header(col));
 426             } else {
 427                 level +=1;
 428                 header_cells.push([make_col_header(col)]);
 429             }
 430             if (queue.length !== 0) {
 431                 make_cells(queue, level);
 432             }
 433         }
 434
 435         set_dim(pivot.cols.main);  // add width and height info to columns headers
 436         if (pivot.cols.main.children.length === 0) {
 437             make_cells(pivot.cols.headers, 0);
 438         } else {
 439             make_cells(pivot.cols.main.children, 1);
 440             header_cells[0].push(self.make_border_cell(1, height).append('Total').css('font-weight', 'bold'));
 441         }
 442
 443         _.each(header_cells, function (cells) {
 444             self.table.append($('<tr></tr>').append(cells));
 445         });
 446     },
 447
 448     get_measure_type: function () {
 449         var measure = this.pivot.measure;
 450         return (measure) ? this.fields[measure].type : 'integer';
 451     },
 452
 453     draw_row: function (row) {
 454         var self = this,
 455             pivot = this.pivot,
 456             measure_type = this.get_measure_type(),
 457             html_row = $('<tr></tr>'),
 458             row_header = this.make_border_cell(1,1)
 459                 .append(this.make_header_title(row).attr('data-id', row.id))
 460                 .addClass('graph_border');
 461
 462         for (var i in _.range(row.path.length)) {
 463             row_header.prepend($('<span/>', {class:'web_graph_indent'}));
 464         }
 465
 466         html_row.append(row_header);
 467
 468         _.each(pivot.cols.headers, function (col) {
 469             if (col.children.length === 0) {
 470                 var value = pivot.get_value(row.id, col.id),
 471                     cell = make_cell(value, col);
 472                 html_row.append(cell);
 473             }
 474         });
 475
 476         if (pivot.cols.main.children.length > 0) {
 477             var cell = make_cell(pivot.get_total(row), pivot.cols.main)
 478                             .css('font-weight', 'bold');
 479             html_row.append(cell);
 480         }
 481
 482         this.table.append(html_row);
 483
 484         function make_cell (value, col) {
 485             var color,
 486                 total,
 487                 cell = $('<td></td>');
 488             if ((self.mode === 'pivot') && (row.is_expanded) && (row.path.length <=2)) {
 489                 color = row.path.length * 5 + 240;
 490                 cell.css('background-color', $.Color(color, color, color));
 491             }
 492             if (value === undefined) {
 493                 return cell;
 494             }
 495             cell.append(instance.web.format_value(value, {type: measure_type}));
 496             if (self.mode === 'heatmap') {
 497                 total = pivot.get_total();
 498                 color = Math.floor(50 + 205*(total - value)/total);
 499                 cell.css('background-color', $.Color(255, color, color));
 500             }
 501             if (self.mode === 'row_heatmap') {
 502                 total = pivot.get_total(row);
 503                 color = Math.floor(50 + 205*(total - value)/total);
 504                 cell.css('background-color', $.Color(255, color, color));
 505             }
 506             if (self.mode === 'col_heatmap') {
 507                 total = pivot.get_total(col);
 508                 color = Math.floor(50 + 205*(total - value)/total);
 509                 cell.css('background-color', $.Color(255, color, color));
 510             }
 511             return cell;
 512         }
 513     },
 514
 515 /******************************************************************************
 516  * Drawing charts methods...
 517  ******************************************************************************/
 518     bar_chart: function () {
 519         var self = this,
 520             dim_x = this.pivot.rows.groupby.length,
 521             dim_y = this.pivot.cols.groupby.length,
 522             data;
 523
 524         // No groupby **************************************************************
 525         if ((dim_x === 0) && (dim_y === 0)) {
 526             data = [{key: 'Total', values:[{
 527                 x: 'Total',
 528                 y: this.pivot.get_value(this.pivot.rows.main.id, this.pivot.cols.main.id),
 529             }]}];
 530         // Only column groupbys ****************************************************
 531         } else if ((dim_x === 0) && (dim_y >= 1)){
 532             data =  _.map(this.pivot.get_columns_depth(1), function (header) {
 533                 return {
 534                     key: header.title,
 535                     values: [{x:header.root.main.title, y: self.pivot.get_total(header)}]
 536                 };
 537             });
 538         // Just 1 row groupby ******************************************************
 539         } else if ((dim_x === 1) && (dim_y === 0))  {
 540             data = _.map(this.pivot.rows.main.children, function (pt) {
 541                 var value = self.pivot.get_value(pt.id, self.pivot.cols.main.id),
 542                     title = (pt.title !== undefined) ? pt.title : 'Undefined';
 543                 return {x: title, y: value};
 544             });
 545             data = [{key: this.measure_label(), values:data}];
 546         // 1 row groupby and some col groupbys**************************************
 547         } else if ((dim_x === 1) && (dim_y >= 1))  {
 548             data = _.map(this.pivot.get_columns_depth(1), function (colhdr) {
 549                 var values = _.map(self.pivot.get_rows_depth(1), function (header) {
 550                     return {
 551                         x: header.title || 'Undefined',
 552                         y: self.pivot.get_value(header.id, colhdr.id, 0)
 553                     };
 554                 });
 555                 return {key: colhdr.title || 'Undefined', values: values};
 556             });
 557         // At least two row groupby*************************************************
 558         } else {
 559             var keys = _.uniq(_.map(this.pivot.get_rows_depth(2), function (hdr) {
 560                 return hdr.title || 'Undefined';
 561             }));
 562             data = _.map(keys, function (key) {
 563                 var values = _.map(self.pivot.get_rows_depth(1), function (hdr) {
 564                     var subhdr = _.find(hdr.children, function (child) {
 565                         return ((child.title === key) || ((child.title === undefined) && (key === 'Undefined')));
 566                     });
 567                     return {
 568                         x: hdr.title || 'Undefined',
 569                         y: (subhdr) ? self.pivot.get_total(subhdr) : 0
 570                     };
 571                 });
 572                 return {key:key, values: values};
 573             });
 574         }
 575
 576         nv.addGraph(function () {
 577           var chart = nv.models.multiBarChart()
 578                 .width(self.width)
 579                 .height(self.height)
 580                 .stacked(self.bar_ui === 'stack')
 581                 .staggerLabels(true);
 582
 583             if (dim_x === 1 && dim_y === 0) { chart.showControls(false); }
 584
 585             d3.select(self.svg)
 586                 .datum(data)
 587                 .attr('width', self.width)
 588                 .attr('height', self.height)
 589                 .call(chart);
 590
 591             nv.utils.windowResize(chart.update);
 592             return chart;
 593         });
 594
 595     },
 596
 597     line_chart: function () {
 598         var self = this,
 599             dim_x = this.pivot.rows.groupby.length,
 600             dim_y = this.pivot.cols.groupby.length;
 601
 602         var data = _.map(this.pivot.get_cols_leaves(), function (col) {
 603             var values = _.map(self.pivot.get_rows_depth(dim_x), function (row) {
 604                 return {x: row.title, y: self.pivot.get_value(row.id,col.id, 0)};
 605             });
 606             var title = _.map(col.path, function (p) {
 607                 return p || 'Undefined';
 608             }).join('/');
 609             if (dim_y === 0) {
 610                 title = self.measure_label();
 611             }
 612             return {values: values, key: title};
 613         });
 614
 615         nv.addGraph(function () {
 616             var chart = nv.models.lineChart()
 617                 .x(function (d,u) { return u; })
 618                 .width(self.width)
 619                 .height(self.height)
 620                 .margin({top: 30, right: 20, bottom: 20, left: 60});
 621
 622             d3.select(self.svg)
 623                 .attr('width', self.width)
 624                 .attr('height', self.height)
 625                 .datum(data)
 626                 .call(chart);
 627
 628             return chart;
 629           });
 630     },
 631
 632     pie_chart: function () {
 633         var self = this,
 634             dim_x = this.pivot.rows.groupby.length;
 635
 636         var data = _.map(this.pivot.get_rows_leaves(), function (row) {
 637             var title = _.map(row.path, function (p) {
 638                 return p || 'Undefined';
 639             }).join('/');
 640             if (dim_x === 0) {
 641                 title = self.measure_label;
 642             }
 643             return {x: title, y: self.pivot.get_total(row)};
 644         });
 645
 646         nv.addGraph(function () {
 647             var chart = nv.models.pieChart()
 648                 .color(d3.scale.category10().range())
 649                 .width(self.width)
 650                 .height(self.height);
 651
 652             d3.select(self.svg)
 653                 .datum(data)
 654                 .transition().duration(1200)
 655                 .attr('width', self.width)
 656                 .attr('height', self.height)
 657                 .call(chart);
 658
 659             nv.utils.windowResize(chart.update);
 660             return chart;
 661         });
 662     },
 663
 664 });
 665
 666 };
 667
 668
 669
 670
 671
 672
 673
 674