code review feedback

Author: MFed

src/components/annotations/attributes.js

@@ -131,7 +131,7 @@ module.exports = {
         role: 'style',
         description: 'Sets the width (in px) of annotation arrow.'
     },
-    absoluteArrowTail: {
+    absolutetail: {
         valType: 'boolean',
         dflt: false,
         role: 'style',
@@ -152,10 +152,10 @@ module.exports = {
         role: 'info',
         description: [
             'Sets the x component of the arrow tail about the arrow head.',
-            'If `absoluteArrowTail` is false, a positive (negative) ',
+            'If `absolutetail` is false, a positive (negative) ',
             'component corresponds to an arrow pointing',
             'from right to left (left to right).',
-            'If `absoluteArrowTail` is true, this is a value on the x axis.'
+            'If `absolutetail` is true, this is a value on the x axis.'
         ].join(' ')
     },
     ay: {
@@ -164,10 +164,10 @@ module.exports = {
         role: 'info',
         description: [
             'Sets the y component of the arrow tail about the arrow head.',
-            'If `absoluteArrowTail` is false, a positive (negative) ',
+            'If `absolutetail` is false, a positive (negative) ',
             'component corresponds to an arrow pointing',
             'from bottom to top (top to bottom).',
-            'If `absoluteArrowTail` is true, this is a value on the y axis.'
+            'If `absolutetail` is true, this is a value on the y axis.'
         ].join(' ')
     },
     // positioning

src/components/annotations/index.js

@@ -59,7 +59,7 @@ function handleAnnotationDefaults(annIn, fullLayout) {
         coerce('arrowwidth', ((borderOpacity && borderWidth) || 1) * 2);
         coerce('ax');
         coerce('ay');
-        coerce('absoluteArrowTail');
+        coerce('absolutetail');
 
         // if you have one part of arrow length you should have both
         Lib.noneOrAll(annIn, annOut, ['ax', 'ay']);
@@ -91,7 +91,7 @@ function handleAnnotationDefaults(annIn, fullLayout) {
                     newval = Lib.dateTime2ms(annIn[axLetter]);
                     if(newval !== false) annIn[axLetter] = newval;
 
-                    if(annIn.absoluteArrowTail) {
+                    if(annIn.absolutetail) {
                         var newvalB = Lib.dateTime2ms(annIn['a' + axLetter]);
                         if(newvalB !== false) annIn['a' + axLetter] = newvalB;
                     }
@@ -456,7 +456,7 @@ annotations.draw = function(gd, index, opt, value) {
             }
 
             var alignShift = 0;
-            if(options.absoluteArrowTail) {
+            if(options.absolutetail) {
                 annPosPx['aa' + axLetter] = ax._offset + ax.l2p(options['a' + axLetter]);
             } else {
                 if(options.showarrow) {
@@ -486,7 +486,7 @@ annotations.draw = function(gd, index, opt, value) {
         // make sure the arrowhead (if there is one)
         // and the annotation center are visible
         if(options.showarrow) {
-            if (options.absoluteArrowTail) {
+            if (options.absolutetail) {
                 arrowX = Lib.constrain(annPosPx.x, 1, fullLayout.width - 1);
                 arrowY = Lib.constrain(annPosPx.y, 1, fullLayout.height - 1);
             } else {
@@ -512,7 +512,7 @@ annotations.draw = function(gd, index, opt, value) {
             outerwidth - borderwidth, outerheight - borderwidth);
 
         var annX = 0, annY = 0;
-        if(options.absoluteArrowTail) {
+        if(options.absolutetail) {
             annX = Math.round(annPosPx.aax - outerwidth / 2);
             annY = Math.round(annPosPx.aay - outerheight / 2);
         } else {
@@ -539,7 +539,7 @@ annotations.draw = function(gd, index, opt, value) {
             //    how-to-get-the-width-of-an-svg-tspan-element
             var arrowX0, arrowY0;
 
-            if(options.absoluteArrowTail) {
+            if(options.absolutetail) {
                 arrowX0 = annPosPx.aax + dx;
                 arrowY0 = annPosPx.aay + dy;
             } else {
@@ -648,7 +648,7 @@ annotations.draw = function(gd, index, opt, value) {
                             (options.y + dy / ya._m) :
                             (1 - ((arrowY + dy - gs.t) / gs.h));
 
-                        if(options.absoluteArrowTail) {
+                        if(options.absolutetail) {
                             update[annbase + '.ax'] = xa ?
                               (options.ax + dx / xa._m) :
                               ((arrowX + dx - gs.l) / gs.w);
@@ -698,7 +698,7 @@ annotations.draw = function(gd, index, opt, value) {
                     ann.call(Lib.setTranslate, x0 + dx, y0 + dy);
                     var csr = 'pointer';
                     if(options.showarrow) {
-                        if(options.absoluteArrowTail) {
+                        if(options.absolutetail) {
                             update[annbase + '.ax'] = xa.p2l(xa.l2p(options.ax) + dx);
                             update[annbase + '.ay'] = ya.p2l(ya.l2p(options.ay) + dy);
                         } else {

test/image/mocks/annotations.json

@@ -42,7 +42,7 @@
                 "font":{"color":"rgb(0, 0, 255)","size":20},
                 "arrowcolor":"rgb(166, 28, 0)","borderpad":3,"textangle":50,"x":5,"y":1
             },
-            {"text":"","showarrow":true,"borderwidth":1.2,"arrowhead":2,"absoluteArrowTail":true,"x":5,"y":5,"ax":4,"ay":3}
+            {"text":"","showarrow":true,"borderwidth":1.2,"arrowhead":2,"absolutetail":true,"x":5,"y":5,"ax":4,"ay":3}
         ]
     }
 }

test/jasmine/tests/annotations_test.js

@@ -13,15 +13,15 @@ describe('Test annotations', function() {
 
             Annotations.supplyLayoutDefaults({ annotations: [{ showarrow: true, arrowhead: 2}] }, annotationDefaults);
 
-            expect(annotationDefaults.annotations[0].absoluteArrowTail).toBe(false);
+            expect(annotationDefaults.annotations[0].absolutetail).toBe(false);
         });
 
-        it('should convert ax/ay date coordinates to milliseconds if absoluteArrowTail is true', function() {
+        it('should convert ax/ay date coordinates to milliseconds if absolutetail is true', function() {
             var annotationOut = { xaxis: { type: 'date', range: ['2000-01-01', '2016-01-01'] }};
             annotationOut._has = Plots._hasPlotType.bind(annotationOut);
 
             var annotationIn = {
-                annotations: [{ showarrow: true, absoluteArrowTail: true, x: '2008-07-01', ax: '2004-07-01', y: 0, ay: 50}]
+                annotations: [{ showarrow: true, absolutetail: true, x: '2008-07-01', ax: '2004-07-01', y: 0, ay: 50}]
             };
 
             Annotations.supplyLayoutDefaults(annotationIn, annotationOut);