categoryorder: rename 'value' to 'total'

Author: antoinerg

src/plots/cartesian/layout_attributes.js

@@ -818,7 +818,7 @@ module.exports = {
         valType: 'enumerated',
         values: [
             'trace', 'category ascending', 'category descending', 'array',
-            'value ascending', 'value descending',
+            'total ascending', 'total descending',
             'min ascending', 'min descending',
             'max ascending', 'max descending',
             'sum ascending', 'sum descending',
@@ -836,9 +836,9 @@ module.exports = {
             'Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category',
             'is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to',
             'the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.',
-            'Set `categoryorder` to *value ascending* or *value descending* if order should be determined by the',
+            'Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the',
             'numerical order of the values.',
-            'Similarly, the order can be determined by the min, max, sum, mean or media of all the values.'
+            'Similarly, the order can be determined by the min, max, sum, mean or median of all the values.'
         ].join(' ')
     },
     categoryarray: {

src/plots/plots.js

@@ -2856,7 +2856,7 @@ plots.doCalcdata = function(gd, traces) {
     Registry.getComponentMethod('errorbars', 'calc')(gd);
 };
 
-var sortAxisCategoriesByValueRegex = /(value|sum|min|max|mean|median) (ascending|descending)/;
+var sortAxisCategoriesByValueRegex = /(total|sum|min|max|mean|median) (ascending|descending)/;
 
 function sortAxisCategoriesByValue(axList, gd) {
     var affectedTraces = [];
@@ -2889,7 +2889,7 @@ function sortAxisCategoriesByValue(axList, gd) {
         'min': function(values) {return Lib.aggNums(Math.min, null, values);},
         'max': function(values) {return Lib.aggNums(Math.max, null, values);},
         'sum': function(values) {return Lib.aggNums(function(a, b) { return a + b;}, null, values);},
-        'value': function(values) {return Lib.aggNums(function(a, b) { return a + b;}, null, values);},
+        'total': function(values) {return Lib.aggNums(function(a, b) { return a + b;}, null, values);},
         'mean': function(values) {return Lib.mean(values);},
         'median': function(values) {return Lib.median(values);}
     };

test/jasmine/tests/calcdata_test.js

@@ -989,15 +989,15 @@ describe('calculated data and points', function() {
                         .then(done);
                     }
 
-                    ['value ascending', 'value descending'].forEach(function(categoryorder) {
+                    ['total ascending', 'total descending'].forEach(function(categoryorder) {
                         it('sorts ' + axName + ' by ' + categoryorder + ' for trace type ' + trace.type, function(done) {
                             var data = [7, 2, 3];
                             var baseMock = {data: [makeData(trace.type, axName, cat, data)], layout: {}};
                             baseMock.layout[axName] = { type: 'category', categoryorder: categoryorder};
 
                             // Set expectations
                             var finalOrder = ['b', 'c', 'a'];
-                            if(categoryorder === 'value descending') finalOrder.reverse();
+                            if(categoryorder === 'total descending') finalOrder.reverse();
                             var expectedAgg = [['a', 7], ['b', 2], ['c', 3]];
 
                             if(trace.type === 'ohlc' || trace.type === 'candlestick') expectedAgg = [['a', 14], ['b', 4], ['c', 6]];
@@ -1012,7 +1012,7 @@ describe('calculated data and points', function() {
                         var data = [7, 2, 3];
                         var data2 = [5, 4, 2];
                         var baseMock = { data: [makeData(type, axName, cat, data), makeData(type, axName, cat, data2)], layout: {}};
-                        baseMock.layout[axName] = { type: 'category', categoryorder: 'value ascending'};
+                        baseMock.layout[axName] = { type: 'category', categoryorder: 'total ascending'};
 
                         var expectedAgg = [['a', data[0] + data2[0]], ['b', data[1] + data2[1]], ['c', data[2] + data2[2]]];
                         if(type === 'ohlc' || type === 'candlestick') expectedAgg = [['a', 2 * expectedAgg[0][1]], ['b', 2 * expectedAgg[1][1]], ['c', 2 * expectedAgg[2][1]]];
@@ -1026,7 +1026,7 @@ describe('calculated data and points', function() {
                         var data = [7, 2, 3];
                         var data2 = [5, 4, 2];
                         var baseMock = { data: [makeData(type, axName, cat, data), makeData(type, axName, cat, data2)], layout: {}};
-                        baseMock.layout[axName] = { type: 'category', categoryorder: 'value ascending'};
+                        baseMock.layout[axName] = { type: 'category', categoryorder: 'total ascending'};
 
                         // Hide second trace
                         baseMock.data[1].visible = 'legendonly';