Rename drawminorticklabel → ticklabelindex

Author: my-tien

draftlogs/7036_add.md

@@ -1 +1 @@
- - Add axis property `drawminorticklabel` for drawing the label for each minor tick n positions away from a major tick [[#7036](https://github.com/plotly/plotly.js/pull/7036)]
+ - Add axis property `ticklabelindex` for drawing the label for each minor tick n positions away from a major tick [[#7036](https://github.com/plotly/plotly.js/pull/7036)]

src/plots/cartesian/axes.js

@@ -909,7 +909,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
     var calendar = ax.calendar;
     var ticklabelstep = ax.ticklabelstep;
     var isPeriod = ax.ticklabelmode === 'period';
-    var drawMinorTickLabel = ax.drawminorticklabel;
+    var ticklabelIndex = ax.ticklabelindex;
     var rng = Lib.simpleMap(ax.range, ax.r2l, undefined, undefined, opts);
     var axrev = (rng[1] < rng[0]);
     var minRange = Math.min(rng[0], rng[1]);
@@ -923,7 +923,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
     var tickVals = [];
     var minorTickVals = [];
     // all ticks for which labels are drawn which is not necessarily the major ticks when
-    // `drawminorticklabel` is set.
+    // `ticklabelindex` is set.
     var labelTickVals = [];
 
     var hasMinor = ax.minor && (ax.minor.ticks || ax.minor.showgrid);
@@ -1079,20 +1079,20 @@ axes.calcTicks = function calcTicks(ax, opts) {
         }
     }
 
-    // check if drawMinorTickLabel makes sense, otherwise ignore it
+    // check if ticklabelIndex makes sense, otherwise ignore it
     if(!minorTickVals || minorTickVals.length < 2) {
-        drawMinorTickLabel = false;
+        ticklabelIndex = false;
     } else {
         var diff = minorTickVals[1].value - minorTickVals[0].value;
         if(!periodCompatibleWithTickformat(diff, ax.tickformat)) {
-            drawMinorTickLabel = false;
+            ticklabelIndex = false;
         }
     }
     // Determine for which ticks to draw labels
-    if(!drawMinorTickLabel) {
+    if (!ticklabelIndex) {
         labelTickVals = tickVals;
     } else {
-        // Collect and sort all major and minor ticks, to find the minor ticks `drawMinorTickLabel`
+        // Collect and sort all major and minor ticks, to find the minor ticks `ticklabelIndex`
         // steps away from each major tick. For those minor ticks we want to draw the label.
 
         var allTickVals = tickVals.concat(minorTickVals);
@@ -1115,7 +1115,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
             .filter(function(index) { return index !== null; });
 
         majorTickIndices.forEach(function(majorIdx) {
-            var minorIdx = majorIdx + drawMinorTickLabel;
+            var minorIdx = majorIdx + ticklabelIndex;
             if(minorIdx >= 0 && minorIdx < allTickVals.length) {
                 labelTickVals.push(allTickVals[minorIdx]);
             }
@@ -1239,7 +1239,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
         var _value = tickVals[i].value;
 
         if(_minor) {
-            if(drawMinorTickLabel && labelTickVals.indexOf(tickVals[i]) !== -1) {
+            if (ticklabelIndex && labelTickVals.indexOf(tickVals[i]) !== -1) {
                 t = setTickLabel(ax, tickVals[i]);
             } else {
                 t = { x: _value };
@@ -1250,7 +1250,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
             lastVisibleHead = ax._prevDateHead;
             t = setTickLabel(ax, tickVals[i]);
             if(tickVals[i].skipLabel ||
-                drawMinorTickLabel && labelTickVals.indexOf(tickVals[i]) === -1) {
+                ticklabelIndex && labelTickVals.indexOf(tickVals[i]) === -1) {
                 hideLabel(t);
             }
 

src/plots/cartesian/axis_defaults.js

@@ -59,8 +59,8 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
         }
     }
 
-    if(!options.noDrawminorticklabel && axType === 'date' && containerOut.ticklabelmode === 'period') {
-        coerce('drawminorticklabel');
+    if(!options.noTicklabelindex && axType === 'date' && containerOut.ticklabelmode === 'period') {
+        coerce('ticklabelindex');
     }
 
     var ticklabelposition = '';

src/plots/cartesian/layout_attributes.js

@@ -721,15 +721,15 @@ module.exports = {
             'outside and vice versa.'
         ].join(' ')
     },
-    drawminorticklabel: {
+    ticklabelindex: {
         // In the future maybe add `arrayOk: true` for labeling several minor ticks, e.g. [-1, 0, 1]
         valType: 'integer',
         editType: 'calc',
         description: [
             'Only for date axes with `ticklabelmode` *period*.',
             'Instead of drawing the major tick label, draw the label for the minor tick',
             'that is n positions away from the major tick. E.g. to always draw the label for the',
-            'minor tick before each major tick, choose `drawminorticklabel` -1'
+            'minor tick before each major tick, choose `ticklabelindex` -1'
         ].join(' ')
     },
     mirror: {

src/plots/gl3d/layout/axis_defaults.js

@@ -42,7 +42,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
                 data: options.data,
                 showGrid: true,
                 noAutotickangles: true,
-                noDrawminorticklabel: true,
+                noTicklabelindex: true,
                 noTickson: true,
                 noTicklabelmode: true,
                 noTicklabelshift: true,

test/image/baselines/zzz_date_axes-ticklabelstep-drawminorticklabel.png renamed to test/image/baselines/zzz_date_axes-ticklabelstep-ticklabelindex.png

@@ -158,7 +158,7 @@
       },
       "tickcolor": "red",
       "ticklabelmode": "period",
-      "drawminorticklabel": 4,
+      "ticklabelindex": 4,
       "anchor": "y"
     },
     "xaxis2": {
@@ -170,7 +170,7 @@
       "tickcolor": "red",
       "ticklabelmode": "period",
       "anchor": "y2",
-      "drawminorticklabel": 1
+      "ticklabelindex": 1
     },
     "xaxis3": {
       "ticklabelstep": 2,
@@ -181,7 +181,7 @@
       "tickcolor": "red",
       "ticklabelmode": "period",
       "anchor": "y3",
-      "drawminorticklabel": 1
+      "ticklabelindex": 1
     },
     "xaxis4": {
       "ticklabelstep": 2,
@@ -192,7 +192,7 @@
       "tickcolor": "red",
       "ticklabelmode": "period",
       "anchor": "y4",
-      "drawminorticklabel": 1
+      "ticklabelindex": 1
     },
     "xaxis5": {
       "ticklabelstep": 2,
@@ -203,7 +203,7 @@
       "tickcolor": "red",
       "ticklabelmode": "period",
       "anchor": "y5",
-      "drawminorticklabel": -2
+      "ticklabelindex": -2
     },
     "xaxis6": {
       "ticklabelstep": 2,
@@ -214,7 +214,7 @@
       "tickcolor": "red",
       "ticklabelmode": "period",
       "anchor": "y6",
-      "drawminorticklabel": 2
+      "ticklabelindex": 2
     },
     "xaxis7": {
       "ticklabelstep": 2,
@@ -225,7 +225,7 @@
       "tickcolor": "red",
       "ticklabelmode": "period",
       "anchor": "y7",
-      "drawminorticklabel": -3
+      "ticklabelindex": -3
     }
   }
 }