Added documentation for the preventUndo parameter in the svgcanvas.setSvgString() function.

2018-02-27 11:21:07 +01:00 · 2018-02-27 11:21:07 +01:00 · 64759a8cab
parent d3ed6cbb8c
commit 64759a8cab
1 changed files with 3 additions and 0 deletions
--- a/editor/svgcanvas.js
+++ b/editor/svgcanvas.js
@ -4439,6 +4439,9 @@ var convertToGroup = this.convertToGroup = function(elem) {
 //
 // Parameters:
 // xmlString - The SVG as XML text.
+// preventUndo - Boolean (defaults to false) indicating if we want to do the
+// changes without adding them to the undo stack - e.g. for initializing a
+// drawing on page load.
 //
 // Returns:
 // This function returns false if the set was unsuccessful, true otherwise.