@maxgraph/core
Version:
maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.
1,279 lines (1,275 loc) • 86.3 kB
JavaScript
/*
Copyright 2021-present The maxGraph project Contributors
Copyright (c) 2006-2019, JGraph Ltd
Copyright (c) 2006-2019, draw.io AG
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import EditorPopupMenu from './EditorPopupMenu.js';
import UndoManager from '../view/undoable_changes/UndoManager.js';
import EditorKeyHandler from './EditorKeyHandler.js';
import EventSource from '../view/event/EventSource.js';
import Client from '../Client.js';
import CompactTreeLayout from '../view/layout/CompactTreeLayout.js';
import { EditorToolbar } from './EditorToolbar.js';
import StackLayout from '../view/layout/StackLayout.js';
import EventObject from '../view/event/EventObject.js';
import { getOffset } from '../util/styleUtils.js';
import Codec from '../serialization/Codec.js';
import { ModelXmlSerializer } from '../serialization/ModelXmlSerializer.js';
import MaxWindow from '../gui/MaxWindow.js';
import MaxForm from '../gui/MaxForm.js';
import Outline from '../view/other/Outline.js';
import Cell from '../view/cell/Cell.js';
import Geometry from '../view/geometry/Geometry.js';
import { FONT_STYLE_MASK } from '../util/Constants.js';
import { Graph } from '../view/Graph.js';
import SwimlaneManager from '../view/layout/SwimlaneManager.js';
import LayoutManager from '../view/layout/LayoutManager.js';
import RootChange from '../view/undoable_changes/RootChange.js';
import ValueChange from '../view/undoable_changes/ValueChange.js';
import CellAttributeChange from '../view/undoable_changes/CellAttributeChange.js';
import PrintPreview from '../view/other/PrintPreview.js';
import Clipboard from '../util/Clipboard.js';
import MaxLog from '../gui/MaxLog.js';
import { isNode } from '../util/domUtils.js';
import { getViewXml, getXml } from '../util/xmlUtils.js';
import { load, post, submit } from '../util/requestUtils.js';
import RubberBandHandler from '../view/plugins/RubberBandHandler.js';
import InternalEvent from '../view/event/InternalEvent.js';
import { show } from '../util/printUtils.js';
import { cloneCell } from '../util/cellArrayUtils.js';
import { isNullish } from '../internal/utils.js';
import { isI18nEnabled, translate } from '../internal/i18n-utils.js';
import { error } from '../gui/guiUtils.js';
/**
* Extends {@link EventSource} to implement an application wrapper for a graph that
* adds {@link actions}, I/O using {@link Codec}, auto-layout using {@link LayoutManager},
* command history using {@link undoManager}, and standard dialogs and widgets, e.g.
* properties, help, outline, toolbar, and popupmenu. It also adds {@link templates}
* to be used as cells in toolbars, auto-validation using the {@link installChangeHandler}
* flag, attribute cycling using {@link cycleAttributeValues}, higher-level events
* such as {@link root}, and backend integration using <urlPost> and {@link urlImage}.
*
* ### Actions
*
* Actions are functions stored in the <actions> array under their names. The
* functions take the {@link Editor} as the first, and an optional {@link Cell} as the
* second argument and are invoked using <execute>. Any additional arguments
* passed to execute are passed on to the action as-is.
*
* A list of built-in actions is available in the <addActions> description.
*
* ### Read/write Diagrams
*
* To read a diagram from an XML string, for example from a text field within the
* page, the following code is used:
*
* ```javascript
* const doc = xmlUtils.parseXML(xmlString);
* const node = doc.documentElement;
* editor.readGraphModel(node);
* ```
*
* For reading a diagram from a remote location, use the {@link open} method.
*
* To save diagrams in XML on a server, you can set the {@link urlPost} variable.
* This variable will be used in {@link getUrlPost} to construct a URL for the post
* request that is issued in the {@link save} method. The post request contains the
* XML representation of the diagram as returned by {@link writeGraphModel} in the
* xml parameter.
*
* On the server side, the post request is processed using standard
* technologies such as Java Servlets, CGI, .NET or ASP.
*
* Here are some examples of processing a post request in various languages.
*
* - Java: URLDecoder.decode(request.getParameter("xml"), "UTF-8").replace("
", "
")
*
* Note that the linefeed should only be replaced if the XML is
* processed in Java, for example when creating an image, but not
* if the XML is passed back to the client-side.
*
* - .NET: HttpUtility.UrlDecode(context.Request.Params["xml"])
* - PHP: urldecode($_POST["xml"])
*
* ### Creating images
*
* A backend (Java, PHP or C#) is required for creating images. The
* distribution contains an example for each backend (ImageHandler.java,
* ImageHandler.cs and graph.php). More information about using a backend
* to create images can be found in the readme.html files. Note that the
* preview is implemented using VML/SVG in the browser and does not require
* a backend. The backend is only required to creates images (bitmaps).
*
* ### Special characters
*
* Note There are five characters that should always appear in XML content as
* escapes, so that they do not interact with the syntax of the markup. These
* are part of the language for all documents based on XML and for HTML.
*
* - < (<)
* - > (>)
* - & (&)
* - " (")
* - ' (')
*
* Although it is part of the XML language, ' is not defined in HTML.
* For this reason the XHTML specification recommends instead the use of
* ' if text may be passed to an HTML user agent.
*
* If you are having problems with special characters on the server-side then
* you may want to try the {@link escapePostData} flag.
*
* For converting decimal escape sequences inside strings, a user has provided us with the following function:
*
* ```javascript
* function html2js(text) {
* const entitySearch = /&#[0-9]+;/;
* let entity;
*
* while (entity = entitySearch.exec(text)) {
* const charCode = entity[0].substring(2, entity[0].length -1);
* text = text.substring(0, entity.index)
* + String.fromCharCode(charCode)
* + text.substring(entity.index + entity[0].length);
* }
*
* return text;
* }
* ```
*
* Otherwise, try using hex escape sequences and the built-in unescape function for converting such strings.
*
* ### Local Files
*
* For saving and opening local files, no standardized method exists that
* works across all browsers. The recommended way of dealing with local files
* is to create a backend that streams the XML data back to the browser (echo)
* as an attachment so that a Save-dialog is displayed on the client-side and
* the file can be saved to the local disk.
*
* For example, in PHP the code that does this looks as follows.
*
* ```javascript
* $xml = stripslashes($_POST["xml"]);
* header("Content-Disposition: attachment; filename=\"diagram.xml\"");
* echo($xml);
* ```
*
* To open a local file, the file should be uploaded via a form in the browser
* and then opened from the server in the editor.
*
* ### Cell Properties
*
* The properties displayed in the properties dialog are the attributes and
* values of the cell's user object, which is an XML node. The XML node is
* defined in the templates section of the config file.
*
* The templates are stored in {@link Editor.templates} and contain cells which
* are cloned at insertion time to create new vertices by use of drag and
* drop from the toolbar. Each entry in the toolbar for adding a new vertex
* must refer to an existing template.
*
* In the following example, the task node is a business object and only the
* Cell node and its Geometry child contain graph information:
*
* ```javascript
* <Task label="Task" description="">
* <Cell vertex="true">
* <Geometry as="geometry" width="72" height="32"/>
* </Cell>
* </Task>
* ```
*
* The idea is that the XML representation is inverse from the in-memory
* representation: The outer XML node is the user object and the inner node is
* the cell. This means the user object of the cell is the Task node with no
* children for the above example:
*
* ```javascript
* <Task label="Task" description=""/>
* ```
*
* The Task node can have any tag name, attributes and child nodes. The
* {@link Codec} will use the XML hierarchy as the user object, while removing the
* "known annotations", such as the Cell node. At save-time the cell data
* will be "merged" back into the user object. The user object is only modified
* via the properties dialog during the lifecycle of the cell.
*
* In the default implementation of {@link createProperties}, the user object's
* attributes are put into a form for editing. Attributes are changed using
* the {@link CellAttributeChange} action in the model. The dialog can be replaced
* by overriding the {@link createProperties} hook or by replacing the showProperties
* action in {@link action}. Alternatively, the entry in the config file's popupmenu
* section can be modified to invoke a different action.
*
* If you want to display the properties dialog on a double click, you can set
* {@link Editor.dblClickAction} to showProperties as follows:
*
* ```javascript
* editor.dblClickAction = 'showProperties';
* ```
*
* ### Popupmenu and Toolbar
*
* The toolbar and popupmenu are typically configured using the respective
* sections in the config file, that is, the popupmenu is defined as follows:
*
* ```javascript
* <Editor>
* <EditorPopupMenu as="popupHandler">
* <add as="cut" action="cut" icon="images/cut.gif"/>
* ...
* ```
*
* New entries can be added to the toolbar by inserting an add-node into the
* above configuration. Existing entries may be removed and changed by
* modifying or removing the respective entries in the configuration.
* The configuration is read by the {@link EditorPopupMenuCodec}, the format of the
* configuration is explained in {@link EditorPopupMenu.decode}.
*
* The toolbar is defined in the EditorToolbar section. Items can be added
* and removed in this section.
*
* ```javascript
* <Editor>
* <EditorToolbar>
* <add as="save" action="save" icon="images/save.gif"/>
* <add as="Swimlane" template="swimlane" icon="images/swimlane.gif"/>
* ...
* ```
*
* The format of the configuration is described in {@link EditorToolbarCodec.decode}.
*
* Ids:
*
* For the IDs, there is an implicit behaviour in {@link Codec}: It moves the Id
* from the cell to the user object at encoding time and vice versa at decoding
* time. For example, if the Task node from above has an id attribute, then
* the {@link Cell.id} of the corresponding cell will have this value. If there
* is no Id collision in the model, then the cell may be retrieved using this
* Id with the {@link GraphDataModel.getCell} function. If there is a collision, a new
* Id will be created for the cell using {@link GraphDataModel.createId}. At encoding
* time, this new Id will replace the value previously stored under the id
* attribute in the Task node.
*
* See {@link EditorCodec}, {@link EditorToolbarCodec} and {@link EditorPopupMenuCodec}
* for information about configuring the editor and user interface.
*
* ### Programmatically inserting cells
*
* For inserting a new cell, say, by clicking a button in the document,
* the following code can be used. This requires an reference to the editor.
*
* ```javascript
* const userObject = new Object();
* const model = editor.graph.model;
* model.beginUpdate();
* try {
* editor.graph.insertVertex({value: userObject, position: [20, 20], size: [80, 30]});
* } finally
* model.endUpdate();
* }
* ```
*
* If a template cell from the config file should be inserted, then a clone
* of the template can be created as follows. The clone is then inserted using
* the add function instead of addVertex.
*
* ```javascript
* const template = editor.templates['task'];
* cont clone = cloneCell(template);
* ```
*
* ### Translations
*
* resources/editor - Language resources for Editor
*
* To load the resources for the Editor, the following code should be used:
* ```javascript
* // Load maxGraph builtin resources
* Translations.loadResources();
* // Load resources for the Editor
* Translations.add(`${Client.basePath}/resources/editor`);
* ```
*
* ### Callback: onInit
*
* Called from within the constructor. In the callback, "this" refers to the editor instance.
*
* ### Cookie: mxgraph=seen
*
* Set when the editor is started. Never expires. Use
* {@link resetFirstTime} to reset this cookie. This cookie
* only exists if {@link onInit} is implemented.
*
* ### Events
*
* #### Event: mxEvent.OPEN
*
* Fires after a file was opened in {@link open}. The <code>filename</code> property
* contains the filename that was used. The same value is also available in
* {@link filename}.
*
* #### Event: mxEvent.SAVE
*
* Fires after the current file was saved in {@link save}. The <code>url</code>
* property contains the URL that was used for saving.
*
* #### Event: mxEvent.POST
*
* Fires if a successful response was received in {@link postDiagram}. The
* <code>request</code> property contains the <MaxXmlRequest>, the
* <code>url</code> and <code>data</code> properties contain the URL and the
* data that were used in the post request.
*
* #### Event: mxEvent.ROOT
*
* Fires when the current root has changed, or when the title of the current
* root has changed. This event has no properties.
*
* #### Event: mxEvent.BEFORE_ADD_VERTEX
*
* Fires before a vertex is added in {@link addVertex}. The <code>vertex</code>
* property contains the new vertex and the <code>parent</code> property
* contains its parent.
*
* #### Event: mxEvent.ADD_VERTEX
*
* Fires between begin- and endUpdate in <addVertex>. The <code>vertex</code>
* property contains the vertex that is being inserted.
*
* #### Event: mxEvent.AFTER_ADD_VERTEX
*
* Fires after a vertex was inserted and selected in <addVertex>. The
* <code>vertex</code> property contains the new vertex.
*
* **Example**
*
* For starting an in-place edit after a new vertex has been added to the
* graph, the following code can be used.
*
* ```javascript
* editor.addListener(mxEvent.AFTER_ADD_VERTEX, function(sender, evt) {
* const vertex = evt.getProperty('vertex');
* if (editor.graph.isCellEditable(vertex)) {
* editor.graph.startEditingAtCell(vertex);
* }
* });
* ```
*
* #### Event: mxEvent.ESCAPE
*
* Fires when the escape key is pressed. The <code>event</code> property
* contains the key event.
*
* @category Editor
*/
export class Editor extends EventSource {
/**
* Constructs a new editor. This function invokes the {@link onInit} callback upon completion.
*
* ```javascript
* const config = load('config/diagram-editor.xml').getDocumentElement();
* const editor = new Editor(config);
* ```
*
* @param config The configuration element that contains the editor configuration.
*/
constructor(config) {
super();
this.onInit = null;
this.lastSnapshot = null;
this.ignoredChanges = null;
this.rubberband = null;
this.isActive = null;
this.destroyed = false;
/**
* Specifies the resource key for the zoom dialog. If the resource for this
* key does not exist then the value is used as the error message. Default is 'askZoom'.
* @default 'askZoom'
*/
this.askZoomResource = isI18nEnabled() ? 'askZoom' : '';
// =====================================================================================
// Group: Controls and Handlers
// =====================================================================================
/**
* Specifies the resource key for the last saved info. If the resource for
* this key does not exist then the value is used as the error message. Default is 'lastSaved'.
* @default 'lastSaved'.
*/
this.lastSavedResource = isI18nEnabled() ? 'lastSaved' : '';
/**
* Specifies the resource key for the current file info. If the resource for
* this key does not exist then the value is used as the error message. Default is 'currentFile'.
* @default 'currentFile'
*/
this.currentFileResource = isI18nEnabled() ? 'currentFile' : '';
/**
* Specifies the resource key for the properties window title. If the
* resource for this key does not exist then the value is used as the
* error message. Default is 'properties'.
* @default 'properties'
*/
this.propertiesResource = isI18nEnabled() ? 'properties' : '';
/**
* Specifies the resource key for the tasks window title. If the
* resource for this key does not exist then the value is used as the
* error message. Default is 'tasks'.
* @default 'tasks'
*/
this.tasksResource = isI18nEnabled() ? 'tasks' : '';
/**
* Specifies the resource key for the help window title. If the
* resource for this key does not exist then the value is used as the
* error message. Default is 'help'.
* @default 'help'
*/
this.helpResource = isI18nEnabled() ? 'help' : '';
/**
* Specifies the resource key for the outline window title. If the
* resource for this key does not exist then the value is used as the
* error message. Default is 'outline'.
* @default 'outline'
*/
this.outlineResource = isI18nEnabled() ? 'outline' : '';
/**
* Reference to the {@link MaxWindow} that contains the outline.
* The {@link outline} is stored in outline.outline.
*/
// TODO should be CustomMaxWindow | null, CustomMaxWindow having a outline property
this.outline = null;
/**
* Holds the render hint used for creating the {@link graph} in {@link setGraphContainer}.
* @default null
*/
this.graphRenderHint = null;
/**
* Holds a {@link EditorToolbar} for displaying the toolbar.
* The toolbar is created in {@link setToolbarContainer}.
*/
this.toolbar = null;
/**
* DOM container that holds the statusbar.
* Use {@link setStatusContainer} to set this value.
*/
this.status = null;
/**
* Holds a {@link EditorPopupMenu} for displaying popupmenus.
*/
this.popupHandler = null;
/**
* Holds an {@link UndoManager} for the command history.
*/
this.undoManager = null;
/**
* Holds a {@link EditorKeyHandler} for handling keyboard events.
* The handler is created in {@link setGraphContainer}.
*/
this.keyHandler = null;
/**
* Maps from actionnames to actions, which are functions taking
* the editor and the cell as arguments. Use {@link addAction}
* to add or replace an action and {@link execute} to execute an action
* by name, passing the cell to be operated upon as the second
* argument.
*/
this.actions = {};
// =====================================================================================
// Group: Actions and Options
// =====================================================================================
/**
* Specifies the name of the action to be executed
* when a cell is double-clicked. Default is 'edit'.
*
* To handle a single-click, use the following code.
*
* @example
* ```javascript
* editor.graph.addListener(mxEvent.CLICK, function(sender, evt) {
* const e = evt.getProperty('event');
* const cell = evt.getProperty('cell');
*
* if (cell && !e.isConsumed()) {
* // Do something useful with cell...
* e.consume();
* }
* });
* ```
* @default 'edit'
*/
this.dblClickAction = 'edit';
/**
* Specifies if new cells must be inserted
* into an existing swimlane. Otherwise, cells
* that are not swimlanes can be inserted as
* top-level cells.
* @default false
*/
this.swimlaneRequired = false;
/**
* Specifies if the context menu should be disabled in the graph container.
* @default true
*/
this.disableContextMenu = true;
/**
* Specifies the function to be used for inserting new
* cells into the graph. This is assigned from the
* {@link EditorToolbar} if a vertex-tool is clicked.
*/
this.insertFunction = null;
// =====================================================================================
// Group: Templates
// =====================================================================================
/**
* Specifies if a new cell should be inserted on a single
* click even using {@link insertFunction} if there is a cell
* under the mouse pointer, otherwise the cell under the
* mouse pointer is selected. Default is false.
* @default false
*/
this.forcedInserting = false;
/**
* Maps from names to prototype cells to be used
* in the toolbar for inserting new cells into
* the diagram.
*/
this.templates = null;
/**
* Prototype edge cell that is used for creating new edges.
*/
this.defaultEdge = null;
/**
* Specifies the edge style to be returned in {@link getEdgeStyle}.
* @default null
*/
this.defaultEdgeStyle = null;
/**
* Prototype group cell that is used for creating new groups.
*/
this.defaultGroup = null;
/**
* Default size for the border of new groups. If `null`, then {@link AbstractGraph.gridSize} is used.
* @default null
*/
this.groupBorderSize = null;
/**
* Contains the URL of the last opened file as a string.
* @default null
*/
this.filename = null;
// =====================================================================================
// Group: Backend Integration
// =====================================================================================
/**
* Character to be used for encoding linefeed in {@link save}.
* @default '
'
*/
this.linefeed = '
';
/**
* Specifies if the name of the post parameter that contains the diagram data in a post request to the server.
* @default 'xml'
*/
this.postParameterName = 'xml';
/**
* Specifies if the data in the post request for saving a diagram should be converted using encodeURIComponent.
* @default true
*/
this.escapePostData = true;
/**
* Specifies the URL to be used for posting the diagram to a backend in {@link save}.
* @default null
*/
this.urlPost = null;
/**
* Specifies the URL to be used for creating a bitmap of the graph in the image action.
* @default null
*/
this.urlImage = null;
/**
* Specifies the direction of the flow in the diagram.
* This is used in the layout algorithms. Default is vertical flow.
* @default false
*/
this.horizontalFlow = false;
// =====================================================================================
// Group: Autolayout
// =====================================================================================
/**
* Specifies if the top-level elements in the
* diagram should be layed out using a vertical
* or horizontal stack depending on the setting
* of {@link horizontalFlow}. The spacing between the
* swimlanes is specified by {@link swimlaneSpacing}.
* Default is false.
*
* If the top-level elements are swimlanes, then
* the intra-swimlane layout is activated by
* the {@link layoutSwimlanes} switch.
* @default false
*/
this.layoutDiagram = false;
/**
* Specifies the spacing between swimlanes if
* automatic layout is turned on in
* {@link layoutDiagram}. Default is 0.
* @default 0
*/
this.swimlaneSpacing = 0;
/**
* Specifies if the swimlanes should be kept at the same
* width or height depending on the setting of
* {@link horizontalFlow}. Default is false.
*
* For horizontal flows, all swimlanes
* have the same height and for vertical flows, all swimlanes
* have the same width. Furthermore, the swimlanes are
* automatically "stacked" if {@link layoutDiagram} is true.
* @default false
*/
this.maintainSwimlanes = false;
/**
* Specifies if the children of swimlanes should be layed out, either vertically or horizontally depending on {@link horizontalFlow}.
* @default false
*/
this.layoutSwimlanes = false;
/**
* Specifies the attribute values to be cycled when inserting new swimlanes.
* @default []
*/
this.cycleAttributeValues = [];
// =====================================================================================
// Group: Attribute Cycling
// =====================================================================================
/**
* Index of the last consumed attribute index.
* If a new swimlane is inserted, then the {@link cycleAttributeValues} at this index will be used as the value for {@link cycleAttributeName}.
* @default 0
*/
this.cycleAttributeIndex = 0;
/**
* Name of the attribute to be assigned a {@link cycleAttributeValues} when inserting new swimlanes.
* @default 'fillColor'
*/
this.cycleAttributeName = 'fillColor';
/**
* Holds the {@link MaxWindow} created in {@link showTasks}.
*/
this.tasks = null;
// =====================================================================================
// Group: Windows
// =====================================================================================
/**
* Icon for the tasks window.
*/
this.tasksWindowImage = null;
/**
* Specifies the top coordinate of the tasks window in pixels. Default is 20.
* @default 20
*/
this.tasksTop = 20;
/**
* Holds the {@link MaxWindow} created in {@link showHelp}
*/
this.help = null;
/**
* Icon for the help window.
*/
this.helpWindowImage = null;
/**
* Specifies the URL to be used for the contents of the
* Online Help window. This is usually specified in the
* resources file under urlHelp for language-specific
* online help support.
*/
this.urlHelp = null;
/**
* Specifies the width of the help window in pixels. Default is 300.
* @default 300
*/
this.helpWidth = 300;
/**
* Specifies the height of the help window in pixels. Default is 260.
* @default 260
*/
// helpHeight: number;
this.helpHeight = 260;
/**
* Specifies the width of the properties window in pixels. Default is 240.
* @default 240
*/
this.propertiesWidth = 240;
/**
* Specifies the height of the properties window in pixels.
* If no height is specified then the window will be automatically
* sized to fit its contents. Default is null.
* @default null
*/
this.propertiesHeight = null;
/**
* Specifies if the properties dialog should be automatically
* moved near the cell it is displayed for, otherwise the
* dialog is not moved. This value is only taken into
* account if the dialog is already visible. Default is false.
* @default false
*/
this.movePropertiesDialog = false;
/**
* Specifies if {@link AbstractGraph.validateGraph} should automatically be invoked after
* each change. Default is false.
* @default false
*/
this.validating = false;
/**
* True if the graph has been modified since it was last saved.
*/
this.modified = false;
this.actions = {};
this.addActions();
// Executes the following only if a document has been instantiated.
// That is, don't execute when the {@link EditorCodec} is set up.
if (document.body) {
// Defines instance fields
this.cycleAttributeValues = [];
this.popupHandler = new EditorPopupMenu();
this.undoManager = new UndoManager();
// Creates the graph and toolbar without the containers
this.graph = this.createGraph();
this.toolbar = this.createToolbar();
// Creates the global key handler (requires graph instance)
this.keyHandler = new EditorKeyHandler(this);
// Configures the editor using the URI
// which was passed to the ctor
this.configure(config);
// Assigns the swimlaneIndicatorColorAttribute on the graph
this.graph.swimlaneIndicatorColorAttribute = this.cycleAttributeName;
// Invokes the 'onInit' hook
this.onInit?.();
}
}
/**
* Returns {@link modified}.
*/
isModified() {
return this.modified;
}
/**
* Sets {@link modified} to the specified boolean value.
* @param value
*/
setModified(value) {
this.modified = value;
}
/**
* Adds the built-in actions to the editor instance.
* save - Saves the graph using <urlPost>.
* print - Shows the graph in a new print preview window.
* show - Shows the graph in a new window.
* exportImage - Shows the graph as a bitmap image using <getUrlImage>.
* refresh - Refreshes the graph's display.
* cut - Copies the current selection into the clipboard
* and removes it from the graph.
* copy - Copies the current selection into the clipboard.
* paste - Pastes the clipboard into the graph.
* delete - Removes the current selection from the graph.
* group - Puts the current selection into a new group.
* ungroup - Removes the selected groups and selects the children.
* undo - Undoes the last change on the graph model.
* redo - Redoes the last change on the graph model.
* zoom - Sets the zoom via a dialog.
* zoomIn - Zooms into the graph.
* zoomOut - Zooms out of the graph
* actualSize - Resets the scale and translation on the graph.
* fit - Changes the scale so that the graph fits into the window.
* showProperties - Shows the properties dialog.
* selectAll - Selects all cells.
* selectNone - Clears the selection.
* selectVertices - Selects all vertices.
* selectEdges = Selects all edges.
* edit - Starts editing the current selection cell.
* enterGroup - Drills down into the current selection cell.
* exitGroup - Moves up in the drilling hierachy
* home - Moves to the topmost parent in the drilling hierarchy
* selectPrevious - Selects the previous cell.
* selectNext - Selects the next cell.
* selectParent - Selects the parent of the selection cell.
* selectChild - Selects the first child of the selection cell.
* collapse - Collapses the currently selected cells.
* expand - Expands the currently selected cells.
* bold - Toggle bold text style.
* italic - Toggle italic text style.
* underline - Toggle underline text style.
* alignCellsLeft - Aligns the selection cells at the left.
* alignCellsCenter - Aligns the selection cells in the center.
* alignCellsRight - Aligns the selection cells at the right.
* alignCellsTop - Aligns the selection cells at the top.
* alignCellsMiddle - Aligns the selection cells in the middle.
* alignCellsBottom - Aligns the selection cells at the bottom.
* alignFontLeft - Sets the horizontal text alignment to left.
* alignFontCenter - Sets the horizontal text alignment to center.
* alignFontRight - Sets the horizontal text alignment to right.
* alignFontTop - Sets the vertical text alignment to top.
* alignFontMiddle - Sets the vertical text alignment to middle.
* alignFontBottom - Sets the vertical text alignment to bottom.
* toggleTasks - Shows or hides the tasks window.
* toggleHelp - Shows or hides the help window.
* toggleOutline - Shows or hides the outline window.
* toggleConsole - Shows or hides the console window.
*/
addActions() {
this.addAction('save', (editor) => {
editor.save();
});
this.addAction('print', (editor) => {
const preview = new PrintPreview(editor.graph, 1);
preview.open();
});
this.addAction('show', (editor) => {
show(editor.graph, null, 10, 10);
});
this.addAction('exportImage', (editor) => {
const url = editor.getUrlImage();
if (url == null || Client.IS_LOCAL) {
editor.execute('show');
}
else {
const node = getViewXml(editor.graph, 1);
const xml = getXml(node, '\n');
submit(url, `${editor.postParameterName}=${encodeURIComponent(xml)}`, document, '_blank');
}
});
this.addAction('refresh', (editor) => {
editor.graph.refresh();
});
this.addAction('cut', (editor) => {
if (editor.graph.isEnabled()) {
Clipboard.cut(editor.graph);
}
});
this.addAction('copy', (editor) => {
if (editor.graph.isEnabled()) {
Clipboard.copy(editor.graph);
}
});
this.addAction('paste', (editor) => {
if (editor.graph.isEnabled()) {
Clipboard.paste(editor.graph);
}
});
this.addAction('delete', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.removeCells();
}
});
this.addAction('group', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setSelectionCell(editor.groupCells());
}
});
this.addAction('ungroup', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setSelectionCells(editor.graph.ungroupCells());
}
});
this.addAction('removeFromParent', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.removeCellsFromParent();
}
});
this.addAction('undo', (editor) => {
if (editor.graph.isEnabled()) {
editor.undo();
}
});
this.addAction('redo', (editor) => {
if (editor.graph.isEnabled()) {
editor.redo();
}
});
this.addAction('zoomIn', (editor) => {
editor.graph.zoomIn();
});
this.addAction('zoomOut', (editor) => {
editor.graph.zoomOut();
});
this.addAction('actualSize', (editor) => {
editor.graph.zoomActual();
});
this.addAction('fit', (editor) => {
editor.graph.getPlugin('fit')?.fit();
});
this.addAction('showProperties', (editor, cell) => {
editor.showProperties(cell);
});
this.addAction('selectAll', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectAll();
}
});
this.addAction('selectNone', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.clearSelection();
}
});
this.addAction('selectVertices', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectVertices();
}
});
this.addAction('selectEdges', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectEdges();
}
});
this.addAction('edit', (editor, cell) => {
if (editor.graph.isEnabled() && editor.graph.isCellEditable(cell)) {
editor.graph.startEditingAtCell(cell);
}
});
this.addAction('toBack', (editor, cell) => {
if (editor.graph.isEnabled()) {
editor.graph.orderCells(true);
}
});
this.addAction('toFront', (editor, cell) => {
if (editor.graph.isEnabled()) {
editor.graph.orderCells(false);
}
});
this.addAction('enterGroup', (editor, cell) => {
editor.graph.enterGroup(cell);
});
this.addAction('exitGroup', (editor) => {
editor.graph.exitGroup();
});
this.addAction('home', (editor) => {
editor.graph.home();
});
this.addAction('selectPrevious', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectPreviousCell();
}
});
this.addAction('selectNext', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectNextCell();
}
});
this.addAction('selectParent', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectParentCell();
}
});
this.addAction('selectChild', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.selectChildCell();
}
});
this.addAction('collapse', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.foldCells(true);
}
});
this.addAction('collapseAll', (editor) => {
if (editor.graph.isEnabled()) {
const cells = editor.graph.getChildVertices();
editor.graph.foldCells(true, false, cells);
}
});
this.addAction('expand', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.foldCells(false);
}
});
this.addAction('expandAll', (editor) => {
if (editor.graph.isEnabled()) {
const cells = editor.graph.getChildVertices();
editor.graph.foldCells(false, false, cells);
}
});
this.addAction('bold', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.toggleCellStyleFlags('fontStyle', FONT_STYLE_MASK.BOLD);
}
});
this.addAction('italic', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.toggleCellStyleFlags('fontStyle', FONT_STYLE_MASK.ITALIC);
}
});
this.addAction('underline', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.toggleCellStyleFlags('fontStyle', FONT_STYLE_MASK.UNDERLINE);
}
});
this.addAction('alignCellsLeft', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.alignCells('left');
}
});
this.addAction('alignCellsCenter', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.alignCells('center');
}
});
this.addAction('alignCellsRight', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.alignCells('right');
}
});
this.addAction('alignCellsTop', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.alignCells('top');
}
});
this.addAction('alignCellsMiddle', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.alignCells('middle');
}
});
this.addAction('alignCellsBottom', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.alignCells('bottom');
}
});
this.addAction('alignFontLeft', (editor) => {
editor.graph.setCellStyles('align', 'left');
});
this.addAction('alignFontCenter', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setCellStyles('align', 'center');
}
});
this.addAction('alignFontRight', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setCellStyles('align', 'right');
}
});
this.addAction('alignFontTop', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setCellStyles('verticalAlign', 'top');
}
});
this.addAction('alignFontMiddle', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setCellStyles('verticalAlign', 'middle');
}
});
this.addAction('alignFontBottom', (editor) => {
if (editor.graph.isEnabled()) {
editor.graph.setCellStyles('verticalAlign', 'bottom');
}
});
this.addAction('zoom', (editor) => {
const current = editor.graph.getView().scale * 100;
const preInput = prompt(translate(editor.askZoomResource) || editor.askZoomResource, String(current));
if (preInput) {
const scale = parseFloat(preInput) / 100;
if (!isNaN(scale)) {
editor.graph.getView().setScale(scale);
}
}
});
this.addAction('toggleTasks', (editor) => {
if (!isNullish(editor.tasks)) {
editor.tasks.setVisible(!editor.tasks.isVisible());
}
else {
editor.showTasks();
}
});
this.addAction('toggleHelp', (editor) => {
if (!isNullish(editor.help)) {
editor.help.setVisible(!editor.help.isVisible());
}
else {
editor.showHelp();
}
});
this.addAction('toggleOutline', (editor) => {
if (isNullish(editor.outline)) {
editor.showOutline();
}
else {
editor.outline.setVisible(!editor.outline.isVisible());
}
});
this.addAction('toggleConsole', (editor) => {
MaxLog.setVisible(!MaxLog.isVisible());
});
}
/**
* Configures the editor using the specified node. To load the
* configuration from a given URL the following code can be used to obtain
* the XML node.
*
* @example
* ```javascript
* var node = mxUtils.load(url).getDocumentElement();
* ```
* @param node XML node that contains the configuration.
*/
configure(node) {
if (node) {
// Creates a decoder for the XML data
// and uses it to configure the editor
const dec = new Codec(node.ownerDocument);
dec.decode(node, this);
// Resets the counters, modified state and
// command history
this.resetHistory();
}
}
/**
* Resets the cookie that is used to remember if the editor has already been used.
*/
resetFirstTime() {
document.cookie = 'mxgraph=seen; expires=Fri, 27 Jul 2001 02:47:11 UTC; path=/';
}
/**
* Resets the command history, modified state and counters.
*/
resetHistory() {
this.lastSnapshot = new Date().getTime();
this.undoManager.clear();
this.ignoredChanges = 0;
this.setModified(false);
}
/**
* Binds the specified actionname to the specified function.
*
* @example
* ```javascript
* editor.addAction('test', function(editor: Editor, cell: Cell)
* {
* mxUtils.alert("test "+cell);
* });
* ```
* @param actionname String that specifies the name of the action to be added.
* @param funct Function that implements the new action. The first argument
* of the function is the editor it is used with,
* the second argument is the cell it operates upon.
*/
addAction(actionname, funct) {
this.actions[actionname] = funct;
}
/**
* Executes the function with the given name in {@link actions} passing the
* editor instance and given cell as the first and second argument. All
* additional arguments are passed to the action as well. This method
* contains a try-catch block and displays an error message if an action
* causes an exception. The exception is re-thrown after the error
* message was displayed.
*
* @example
* ```javascript
* editor.execute("showProperties", cell);
* ```
* @param actionname
* @param cell
* @param evt
*/
execute(actionname, cell = null, evt = null) {
const action = this.actions[actionname];
if (action) {
try {
// Creates the array of arguments by replacing the actionname
// with the editor instance in the args of this function
const args = [this, cell, evt];
// Invokes the function on the editor using the args
action.apply(this, args);
}
catch (e) {
error(`Cannot execute ${actionname}: ${e.message}`, 280, true);
throw e;
}
}
else {
error(`Cannot find action ${actionname}`, 280, true);
}
}
/**
* Adds the specified template under the given name in {@link templates}.
* @param name
* @param template
*/
addTemplate(name, template) {
this.templates[name] = template;
}
/**
* Returns the template for the given name.
* @param name
*/
getTemplate(name) {
return this.templates[name];
}
/**
* Creates the {@link AbstractGraph} for the editor.
*
* The AbstractGraph is created with no container and is initialized from {@link setGraphContainer}.
*
* @returns the AbstractGraph instance used by the Editor
*/
createGraph() {
const graph = new Graph();
// Enables rubberband, tooltips, panning
graph.setTooltips(true);
graph.setPanning(true);
// Overrides the dblclick method on the graph to
// invoke the dblClickAction for a cell and reset
// the selection tool in the toolbar
this.installDblClickHandler(graph);
// Installs the command history
this.installUndoHandler(graph);
// Installs the handlers for the root event
this.installDrillHandler(graph);
// Installs the handler for validation
this.installChangeHandler(graph);
// Installs the handler for calling the
// insert function and consume the
// event if an insert function is defined
this.installInsertHandler(graph);
// Redirects the function for creating the popupmenu items
const popupMenuHandler = graph.getPlugin('PopupMenuHandler');
if (popupMenuHandler) {
popupMenuHandler.factoryMethod = (menu, cell, evt) => {
return this.createPopupMenu(menu, cell, evt);
};
}
// Redirects the function for creating new connections in the diagram
const connectionHandler = graph.getPlugin('ConnectionHandler');
if (connectionHandler) {
connectionHandler.factoryMethod = (source, target) => {
return this.createEdge(source, target);
};
}
// Maintains swimlanes and installs auto-layout
this.createSwimlaneManager(graph);
this.createLayoutManager(graph);
return graph;
}
/**
* Sets the graph's container using {@link AbstractGraph.init}.
* @param graph
* @returns SwimlaneManager instance
*/
createSwimlaneManager(graph) {
const swimlaneMgr = new SwimlaneManager(graph, false);
swimlaneMgr.isHorizontal = () => {
return this.horizontalFlow;
};
swimlaneMgr.isEnabled = () => {
return this.maintainSwimlanes;
};
return swimlaneMgr;
}
/**