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

/*---------------------------------------------------------
 * OpenERP web_graph
 *---------------------------------------------------------*/

/* jshint undef: false  */

openerp.web_graph = function (instance) {
'use strict';

var _lt = instance.web._lt;
var _t = instance.web._t;
var QWeb = instance.web.qweb;

instance.web.views.add('graph', 'instance.web_graph.GraphView');

instance.web_graph.GraphView = instance.web.View.extend({
    display_name: _lt('Graph'),
    view_type: 'graph',

    init: function(parent, dataset, view_id, options) {
        this._super(parent, dataset, view_id, options);
        this.dataset = dataset;
        this.model = new instance.web.Model(dataset.model, {group_by_no_leaf: true});
        this.search_view = parent.searchview;
        this.search_view_groupby = [];
        this.groupby_mode = 'default';  // 'default' or 'manual'
        this.default_row_groupby = [];
        this.default_col_groupby = [];
        this.search_field = {
            get_context: this.proxy('get_context'),
            get_domain: function () {},
            get_groupby: function () { },
        };
    },

    get_context: function (facet) {
        var col_group_by = _.map(facet.values.models, function (model) {
            return model.attributes.value.attrs.context.col_group_by;
        });
        return {col_group_by : col_group_by};
    },

    start: function () {
        var options = {enabled:false};
        this.graph_widget = new openerp.web_graph.Graph(this, this.model, options);
        this.graph_widget.appendTo(this.$el);
        this.graph_widget.pivot.on('groupby_changed', this, this.proxy('register_groupby'));
        return this.load_view();
    },

    view_loading: function (fields_view_get) {
        var self = this,
            arch = fields_view_get.arch,
            measure = null,
            stacked = false;

        if (arch.attrs.type === 'bar' || !_.has(arch.attrs, 'type')) {
            this.graph_widget.mode = 'bar_chart';
        }
        if (arch.attrs.stacked === 'True') {
            stacked = true;
        }

        _.each(arch.children, function (field) {
            if (_.has(field.attrs, 'type')) {
                switch (field.attrs.type) {
                    case 'row':
                        self.default_row_groupby.push(field.attrs.name);
                        break;
                    case 'col':
                        self.default_col_groupby.push(field.attrs.name);
                        break;
                    case 'measure':
                        measure = field.attrs.name;
                        break;
                }
            } else {  // old style, kept for backward compatibility
                if ('operator' in field.attrs) {
                    measure = (measure) ? measure : field.attrs.name;
                } else {
                    self.default_row_groupby.push(field.attrs.name);
                }
            }
        });
        this.graph_widget.config({
            measure:measure,
            update:false,
            bar_ui: (stacked) ? 'stack' : 'group'
        });
    },

    do_search: function (domain, context, group_by) {
        var col_groupby = context.col_group_by || [],
            options = {domain:domain};

        this.search_view_groupby = group_by;

        if (group_by.length && this.groupby_mode !== 'manual') {
            if (_.isEqual(col_groupby, [])) {
                col_groupby = this.default_col_groupby;
            }
        }
        if (group_by.length || col_groupby.length) {
            this.groupby_mode = 'manual';
        }
        if (!this.graph_widget.enabled) {
            options.update = false;
            options.silent = true;
        }

        if (this.groupby_mode === 'manual') {
            options.row_groupby = group_by;
            options.col_groupby = col_groupby;
        } else {
            options.row_groupby = _.toArray(this.default_row_groupby);
            options.col_groupby = _.toArray(this.default_col_groupby);
        }
        this.graph_widget.pivot.config(options);

        if (!this.graph_widget.enabled) {
            this.graph_widget.activate_display();
            this.ViewManager.on('switch_mode', this, function () {this.graph_widget.pivot.update_data(); });
        }
    },

    do_show: function () {
        this.do_push_state({});
        return this._super();
    },

    register_groupby: function() {
        var self = this,
            query = this.search_view.query;

        this.groupby_mode = 'manual';
        if (_.isEqual(this.search_view_groupby, this.graph_widget.pivot.rows.groupby) ||
            (!_.has(this.search_view, '_s_groupby'))) {
            return;
        }
        var rows = _.map(this.graph_widget.pivot.rows.groupby, function (group) {
            return make_facet('GroupBy', group);
        });
        var cols = _.map(this.graph_widget.pivot.cols.groupby, function (group) {
            return make_facet('ColGroupBy', group);
        });

        query.reset(rows.concat(cols));

        function make_facet (category, fields) {
            var values,
                icon,
                backbone_field,
                cat_name;
            if (!(fields instanceof Array)) { fields = [fields]; }
            if (category === 'GroupBy') {
                cat_name = 'group_by';
                icon = 'w';
                backbone_field = self.search_view._s_groupby;
            } else {
                cat_name = 'col_group_by';
                icon = 'f';
                backbone_field = self.search_field;
            }
            values =  _.map(fields, function (field) {
                var context = {};
                context[cat_name] = field;
                return {label: self.graph_widget.fields[field].string, value: {attrs:{domain: [], context: context}}};
            });
            return {category:category, values: values, icon:icon, field: backbone_field};
        }
    },
});

instance.web_graph.Graph = instance.web.Widget.extend({
    template: 'GraphWidget',

    events: {
        'click .graph_mode_selection li' : 'mode_selection',
        'click .graph_measure_selection li' : 'measure_selection',
        'click .graph_options_selection li' : 'option_selection',
        'click .web_graph_click' : 'header_cell_clicked',
        'click a.field-selection' : 'field_selection',
    },

    init: function(parent, model, options) {
        this._super(parent);
        this.model = model;
        this.important_fields = [];
        this.measure_list = [];
        this.fields = [];
        this.pivot = new openerp.web_graph.PivotTable(model, []);
        this.mode = 'pivot';
        if (_.has(options, 'mode')) { this.mode = mode; }
        this.enabled = true;
        if (_.has(options, 'enabled')) { this.enabled = options.enabled; }
        this.visible_ui = true;
        this.bar_ui = 'group'; // group or stack
        this.config(options || {});
    },

    // hide ui/show, stacked/grouped
    config: function (options) {
        if (_.has(options, 'visible_ui')) {
            this.visible_ui = options.visible_ui;
        }
        if (_.has(options, 'bar_ui')) {
            this.bar_ui = options.bar_ui;
        }
        this.pivot.config(options);
    },

    start: function() {
        var self = this;
        this.table = $('<table></table>');
        this.$('.graph_main_content').append(this.table);
        // get the most important fields (of the model) by looking at the
        // groupby filters defined in the search view
        var options = {model:this.model, view_type: 'search'},
            deferred1 = instance.web.fields_view_get(options).then(function (search_view) {
                var groups = _.select(search_view.arch.children, function (c) {
                    return (c.tag == 'group') && (c.attrs.string != 'Display');
                });
                _.each(groups, function(g) {
                    _.each(g.children, function (g) {
                        if (g.attrs.context) {
                            var field_id = py.eval(g.attrs.context).group_by;
                            if (field_id) {
                                self.important_fields.push(field_id);
                            }
                        }
                    });
                });
            });

        // get the fields descriptions and measure list from the model
        var deferred2 = this.model.call('fields_get', []).then(function (fs) {
            self.fields = fs;
            self.pivot.config({fields:fs});
            var temp = _.map(fs, function (field, name) {
                return {name:name, type: field.type};
            });
            temp = _.filter(temp, function (field) {
                return (((field.type === 'integer') || (field.type === 'float')) && (field.name !== 'id'));
            });
            self.measure_list = _.map(temp, function (field) {
                return field.name;
            });

            var measure_selection = self.$('.graph_measure_selection');
            _.each(self.measure_list, function (measure) {
                var choice = $('<a></a>').attr('data-choice', measure)
                                         .attr('href', '#')
                                         .append(self.fields[measure].string);
                measure_selection.append($('<li></li>').append(choice));
            });
        });

        return $.when(deferred1, deferred2).then(function () {
            if (this.enabled) {
                this.activate_display();
            }
        });
    },

    activate_display: function () {
        this.pivot.on('redraw_required', this, this.proxy('display_data'));
        this.pivot.update_data();
        this.enabled = true;
        instance.web.bus.on('click', this, function () {
            if (this.dropdown) {
                this.dropdown.remove();
                this.dropdown = null;
            }
        });
    },

    display_data: function () {
        this.$('.graph_main_content svg').remove();
        this.$('.graph_main_content div').remove();
        this.table.empty();

        if (this.visible_ui) {
            this.$('.graph_header').css('display', 'block');
        } else {
            this.$('.graph_header').css('display', 'none');
        }
        if (this.pivot.no_data) {
            this.$('.graph_main_content').append($(QWeb.render('graph_no_data')));
        } else {
            var table_modes = ['pivot', 'heatmap', 'row_heatmap', 'col_heatmap'];
            if (_.contains(table_modes, this.mode)) {
                this.draw_table();
            } else {
                this.$('.graph_main_content').append($('<div><svg></svg></div>'));
                this.svg = this.$('.graph_main_content svg')[0];
                this.width = this.$el.width();
                this.height = Math.min(Math.max(document.documentElement.clientHeight - 116 - 60, 250), Math.round(0.8*this.$el.width()));
                this[this.mode]();
            }
        }
    },

    mode_selection: function (event) {
        event.preventDefault();
        var mode = event.target.attributes['data-mode'].nodeValue;
        this.mode = mode;
        this.display_data();
    },

    measure_selection: function (event) {
        event.preventDefault();
        var measure = event.target.attributes['data-choice'].nodeValue;
        var actual_measure = (measure === '__count') ? null : measure;
        this.pivot.config({measure:actual_measure});
    },

    option_selection: function (event) {
        event.preventDefault();
        switch (event.target.attributes['data-choice'].nodeValue) {
            case 'bar_grouped':
                this.bar_ui = 'group';
                if (this.mode === 'bar_chart') {
                    this.display_data();
                }
                break;
            case 'bar_stacked':
                this.bar_ui = 'stack';
                if (this.mode === 'bar_chart') {
                    this.display_data();
                }
                break;
            case 'swap_axis':
                this.pivot.swap_axis();
                break;
            case 'expand_all':
                this.pivot.rows.headers = null;
                this.pivot.cols.headers = null;
                this.pivot.update_data();
                break;
            case 'update_values':
                this.pivot.update_data();
                break;
            case 'export_data':
                // Export code...  To do...
                break;
        }
    },

    header_cell_clicked: function (event) {
        event.preventDefault();
        event.stopPropagation();
        var id = event.target.attributes['data-id'].nodeValue,
            header = this.pivot.get_header(id),
            self = this;

        if (header.is_expanded) {
            this.pivot.fold(header);
        } else {
            if (header.path.length < header.root.groupby.length) {
                var field = header.root.groupby[header.path.length];
                this.pivot.expand(id, field);
            } else {
                if (!this.important_fields.length) {
                    return;
                }
                var fields = _.map(this.important_fields, function (field) {
                        return {id: field, value: self.fields[field].string};
                });
                this.dropdown = $(QWeb.render('field_selection', {fields:fields, header_id:id}));
                $(event.target).after(this.dropdown);
                this.dropdown.css({position:'absolute',
                                   left:event.pageX,
                                   top:event.pageY});
                this.$('.field-selection').next('.dropdown-menu').toggle();
            }
        }
    },

    field_selection: function (event) {
        var id = event.target.attributes['data-id'].nodeValue,
            field_id = event.target.attributes['data-field-id'].nodeValue;
        event.preventDefault();
        this.pivot.expand(id, field_id);
    },

/******************************************************************************
 * Drawing pivot table methods...
 ******************************************************************************/
    draw_table: function () {
        this.pivot.rows.main.title = 'Total';
        this.pivot.cols.main.title = this.measure_label();
        this.draw_top_headers();
        _.each(this.pivot.rows.headers, this.proxy('draw_row'));
    },

    measure_label: function () {
        return (this.pivot.measure) ? this.fields[this.pivot.measure].string : 'Quantity';
    },

    make_border_cell: function (colspan, rowspan) {
        return $('<td></td>').addClass('graph_border')
                             .attr('colspan', colspan)
                             .attr('rowspan', rowspan);
    },

    make_header_title: function (header) {
        return $('<span> </span>')
            .addClass('web_graph_click')
            .attr('href', '#')
            .addClass((header.is_expanded) ? 'fa fa-minus-square' : 'fa fa-plus-square')
            .append((header.title !== undefined) ? header.title : 'Undefined');
    },

    draw_top_headers: function () {
        var self = this,
            pivot = this.pivot,
            height = _.max(_.map(pivot.cols.headers, function(g) {return g.path.length;})),
            header_cells = [[this.make_border_cell(1, height)]];

        function set_dim (cols) {
            _.each(cols.children, set_dim);
            if (cols.children.length === 0) {
                cols.height = height - cols.path.length + 1;
                cols.width = 1;
            } else {
                cols.height = 1;
                cols.width = _.reduce(cols.children, function (sum,c) { return sum + c.width;}, 0);
            }
        }

        function make_col_header (col) {
            var cell = self.make_border_cell(col.width, col.height);
            return cell.append(self.make_header_title(col).attr('data-id', col.id));
        }

        function make_cells (queue, level) {
            var col = queue[0];
            queue = _.rest(queue).concat(col.children);
            if (col.path.length == level) {
                _.last(header_cells).push(make_col_header(col));
            } else {
                level +=1;
                header_cells.push([make_col_header(col)]);
            }
            if (queue.length !== 0) {
                make_cells(queue, level);
            }
        }

        set_dim(pivot.cols.main);  // add width and height info to columns headers
        if (pivot.cols.main.children.length === 0) {
            make_cells(pivot.cols.headers, 0);
        } else {
            make_cells(pivot.cols.main.children, 1);
            header_cells[0].push(self.make_border_cell(1, height).append('Total').css('font-weight', 'bold'));
        }

        _.each(header_cells, function (cells) {
            self.table.append($('<tr></tr>').append(cells));
        });
    },

    get_measure_type: function () {
        var measure = this.pivot.measure;
        return (measure) ? this.fields[measure].type : 'integer';
    },

    draw_row: function (row) {
        var self = this,
            pivot = this.pivot,
            measure_type = this.get_measure_type(),
            html_row = $('<tr></tr>'),
            row_header = this.make_border_cell(1,1)
                .append(this.make_header_title(row).attr('data-id', row.id))
                .addClass('graph_border');

        for (var i = 0; i < row.path.length; i++) {
            row_header.prepend($('<span/>', {class:'web_graph_indent'}));
        }

        html_row.append(row_header);

        _.each(pivot.cols.headers, function (col) {
            if (col.children.length === 0) {
                var value = pivot.get_value(row.id, col.id),
                    cell = make_cell(value, col);
                html_row.append(cell);
            }
        });

        if (pivot.cols.main.children.length > 0) {
            var cell = make_cell(pivot.get_total(row), pivot.cols.main)
                            .css('font-weight', 'bold');
            html_row.append(cell);
        }

        this.table.append(html_row);

        function make_cell (value, col) {
            var color,
                total,
                cell = $('<td></td>');
            if ((self.mode === 'pivot') && (row.is_expanded) && (row.path.length <=2)) {
                color = row.path.length * 5 + 240;
                cell.css('background-color', $.Color(color, color, color));
            }
            if (value === undefined) {
                return cell;
            }
            cell.append(instance.web.format_value(value, {type: measure_type}));
            if (self.mode === 'heatmap') {
                total = pivot.get_total();
                color = Math.floor(50 + 205*(total - value)/total);
                cell.css('background-color', $.Color(255, color, color));
            }
            if (self.mode === 'row_heatmap') {
                total = pivot.get_total(row);
                color = Math.floor(50 + 205*(total - value)/total);
                cell.css('background-color', $.Color(255, color, color));
            }
            if (self.mode === 'col_heatmap') {
                total = pivot.get_total(col);
                color = Math.floor(50 + 205*(total - value)/total);
                cell.css('background-color', $.Color(255, color, color));
            }
            return cell;
        }
    },

/******************************************************************************
 * Drawing charts methods...
 ******************************************************************************/
    bar_chart: function () {
        var self = this,
            dim_x = this.pivot.rows.groupby.length,
            dim_y = this.pivot.cols.groupby.length,
            data;

        // No groupby **************************************************************
        if ((dim_x === 0) && (dim_y === 0)) {
            data = [{key: 'Total', values:[{
                x: 'Total',
                y: this.pivot.get_value(this.pivot.rows.main.id, this.pivot.cols.main.id),
            }]}];
        // Only column groupbys ****************************************************
        } else if ((dim_x === 0) && (dim_y >= 1)){
            data =  _.map(this.pivot.get_columns_depth(1), function (header) {
                return {
                    key: header.title,
                    values: [{x:header.root.main.title, y: self.pivot.get_total(header)}]
                };
            });
        // Just 1 row groupby ******************************************************
        } else if ((dim_x === 1) && (dim_y === 0))  {
            data = _.map(this.pivot.rows.main.children, function (pt) {
                var value = self.pivot.get_value(pt.id, self.pivot.cols.main.id),
                    title = (pt.title !== undefined) ? pt.title : 'Undefined';
                return {x: title, y: value};
            });
            data = [{key: this.measure_label(), values:data}];
        // 1 row groupby and some col groupbys**************************************
        } else if ((dim_x === 1) && (dim_y >= 1))  {
            data = _.map(this.pivot.get_columns_depth(1), function (colhdr) {
                var values = _.map(self.pivot.get_rows_depth(1), function (header) {
                    return {
                        x: header.title || 'Undefined',
                        y: self.pivot.get_value(header.id, colhdr.id, 0)
                    };
                });
                return {key: colhdr.title || 'Undefined', values: values};
            });
        // At least two row groupby*************************************************
        } else {
            var keys = _.uniq(_.map(this.pivot.get_rows_depth(2), function (hdr) {
                return hdr.title || 'Undefined';
            }));
            data = _.map(keys, function (key) {
                var values = _.map(self.pivot.get_rows_depth(1), function (hdr) {
                    var subhdr = _.find(hdr.children, function (child) {
                        return ((child.title === key) || ((child.title === undefined) && (key === 'Undefined')));
                    });
                    return {
                        x: hdr.title || 'Undefined',
                        y: (subhdr) ? self.pivot.get_total(subhdr) : 0
                    };
                });
                return {key:key, values: values};
            });
        }

        nv.addGraph(function () {
          var chart = nv.models.multiBarChart()
                .width(self.width)
                .height(self.height)
                .reduceXTicks(false)
                .stacked(self.bar_ui === 'stack')
                .showControls(false)
                .staggerLabels(true);

            if (self.width / data[0].values.length < 100) {
                chart.rotateLabels(-15);
                chart.reduceXTicks(true);
                chart.margin({bottom:40});
            }

            d3.select(self.svg)
                .datum(data)
                .attr('width', self.width)
                .attr('height', self.height)
                .call(chart);

            nv.utils.windowResize(chart.update);
            return chart;
        });

    },

    line_chart: function () {
        var self = this,
            dim_x = this.pivot.rows.groupby.length,
            dim_y = this.pivot.cols.groupby.length;

        var data = _.map(this.pivot.get_cols_leaves(), function (col) {
            var values = _.map(self.pivot.get_rows_depth(dim_x), function (row) {
                return {x: row.title, y: self.pivot.get_value(row.id,col.id, 0)};
            });
            var title = _.map(col.path, function (p) {
                return p || 'Undefined';
            }).join('/');
            if (dim_y === 0) {
                title = self.measure_label();
            }
            return {values: values, key: title};
        });

        nv.addGraph(function () {
            var chart = nv.models.lineChart()
                .x(function (d,u) { return u; })
                .width(self.width)
                .height(self.height)
                .margin({top: 30, right: 20, bottom: 20, left: 60});

            d3.select(self.svg)
                .attr('width', self.width)
                .attr('height', self.height)
                .datum(data)
                .call(chart);

            return chart;
          });
    },

    pie_chart: function () {
        var self = this,
            dim_x = this.pivot.rows.groupby.length;

        var data = _.map(this.pivot.get_rows_leaves(), function (row) {
            var title = _.map(row.path, function (p) {
                return p || 'Undefined';
            }).join('/');
            if (dim_x === 0) {
                title = self.measure_label;
            }
            return {x: title, y: self.pivot.get_total(row)};
        });

        nv.addGraph(function () {
            var chart = nv.models.pieChart()
                .color(d3.scale.category10().range())
                .width(self.width)
                .height(self.height);

            d3.select(self.svg)
                .datum(data)
                .transition().duration(1200)
                .attr('width', self.width)
                .attr('height', self.height)
                .call(chart);

            nv.utils.windowResize(chart.update);
            return chart;
        });
    },

});

};