rename uvref to arrowref

Author: emilykl

src/traces/quiver/attributes.js

@@ -38,7 +38,7 @@ var attrs = {
         anim: true,
         description: 'Sets the y components of the vector arrows.'
     },
-    uvref: {
+    arrowref: {
         valType: 'enumerated',
         values: ['paper', 'data'],
         dflt: 'data',
@@ -58,7 +58,7 @@ var attrs = {
         dflt: 'scaled',
         description: [
             'Determines whether vector arrows are drawn according to their raw lengths,',
-            'or scaled based on the maximum vector length and point density. Note: When `uvref` is *paper*',
+            'or scaled based on the maximum vector length and point density. Note: When `arrowref` is *paper*',
             'vectors are always scaled and `lengthmode` *raw* is ignored.'
         ].join(' ')
     },

src/traces/quiver/calc.js

@@ -33,7 +33,7 @@ module.exports = function calc(gd, trace) {
     const uArr = trace.u || [];
     const vArr = trace.v || [];
 
-    const { anchor, lengthmode, uvref } = trace;
+    const { anchor, lengthmode, arrowref } = trace;
     const isTip = anchor === 'tip';
     const isCenter = anchor === 'center';
 
@@ -107,8 +107,8 @@ module.exports = function calc(gd, trace) {
     // Store maxNorm for use by plot step
     trace._maxNorm = normMax;
 
-    if (lengthmode === 'scaled' || uvref === 'paper') {
-        // Ignore lengthmode 'raw' if uvref is set to 'paper': always scale
+    if (lengthmode === 'scaled' || arrowref === 'paper') {
+        // Ignore lengthmode 'raw' if arrowref is set to 'paper': always scale
 
         // Compute point density of the entire trace: Area of bounding box
         // divided by number of points. This is used to scale arrows in
@@ -128,7 +128,7 @@ module.exports = function calc(gd, trace) {
         } else {
             trace._scaleFactor = Math.sqrt(pointDensity) / trace._maxNorm;
         }
-        // Note: If uvref === 'paper', this scale factor must be
+        // Note: If arrowref === 'paper', this scale factor must be
         // multiplied by Math.sqrt(xa._m * ya._m), but we can't do that quite yet
         // since the axis scales are not fully determined. Do it in plot step instead.
     } else {
@@ -146,7 +146,7 @@ module.exports = function calc(gd, trace) {
     const yTailPositions = new Array(len);
     var arrowLenX, arrowLenY;
     // Compute the x- and y-positions of the tip of each arrow,
-    // assuming uvref === 'data' (i.e. u/v are in data coordinates)
+    // assuming arrowref === 'data' (i.e. u/v are in data coordinates)
     for(var i = 0; i < len; i++) {
         var cdi = cd[i];
         arrowLenX = cdi._u * trace._scaleFactor;
@@ -169,12 +169,12 @@ module.exports = function calc(gd, trace) {
         }
     }
 
-    if (uvref === 'data') {
-        // If uvref is 'data', we can use the arrow tip positions directly to expand the axes ranges
+    if (arrowref === 'data') {
+        // If arrowref is 'data', we can use the arrow tip positions directly to expand the axes ranges
         trace._extremes[xa._id] = Axes.findExtremes(xa, xTipPositions.concat(xTailPositions), {padded: true});
         trace._extremes[ya._id] = Axes.findExtremes(ya, yTipPositions.concat(yTailPositions), {padded: true});
-    } else {  // uvref === 'paper'
-        // TODO: For now, just do the same thing as for uvref === 'data', but this is not correct.
+    } else {  // arrowref === 'paper'
+        // TODO: For now, just do the same thing as for arrowref === 'data', but this is not correct.
         // We actually need more sophisticated logic here, since this will give a bad result
         // if the data aspect ratio is very different from the plot aspect ratio.
         trace._extremes[xa._id] = Axes.findExtremes(xa, xTipPositions.concat(xTailPositions), {padded: true});

src/traces/quiver/defaults.js

@@ -30,7 +30,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         for(var j = 0; j < len; j++) traceOut.v[j] = 0;
     }
 
-    coerce('uvref');
+    coerce('arrowref');
 
     // Sizing API inspired by cone, but not identical
     coerce('lengthmode');

src/traces/quiver/plot.js

@@ -102,10 +102,10 @@ function plotOne(gd, idx, plotinfo, cdscatter, cdscatterAll, element, transition
     lineSegments.exit().remove();
 
     // Use maxNorm precomputed in calc
-    const { anchor, maxNorm = 0, uvref } = trace;
+    const { anchor, maxNorm = 0, arrowref } = trace;
 
-    // Adjust scale factor if uvref is 'paper'
-    const scaleFactor = (uvref === 'paper') ? trace._scaleFactor * Math.sqrt(Math.abs(xa._m * ya._m)) : trace._scaleFactor;
+    // Adjust scale factor if arrowref is 'paper'
+    const scaleFactor = (arrowref === 'paper') ? trace._scaleFactor * Math.sqrt(Math.abs(xa._m * ya._m)) : trace._scaleFactor;
     const markerArrowsize = trace.marker.arrowsize;
 
     // Update line segments
@@ -119,12 +119,12 @@ function plotOne(gd, idx, plotinfo, cdscatter, cdscatterAll, element, transition
         }
 
         // Compute pixel location of vector tip, *relative to* vector base (before scaling).
-        // If uvref is 'paper', then u/v are interpreted in pixel coordinates, so we can use them directly.
-        // If uvref is 'data', then u/v are interpreted in data coordinates, so we need to convert them to pixel coordinates.
+        // If arrowref is 'paper', then u/v are interpreted in pixel coordinates, so we can use them directly.
+        // If arrowref is 'data', then u/v are interpreted in data coordinates, so we need to convert them to pixel coordinates.
         // TODO: This probably doesn't work for log axes, but let's ignore log axes for now
         // since I'm not sure they make sense for quiver plots anyway
-        const pu = ((uvref === 'paper') ? cdi._u * Math.sign(xa._m) : d3.round(xa._m * cdi._u)) * scaleFactor;
-        const pv = ((uvref === 'paper') ? cdi._v * Math.sign(ya._m) : d3.round(ya._m * cdi._v)) * scaleFactor;
+        const pu = ((arrowref === 'paper') ? cdi._u * Math.sign(xa._m) : d3.round(xa._m * cdi._u)) * scaleFactor;
+        const pv = ((arrowref === 'paper') ? cdi._v * Math.sign(ya._m) : d3.round(ya._m * cdi._v)) * scaleFactor;
 
         // Compute arrow in data space
         // Check whether arrowsize was set explicitly in the input trace

src/types/generated/schema.d.ts

@@ -6731,7 +6731,7 @@ export interface QuiverData {
      */
     lengthfactor?: number;
     /**
-     * Determines whether vector arrows are drawn according to their raw lengths, or scaled based on the maximum vector length and point density. Note: When `uvref` is *paper* vectors are always scaled and `lengthmode` *raw* is ignored.
+     * Determines whether vector arrows are drawn according to their raw lengths, or scaled based on the maximum vector length and point density. Note: When `arrowref` is *paper* vectors are always scaled and `lengthmode` *raw* is ignored.
      * @default 'scaled'
      */
     lengthmode?: 'scaled' | 'raw';
@@ -6853,7 +6853,7 @@ export interface QuiverData {
      * Determines how the u/v vector components are interpreted. If *paper*, u/v are interpreted in pixel coordinates and the rendered vector angle does not change regardless of the axis scales. If *data*, u/v are interpreted in data coordinates and the rendered vector angle may change, e.g. if zooming in along a single axis
      * @default 'data'
      */
-    uvref?: 'paper' | 'data';
+    arrowref?: 'paper' | 'data';
     /** Sets the y components of the vector arrows. */
     v?: Datum[] | Datum[][] | TypedArray;
     /** Sets the hover text formatting rule for `v` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format. */

test/image/mocks/quiver_colorscale.json

@@ -8,7 +8,7 @@
       "v": [1, 1, 1, 2, 2, 2, 3, 3, 3],
       "lengthmode": "scaled",
       "anchor": "tail",
-      "uvref": "paper",
+      "arrowref": "paper",
       "marker": {
         "showscale": true,
         "colorbar": {

test/jasmine/tests/quiver_test.js

@@ -102,10 +102,10 @@ describe('Test quiver defaults', function() {
         expect(gd._fullData[0].lengthfactor).toBe(1);
     });
 
-    it('should set uvref default to data', function() {
+    it('should set arrowref default to data', function() {
         gd = makeGD();
         supplyAllDefaults(gd);
-        expect(gd._fullData[0].uvref).toBe('data');
+        expect(gd._fullData[0].arrowref).toBe('data');
     });
 
     it('should set anchor default to tail', function() {