svgedit

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Tutorial: Events</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Tutorial: Events</h1> <section> <header> <h2>Events</h2> </header> <article> <h1>Introduction</h1> <h2><code>save</code>, <code>open</code>, <code>exportImage</code> (<code>setCustomHandlers</code>)</h2> <p>You can hook to the save event (e.g. in an extension), to handle saving the SVG file differently:</p> <h3>Example</h3> <pre class="prettyprint source lang-js"><code>svgEditor.setCustomHandlers({ save (_win, _data) { // Save svg } }) </code></pre> <p>Other methods corresponding to UI events that may be supplied are <code>open</code> and <code>exportImage</code>.</p> <p>See <code><code>CustomHandler</code></code> for the required format of the object to be passed to <code><code>setCustomHandlers</code></code>.</p> <h2>Parent/Opening window events</h2> <h3><code>svgEditorReady</code></h3> <p>The <code>svgEditorReady</code> event is triggered on a containing <code>document</code> (of <code>window.opener</code> or <code>window.parent</code>) when the editor is loaded.</p> <p>See <a href="module-SVGEditor.html#event:event:svgEditorReadyEvent"><code>svgEditorReadyEvent</code></a> for the JSDocs.</p> <h3>Example</h3> <pre class="prettyprint source lang-js"><code>$(document).bind('svgEditorReady', function () { const svg = ` <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> <svg xmlns="http://www.w3.org/2000/svg" width="100" height="50"> <ellipse cx="50" cy="25" rx="50" ry="25" style="fill:blue;"/> </svg>` $('iframe.svgedit')[0].contentWindow.svgCanvas.setSvgString(svg) }) </code></pre> <p>If you are acting within the frame, you may use <code>svgEditor.ready</code> (see "Editor (within-frame) events (<code>svgEditor</code>)" below).</p> <h2>Editor (within-frame) events (<code>svgEditor</code>)</h2> <h3><code>svgEditor.canvas</code></h3> <ul> <li>Canvas object. See "Canvas events".</li> </ul> <h3><code>svgEditor.canvas.bind(eventName, function () {})</code></h3> <ul> <li>Method for listening to canvas events. See "Canvas events".</li> </ul> <h3><code>svgEditor.ready(function () {})</code></h3> <p>Method for listening to editor callbacks. Used internally as well.</p> <p>No arguments passed to callback.</p> <p>See <code><code>SVGEditor.ready</code></code>.</p> <h2>Extension events</h2> <p>Most extensions will want to run functions when certain events are triggered. This is a list of the current events that can be hooked onto. All events are optional.</p> <p>See the <code>vars</code> param of <code><code>runExtensions</code></code> for some of the available extension events and their descriptions and types.</p> <p>See <code><code>ExtensionStatus</code></code> for the values to be returned by the corresponding extension methods listening for these extension event types.</p> <h2>Canvas events</h2> <p>Canvas events are listened to with the bind method (<code>JSDocs API</code>):</p> <pre class="prettyprint source lang-js"><code>canvas.bind(eventName, callback) </code></pre> <p>Canvas events are passed between the editor and canvas and should mostly only of be of interest to those working with the <a href="tutorial-CanvasAPI.html">Canvas</a> alone or those developing SVGEdit).</p> <p><code>callback</code> (see <code><code>EventHandler</code></code>) will be passed the <code>window</code> object and a single argument specific to the event (see <code><code>GenericCanvasEvent</code></code>).</p> <p>The <code>bind</code> method will return any previous callback attached to the given event name.</p> <p>The method used to trigger these bound events is <code>call()</code> (<code>JSDocs</code>).</p> <p>All events below are currently called from within <code>svgcanvas.js</code> except where noted. All events are also defined internally within <code>svg-editor.js</code> except where noted.</p> <table> <thead> <tr> <th>Event</th> <th>Where bound/defined (besides editor)</th> <th>Where called/triggered (besides canvas)</th> </tr> </thead> <tbody> <tr> <td><code>changed</code></td> <td></td> <td>(Also called from <code>draw.js</code>, <code>ext-arrows.js</code>, <code>ext-foreignObject.js</code>, <code>ext-markers.js</code>, <code>ext-polygon.js</code>, <code>ext-star.js</code>, and <code>path.js</code>)</td> </tr> <tr> <td><code>cleared</code></td> <td>Not bound/defined in SVGEdit.</td> <td></td> </tr> <tr> <td><code>contextset</code></td> <td></td> <td>Only called from <code>draw.js</code></td> </tr> <tr> <td><code>exported</code></td> <td></td> <td></td> </tr> <tr> <td><code>exportedPDF</code></td> <td></td> <td></td> </tr> <tr> <td><code>extension_added</code></td> <td></td> <td></td> </tr> <tr> <td><code>extensions_added</code></td> <td></td> <td>Only called from <code>svg-editor.js</code></td> </tr> <tr> <td><code>message</code></td> <td>Only bound/defined in <code>ext-webappfind.js</code></td> <td>Only called from <code>svg-editor.js</code></td> </tr> <tr> <td><code>pointsAdded</code></td> <td>Not bound/defined in SVGEdit.</td> <td></td> </tr> <tr> <td><code>saved</code></td> <td></td> <td></td> </tr> <tr> <td><code>selected</code></td> <td></td> <td>Also called from <code>path.js</code></td> </tr> <tr> <td><code>setnonce</code></td> <td>Only bound/defined in <code>ext-arrows.js</code></td> <td></td> </tr> <tr> <td><code>transition</code></td> <td></td> <td></td> </tr> <tr> <td><code>updateCanvas</code></td> <td></td> <td></td> </tr> <tr> <td><code>unsetnonce</code></td> <td>Only bound/defined in <code>ext-arrows.js</code></td> <td></td> </tr> <tr> <td><code>zoomed</code></td> <td></td> <td></td> </tr> <tr> <td><code>zoomDone</code></td> <td></td> <td></td> </tr> </tbody> </table> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="editor_extensions_ext-layer_view_locale_zh-CN.module_js.html">editor/extensions/ext-layer_view/locale/zh-CN.js</a></li><li><a href="module-SVGEditor.html">SVGEditor</a></li><li><a href="module-contextmenu.html">contextmenu</a></li><li><a href="module-jGraduate.html">jGraduate</a></li><li><a href="module-jPicker.html">jPicker</a></li><li><a href="module-locale.html">locale</a></li></ul><h3>Externals</h3><ul><li><a href="external-JamilihArray.html">JamilihArray</a></li><li><a href="external-Math.html">Math</a></li><li><a href="external-Window.html">Window</a></li><li><a href="external-jQuery.html">jQuery</a></li></ul><h3>Namespaces</h3><ul><li><a href="external-jQuery.fn.html">fn</a></li><li><a href="external-jQuery.fn.$.fn.jPicker.defaults.html">defaults</a></li><li><a href="external-jQuery.fn.exports.jPickerMethod.html">exports.jPickerMethod</a></li><li><a href="external-jQuery.fn.jGraduateDefaults.html">jGraduateDefaults</a></li><li><a href="external-jQuery.fn.jGraduateDefaults.images.html">images</a></li><li><a href="external-jQuery.fn.jGraduateDefaults.window.html">window</a></li><li><a href="external-jQuery.jGraduate.html">jGraduate</a></li><li><a href="external-jQuery.jPicker.html">jPicker</a></li><li><a href="external-jQuery.jPicker.ColorMethods.html">ColorMethods</a></li></ul><h3>Classes</h3><ul><li><a href="BottomPanel.html">BottomPanel</a></li><li><a href="Dropdown.html">Dropdown</a></li><li><a href="EditorStartup.html">EditorStartup</a></li><li><a href="ElixMenuButton.html">ElixMenuButton</a></li><li><a href="ElixNumberSpinBox.html">ElixNumberSpinBox</a></li><li><a href="ExplorerButton.html">ExplorerButton</a></li><li><a href="FlyingButton.html">FlyingButton</a></li><li><a href="LayersPanel.html">LayersPanel</a></li><li><a href="LeftPanel.html">LeftPanel</a></li><li><a href="MainMenu.html">MainMenu</a></li><li><a href="NumberSpinBox.html">NumberSpinBox</a></li><li><a href="PaintBox.html">PaintBox</a></li><li><a href="PlainNumberSpinBox.html">PlainNumberSpinBox</a></li><li><a href="Rulers.html">Rulers</a></li><li><a href="SEInput.html">SEInput</a></li><li><a href="SEPalette.html">SEPalette</a></li><li><a href="SESpinInput.html">SESpinInput</a></li><li><a href="SeCMenuDialog.html">SeCMenuDialog</a></li><li><a href="SeCMenuLayerDialog.html">SeCMenuLayerDialog</a></li><li><a href="SeColorPicker.html">SeColorPicker</a></li><li><a href="SeEditPrefsDialog.html">SeEditPrefsDialog</a></li><li><a href="SeExportDialog.html">SeExportDialog</a></li><li><a href="SeImgPropDialog.html">SeImgPropDialog</a></li><li><a href="SeList.html">SeList</a></li><li><a href="SeMenu.html">SeMenu</a></li><li><a href="SeMenuItem.html">SeMenuItem</a></li><li><a href="SePlainAlertDialog.html">SePlainAlertDialog</a></li><li><a href="SePlainBorderButton.html">SePlainBorderButton</a></li><li><a href="SePromptDialog.html">SePromptDialog</a></li><li><a href="SeStorageDialog.html">SeStorageDialog</a></li><li><a href="SeSvgSourceEditorDialog.html">SeSvgSourceEditorDialog</a></li><li><a href="SeText.html">SeText</a></li><li><a href="ToolButton.html">ToolButton</a></li><li><a href="TopPanel.html">TopPanel</a></li><li><a href="configObj.html">configObj</a></li><li><a href="external-jQuery.jGraduate.Paint.html">Paint</a></li><li><a href="external-jQuery.jPicker.Color.html">Color</a></li><li><a href="module.exports.html">exports</a></li><li><a href="module.exports_module.exports.html">exports</a></li><li><a href="module-SVGEditor-Editor.html">Editor</a></li><li><a href="module-jPicker.module.exports.html">module.exports</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-SVGEditor.Config.html">Config</a></li><li><a href="module-SVGEditor.Prefs.html">Prefs</a></li><li><a href="module-SVGthis.CustomHandler.html">CustomHandler</a></li><li><a href="module-locale.LocaleEditorInit.html">LocaleEditorInit</a></li></ul><h3>Events</h3><ul><li><a href="module-SVGEditor.html#event:event:svgEditorReadyEvent">svgEditorReadyEvent</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-CanvasAPI.html">CanvasAPI</a></li><li><a href="tutorial-Editor.html">Editor</a></li><li><a href="tutorial-EditorAPI.html">EditorAPI</a></li><li><a href="tutorial-Events.html">Events</a></li><li><a href="tutorial-FrequentlyAskedQuestions.html">Frequently Asked Questions (FAQ)</a></li></ul><h3>Global</h3><ul><li><a href="global.html#attributeChangedCallback">attributeChangedCallback</a></li><li><a href="global.html#connectedCallback">connectedCallback</a></li><li><a href="global.html#constructor">constructor</a></li><li><a href="global.html#createTemplate">createTemplate</a></li><li><a href="global.html#decrement">decrement</a></li><li><a href="global.html#expireCookie">expireCookie</a></li><li><a href="global.html#formatValueFormatthenumericvalueasastring.Thisisusedafterincrementing/decrementingthevaluetoreformatthevalueasastring.">formatValue Format the numeric value as a string. This is used after incrementing/decrementing the value to reformat the value as a string.</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#handleClick">handleClick</a></li><li><a href="global.html#handleClose">handleClose</a></li><li><a href="global.html#handleInput">handleInput</a></li><li><a href="global.html#handleKeyDown">handleKeyDown</a></li><li><a href="global.html#handleMouseDown">handleMouseDown</a></li><li><a href="global.html#handleMouseUp">handleMouseUp</a></li><li><a href="global.html#handleOptionsChange">handleOptionsChange</a></li><li><a href="global.html#handleSelect">handleSelect</a></li><li><a href="global.html#handleShow">handleShow</a></li><li><a href="global.html#increment">increment</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#inputsize">inputsize</a></li><li><a href="global.html#isNullish">isNullish</a></li><li><a href="global.html#loadloadConfig">load load Config</a></li><li><a href="global.html#loadFromURLLoadconfig/datafromURLifgiven">loadFromURL Load config/data from URL if given</a></li><li><a href="global.html#name">name</a></li><li><a href="global.html#observedAttributes">observedAttributes</a></li><li><a href="global.html#parseValue">parseValue</a></li><li><a href="global.html#pref">pref</a></li><li><a href="global.html#readySignal">readySignal</a></li><li><a href="global.html#regexEscape">regexEscape</a></li><li><a href="global.html#removeStoragePrefCookie">removeStoragePrefCookie</a></li><li><a href="global.html#replaceStoragePrompt">replaceStoragePrompt</a></li><li><a href="global.html#set">set</a></li><li><a href="global.html#setupCurConfig">setupCurConfig</a></li><li><a href="global.html#setupCurPrefs">setupCurPrefs</a></li><li><a href="global.html#src">src</a></li><li><a href="global.html#stateEffects">stateEffects</a></li><li><a href="global.html#stepDown">stepDown</a></li><li><a href="global.html#stepUp">stepUp</a></li><li><a href="global.html#triggerInputChanged">triggerInputChanged</a></li><li><a href="global.html#updateLib">updateLib</a></li><li><a href="global.html#value">value</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.5</a> on Sun Dec 07 2025 19:46:40 GMT+0100 (Central European Standard Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>