Editor Events

Where <Result Callback> is a function your app will call to provide clipboard content to the editor. Your code should call the result callback passing it one argument: a Javascript object composed as described in the setClipboardContent event.

Where <Clipboard Content Object> is a hash containing these values:

Where <View Key> indicates the context in which the user activated the Copy to Clipboard command. If the command resulted from the user selecting the Copy to Clipboard button on the Manage tab, the View Key argument will be undefined. If the command was triggered by the user selecting the Copy to Clipboard command on the Active View menu on the toolbar's View tab, the View Key argument will be key of the active view, or undefined if "Diagram" is the active view. If you use this handler, make sure to set the copyDrawingEnabled Startup option to true.

						// example assumes editor is an initialized ESDWeb object

						editor.on('getClipboardContent', myClipboard.getContent);
						editor.on('setClipboardContent', myClipboard.setContent);
						editor.on('copyDrawing', myClipboard.copyDrawing);

						...
						myClipboard.getContent = function(callback) {
							// called when user does a paste action
							var clipContent = {
								type: 'image',
								value: 'data:image/png;base64,...',
								width: 800,
								height: 600
							};
							callback(clipContent);
						};
						myClipboard.setContent = function(clipContent) {
							// This function is called when user does a cut or copy action. Add code
							// here to retain the values in the clipContent object.
						};
						myClipboard.copyDrawing = function(viewKey) {
							// This function is called when the user chooses Copy Drawing on the toolbar's Manage
							// tab or in the View Actions menu on the toolbar's View tab. Your implementation
							// should export the diagram as an image and place the resulting image into your
							// clipboard manager.
					        var options = {
					            includePrefix: true,
           						viewKey: viewKey
       						};
       						editor.exportImage(options, function(image) {
								// add code here to retain the image in your clipboard manager
       						}, function(e) {
								// log/report the export failure
							});
						};
					

						// example assumes editor is an initialized ESDWeb object

						editor.on('commandEnable', myToolbar.commandEnable);
						editor.on('commandBegin', myToolbar.commandBegin);
						editor.on('commandEnd', myToolbar.commandEnd);

						...
						myToolbar.commandEnable = function(commandInfo, enable) {
							// commandInfo will be a String or Array of Strings
							var cmdArray = Array.isArray(commandInfo) ? commandInfo : [commandInfo];

							cmdArray.forEach(function(commandName) {
								// enable/disable our zoom buttons as directed by the editor -
								// this assumes zoom buttons with IDs btnZoomIn, btnZoomOut, btnZoomToFit
								switch (cmd) {
								case 'zoomIn':		$('#btnZoomIn').disabled = !enable;		break;
								case 'zoomOut': 	$('#btnZoomOut').disabled = !enable;	break;
								case 'zoomToFit':	$('#btnZoomToFit').disabled = !enable;	break;

								// additional case statements here: for all other supported commands
								}
							});
						};

						myToolbar.commandBegin = function(commandName) {
							if ('draw_streetStraight' === commandName) {
								// while the street is being drawn show the street toolbar button pressed
								$("#streetTool").pressed=true;
							}
							// additional code here for all shapes whose draw operations are long running
						};

						myToolbar.commandEnd = function(commandName) {
							if ('draw_streetStraight' === commandName) {
								// draw operation is complete so unpress the street toolbar button
								$("#streetTool").pressed=false;
							}
							// additional code here for all shapes whose draw operations are long running
						};
					

Where <location> is a location object as described in the setLocation command.

Where <value> is the map's opacity (floating point value between 0.0 and 1.0).

Where <label> is the label of the map scheme, and <index> is the index of the newly active service into the list of map services. (see mapServicesUpdate below)

Where <mapServices> is an array of objects of this form:
{
}
Note: the last service will have label and value both set to "None", and data will be null.

Where <serviceLabel> is the name of the map service that was not found.

Where <error> is an error message returned from the map scheme, or undefined if the update was successful.

						// 1) These examples assume editor is an initialized ESDWeb object
						// 2) The templateDatabase methods below are just example stubs.
						//    You will need to replace them with something that retrieves
						//    the data from your data store of choice.

						require(["dojo/Deferred"], function(Deferred) {
						    editor.on('getTemplateGroups', function() {
        						var deferred = new Deferred(),
									result;

								// Retrieve and return the template groups.
								result = templateDatabase.getGroups();
								setTimeout(function() {
									deferred.resolve(JSON.stringify(result));
								});

								return deferred.promise;
						    });

							editor.on('findTemplates', function(groupName, searchString) {
        						var deferred = new Deferred(),
									result;

								// Retrieve and return a collection of matching templates.
								result = templateDatabase.getTemplates(groupName, searchString);
								setTimeout(function() {
									deferred.resolve(JSON.stringify(result));
								});

								return deferred.promise;
							});

							editor.on('getTemplate', function(templateID) {
        						var deferred = new Deferred(),
									result;

								// Retrieve and return the SVG for a template.
								result = templateDatabase.getTemplate(templateID);
								setTimeout(function() {
									deferred.resolve(result);
								});

								return deferred.promise;
							});
						});
					

Where:

• Exception: The exception object.
• Error Number: An optional numeric error code.
• Summary Message: A summary message. If omitted, a generic message should be used.
• Detail Message: More detailed message. If omitted, exception message should be used.
• Log Only: When true, the exception will be logged but will not be delivered to the user using the standard exception reporting mechanism. The assumption is that when this parameter is true, the user will be informed in some other way. The default is false.

Where <drop event> is a hash containing these properties:

Returns a promise that resolves to a string of symbol favorites.

Where <Favorites Definition> is an array of objects - each describing a "favorite" symbol.

Where <selectedShapeCount> is the number of shapes currently selected.

Where <Attachment ID> is the unique id of an existing image or document attachment.

Where <viewState> is the viewState object for the added view.

Where <viewState> is the viewState object for the deleted view or undefined if the diagram was erased.

Where <viewState> is the viewState object for the modified view.