Defines the image used for error dialogs.
Specifies the resource key for the title of the error window. If the resource for this key does not exist then the value is used as the title. Default is 'error'.
Replaces characters (less than, greater than, newlines and quotes) with their HTML entities in the given string and returns the result.
String that contains the characters to be converted.
If newlines should be replaced. Default is true.
Adds the specified stylename to the given style if it does not already contain the stylename.
Adds a transparent background to the filter of the given node. This background can be used in IE8 standards mode (native IE8 only) to pass events through the node.
Displays the given alert in a new dialog. This implementation uses the built-in alert function. This is used to display validation errors when connections cannot be changed or created.
The message to be displayed.
See mxEffects.animateChanges. This is for backwards compatibility and will be removed later.
Converts the given arc to a series of curves.
Returns a wrapper function that locks the execution scope of the given function to the specified scope. Inside funct, the “this” keyword becomes a reference to that scope.
Appends a linebreak to the given parent and returns the linebreak.
DOM node to append the linebreak to.
Returns a new button with the given level and function as an onclick event handler.
String that represents the label of the button.
Function to be called if the button is pressed.
See mxEffects.cascadeOpacity. This is for backwards compatibility and will be removed later.
Clears the current selection in the page.
Recursively clones the specified object ignoring all field names in the given array of transient fields. mxObjectIdentity.FIELD_NAME is always ignored by this function.
Object to be cloned.
Displays the given message in a confirm dialog. This implementation uses the built-in confirm function.
String specifying the message to be displayed.
Returns true if the specified point (x, y) is contained in the given rectangle.
mxRectangle that represents the area
X-coordinate of the point.
Y-coordinate of the point.
Converts the specified point (x, y) using the offset of the specified container and returns a new mxPoint with the result.
DOM node to use for the offset.
X-coordinate of the point to be converted.
Y-coordinate of the point to be converted.
Creates and returns an image (IMG node) or VML image (v:image) in IE6 in quirks mode.
URL that points to the image to be displayed.
Returns a new, empty Microsoft.XMLDOM document using ActiveXObject.
Returns a new, empty XML document.
Returns true if all properties of the given objects are equal. Values with NaN are equal to NaN and unequal to any other value.
First object to be compared.
Second object to be compared.
Displays the given error message in a new
The message to be displayed.
The width of the window.
Evaluates the given expression using eval and returns the JavaScript object that represents the expression result. Supports evaluation of expressions that define functions and returns the function object for these expressions.
A string that represents a JavaScript expression.
Assigns a copy of the superclass prototype to the subclass prototype. Note that this does not call the constructor of the superclass at this point, the superclass constructor should be called explicitely in the subclass constructor.
Constructor of the subclass.
Constructor of the superclass.
Returns the text content of the specified node.
DOM nodes to return the text for.
See mxEffects.fadeOut. This is for backwards compatibility and will be removed later.
Finds the index of the nearest segment on the given cell state for the specified coordinate pair.
Returns the first node where attr equals value. This implementation does not use XPath.
Makes sure the given node is inside the visible area of the window. This is done by setting the left and top in the style.
Calls the given function for each element of the given array and returns the array.
Array that contains the elements.
Function to be called for each object.
Loads the specified URL asynchronously and invokes the given functions depending on the request status. Returns the mxXmlRequest in use. Both functions take the mxXmlRequest as the only parameter. See mxUtils.load for a synchronous implementation.
Returns an mxPoint that represents the horizontal and vertical alignment for numeric computations. X is -0.5 for center, -1 for right and 0 for left alignment. Y is -0.5 for middle, -1 for bottom and 0 for top alignment. Default values for missing arguments is top, left.
Loads the URLs in the given array asynchronously and invokes the given function if all requests returned with a valid 2xx status. The error handler is invoked once on the first error or invalid response.
Returns the bounding box for the rotated rectangle.
mxRectangle to be rotated.
Returns an array of child nodes that are of the given node type.
Parent DOM node to return the children from.
Returns the color value for the given key in the given associative array or the given default value if the value is null. If the value is mxConstants.NONE then null is returned.
Associative array that contains the value for the key whose value should be returned.
Key whose value should be returned.
Value to be returned if the value for the given key is null. Default is null.
Returns the current style of the specified element.
Adds the given margins to the given rectangle and rotates and flips the rectangle according to the respective styles in style.
Returns the scroll origin of the given document or the current document if no document is given.
Returns the client size for the current document as an mxRectangle.
Returns the name for the given function.
JavaScript object that represents a function.
Returns the inner HTML for the given node as a string or an empty string if no node was specified. The inner HTML is the text representing all children of the node, but not the node itself.
Returns the numeric value for the given key in the given associative array or the given default value (or 0) if the value is null. The value is converted to a numeric value using the Number function.
Associative array that contains the value for the key.
Key whose value should be returned.
Returns the offset for the specified container as an mxPoint. The offset is the distance from the top left corner of the container to the top left corner of the document.
Returns the outer HTML for the given node as a string or an empty string if no node was specified. The outer HTML is the text representing all children of the node including the node itself.
Returns the intersection between the polygon defined by the array of points and the line between center and point.
Returns an integer mask of the port constraints of the given map
mxCellState that represents the terminal.
mxCellState that represents the edge.
Boolean that specifies if the terminal is the source terminal.
Default value to be returned.
Returns a pretty printed string that represents the XML tree for the given node. This method should only be used to print XML for reading, use getXml instead to obtain a string for processing.
DOM node to return the XML for.
Rotates the given point by the given cos and sin.
Returns the scale to be used for printing the graph with the given bounds across the specifies number of pages with the given format. The scale is always computed such that it given the given amount or fewer pages in the print output. See mxPrintPreview for an example.
Specifies the number of pages in the print output.
mxGraph that should be printed.
Optional mxRectangle that specifies the page format. Default is mxConstants.PAGE_FORMAT_A4_PORTRAIT.
The border along each side of every page.
Returns the top, left corner of the viewrect as an mxPoint.
Returns an mxRectangle with the size (width and height in pixels) of
the given string. The string may contain HTML markup. Newlines should be
converted to
before calling this method. The caller is responsible
for sanitizing the HTML markup.
String whose size should be returned.
Integer that specifies the font size in pixels. Default is <mxConstants.DEFAULT_FONTSIZE>.
String that specifies the name of the font family. Default is <mxConstants.DEFAULT_FONTFAMILY>.
Returns the stylename in a style of the form [(stylename|key=value);] or an empty string if the given style does not contain a stylename.
String of the form [(stylename|key=value);]
Returns the stylenames in a style of the form [(stylename|key=value);] or an empty array if the given style does not contain any stylenames.
String of the form [(stylename|key=value);]
Returns the text content of the specified node.
DOM node to return the text content for.
Returns the value for the given key in the given associative array or the given default value if the value is null.
Associative array that contains the value for the key.
Key whose value should be returned.
Value to be returned if the value for the given key is null.
Returns the XML content of the specified node. For Internet Explorer, all \r\n\t[\t]* are removed from the XML string and the remaining \r\n are replaced by \n. All \n are then replaced with linefeed, or if no linefeed is defined.
DOM node to return the XML for.
Returns true if the overflow CSS property of the given node is either scroll or auto.
DOM node whose style should be checked for scrollbars.
Cross browser implementation for document.importNode. Uses document.importNode in all browsers but IE, where the node is cloned by creating a new node and copying all attributes and children into it using importNode, recursively.
Document to import the node into.
Node to be imported.
If all children should be imported.
Full DOM API implementation for importNode without using importNode API call.
Document to import the node into.
Node to be imported.
If all children should be imported.
Returns the index of obj in array or -1 if the array does not contain the given object.
Array to check for the given obj.
Object to find in the given array.
Returns the index of the given stylename in the given style. This returns -1 if the given stylename does not occur (as a stylename) in the given style, otherwise it returns the index of the first character.
Returns the intersection of two lines as an mxPoint.
X-coordinate of the first line's startpoint.
X-coordinate of the first line's startpoint.
X-coordinate of the first line's endpoint.
Y-coordinate of the first line's endpoint.
X-coordinate of the second line's startpoint.
Y-coordinate of the second line's startpoint.
X-coordinate of the second line's endpoint.
Y-coordinate of the second line's endpoint.
Returns true if the two rectangles intersect.
mxRectangle to be checked for intersection.
mxRectangle to be checked for intersection.
Returns true if the state and the hotspot intersect.
X-coordinate.
Y-coordinate.
Returns true if the given ancestor is an ancestor of the given DOM node in the DOM. This also returns true if the child is the ancestor.
DOM node that represents the ancestor.
DOM node that represents the child.
Returns true if the given value is an valid integer number.
String representing the possibly numeric value.
Returns true if the given value is of type number and isNaN returns true.
Returns true if the given value is an XML node with the node name and if the optional attribute has the specified value.
This implementation assumes that the given value is a DOM node if the nodeType property is numeric, that is, if isNaN returns false for value.nodeType.
Object that should be examined as a node.
String that specifies the node name.
Returns true if the specified value is numeric, that is, if it is not null, not an empty string, not a HEX number and isNaN returns false.
String representing the possibly numeric value.
Returns true if the given node is in the VML namespace.
DOM node whose tag urn should be checked.
DOM node to contain the new link.
String that is used as the link label.
Function to execute when the link is clicked.
Adds a hyperlink to the specified parent that invokes action on the specified editor.
DOM node to contain the new link.
String that is used as the link label.
mxEditor that will execute the action.
String that defines the name of the action to be executed.
Adds a hyperlink to the specified parent that invokes the specified function on the editor passing along the specified argument. The function name is the name of a function of the editor instance, not an action name.
DOM node to contain the new link.
String that is used as the link label.
mxEditor instance to execute the function on.
String that represents the name of the function.
Object that represents the argument to the function.
Loads the specified URL synchronously and returns the mxXmlRequest. Throws an exception if the file cannot be loaded. See mxUtils.get for an asynchronous implementation.
URL to get the data from.
Loads the specified URL asynchronously into the specified document, invoking onload after the document has been loaded. This implementation does not use mxXmlRequest, but the document.load method.
URL to get the data from.
The document to load the URL into.
Function to execute when the URL has been loaded.
Strips all whitespaces from the beginning of the string. Without the second parameter, this will trim these characters:
Configures the given DOM element to act as a drag source for the specified graph. Returns a a new mxDragSource. If {@link mxDragSource.guideEnabled} is enabled then the x and y arguments must be used in funct to match the preview location.
DOM element to make draggable.
Function to execute on a successful drop.
Returns the remainder of division of n by m. You should use this instead of the built-in operation as the built-in operation does not properly handle negative numbers.
Appends a new paragraph with the given text to the specified parent and returns the paragraph.
DOM node to append the text node to.
String representing the text for the new paragraph.
Parses the given CSS numeric value adding handling for the values thin, medium and thick (2, 4 and 6).
Parses the specified XML string into a new XML document and returns the new document.
Shows the specified text content in a new mxWindow or a new browser window if isInternalWindow is false.
String that specifies the text to be displayed.
Posts the specified params to the given URL asynchronously and invokes
the given functions depending on the request status. Returns the
URL to get the data from.
Parameters for the post request.
Displays the given message in a prompt dialog. This implementation uses the built-in prompt function.
String specifying the message to be displayed.
Returns the distance between a line defined by two points and a point. To get the distance between a point and a segment (with a specific length) use {@link mxUtils.ptSeqDistSq}.
X-coordinate of point 1 of the line.
Y-coordinate of point 1 of the line.
X-coordinate of point 1 of the line.
Y-coordinate of point 1 of the line.
X-coordinate of the point.
Y-coordinate of the point.
Returns the square distance between a segment and a point. To get the distance between a point and a line (with infinite length) use mxUtils.ptLineDist.
X-coordinate of the startpoint of the segment.
Y-coordinate of the startpoint of the segment.
X-coordinate of the endpoint of the segment.
Y-coordinate of the endpoint of the segment.
X-coordinate of the point.
Y-coordinate of the point.
Returns true if the given rectangle intersects the given segment.
mxRectangle that represents the rectangle.
mxPoint that represents the first point of the segment.
mxPoint that represents the second point of the segment.
Returns 1 if the given point on the right side of the segment, 0 if its on the segment, and -1 if the point is on the left side of the segment.
X-coordinate of the startpoint of the segment.
Y-coordinate of the startpoint of the segment.
X-coordinate of the endpoint of the segment.
Y-coordinate of the endpoint of the segment.
X-coordinate of the point.
Y-coordinate of the point.
Removes all occurrences of the given object in the given array or object. If there are multiple occurrences of the object, be they associative or as an array entry, all occurrences are removed from the array or deleted from the object. By removing the object from the array, all elements following the removed element are shifted by one step towards the beginning of the array.
The length of arrays is not modified inside this function.
Object to find in the given array.
Array to check for the given obj.
Removes all stylenames from the given style and returns the updated style.
Removes the cursors from the style of the given DOM node and its descendants.
DOM node to remove the cursor style from.
Removes all duplicates from the given array.
Removes all occurrences of the specified stylename in the given style and returns the updated style. Trailing semicolons are not preserved.
Removes the sibling text nodes for the given node that only consists of tabs, newlines and spaces.
DOM node whose siblings should be removed.
Replaces each trailing newline with the given pattern.
Reverse the port constraint bitmask. For example, north | east becomes south | west
Strips all whitespaces from the end of the string. Without the second parameter, this will trim these characters:
Sets or toggles the flag bit for the given key in the cell's styles. If value is null then the flag is toggled.
mxGraphModel that contains the cells.
Array of mxCell to change the style for.
Key of the style to be changed.
Integer for the bit to be changed.
Assigns the value for the given key in the styles of the given cells, or removes the key from the styles if the value is null.
mxGraphModel to execute the transaction in.
Key of the style to be changed.
New value for the given key.
Sets the opacity of the specified DOM node to the given value in %.
DOM node to set the opacity for.
Opacity in %. Possible values are between 0 and 100.
Adds the given style with the standard name and an optional vendor prefix for the current browser.
Adds or removes the given key, value pair to the style and returns the new style. If value is null or zero length then the key is removed from the style. This is for cell styles, not for CSS styles.
String of the form [(stylename|key=value);].
Key of the style to be changed.
New value for the given key.
Sets or removes the given key from the specified style and returns the new style. If value is null then the flag is toggled.
String of the form [(stylename|key=value);].
Key of the style to be changed.
Integer for the bit to be changed.
Sets the text content of the specified node.
DOM node to set the text content for.
String that represents the text content.
Copies the styles and the markup from the graph's container into the given document and removes all cursor styles. The document is returned.
This function should be called from within the document with the graph. If you experience problems with missing stylesheets in IE then try adding the domain to the trusted sites.
mxGraph to be copied.
Document where the new graph is created.
Submits the given parameters to the specified URL using mxXmlRequest.simulate and returns the mxXmlRequest. Make sure to use encodeURIComponent for the parameter values.
URL to get the data from.
Parameters for the form.
Document to create the form in.
Target to send the form result to.
Converts the given radians to degree.
Converts the given degree to radians.
Returns a textual representation of the specified object.
Object to return the string representation for.
Strips all whitespaces from both end of the string. Without the second parameter, Javascript function will trim these characters:
Creates a text node for the given string and appends it to the given parent. Returns the text node.
DOM node to append the text node to.
String representing the text to be added.
Creates a text node for the given string and appends it to the given parent with an additional linefeed. Returns the text node.
DOM node to append the text node to.
String representing the text to be added.
Generated using TypeDoc
Specifies the resource key for the label of the close button. If the resource for this key does not exist then the value is used as the label. Default is 'close'.
'close'