Rename categorylabels -> ticktext and categorylabelfont -> tickfont

for better consistency with other trace / axis types.

Author: Jon M. Mease

src/traces/parcats/attributes.js

@@ -94,7 +94,7 @@ module.exports = {
         description: 'Sets the font for the `dimension` labels.'
     }),
 
-    categorylabelfont: fontAttrs({
+    tickfont: fontAttrs({
         editType: 'calc',
         description: 'Sets the font for the `category` labels.'
     }),
@@ -135,12 +135,12 @@ module.exports = {
                 'Used with `categoryorder`.'
             ].join(' ')
         },
-        categorylabels: {
+        ticktext: {
             valType: 'data_array',
             role: 'info',
             editType: 'calc',
             description: [
-                'Sets alternative labels for the categories in this dimension.',
+                'Sets alternative tick labels for the categories in this dimension.',
                 'Only has an effect if `categoryorder` is set to *array*.',
                 'Should be an array the same length as `categoryarray`',
                 'Used with `categoryorder`.'

src/traces/parcats/calc.js

@@ -178,7 +178,7 @@ module.exports = function calc(gd, trace) {
 
             if(cats[catInd] === undefined) {
                 var catValue = trace.dimensions[containerInd].categoryarray[catInd];
-                var catLabel = trace.dimensions[containerInd].categorylabels[catInd];
+                var catLabel = trace.dimensions[containerInd].ticktext[catInd];
                 cats[catInd] = createCategoryModel(d, catInd, catValue, catLabel);
             }
 
@@ -485,17 +485,17 @@ function validateCategoryProperties(dim, uniqueInfoDim) {
     // Update categoryarray
     dim.categoryarray = uniqueInfoDim.uniqueValues;
 
-    // Handle categorylabels
-    if(dim.categorylabels === null || dim.categorylabels === undefined) {
-        dim.categorylabels = [];
+    // Handle ticktext
+    if(dim.ticktext === null || dim.ticktext === undefined) {
+        dim.ticktext = [];
     } else {
         // Shallow copy to avoid modifying input array
-        dim.categorylabels = dim.categorylabels.slice();
+        dim.ticktext = dim.ticktext.slice();
     }
 
-    // Extend categorylabels with elements from uniqueInfoDim.uniqueValues
-    for(var i = dim.categorylabels.length; i < uniqueInfoDim.uniqueValues.length; i++) {
-        dim.categorylabels.push(uniqueInfoDim.uniqueValues[i]);
+    // Extend ticktext with elements from uniqueInfoDim.uniqueValues
+    for(var i = dim.ticktext.length; i < uniqueInfoDim.uniqueValues.length; i++) {
+        dim.ticktext.push(uniqueInfoDim.uniqueValues[i]);
     }
 }
 

src/traces/parcats/defaults.js

@@ -64,10 +64,10 @@ function dimensionDefaults(dimensionIn, dimensionOut) {
         // coerce 'categoryarray' only in array order case
         if(order === 'array') {
             coerce('categoryarray');
-            coerce('categorylabels');
+            coerce('ticktext');
         } else {
             delete dimensionIn.categoryarray;
-            delete dimensionIn.categorylabels;
+            delete dimensionIn.ticktext;
         }
 
         // cannot set 'categoryorder' to 'array' with an invalid 'categoryarray'
@@ -118,5 +118,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         color: layout.font.color
     };
 
-    Lib.coerceFont(coerce, 'categorylabelfont', categoryfontDefault);
+    Lib.coerceFont(coerce, 'tickfont', categoryfontDefault);
 };

src/traces/parcats/parcats.js

@@ -1193,12 +1193,12 @@ function dragDimensionEnd(d) {
             var sortedCategoryModels = d.model.categories.slice().sort(
                 function(a, b) { return a.displayInd - b.displayInd; });
 
-            // Get new categoryarray and categorylabels values
+            // Get new categoryarray and ticktext values
             var newCategoryArray = sortedCategoryModels.map(function(v) { return v.categoryValue; });
             var newCategoryLabels = sortedCategoryModels.map(function(v) { return v.categoryLabel; });
 
             restyleData['dimensions[' + d.model.containerInd + '].categoryarray'] = [newCategoryArray];
-            restyleData['dimensions[' + d.model.containerInd + '].categorylabels'] = [newCategoryLabels];
+            restyleData['dimensions[' + d.model.containerInd + '].ticktext'] = [newCategoryLabels];
             restyleData['dimensions[' + d.model.containerInd + '].categoryorder'] = 'array';
         }
     }
@@ -1475,7 +1475,7 @@ function createParcatsViewModel(graphDiv, layout, wrappedParcatsModel) {
         bundlecolors: trace.bundlecolors,
         sortpaths: trace.sortpaths,
         labelfont: trace.labelfont,
-        categorylabelfont: trace.categorylabelfont,
+        categorylabelfont: trace.tickfont,
         pathShape: pathShape,
         dragDimension: null,
         margin: margin,

test/image/mocks/parcats_fonts.json

@@ -7,7 +7,7 @@
         {"label": "Two", "values": ["A", "B", "A", "B", "C", "C", "A", "B", "C"]},
         {"label": "Three", "values": [11, 11, 11, 11, 11, 11, 11, 11, 11]}],
       "labelfont": {"family": "Rockwell", "size": 20, "color": "gray"},
-      "categorylabelfont": {"family": "Arial", "size": 10, "color": "firebrick"}
+      "tickfont": {"family": "Arial", "size": 10, "color": "firebrick"}
     }
   ],
   "layout": {

test/image/mocks/parcats_reordered.json

@@ -3,9 +3,10 @@
     {"type": "parcats",
       "domain": {"x": [0.125, 0.625],"y": [0.25, 0.75]},
       "dimensions": [
-        {"label": "One", "values": [1, 1, 2, 1, 2, 1, 1, 2, 1], "displayindex": 0},
-        {"label": "Two", "values": ["A", "B", "A", "B", "C", "C", "A", "B", "C"], "displayindex": 2,
-          "categoryarray": ["B", "A", "C"]},
+        {"label": "One", "values": [1, 1, 2, 1, 2, 1, 1, 2, 1],
+          "displayindex": 0, "categoryarray": [1, 2], "ticktext": ["One", "Two"]},
+        {"label": "Two", "values": ["A", "B", "A", "B", "C", "C", "A", "B", "C"],
+          "displayindex": 2, "categoryarray": ["B", "A", "C"]},
         {"label": "Three", "values": [11, 11, 11, 11, 11, 11, 11, 11, 11], "displayindex": 1}]}
   ],
   "layout": {

test/jasmine/tests/parcats_test.js

@@ -355,13 +355,13 @@ describe('Dimension reordered parcats trace', function() {
                     {dimensionInd: 0, displayInd: 0, dimensionLabel: 'One'});
 
                 checkCategoryCalc(gd, 0, 0, {
-                    categoryLabel: 1,
+                    categoryLabel: "One",
                     dimensionInd: 0,
                     categoryInd: 0,
                     displayInd: 0});
 
                 checkCategoryCalc(gd, 0, 1, {
-                    categoryLabel: 2,
+                    categoryLabel: "Two",
                     dimensionInd: 0,
                     categoryInd: 1,
                     displayInd: 1});
@@ -428,12 +428,12 @@ describe('Dimension reordered parcats trace', function() {
                     {dimensionInd: 0, displayInd: 0, dimensionLabel: 'One'});
 
                 checkCategoryCalc(gd, 0, 0, {
-                    categoryLabel: 1,
+                    categoryLabel: "One",
                     categoryInd: 0,
                     displayInd: 0});
 
                 checkCategoryCalc(gd, 0, 1, {
-                    categoryLabel: 2,
+                    categoryLabel: "Two",
                     categoryInd: 1,
                     displayInd: 1});
 
@@ -994,7 +994,7 @@ describe('Drag to reordered categories', function() {
                         'dimensions[2].displayindex': 1,
                         'dimensions[1].categoryorder': 'array',
                         'dimensions[1].categoryarray': [['C', 'A', 'B' ]],
-                        'dimensions[1].categorylabels': [['C', 'A', 'B' ]]},
+                        'dimensions[1].ticktext': [['C', 'A', 'B' ]]},
                     [0]]);
 
                 restyleCallback.calls.reset();
@@ -1079,7 +1079,7 @@ describe('Drag to reordered categories', function() {
                     {
                         'dimensions[1].categoryorder': 'array',
                         'dimensions[1].categoryarray': [['C', 'A', 'B' ]],
-                        'dimensions[1].categorylabels': [['C', 'A', 'B' ]]},
+                        'dimensions[1].ticktext': [['C', 'A', 'B' ]]},
                     [0]]);
 
                 restyleCallback.calls.reset();