rename attribute to skipticklabels and update description

Author: archmoj

draftlogs/6088_add.md

@@ -0,0 +1 @@
+ - Implement `skipticklabels` on 2D axes & colorbars [[#6088](https://github.com/plotly/plotly.js/pull/6088)]

src/components/colorbar/attributes.js

@@ -166,7 +166,7 @@ module.exports = overrideAll({
     ticklen: axesAttrs.ticklen,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,
-    ticklabeljump: axesAttrs.ticklabeljump,
+    skipticklabels: axesAttrs.skipticklabels,
     showticklabels: axesAttrs.showticklabels,
     tickfont: fontAttrs({
         description: 'Sets the color bar\'s tick label font'

src/components/colorbar/draw.js

@@ -933,7 +933,7 @@ function mockColorBarAxis(gd, opts, zrange) {
         showticklabels: opts.showticklabels,
         ticklabelposition: opts.ticklabelposition,
         ticklabeloverflow: opts.ticklabeloverflow,
-        ticklabeljump: opts.ticklabeljump,
+        skipticklabels: opts.skipticklabels,
         tickfont: opts.tickfont,
         tickangle: opts.tickangle,
         tickformat: opts.tickformat,

src/plots/cartesian/axes.js

@@ -835,7 +835,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
         x = axes.tickIncrement(x, ax.dtick, !axrev, ax.calendar);
     }
 
-    var ticklabeljump = ax.ticklabeljump;
+    var skipticklabels = ax.skipticklabels;
 
     var maxTicks = Math.max(1000, ax._length || 0);
     var tickVals = [];
@@ -876,7 +876,7 @@ axes.calcTicks = function calcTicks(ax, opts) {
             value: x
         };
 
-        if(ticklabeljump && (id % (ticklabeljump + 1))) {
+        if(skipticklabels && (id % (skipticklabels + 1))) {
             obj.jumpLabel = true;
         }
 
@@ -2990,7 +2990,7 @@ axes.drawLabels = function(gd, ax, opts) {
     var axLetter = axId.charAt(0);
     var cls = opts.cls || axId + 'tick';
 
-    var vals = ax.ticklabeljump ?
+    var vals = ax.skipticklabels ?
         opts.vals.filter(function(d) { return !d.jumpLabel; }) :
         opts.vals;
 

src/plots/cartesian/layout_attributes.js

@@ -412,14 +412,17 @@ module.exports = {
             'To set ticks every 4 years, set `dtick` to *M48*'
         ].join(' ')
     },
-    ticklabeljump: {
+    skipticklabels: {
         valType: 'integer',
         min: 0,
         dflt: 0,
         editType: 'ticks',
         description: [
-            'Sets the step between ticklabels.',
-            'Could be used to hide labels between every n-th ticks.'
+            'Sets the spacing between tick labels as compared to the spacing between ticks.',
+            'A value of 0 (default) means each tick gets a label.',
+            'A value of 1 means shows every 2nd level.',
+            'A larger value n means only every (n+1)th tick is labeled.',
+            '`tick0` determines which labels are shown.'
         ].join(' ')
     },
     tickvals: {

src/plots/cartesian/tick_label_defaults.js

@@ -28,7 +28,7 @@ module.exports = function handleTickLabelDefaults(containerIn, containerOut, coe
             color: dfltFontColor
         });
 
-        if(!options.noTicklabeljump) coerce('ticklabeljump');
+        if(!options.noskipticklabels) coerce('skipticklabels');
 
         if(!options.noAng) coerce('tickangle');
 

src/plots/gl3d/layout/axis_defaults.js

@@ -43,7 +43,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
                 showGrid: true,
                 noTickson: true,
                 noTicklabelmode: true,
-                noTicklabeljump: true,
+                noskipticklabels: true,
                 noTicklabelposition: true,
                 noTicklabeloverflow: true,
                 bgColor: options.bgColor,

src/plots/polar/layout_attributes.js

@@ -32,7 +32,7 @@ var axisTickAttrs = overrideAll({
     ticklen: axesAttrs.ticklen,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,
-    ticklabeljump: axesAttrs.ticklabeljump,
+    skipticklabels: axesAttrs.skipticklabels,
     showticklabels: axesAttrs.showticklabels,
     showtickprefix: axesAttrs.showtickprefix,
     tickprefix: axesAttrs.tickprefix,

src/plots/smith/layout_defaults.js

@@ -83,7 +83,7 @@ function handleDefaults(contIn, contOut, coerce, opts) {
             }
 
             handleTickLabelDefaults(axIn, axOut, coerceAxis, axOut.type, {
-                noTicklabeljump: true,
+                noskipticklabels: true,
                 noAng: !isRealAxis,
                 noExp: true,
                 font: {

src/plots/ternary/layout_attributes.js

@@ -25,7 +25,7 @@ var ternaryAxesAttrs = {
     ticklen: axesAttrs.ticklen,
     tickwidth: axesAttrs.tickwidth,
     tickcolor: axesAttrs.tickcolor,
-    ticklabeljump: axesAttrs.ticklabeljump,
+    skipticklabels: axesAttrs.skipticklabels,
     showticklabels: axesAttrs.showticklabels,
     showtickprefix: axesAttrs.showtickprefix,
     tickprefix: axesAttrs.tickprefix,