Improved tickmode schema declaration

Author: filipesantiagoAM

src/components/colorbar/attributes.js

@@ -129,19 +129,7 @@ module.exports = overrideAll({
         description: 'Sets the color of padded area.'
     },
     // tick and title properties named and function exactly as in axes
-    tickmode: extendFlat({}, axesAttrs.tickmode, {
-        values: ['auto', 'linear', 'array'],
-        description: [
-            'Sets the tick mode for this axis.',
-            'If *auto*, the number of ticks is set via `nticks`.',
-            'If *linear*, the placement of the ticks is determined by',
-            'a starting position `tick0` and a tick step `dtick`',
-            '(*linear* is the default value if `tick0` and `dtick` are provided).',
-            'If *array*, the placement of the ticks is set via `tickvals`',
-            'and the tick text is `ticktext`.',
-            '(*array* is the default value if `tickvals` is provided).'
-        ].join(' ')
-    }),
+    tickmode: axesAttrs.minor.tickmode,
     nticks: axesAttrs.nticks,
     tick0: axesAttrs.tick0,
     dtick: axesAttrs.dtick,

src/plots/cartesian/layout_attributes.js

@@ -12,34 +12,31 @@ var constants = require('./constants');
 var HOUR = constants.HOUR_PATTERN;
 var DAY_OF_WEEK = constants.WEEKDAY_PATTERN;
 
-function makeTickmode(minor) {
-    var values = ['auto', 'linear', 'array', 'sync'];
-    var description = [
+var minorTickmode = {
+    valType: 'enumerated',
+    values: ['auto', 'linear', 'array'],
+    editType: 'ticks',
+    impliedEdits: {tick0: undefined, dtick: undefined},
+    description: [
         'Sets the tick mode for this axis.',
         'If *auto*, the number of ticks is set via `nticks`.',
         'If *linear*, the placement of the ticks is determined by',
         'a starting position `tick0` and a tick step `dtick`',
         '(*linear* is the default value if `tick0` and `dtick` are provided).',
         'If *array*, the placement of the ticks is set via `tickvals`',
         'and the tick text is `ticktext`.',
-        '(*array* is the default value if `tickvals` is provided).',
+        '(*array* is the default value if `tickvals` is provided).'
+    ].join(' ')
+};
+
+var tickmode = extendFlat({}, minorTickmode, {
+    values: minorTickmode.values.slice().concat(['sync']),
+    description: [
+        minorTickmode.description,
         'If *sync*, the number of ticks will sync with the overlayed axis',
         'set by `overlaying` property.'
-    ];
-
-    if(minor) {
-        values = values.slice(0, -1);
-        description = description.slice(0, -2);
-    }
-
-    return {
-        valType: 'enumerated',
-        values: values,
-        editType: 'ticks',
-        impliedEdits: {tick0: undefined, dtick: undefined},
-        description: description.join(' ')
-    };
-}
+    ].join(' ')
+});
 
 function makeNticks(minor) {
     return {
@@ -516,7 +513,7 @@ module.exports = {
     }),
 
     // ticks
-    tickmode: makeTickmode(),
+    tickmode: tickmode,
     nticks: makeNticks(),
     tick0: tick0,
     dtick: dtick,
@@ -959,7 +956,7 @@ module.exports = {
     },
 
     minor: {
-        tickmode: makeTickmode('minor'),
+        tickmode: minorTickmode,
         nticks: makeNticks('minor'),
         tick0: tick0,
         dtick: dtick,

src/plots/cartesian/position_defaults.js

@@ -83,6 +83,12 @@ module.exports = function handlePositionDefaults(containerIn, containerOut, coer
         // which applied in the calculation below:
         if(domain[0] > domain[1] - 1 / 4096) containerOut.domain = dfltDomain;
         Lib.noneOrAll(containerIn.domain, containerOut.domain, dfltDomain);
+
+        // tickmode sync needs an overlaying axis, otherwise 
+        // we should default it to 'auto'
+        if(containerOut.tickmode === 'sync') {
+            containerOut.tickmode = 'auto';
+        }
     }
 
     coerce('layer');

src/plots/cartesian/tick_value_defaults.js

@@ -26,10 +26,8 @@ module.exports = function handleTickValueDefaults(containerIn, containerOut, coe
         'auto';
     var tickmode = coerce(prefix + 'tickmode', tickmodeDefault);
 
-    if(tickmode === 'auto') {
+    if(tickmode === 'auto' || tickmode === 'sync') {
         coerce(prefix + 'nticks');
-    } else if(tickmode === 'sync') {
-        coerce('overlaying');
     } else if(tickmode === 'linear') {
         // dtick is usually a positive number, but there are some
         // special strings available for log or date axes

src/plots/gl3d/layout/axis_attributes.js

@@ -74,19 +74,7 @@ module.exports = overrideAll({
         anim: false
     }),
     // ticks
-    tickmode: extendFlat({}, axesAttrs.tickmode, {
-        values: ['auto', 'linear', 'array'],
-        description: [
-            'Sets the tick mode for this axis.',
-            'If *auto*, the number of ticks is set via `nticks`.',
-            'If *linear*, the placement of the ticks is determined by',
-            'a starting position `tick0` and a tick step `dtick`',
-            '(*linear* is the default value if `tick0` and `dtick` are provided).',
-            'If *array*, the placement of the ticks is set via `tickvals`',
-            'and the tick text is `ticktext`.',
-            '(*array* is the default value if `tickvals` is provided).'
-        ].join(' ')
-    }),
+    tickmode: axesAttrs.minor.tickmode,
     nticks: axesAttrs.nticks,
     tick0: axesAttrs.tick0,
     dtick: axesAttrs.dtick,

src/plots/polar/layout_attributes.js

@@ -23,19 +23,7 @@ var axisLineGridAttr = overrideAll({
 }, 'plot', 'from-root');
 
 var axisTickAttrs = overrideAll({
-    tickmode: extendFlat({}, axesAttrs.tickmode, {
-        values: ['auto', 'linear', 'array'],
-        description: [
-            'Sets the tick mode for this axis.',
-            'If *auto*, the number of ticks is set via `nticks`.',
-            'If *linear*, the placement of the ticks is determined by',
-            'a starting position `tick0` and a tick step `dtick`',
-            '(*linear* is the default value if `tick0` and `dtick` are provided).',
-            'If *array*, the placement of the ticks is set via `tickvals`',
-            'and the tick text is `ticktext`.',
-            '(*array* is the default value if `tickvals` is provided).'
-        ].join(' ')
-    }),
+    tickmode: axesAttrs.minor.tickmode,
     nticks: axesAttrs.nticks,
     tick0: axesAttrs.tick0,
     dtick: axesAttrs.dtick,

src/plots/ternary/layout_attributes.js

@@ -15,19 +15,7 @@ var ternaryAxesAttrs = {
     },
     color: axesAttrs.color,
     // ticks
-    tickmode: extendFlat({}, axesAttrs.tickmode, {
-        values: ['auto', 'linear', 'array'],
-        description: [
-            'Sets the tick mode for this axis.',
-            'If *auto*, the number of ticks is set via `nticks`.',
-            'If *linear*, the placement of the ticks is determined by',
-            'a starting position `tick0` and a tick step `dtick`',
-            '(*linear* is the default value if `tick0` and `dtick` are provided).',
-            'If *array*, the placement of the ticks is set via `tickvals`',
-            'and the tick text is `ticktext`.',
-            '(*array* is the default value if `tickvals` is provided).'
-        ].join(' ')
-    }),
+    tickmode: axesAttrs.minor.tickmode,
     nticks: extendFlat({}, axesAttrs.nticks, {dflt: 6, min: 1}),
     tick0: axesAttrs.tick0,
     dtick: axesAttrs.dtick,

src/traces/indicator/attributes.js

@@ -307,19 +307,7 @@ module.exports = {
                 dflt: true
             }),
             // tick and title properties named and function exactly as in axes
-            tickmode: extendFlat({}, axesAttrs.tickmode, {
-                values: ['auto', 'linear', 'array'],
-                description: [
-                    'Sets the tick mode for this axis.',
-                    'If *auto*, the number of ticks is set via `nticks`.',
-                    'If *linear*, the placement of the ticks is determined by',
-                    'a starting position `tick0` and a tick step `dtick`',
-                    '(*linear* is the default value if `tick0` and `dtick` are provided).',
-                    'If *array*, the placement of the ticks is set via `tickvals`',
-                    'and the tick text is `ticktext`.',
-                    '(*array* is the default value if `tickvals` is provided).'
-                ].join(' ')
-            }),
+            tickmode: axesAttrs.minor.tickmode,
             nticks: axesAttrs.nticks,
             tick0: axesAttrs.tick0,
             dtick: axesAttrs.dtick,