diff --git a/addons/base_graph/static/src/js/graph.js b/addons/base_graph/static/src/js/graph.js
index 0c0f9deb629..edf3809d6f1 100644
--- a/addons/base_graph/static/src/js/graph.js
+++ b/addons/base_graph/static/src/js/graph.js
@@ -3,6 +3,15 @@
*---------------------------------------------------------*/
openerp.base_graph = function (openerp) {
+var COLOR_PALETTE = [
+ '#cc99ff', '#ccccff', '#48D1CC', '#CFD784', '#8B7B8B', '#75507b',
+ '#b0008c', '#ff0000', '#ff8e00', '#9000ff', '#0078ff', '#00ff00',
+ '#e6ff00', '#ffff00', '#905000', '#9b0000', '#840067', '#9abe00',
+ '#ffc900', '#510090', '#0000c9', '#009b00', '#75507b', '#3465a4',
+ '#73d216', '#c17d11', '#edd400', '#fcaf3e', '#ef2929', '#ff00c9',
+ '#ad7fa8', '#729fcf', '#8ae234', '#e9b96e', '#fce94f', '#f57900',
+ '#cc0000', '#d400a8'];
+
QWeb.add_template('/base_graph/static/src/xml/base_graph.xml');
openerp.base.views.add('graph', 'openerp.base_graph.GraphView');
openerp.base_graph.GraphView = openerp.base.Controller.extend({
@@ -25,7 +34,6 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
this.rpc("/base_graph/graphview/load", {"model": this.model, "view_id": this.view_id}, this.on_loaded);
},
on_loaded: function(data) {
- var self = this;
this.all_fields = data.all_fields;
this.fields_view = data.fields_view;
this.name = this.fields_view.name || this.fields_view.arch.attrs.string;
@@ -39,17 +47,18 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
this.group_field = '';
this.orientation = this.fields_view.arch.attrs.orientation || '';
- for(fld in this.fields_view.arch.children) {
- if (this.fields_view.arch.children[fld].attrs.operator) {
- this.operator.push(this.fields_view.arch.children[fld].attrs.name);
+ _.each(this.fields_view.arch.children, function (field) {
+ if (field.attrs.operator) {
+ this.operator.push(field.attrs.name);
}
- else if (this.fields_view.arch.children[fld].attrs.group) {
- this.group_field = this.fields_view.arch.children[fld].attrs.name;
+ else if (field.attrs.group) {
+ this.group_field = field.attrs.name;
}
else {
- this.chart_info_fields.push(this.fields_view.arch.children[fld].attrs.name);
+ this.chart_info_fields.push(field.attrs.name);
}
- }
+ }, this);
+
this.operator_field = this.operator[0];
if(this.operator.length > 1){
this.operator_field_one = this.operator[1];
@@ -60,7 +69,7 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
this.chart_info = this.chart_info_fields[0];
this.x_title = this.fields[this.chart_info_fields[0]]['string'];
this.y_title = this.fields[this.operator_field]['string'];
- self.load_chart();
+ this.load_chart();
},
load_chart: function(data) {
@@ -80,75 +89,62 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
}
},
- schedule_chart: function(result) {
+ schedule_chart: function(results) {
this.$element.html(QWeb.render("GraphView", {"fields_view": this.fields_view, "chart": this.chart,'view_id': this.view_id}));
- this.opration_fld = {};
- if (result.length){
- for(res in result) {
- for(fld in result[res]) {
- if (typeof result[res][fld] == 'object') {
- result[res][fld] = result[res][fld][result[res][fld].length - 1];
- }
- if (typeof result[res][fld] == 'string'){
- if (this.all_fields[fld]['selection']){
- for (i in this.all_fields[fld]['selection']){
- if(result[res][fld] == this.all_fields[fld]['selection'][i][0]){
- result[res][fld] = this.all_fields[fld]['selection'][i];
- }
- }
+ if (!results.length) {
+ return;
+ }
+ _.each(results, function (result) {
+ _.each(result, function (field_value, field_name) {
+ if (typeof field_value == 'object') {
+ result[field_name] = field_value[field_value.length - 1];
+ }
+ if (typeof field_value == 'string') {
+ var choices = this.all_fields[field_name]['selection'];
+ _.each(choices, function (choice) {
+ if (field_value == choice[0]) {
+ result[field_name] = choice;
}
- }
+ });
+ }
+ }, this);
+ }, this);
+
+ var graph_data = {};
+ _.each(results, function (result) {
+ var column_key = result[this.chart_info_fields] + "_" + result[this.group_field];
+ var column_descriptor = {};
+ if (graph_data[column_key] == undefined) {
+ column_descriptor[this.operator_field] = result[this.operator_field];
+ if (this.operator.length > 1) {
+ column_descriptor[this.operator_field_one] = result[this.operator_field_one];
+ }
+ column_descriptor[this.chart_info_fields] = result[this.chart_info_fields];
+ if (this.group_field) {
+ column_descriptor[this.group_field] = (typeof result[this.group_field] == 'object') ? result[this.group_field][1] : result[this.group_field];
+ }
+ } else {
+ column_descriptor = graph_data[column_key];
+ column_descriptor[this.operator_field] += result[this.operator_field];
+ if (this.operator.length > 1) {
+ column_descriptor[this.operator_field_one] += result[this.operator_field_one];
}
}
+ graph_data[column_key] = column_descriptor;
+ }, this);
- for (i in result){
- var gen_key = result[i][this.chart_info_fields]+"_"+result[i][this.group_field];
- if (this.opration_fld[gen_key] == undefined){
- var map_val = {}
- map_val[this.operator_field] = result[i][this.operator_field];
- if (this.operator.length > 1){
- map_val[this.operator_field_one] = result[i][this.operator_field_one];
- }
- map_val[this.chart_info_fields] = result[i][this.chart_info_fields];
- if (this.group_field){
- map_val[this.group_field] = (typeof result[i][this.group_field] == 'object')?result[i][this.group_field][1]:result[i][this.group_field];
- }
- this.opration_fld[gen_key] = map_val;
- }else{
- map_val = this.opration_fld[gen_key];
- map_val[this.operator_field] = map_val[this.operator_field] + result[i][this.operator_field];
- if (this.operator.length > 1){
- map_val[this.operator_field_one] = map_val[this.operator_field_one] + result[i][this.operator_field_one];
- }
- this.opration_fld[gen_key] = map_val;
- }
- }
- result = []
- for (i in this.opration_fld){
- result.push(this.opration_fld[i]);
- }
-
- if(this.chart == 'bar') {
- return this.schedule_bar(result);
- } else if(this.chart == "pie") {
- return this.schedule_pie(result);
- }
+ if (this.chart == 'bar') {
+ return this.schedule_bar(_.values(graph_data));
+ } else if (this.chart == "pie") {
+ return this.schedule_pie(_.values(graph_data));
}
},
- schedule_bar: function(result) {
+ schedule_bar: function(results) {
var self = this;
var view_chart = '';
- var xystr = {};
- var xyname = {};
- var res = [];
- this.group_list = [];
- var newkey = '';
-
- var COLOR_PALETTE = ['#cc99ff', '#ccccff', '#48D1CC', '#CFD784', '#8B7B8B', '#75507b', '#b0008c', '#ff0000', '#ff8e00', '#9000ff', '#0078ff', '#00ff00', '#e6ff00', '#ffff00',
- '#905000', '#9b0000', '#840067', '#9abe00', '#ffc900', '#510090', '#0000c9', '#009b00',
- '#75507b', '#3465a4', '#73d216', '#c17d11', '#edd400', '#fcaf3e', '#ef2929', '#ff00c9',
- '#ad7fa8', '#729fcf', '#8ae234', '#e9b96e', '#fce94f', '#f57900', '#cc0000', '#d400a8'];
+ var group_list = [];
+ var newkey = '', newkey_one;
if(self.group_field && (this.operator.length <= 1)){
view_chart = self.orientation == 'horizontal'? 'stackedBarH' : 'stackedBar';
@@ -156,90 +152,84 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
view_chart = self.orientation == 'horizontal'? 'barH' : 'bar';
}
- for (i in result){
- if (self.group_field && (this.operator.length <= 1)){
- newkey =result[i][self.group_field].split(' ').join('_');
- }else{
+ _.each(results, function (result) {
+ if (self.group_field && (this.operator.length <= 1)) {
+ newkey = result[self.group_field].split(' ').join('_');
+ } else {
newkey = "val";
}
- if (jQuery.inArray(newkey, self.group_list) == -1){
- self.group_list.push(newkey);
- if(this.operator.length > 1){
- var newkey_one = "val1";
- self.group_list.push(newkey_one);
- }
+ if (_.contains(group_list, newkey)) {
+ return;
}
- }
+ group_list.push(newkey);
+ if (this.operator.length > 1) {
+ newkey_one = "val1";
+ group_list.push(newkey_one);
+ }
+ }, this);
- for (i in result){
- var xystring = result[i][self.chart_info_fields];
+ var abscissa_data = {};
+ _.each(results, function (result) {
+ var label = result[self.chart_info_fields],
+ section = {};
if (self.group_field && (self.operator.length <= 1)){
- newkey =result[i][self.group_field].split(' ').join('_');
+ newkey = result[self.group_field].split(' ').join('_');
}else{
newkey = "val";
}
- if (xystr[xystring] == undefined){
- xyname = {};
- xyname[self.chart_info_fields] = xystring;
- for (j in self.group_list){
- xyname[self.group_list[j]] = 0.0001;
- }
- xyname[newkey] = result[i][self.operator_field];
- if (self.operator.length > 1){
- xyname[newkey_one] = result[i][self.operator_field_one];
- }
- xystr[xystring] = xyname;
+ if (abscissa_data[label] == undefined){
+ section[self.chart_info_fields] = label;
+ _.each(group_list, function (group) {
+ section[group] = 0.0001;
+ });
+ } else {
+ section = abscissa_data[label];
}
- else{
- xyname = {};
- xyname = xystr[xystring];
- xyname[newkey] = result[i][self.operator_field];
- if (self.operator.length > 1){
- xyname[newkey_one] = result[i][self.operator_field_one];
- }
- xystr[xystring] = xyname;
+ section[newkey] = result[self.operator_field];
+ if (self.operator.length > 1){
+ section[newkey_one] = result[self.operator_field_one];
}
- }
- for (i in xystr){
- res.push(xystr[i]);
- }
+ abscissa_data[label] = section;
+ });
//for legend color
- var grp_color = [];
- for (i in self.group_list){
- var legend = {};
- if (self.group_list[i] == "val"){
+ var grp_color = _.map(group_list, function (group_legend, index) {
+ var legend = {color: COLOR_PALETTE[index]};
+
+ if (group_legend == "val"){
legend['text'] = self.fields[self.operator_field]['string']
- }else if(self.group_list[i] == "val1"){
+ }else if(group_legend == "val1"){
legend['text'] = self.fields[self.operator_field_one]['string']
}else{
- legend['text'] = self.group_list[i];
+ legend['text'] = group_legend;
}
- legend['color'] = COLOR_PALETTE[i];
- grp_color.push(legend);
- }
+ return legend;
+ });
//for axis's value and title
- var temp_ax = {};
- var oth_ax = {};
- temp_ax['template'] = self.chart_info_fields;
- temp_ax['title'] = ""+self.x_title+"" ;
- oth_ax['lines'] = true;
- oth_ax['title'] = ""+self.y_title+"";
+ var abscissa_description = {
+ template: self.chart_info_fields,
+ title: ""+self.x_title+""
+ };
+ var ordinate_description = {
+ lines: true,
+ title: ""+self.y_title+""
+ };
+ var x_axis, y_axis;
if (self.orientation == 'horizontal'){
- var x_ax = oth_ax;
- var y_ax = temp_ax;
+ x_axis = ordinate_description;
+ y_axis = abscissa_description;
}else{
- var x_ax = temp_ax;
- var y_ax = oth_ax;
+ x_axis = abscissa_description;
+ y_axis = ordinate_description;
}
var bar_chart = new dhtmlxchartChart({
view: view_chart,
container: self.view_id+"-barchart",
- value:"#"+self.group_list[0]+"#",
+ value:"#"+group_list[0]+"#",
gradient: "3d",
border: false,
width: 1024,
@@ -248,29 +238,29 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
origin:0,
xAxis:{
template:function(obj){
- if(x_ax['template']){
- var val = obj[x_ax['template']];
- val = (typeof val == 'object')?val[1]:(val==false?'Undefined':val);
+ if(x_axis['template']){
+ var val = obj[x_axis['template']];
+ val = (typeof val == 'object')?val[1]:(!val?'Undefined':val);
return val;
}else{
return obj;
}
},
- title:x_ax['title'],
- lines:x_ax['lines']
+ title:x_axis['title'],
+ lines:x_axis['lines']
},
yAxis:{
template:function(obj){
- if(y_ax['template']){
- var vals = obj[y_ax['template']];
- vals = (typeof vals == 'object')?vals[1]:(vals==false?'Undefined':vals);
+ if(y_axis['template']){
+ var vals = obj[y_axis['template']];
+ vals = (typeof vals == 'object')?vals[1]:(!vals?'Undefined':vals);
return vals;
}else{
return obj;
}
},
- title:y_ax['title'],
- lines: y_ax['lines']
+ title:y_axis['title'],
+ lines: y_axis['lines']
},
padding: {
left: 75
@@ -283,19 +273,18 @@ openerp.base_graph.GraphView = openerp.base.Controller.extend({
marker:{
type:"round",
width:12
- },
+ }
}
});
- for (var i = 1; i`, it is far more complex than in Python (where it Just
+Works™) due to the interaction of various Javascript features, but to iterate
+on arrays it becomes downright deadly and errorneous: ``for…in`` really
+iterates over an *object*'s *properties*.
+
+With an array, this has the following consequences:
+
+* It does not necessarily iterate in numerical order, nor does it iterate in
+ any kind of set order. The order is implementation-dependent and may vary
+ from one run to the next depending on a number of reasons and implementation
+ details.
+* If properties are added to an array, to ``Array.prototype`` or to
+ ``Object.prototype`` (the latter two should not happen in well-behaved
+ javascript code, but you never know...) those properties *will* be iterated
+ over by ``for…in``. While ``Object.hasOwnProperty`` will guard against
+ iterating prototype properties, they will not guard against properties set
+ on the array instance itself (as memoizers for instance).
+
+ Note that this includes setting negative keys on arrays.
+
+For this reason, ``for…in`` should **never** be used on array objects. Instead,
+you should use either a normal ``for`` or (even better, unless you have
+profiled the code and found a hotspot) one of Underscore's array iteration
+methods (`_.each`_, `_.map`_, `_.filter`_, etc...).
+
+Underscore is guaranteed to be bundled and available in OpenERP Web scopes.
+
+.. _for-in-iteration:
+
+Use ``hasOwnProperty`` when iterating on an object with ``for … in``
+********************************************************************
+
+``for…in`` is Javascript's built-in facility for iterating over and object's
+properties.
+
+`It is also fairly tricky to use`_: it iterates over *all* non-builtin
+properties of your objects [#]_, which includes methods of an object's class.
+
+As a result, when iterating over an object with ``for…in`` the first line of
+the body *should* generally be a call to `Object.hasOwnProperty`_. This call
+will check whether the property was set directly on the object or comes from
+the object's class:
+
+.. code-block:: javascript
+
+ for(var key in ob) {
+ if (!ob.hasOwnProperty(key)) {
+ // comes from ob's class
+ continue;
+ }
+ // do stuff with key
+ }
+
+Since properties can be added directly to e.g. ``Object.prototype`` (even
+though it's usually considered bad style), you should not assume you ever know
+which properties ``for…in`` is going to iterate over.
+
+An alternative is to use Underscore's iteration methods, which generally work
+over objects as well as arrays:
+
+Instead of
+
+.. code-block:: javascript
+
+ for (var key in ob) {
+ if (!ob.hasOwnProperty(key)) { continue; }
+ var value = ob[key];
+ // Do stuff with key and value
+ }
+
+you could write:
+
+.. code-block:: javascript
+
+ _.each(ob, function (value, key) {
+ // do stuff with key and value
+ });
+
+and not worry about the details of the iteration: underscore should do the
+right thing for you on its own [#]_.
+
Writing documentation
+++++++++++++++++++++
@@ -44,14 +196,18 @@ RST, using Sphinx's `Python domain`_ [#]_:
docstring, using Sphinx's `info fields`_
For parameters types, built-in and stdlib types should be using the
- combined syntax::
+ combined syntax:
+
+ .. code-block:: restructuredtext
:param dict foo: what the purpose of foo is
unless a more extensive explanation needs to be given (e.g. the
specification that the input should be a list of 3-tuple needs to
use ``:type:`` even though all types involved are built-ins). Any
- other type should be specified in full using the ``:type:`` field::
+ other type should be specified in full using the ``:type:`` field
+
+ .. code-block:: restructuredtext
:param foo: what the purpose of foo is
:type foo: some.addon.Class
@@ -87,12 +243,16 @@ when writing javascript API documentation:
are not documented, or JsDoc will not understand what they are and
will not generate documentation for their content.
- As a result, the bare minimum for a namespace is::
+ As a result, the bare minimum for a namespace is:
+
+ .. code-block:: javascript
/** @namespace */
foo.bar.baz = {};
- while for a class it is::
+ while for a class it is:
+
+ .. code-block:: javascript
/** @class */
foo.bar.baz.Qux = [...]
@@ -189,7 +349,6 @@ with the descriptions and irrelevant atttributes stripped):
.. code-block:: javascript
-
openerp.base.search.Widget = openerp.base.Controller.extend(
/** @lends openerp.base.search.Widget# */{
/**
@@ -220,6 +379,30 @@ Roadmap
Release notes
+++++++++++++
+.. [#] More precisely, it iterates over all *enumerable* properties. It just
+ happens that built-in properties (such as ``String.indexOf`` or
+ ``Object.toString``) are set to non-enumerable.
+
+ The enumerability of a property can be checked using
+ `Object.propertyIsEnumeable`_.
+
+ Before ECMAScript 5, it was not possible for user-defined properties
+ to be non-enumerable in a portable manner. ECMAScript 5 introduced
+ `Object.defineProperty`_ which lets user code create non-enumerable
+ properties (and more, read-only properties for instance, or implicit
+ getters and setters). However, support for these is not fully complete
+ at this point, and they are not being used in OpenERP Web code anyway.
+
+.. [#] While using underscore is generally the preferred method (simpler,
+ more reliable and easier to write than a *correct* ``for…in``
+ iteration), it is also probably slower (due to the overhead of
+ calling a bunch of functions).
+
+ As a result, if you profile some code and find out that an underscore
+ method adds unacceptable overhead in a tight loop, you may want to
+ replace it with a ``for…in`` (or a regular ``for`` statement for
+ arrays).
+
.. [#] Because Python is the default domain, the ``py:`` markup prefix
is optional and should be left out.
@@ -252,3 +435,17 @@ Release notes
http://code.google.com/p/jsdoc-toolkit/
.. _John Resig's Class implementation:
http://ejohn.org/blog/simple-javascript-inheritance/
+.. _\_.each:
+ http://documentcloud.github.com/underscore/#each
+.. _\_.map:
+ http://documentcloud.github.com/underscore/#map
+.. _\_.filter:
+ http://documentcloud.github.com/underscore/#select
+.. _It is also fairly tricky to use:
+ https://developer.mozilla.org/en/JavaScript/Reference/Statements/for...in#Description
+.. _Object.propertyIsEnumeable:
+ https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/propertyIsEnumerable
+.. _Object.defineProperty:
+ https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/defineProperty
+.. _Object.hasOwnProperty:
+ https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/hasOwnProperty