add label.texttemplate to draw_newshape

Author: emilykl

src/components/shapes/draw_newshape/attributes.js

@@ -2,6 +2,8 @@
 
 var fontAttrs = require('../../../plots/font_attributes');
 var dash = require('../../drawing/attributes').dash;
+var templateFormatStringDescription = require('../../../plots/template_attributes').templateFormatStringDescription;
+var describeVariables = require('../../../plots/template_attributes').describeVariables;
 var extendFlat = require('../../../lib/extend').extendFlat;
 
 module.exports = {
@@ -86,6 +88,17 @@ module.exports = {
                 editType: 'none',
                 description: 'Sets the text to display with the new shape.'
             },
+            texttemplate: {
+                valType: 'string',
+                dflt: '',
+                editType: 'calc+arraydraw',
+                description: [
+                    'Template string used for rendering the new shape\'s label.',
+                    'Note that this will override `text`.',
+                    templateFormatStringDescription(),
+                    describeVariables(['x0', 'y0', 'x1', 'y1', 'slope']),
+                ].join(' ')
+            },
             font: fontAttrs({
                 editType: 'none',
                 description: 'Sets the new shape label text font.'

src/components/shapes/draw_newshape/defaults.js

@@ -28,7 +28,8 @@ module.exports = function supplyDrawNewShapeDefaults(layoutIn, layoutOut, coerce
 
     var isLine = layoutIn.dragmode === 'drawline';
     var labelText = coerce('newshape.label.text');
-    if(labelText) {
+    var labelTextTemplate = coerce('newshape.label.texttemplate');
+    if(labelText || labelTextTemplate) {
         coerce('newshape.label.textangle');
         var labelTextPosition = coerce('newshape.label.textposition', isLine ? 'middle' : 'middle center');
         coerce('newshape.label.xanchor');

test/image/mocks/zz-text_on_shapes_texttemplate.json

@@ -14,6 +14,21 @@
         "shapes":[
             {"label":{"text":"this will be overridden", "texttemplate": "Here is x0 divided by 2: %{x0/2:.2f}"}, "layer":"below","x0":2,"x1":5,"y0":6,"y1":9,"opacity":0.5,"fillcolor":"#05e","line":{"width":3,"color":"#025","dash":"dashdot"}, "editable": true},
             {"label":{"text":"this will be overridden", "texttemplate": "Here is the slope: %{slope:.3f}"}, "layer":"below","x0":5,"x1":9,"y0":2.5,"y1":9,"type": "line", "opacity":0.5,"fillcolor":"#05e","line":{"width":3,"color":"#025"}, "editable": true}
+        ],
+        "newshape": {
+            "label": {
+                "texttemplate": "New shapes display a slope! Slope = %{slope:.1f}"
+            }
+        }
+    },
+    "config": {
+        "modeBarButtonsToAdd": [
+            "drawline",
+            "drawopenpath",
+            "drawclosedpath",
+            "drawcircle",
+            "drawrect",
+            "eraseshape"
         ]
     }
 }