Merge pull request #6679 from plotly/eraseActiveShape-command

add `Plotly.deleteActiveShape` command
plotly · Jul 24, 2023 · e0e79b4 · e0e79b4
2 parents 149c895 + 5c9a7c9
commit e0e79b4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/draftlogs/6679_add.md b/draftlogs/6679_add.md
@@ -0,0 +1 @@
+ - add Plotly.deleteActiveShape command [[#6679](https://github.com/plotly/plotly.js/pull/6679)]
diff --git a/src/components/shapes/draw.js b/src/components/shapes/draw.js
@@ -669,7 +669,7 @@ function eraseActiveShape(gd) {
 
         delete gd._fullLayout._activeShapeIndex;
 
-        Registry.call('_guiRelayout', gd, {
+        return Registry.call('_guiRelayout', gd, {
             shapes: list
         });
     }

diff --git a/src/plot_api/index.js b/src/plot_api/index.js
@@ -24,6 +24,12 @@ exports.deleteFrames = main.deleteFrames;
 exports.animate = main.animate;
 exports.setPlotConfig = main.setPlotConfig;
 
+var getGraphDiv = require('../lib/dom').getGraphDiv;
+var eraseActiveShape = require('../components/shapes/draw').eraseActiveShape;
+exports.deleteActiveShape = function(gd) {
+    return eraseActiveShape(getGraphDiv(gd));
+};
+
 exports.toImage = require('./to_image');
 exports.validate = require('./validate');
 exports.downloadImage = require('../snapshot/download');