scalewith -> scaleanchor

Author: alexcjohnson

src/plots/cartesian/constraint_defaults.js

@@ -16,18 +16,18 @@ var id2name = require('./axis_ids').id2name;
 module.exports = function handleConstraintDefaults(containerIn, containerOut, coerce, counterAxes, layoutOut) {
     var constraintGroups = layoutOut._axisConstraintGroups;
 
-    if(!containerIn.scalewith) return;
+    if(!containerIn.scaleanchor) return;
 
     var constraintOpts = getConstraintOpts(constraintGroups, containerOut._id, counterAxes, layoutOut);
 
-    var scalewith = Lib.coerce(containerIn, containerOut, {
-        scalewith: {
+    var scaleanchor = Lib.coerce(containerIn, containerOut, {
+        scaleanchor: {
             valType: 'enumerated',
             values: constraintOpts.linkableAxes
         }
-    }, 'scalewith');
+    }, 'scaleanchor');
 
-    if(scalewith) {
+    if(scaleanchor) {
         var scaleratio = coerce('scaleratio');
         // TODO: I suppose I could do attribute.min: Number.MIN_VALUE to avoid zero,
         // but that seems hacky. Better way to say "must be a positive number"?
@@ -37,18 +37,18 @@ module.exports = function handleConstraintDefaults(containerIn, containerOut, co
         if(!scaleratio) scaleratio = containerOut.scaleratio = 1;
 
         updateConstraintGroups(constraintGroups, constraintOpts.thisGroup,
-            containerOut._id, scalewith, scaleratio);
+            containerOut._id, scaleanchor, scaleratio);
     }
-    else if(counterAxes.indexOf(containerIn.scalewith) !== -1) {
-        Lib.warn('ignored ' + containerOut._name + '.scalewith: "' +
-            containerIn.scalewith + '" to avoid an infinite loop ' +
+    else if(counterAxes.indexOf(containerIn.scaleanchor) !== -1) {
+        Lib.warn('ignored ' + containerOut._name + '.scaleanchor: "' +
+            containerIn.scaleanchor + '" to avoid an infinite loop ' +
             'and possibly inconsistent scaleratios.');
     }
 };
 
 function getConstraintOpts(constraintGroups, thisID, counterAxes, layoutOut) {
     // If this axis is already part of a constraint group, we can't
-    // scalewith any other axis in that group, or we'd make a loop.
+    // scaleanchor any other axis in that group, or we'd make a loop.
     // Filter counterAxes to enforce this, also matching axis types.
 
     var thisType = layoutOut[id2name(thisID)].type;
@@ -84,10 +84,10 @@ function getConstraintOpts(constraintGroups, thisID, counterAxes, layoutOut) {
  *
  * thisGroup: the group the current axis is already in
  * thisID: the id if the current axis
- * scalewith: the id of the axis to scale it with
- * scaleratio: the ratio of this axis to the scalewith axis
+ * scaleanchor: the id of the axis to scale it with
+ * scaleratio: the ratio of this axis to the scaleanchor axis
  */
-function updateConstraintGroups(constraintGroups, thisGroup, thisID, scalewith, scaleratio) {
+function updateConstraintGroups(constraintGroups, thisGroup, thisID, scaleanchor, scaleratio) {
     var i, j, groupi, keyj, thisGroupIndex;
 
     if(thisGroup === null) {
@@ -103,11 +103,11 @@ function updateConstraintGroups(constraintGroups, thisGroup, thisID, scalewith,
     var thisGroupKeys = Object.keys(thisGroup);
 
     // we know that this axis isn't in any other groups, but we don't know
-    // about the scalewith axis. If it is, we need to merge the groups.
+    // about the scaleanchor axis. If it is, we need to merge the groups.
     for(i = 0; i < constraintGroups.length; i++) {
         groupi = constraintGroups[i];
-        if(i !== thisGroupIndex && groupi[scalewith]) {
-            var baseScale = groupi[scalewith];
+        if(i !== thisGroupIndex && groupi[scaleanchor]) {
+            var baseScale = groupi[scaleanchor];
             for(j = 0; j < thisGroupKeys.length; j++) {
                 keyj = thisGroupKeys[j];
                 groupi[keyj] = baseScale * scaleratio * thisGroup[keyj];
@@ -117,12 +117,12 @@ function updateConstraintGroups(constraintGroups, thisGroup, thisID, scalewith,
         }
     }
 
-    // otherwise, we insert the new scalewith axis as the base scale (1)
+    // otherwise, we insert the new scaleanchor axis as the base scale (1)
     // in its group, and scale the rest of the group to it
     if(scaleratio !== 1) {
         for(j = 0; j < thisGroupKeys.length; j++) {
             thisGroup[thisGroupKeys[j]] *= scaleratio;
         }
     }
-    thisGroup[scalewith] = 1;
+    thisGroup[scaleanchor] = 1;
 }

src/plots/cartesian/layout_attributes.js

@@ -107,9 +107,9 @@ module.exports = {
             'If true, then zoom is disabled.'
         ].join(' ')
     },
-    // scalewith: not used directly, just put here for reference
+    // scaleanchor: not used directly, just put here for reference
     // values are any opposite-letter axis id
-    scalewith: {
+    scaleanchor: {
         valType: 'enumerated',
         values: [
             constants.idRegex.x.toString(),
@@ -123,9 +123,9 @@ module.exports = {
             'Both axes are still zoomable, but when you zoom one, the other will',
             'zoom the same amount, keeping a fixed midpoint.',
             'Autorange will also expand about the midpoints to satisfy the constraint.',
-            'You can chain these, ie `yaxis: {scalewith: *x*}, xaxis2: {scalewith: *y*}`',
+            'You can chain these, ie `yaxis: {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}`',
             'but you can only link axes of the same `type`.',
-            'Loops (`yaxis: {scalewith: *x*}, xaxis: {scalewith: *y*}` or longer) are redundant',
+            'Loops (`yaxis: {scaleanchor: *x*}, xaxis: {scaleanchor: *y*}` or longer) are redundant',
             'and the last constraint encountered will be ignored to avoid possible',
             'inconsistent constraints via `scaleratio`.'
         ].join(' ')
@@ -136,7 +136,7 @@ module.exports = {
         dflt: 1,
         role: 'info',
         description: [
-            'If this axis is linked to another by `scalewith`, this determines the pixel',
+            'If this axis is linked to another by `scaleanchor`, this determines the pixel',
             'to unit scale ratio. For example, if this value is 10, then every unit on',
             'this axis spans 10 times the number of pixels as a unit on the linked axis.',
             'Use this for example to create an elevation profile where the vertical scale',

src/plots/cartesian/layout_defaults.js

@@ -143,7 +143,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         return out;
     }
 
-    // sets of axes linked by `scalewith` along with the scaleratios compounded
+    // sets of axes linked by `scaleanchor` along with the scaleratios compounded
     // together, populated in handleConstraintDefaults
     layoutOut._axisConstraintGroups = [];
 

test/image/baselines/axes_scalewith.png renamed to test/image/baselines/axes_scaleanchor.png

@@ -8,8 +8,8 @@
     "height":600,
     "title": "fixed-ratio axes",
     "xaxis": {"nticks": 10, "title": "shared X axis"},
-    "yaxis": {"scalewith": "x", "domain": [0, 0.45], "title": "1:1"},
-    "yaxis2": {"scalewith": "x", "scaleratio": 0.2, "domain": [0.55,1], "title": "1:5"},
+    "yaxis": {"scaleanchor": "x", "domain": [0, 0.45], "title": "1:1"},
+    "yaxis2": {"scaleanchor": "x", "scaleratio": 0.2, "domain": [0.55,1], "title": "1:5"},
     "showlegend": false
   }
 }