plotly#189 Renaming attributes

Author: monfera

src/plots/cartesian/axis_defaults.js

@@ -20,7 +20,7 @@ var layoutAttributes = require('./layout_attributes');
 var handleTickValueDefaults = require('./tick_value_defaults');
 var handleTickMarkDefaults = require('./tick_mark_defaults');
 var handleTickLabelDefaults = require('./tick_label_defaults');
-var handleCategoryModeDefaults = require('./category_mode_defaults');
+var handleCategoryOrderDefaults = require('./category_order_defaults');
 var setConvert = require('./set_convert');
 var orderedCategories = require('./ordered_categories');
 var cleanDatum = require('./clean_datum');
@@ -75,7 +75,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     }
 
     containerOut._initialCategories = axType === 'category' ?
-        orderedCategories(letter, containerIn.categorymode, containerIn.categorylist, options.data) :
+        orderedCategories(letter, containerIn.categoryorder, containerIn.categoryarray, options.data) :
         [];
 
     setConvert(containerOut);
@@ -111,7 +111,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     handleTickValueDefaults(containerIn, containerOut, coerce, axType);
     handleTickLabelDefaults(containerIn, containerOut, coerce, axType, options);
     handleTickMarkDefaults(containerIn, containerOut, coerce, options);
-    handleCategoryModeDefaults(containerIn, containerOut, coerce);
+    handleCategoryOrderDefaults(containerIn, containerOut, coerce);
 
     var lineColor = coerce2('linecolor', dfltColor),
         lineWidth = coerce2('linewidth'),

src/plots/cartesian/category_mode_defaults.js

@@ -0,0 +1,39 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var layoutAttributes = require('./layout_attributes');
+
+module.exports = function handleCategoryOrderDefaults(containerIn, containerOut, coerce) {
+
+    if(containerIn.type !== 'category') return;
+
+    var validCategories = layoutAttributes.categoryorder.values;
+
+    var propercategoryarray = Array.isArray(containerIn.categoryarray) && containerIn.categoryarray.length > 0;
+
+    if(validCategories.indexOf(containerIn.categoryorder) === -1 && propercategoryarray) {
+
+        // when unspecified or invalid, use the default, unless categoryarray implies 'array'
+        coerce('categoryorder', 'array'); // promote to 'array'
+
+    } else if(containerIn.categoryorder === 'array' && !propercategoryarray) {
+
+        // when mode is 'array' but no list is given, revert to default
+
+        containerIn.categoryorder = 'trace'; // revert to default
+        coerce('categoryorder');
+
+    } else {
+
+        // otherwise use the supplied mode, or the default one if unsupplied or invalid
+        coerce('categoryorder');
+
+    }
+};

src/plots/cartesian/category_order_defaults.js

@@ -465,7 +465,7 @@ module.exports = {
             'Only has an effect if `anchor` is set to *free*.'
         ].join(' ')
     },
-    categorymode: {
+    categoryorder: {
         valType: 'enumerated',
         values: [
             'trace', 'category ascending', 'category descending', 'array'
@@ -476,22 +476,22 @@ module.exports = {
         description: [
             'Specifies the ordering logic for the case of categorical variables.',
             'By default, plotly uses *trace*, which specifies the order that is present in the data supplied.',
-            'Set `categorymode` to *category ascending* or *category descending* if order should be determined by',
+            'Set `categoryorder` to *category ascending* or *category descending* if order should be determined by',
             'the alphanumerical order of the category names.',
-            /*'Set `categorymode` to *value ascending* or *value descending* if order should be determined by the',
+            /*'Set `categoryorder` to *value ascending* or *value descending* if order should be determined by the',
             'numerical order of the values.',*/ // // value ascending / descending to be implemented later
-            'Set `categorymode` to *array* to derive the ordering from the attribute `categorylist`. If a category',
-            'is not found in the `categorylist` array, the sorting behavior for that attribute will be identical to',
-            'the *trace* mode. The unspecified categories will follow the categories in `categorylist`.'
+            '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`.'
         ].join(' ')
     },
-    categorylist: {
+    categoryarray: {
         valType: 'data_array',
         role: 'info',
         description: [
             'Sets the order in which categories on this axis appear.',
-            'Only has an effect if `categorymode` is set to *array*.',
-            'Used with `categorymode`.'
+            'Only has an effect if `categoryorder` is set to *array*.',
+            'Used with `categoryorder`.'
         ].join(' ')
     },
 

src/plots/cartesian/layout_attributes.js

@@ -53,22 +53,22 @@ function flattenUniqueSort(axisLetter, sortFunction, data) {
 
 
 /**
- * This pure function returns the ordered categories for specified axisLetter, categorymode, categorylist and data.
+ * This pure function returns the ordered categories for specified axisLetter, categoryorder, categoryarray and data.
  *
- * If categorymode is 'array', the result is a fresh copy of categorylist, or if unspecified, an empty array.
+ * If categoryorder is 'array', the result is a fresh copy of categoryarray, or if unspecified, an empty array.
  *
- * If categorymode is 'category ascending' or 'category descending', the result is an array of ascending or descending
+ * If categoryorder is 'category ascending' or 'category descending', the result is an array of ascending or descending
  * order of the unique categories encountered in the data for specified axisLetter.
  *
- * See cartesian/layout_attributes.js for the definition of categorymode and categorylist
+ * See cartesian/layout_attributes.js for the definition of categoryorder and categoryarray
  *
  */
 
 // orderedCategories :: String -> String -> [String] -> [[String]] -> [String]
-module.exports = function orderedCategories(axisLetter, categorymode, categorylist, data) {
+module.exports = function orderedCategories(axisLetter, categoryorder, categoryarray, data) {
 
-    switch(categorymode) {
-        case 'array': return Array.isArray(categorylist) ? categorylist.slice() : [];
+    switch(categoryorder) {
+        case 'array': return Array.isArray(categoryarray) ? categoryarray.slice() : [];
         case 'category ascending': return flattenUniqueSort(axisLetter, d3.ascending, data);
         case 'category descending': return flattenUniqueSort(axisLetter, d3.descending, data);
         case 'trace': return [];

src/plots/cartesian/ordered_categories.js

@@ -68,8 +68,8 @@ module.exports = {
         description: 'Sets whether or not this axis is labeled'
     },
     color: axesAttrs.color,
-    categorymode: axesAttrs.categorymode,
-    categorylist: axesAttrs.categorylist,
+    categoryorder: axesAttrs.categoryorder,
+    categoryarray: axesAttrs.categoryarray,
     title: axesAttrs.title,
     titlefont: axesAttrs.titlefont,
     type: axesAttrs.type,

src/plots/gl3d/layout/axis_attributes.js

@@ -7,7 +7,7 @@
         "xaxis": {
             "title": "category ascending",
             "type": "category",
-            "categorymode": "category ascending",
-            "categorylist": ["y","b","x","a","d","z","e","c", "q", "k"]
+            "categoryorder": "category ascending",
+            "categoryarray": ["y","b","x","a","d","z","e","c", "q", "k"]
         }}
 }

test/image/mocks/axes_category_ascending.json

@@ -28,8 +28,8 @@
                 3.1833667334669338
             ],
             "autorange": true,
-            "categorymode": "array",
-            "categorylist": [2,4,5,1]
+            "categoryorder": "array",
+            "categoryarray": [2,4,5,1]
         },
         "yaxis": {
             "type": "linear",

test/image/mocks/axes_category_categorylist.json

@@ -7,7 +7,7 @@
         "title": "categorylist with truncated tails (y, q, k not plotted)",
         "xaxis": {
             "type": "category",
-            "categorymode": "array",
-            "categorylist": ["y","b","x","a","d","z","e","c", "q", "k"]
+            "categoryorder": "array",
+            "categoryarray": ["y","b","x","a","d","z","e","c", "q", "k"]
         }}
 }

test/image/mocks/axes_category_categorylist_truncated_tails.json

@@ -23,8 +23,8 @@
         "title": "category descending",
         "xaxis": {
             "type": "category",
-            "categorymode": "category descending",
-            "categorylist": [2,4,5,1]
+            "categoryorder": "category descending",
+            "categoryarray": [2,4,5,1]
         },
         "yaxis": {
             "type": "linear",

test/image/mocks/axes_category_descending.json

@@ -23,8 +23,8 @@
         "title": "category descending",
         "xaxis": {
             "type": "category",
-            "categorymode": "category descending",
-            "categorylist": [2,4,5,1]
+            "categoryorder": "category descending",
+            "categoryarray": [2,4,5,1]
         },
         "yaxis": {
             "type": "linear",