Replace ticklabelshiftx/y with ticklabelrunoff and ticklabelstandoff

And remove this feature from all non-cartesian traces. If other plots should be supported, this can be added and tested in separate PRs.

Author: my-tien

src/components/colorbar/attributes.js

@@ -169,6 +169,7 @@ module.exports = overrideAll({
             'In other cases the default is *hide past div*.'
         ].join(' ')
     }),
+
     // ticklabelposition: not used directly, as values depend on orientation
     // left/right options are for x axes, and top/bottom options are for y axes
     ticklabelposition: {
@@ -187,8 +188,6 @@ module.exports = overrideAll({
             'top and bottom when `orientation` is *v*.'
         ].join(' ')
     },
-    ticklabelshiftx: axesAttrs.ticklabelshiftx,
-    ticklabelshifty: axesAttrs.ticklabelshifty,
     ticklen: axesAttrs.ticklen,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,

src/components/colorbar/defaults.js

@@ -111,6 +111,7 @@ module.exports = function colorbarDefaults(containerIn, containerOut, layout) {
     var font = layout.font;
     var opts = {
         noAutotickangles: true,
+        noTicklabelrunoffstandoff: true,
         outerTicks: false,
         font: font
     };

src/plots/cartesian/axes.js

@@ -2968,23 +2968,23 @@ axes.makeTransTickFn = function(ax) {
 
 axes.makeTransTickLabelFn = function(ax) {
     var uv = getTickLabelUV(ax);
-    var shiftx = ax.ticklabelshiftx || 0;
-    var shifty = ax.ticklabelshifty || 0;
+    var runoff = ax.ticklabelrunoff || 0;
+    var standoff = ax.ticklabelstandoff || 0;
 
     var u = uv[0];
     var v = uv[1];
 
     return ax._id.charAt(0) === 'x' ?
         function(d) {
             return strTranslate(
-                u + ax._offset + ax.l2p(getPosX(d)) + shiftx,
-                v + shifty
+                u + ax._offset + ax.l2p(getPosX(d)) + standoff,
+                v + runoff
             );
         } :
         function(d) {
             return strTranslate(
-                v + shiftx,
-                u + ax._offset + ax.l2p(getPosX(d)) + shifty
+                v + runoff,
+                u + ax._offset + ax.l2p(getPosX(d)) + standoff
             );
         };
 };

src/plots/cartesian/layout_attributes.js

@@ -698,20 +698,20 @@ module.exports = {
             'In other cases the default is *hide past div*.'
         ].join(' ')
     },
-    ticklabelshiftx: {
+    ticklabelrunoff: {
         valType: 'integer',
         dflt: 0,
         editType: 'ticks',
         description: [
-            'Horizontally shifts the tick labels by the specified number of pixels.'
+            'Shifts the tick labels by the specified number of pixels in parallel to the axis.'
         ].join(' ')
     },
-    ticklabelshifty: {
+    ticklabelstandoff: {
         valType: 'integer',
         dflt: 0,
         editType: 'ticks',
         description: [
-            'Vertically shifts the tick labels by the specified number of pixels.'
+            'Shifts the tick labels by the specified number of pixels orthogonally to the axis.'
         ].join(' ')
     },
     mirror: {

src/plots/cartesian/tick_label_defaults.js

@@ -16,8 +16,10 @@ module.exports = function handleTickLabelDefaults(containerIn, containerOut, coe
 
     var showTickLabels = coerce('showticklabels');
     if(showTickLabels) {
-        coerce('ticklabelshiftx');
-        coerce('ticklabelshifty');
+        if(!options.noTicklabelrunoffstandoff) {
+            coerce('ticklabelrunoff');
+            coerce('ticklabelstandoff');
+        }
         var font = options.font || {};
         var contColor = containerOut.color;
         var position = containerOut.ticklabelposition || '';

src/plots/gl3d/layout/axis_attributes.js

@@ -93,8 +93,6 @@ module.exports = overrideAll({
     ticks: axesAttrs.ticks,
     mirror: axesAttrs.mirror,
     ticklen: axesAttrs.ticklen,
-    ticklabelshiftx: axesAttrs.ticklabelshiftx,
-    ticklabelshifty: axesAttrs.ticklabelshifty,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,
     showticklabels: axesAttrs.showticklabels,

src/plots/gl3d/layout/axis_defaults.js

@@ -44,6 +44,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
                 noAutotickangles: true,
                 noTickson: true,
                 noTicklabelmode: true,
+                noTicklabelrunoffstandoff: true,
                 noTicklabelstep: true,
                 noTicklabelposition: true,
                 noTicklabeloverflow: true,

src/plots/polar/layout_attributes.js

@@ -33,8 +33,6 @@ var axisTickAttrs = overrideAll({
     ticklen: axesAttrs.ticklen,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,
-    ticklabelshiftx: axesAttrs.ticklabelshiftx,
-    ticklabelshifty: axesAttrs.ticklabelshifty,
     ticklabelstep: axesAttrs.ticklabelstep,
     showticklabels: axesAttrs.showticklabels,
     labelalias: axesAttrs.labelalias,

src/plots/polar/layout_defaults.js

@@ -186,7 +186,8 @@ function handleDefaults(contIn, contOut, coerce, opts) {
                     size: dfltFontSize,
                     family: dfltFontFamily
                 },
-                noAutotickangles: axName === 'angularaxis'
+                noAutotickangles: axName === 'angularaxis',
+                noTicklabelrunoffstandoff: true
             });
 
             handleTickMarkDefaults(axIn, axOut, coerceAxis, {outerTicks: true});

src/plots/smith/layout_attributes.js

@@ -18,8 +18,6 @@ var axisLineGridAttr = overrideAll({
 }, 'plot', 'from-root');
 
 var axisTickAttrs = overrideAll({
-    ticklabelshiftx: axesAttrs.ticklabelshiftx,
-    ticklabelshifty: axesAttrs.ticklabelshifty,
     ticklen: axesAttrs.ticklen,
     tickwidth: extendFlat({}, axesAttrs.tickwidth, {dflt: 2}),
     tickcolor: axesAttrs.tickcolor,

src/plots/smith/layout_defaults.js

@@ -90,6 +90,7 @@ function handleDefaults(contIn, contOut, coerce, opts) {
 
             handleTickLabelDefaults(axIn, axOut, coerceAxis, axOut.type, {
                 noAutotickangles: true,
+                noTicklabelrunoffstandoff: true,
                 noTicklabelstep: true,
                 noAng: !isRealAxis,
                 noExp: true,

src/plots/ternary/layout_attributes.js

@@ -25,8 +25,6 @@ var ternaryAxesAttrs = {
     ticklen: axesAttrs.ticklen,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,
-    ticklabelshiftx: axesAttrs.ticklabelshiftx,
-    ticklabelshifty: axesAttrs.ticklabelshifty,
     ticklabelstep: axesAttrs.ticklabelstep,
     showticklabels: axesAttrs.showticklabels,
     labelalias: axesAttrs.labelalias,

src/plots/ternary/layout_defaults.js

@@ -91,7 +91,7 @@ function handleAxisDefaults(containerIn, containerOut, options, ternaryLayoutOut
 
     handleTickValueDefaults(containerIn, containerOut, coerce, 'linear');
     handlePrefixSuffixDefaults(containerIn, containerOut, coerce, 'linear');
-    handleTickLabelDefaults(containerIn, containerOut, coerce, 'linear', { noAutotickangles: true });
+    handleTickLabelDefaults(containerIn, containerOut, coerce, 'linear', { noAutotickangles: true, noTicklabelrunoffstandoff: true });
     handleTickMarkDefaults(containerIn, containerOut, coerce,
         { outerTicks: true });
 

src/traces/carpet/ab_defaults.js

@@ -31,6 +31,7 @@ function mimickAxisDefaults(traceIn, traceOut, fullLayout, dfltColor) {
 
         var defaultOptions = {
             noAutotickangles: true,
+            noTicklabelrunoffstandoff: true,
             noTicklabelstep: true,
             tickfont: 'x',
             id: axLetter + 'axis',

src/traces/carpet/axis_attributes.js

@@ -157,22 +157,6 @@ module.exports = {
             'Has an effect only if `tickmode` is set to *auto*.'
         ].join(' ')
     },
-    ticklabelshiftx: {
-        valType: 'integer',
-        dflt: 0,
-        editType: 'calc',
-        description: [
-            'Horizontally shifts the tick labels by the specified number of pixels.'
-        ].join(' ')
-    },
-    ticklabelshifty: {
-        valType: 'integer',
-        dflt: 0,
-        editType: 'calc',
-        description: [
-            'Vertically shifts the tick labels by the specified number of pixels.'
-        ].join(' ')
-    },
     tickvals: {
         valType: 'data_array',
         editType: 'calc',

src/traces/indicator/attributes.js

@@ -317,8 +317,6 @@ module.exports = {
             ticklen: axesAttrs.ticklen,
             tickwidth: axesAttrs.tickwidth,
             tickcolor: axesAttrs.tickcolor,
-            ticklabelshiftx: axesAttrs.ticklabelshiftx,
-            ticklabelshifty: axesAttrs.ticklabelshifty,
             ticklabelstep: axesAttrs.ticklabelstep,
             showticklabels: axesAttrs.showticklabels,
             labelalias: axesAttrs.labelalias,

src/traces/indicator/defaults.js

@@ -132,7 +132,8 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
         var opts = {
             font: layout.font,
             noAutotickangles: true,
-            outerTicks: true
+            outerTicks: true,
+            noTicklabelrunoffstandoff: true
         };
         handleTickValueDefaults(axisIn, axisOut, coerceGaugeAxis, 'linear');
         handlePrefixSuffixDefaults(axisIn, axisOut, coerceGaugeAxis, 'linear', opts);