plotly#189 initial round of coercions with test cases

Author: monfera

src/plots/cartesian/axis_defaults.js

@@ -17,6 +17,7 @@ var Plots = require('../plots');
 var layoutAttributes = require('./layout_attributes');
 var handleTickValueDefaults = require('./tick_value_defaults');
 var handleTickDefaults = require('./tick_defaults');
+var handleCategoryModeDefaults = require('./category_mode_defaults');
 var setConvert = require('./set_convert');
 var orderedCategories = require('./ordered_categories');
 var cleanDatum = require('./clean_datum');
@@ -96,6 +97,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
 
     handleTickValueDefaults(containerIn, containerOut, coerce, axType);
     handleTickDefaults(containerIn, containerOut, coerce, axType, options);
+    handleCategoryModeDefaults(containerIn, containerOut, coerce);
 
     var lineColor = Lib.coerce2(containerIn, containerOut, layoutAttributes, 'linecolor'),
         lineWidth = Lib.coerce2(containerIn, containerOut, layoutAttributes, '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';
+
+module.exports = function handleCategoryModeDefaults(containerIn, containerOut, coerce) {
+
+    if(containerIn.type === 'category') {
+
+        var validCategories = ['trace', 'category ascending', 'category descending', 'array'];
+
+        var properCategoryList = Array.isArray(containerIn.categorylist) && containerIn.categorylist.length > 0;
+
+        if(validCategories.indexOf(containerIn.categorymode) === -1 && properCategoryList) {
+
+            // when unspecified or invalid, use the default, unless categorylist implies 'array'
+            coerce('categorymode', 'array'); // promote to 'array
+
+        } else if(containerIn.categorymode === 'array' && !properCategoryList) {
+
+            // when mode is 'array' but no list is given, revert to default
+
+            containerIn.categorymode = 'trace'; // revert to default
+            coerce('categorymode');
+
+        } else {
+
+            // otherwise use the supplied mode, or the default one if unsupplied or invalid
+            coerce('categorymode');
+
+        }
+    }
+};

test/jasmine/tests/axes_test.js

@@ -321,6 +321,68 @@ describe('Test axes', function() {
         });
     });
 
+    describe('categorymode', function() {
+
+        var gd;
+
+        beforeEach(function() {
+            gd = createGraphDiv();
+        });
+
+        afterEach(destroyGraphDiv);
+
+        describe('setting, or not setting categorymode if it is not explicitly declared', function() {
+
+            it('should set categorymode to default if categorymode and categorylist are not supplied', function() {
+                PlotlyInternal.plot(gd, [{x: ['c','a','e','b','d'], y: [15,11,12,13,14]}], {xaxis: {type: 'category'}});
+                expect(gd._fullLayout.xaxis.categorymode).toBe('trace');
+            });
+
+            it('should set categorymode to default even if type is not set to category explicitly', function() {
+                PlotlyInternal.plot(gd, [{x: ['c','a','e','b','d'], y: [15,11,12,13,14]}]);
+                expect(gd._fullLayout.xaxis.categorymode).toBe('trace');
+            });
+
+            it('should NOT set categorymode to default if type is not category', function() {
+                PlotlyInternal.plot(gd, [{x: ['c','a','e','b','d'], y: [15,11,12,13,14]}]);
+                expect(gd._fullLayout.yaxis.categorymode).toBe(undefined);
+            });
+
+            it('should set categorymode to default if type is overridden to be category', function() {
+                PlotlyInternal.plot(gd, [{x: [1,2,3,4,5], y: [15,11,12,13,14]}], {yaxis: {type: 'category'}});
+                expect(gd._fullLayout.xaxis.categorymode).toBe(undefined);
+                expect(gd._fullLayout.yaxis.categorymode).toBe('trace');
+            });
+
+        });
+
+        describe('setting, or not setting categorymode to "array"', function() {
+
+            it('should leave categorymode on "array" if it is supplied', function() {
+                PlotlyInternal.plot(gd, [{x: ['c','a','e','b','d'], y: [15,11,12,13,14]}], {
+                    xaxis: {type: 'category', categorymode: "array", categorylist: ['b','a','d','e','c']}
+                });
+                expect(gd._fullLayout.xaxis.categorymode).toBe('array');
+            });
+
+            it('should switch categorymode on "array" if it is not supplied but categorylist is supplied', function() {
+                PlotlyInternal.plot(gd, [{x: ['c','a','e','b','d'], y: [15,11,12,13,14]}], {
+                    xaxis: {type: 'category', categorylist: ['b','a','d','e','c']}
+                });
+                expect(gd._fullLayout.xaxis.categorymode).toBe('array');
+            });
+
+            it('should revert categorymode to "trace" if "array" is supplied but there is no list', function() {
+                PlotlyInternal.plot(gd, [{x: ['c','a','e','b','d'], y: [15,11,12,13,14]}], {
+                    xaxis: {type: 'category', categorymode: "array"}
+                });
+                expect(gd._fullLayout.xaxis.categorymode).toBe('trace');
+            });
+
+        });
+
+    });
+
     describe('handleTickDefaults', function() {
         var data = [{ x: [1,2,3], y: [3,4,5] }],
             gd;