zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/js-api/files/mxClient-js.html

159 lines
79 KiB
HTML
Raw Normal View History

4.2.2 release
2020-10-28 16:11:03 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxClient</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.51 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxClient"></a>mxClient</h1><div class=CBody><p>Bootstrapping mechanism for the mxGraph thin client.&nbsp; The production version of this file contains all code required to run the mxGraph thin client, as well as global constants to identify the browser and operating system in use.&nbsp; You may have to load chrome://global/content/contentAreaUtils.js in your page to disable certain security restrictions in Mozilla.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxClient" >mxClient</a></td><td class=SDescription>Bootstrapping mechanism for the mxGraph thin client. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxClient.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.VERSION" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">VERSION</a></td><td class=SDescription>Contains the current version of the mxGraph library. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_IE" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">IS_IE</a></td><td class=SDescription>True if the current browser is Internet Explorer 10 or below. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_IE6" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">IS_IE6</a></td><td class=SDescription>True if the current browser is Internet Explorer 6.x.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_IE11" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">IS_IE11</a></td><td class=SDescription>True if the current browser is Internet Explorer 11.x.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_EDGE" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">IS_EDGE</a></td><td class=SDescription>True if the current browser is Microsoft Edge.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_QUIRKS" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">IS_QUIRKS</a></td><td class=SDescription>True if the current browser is Internet Explorer and it is in quirks mode.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_EM" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">IS_EM</a></td><td class=SDescription>True if the browser is IE11 in enterprise mode (IE8 standards mode).</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.VML_PREFIX" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">VML_PREFIX</a></td><td class=SDescription>Prefix for VML namespace in node names. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.OFFICE_PREFIX" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">OFFICE_PREFIX</a></td><td class=SDescription>Prefix for VML office namespace in node names. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_NS" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">IS_NS</a></td><td class=SDescription>True if the current browser is Netscape (including Firefox).</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_OP" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">IS_OP</a></td><td class=SDescription>True if the current browser is Opera.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_OT" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">IS_OT</a></td><td class=SDescription>True if -o-transf
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxClient.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.VERSION"></a>VERSION</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">VERSION: '4.2.2'</td></tr></table></blockquote><p>Contains the current version of the mxGraph library.&nbsp; The strings that communicate versions of mxGraph use the following format.</p><p>versionMajor.versionMinor.buildNumber.revisionNumber</p><p>Current version is 4.2.2.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_IE"></a>IS_IE</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_IE: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Internet Explorer 10 or below.&nbsp; Use <a href="#mxClient.IS_IE11" class=LVariable id=link36 onMouseOver="ShowTip(event, 'tt4', 'link36')" onMouseOut="HideTip('tt4')">mxClient.IS_IE11</a> to detect IE 11.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_IE6"></a>IS_IE6</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_IE6: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Internet Explorer 6.x.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_IE11"></a>IS_IE11</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_IE11: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Internet Explorer 11.x.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_EDGE"></a>IS_EDGE</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_EDGE: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Microsoft Edge.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_QUIRKS"></a>IS_QUIRKS</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_QUIRKS: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Internet Explorer and it is in quirks mode.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_EM"></a>IS_EM</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=2>IS_EM: 'spellcheck' in document.createElement(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>'textarea'</td></tr><tr><td class="PAfterParameters prettyprint "colspan=2>) &amp;&amp; document.documentMode</td></tr></table></td></tr></table></blockquote><p>True if the browser is IE11 in enterprise mode (IE8 standards mode).</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.VML_PREFIX"></a>VML_PREFIX</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">VML_PREFIX: 'v'</td></tr></table></blockquote><p>Prefix for VML namespace in node names.&nbsp; Default is &lsquo;v&rsquo;.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.OFFICE_PREFIX"></a>OFFICE_PREFIX</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">OFFICE_PREFIX: 'o'</td></tr></table></blockquote><p>Prefix for VML office namespace in node names.&nbsp; Default is &lsquo;o&rsquo;.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_NS"></a>IS_NS</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_NS: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Netscape (including Firefox).</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_OP"></a>IS_OP</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_OP: navigator.userAgent !</td></tr></table></blockquote><p>True if the current browser is Opera.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_OT"></a>IS_OT</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_OT: navigator.userAgent !</td></tr></table></blockquote><p>True if -o-transform is available as a CSS style, ie for Opera browsers based on a Presto engine with version 2.5 or later.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_SF"></a>IS_SF</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_SF: /Apple Computer</td></tr></table></blockquote><p>True if the current browser is Safari.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_ANDROID"></a>IS_ANDROID</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>IS_ANDROID: navigator.appVersion.indexOf(</td><td class="PParameter prettyprint " nowrap>'Android'</td><td class="PAfterParameters prettyprint "nowrap>) &gt;</td></tr></table></td></tr></table></blockquote><p>Returns true if the user agent contains Android.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_IOS"></a>IS_IOS</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>IS_IOS: (</td><td class="PParameter prettyprint " nowrap>/iP(hone|od|ad)/.test(navigator.platform)</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the user agent is an iPad, iPhone or iPod.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_GC"></a>IS_GC</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>IS_GC: /Google Inc/.test(</td><td class="PParameter prettyprint " nowrap>navigator.vendor</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>True if the current browser is Google Chrome.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_CHROMEAPP"></a>IS_CHROMEAPP</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_CHROMEAPP: window.chrome !</td></tr></table></blockquote><p>True if the this is running inside a Chrome App.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_FF"></a>IS_FF</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_FF: typeof InstallTrigger !</td></tr></table></blockquote><p>True if the current browser is Firefox.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_MT"></a>IS_MT</h3><div class=CBody><p>True if -moz-transform is available as a CSS style.&nbsp; This is the case for all Firefox-based browsers newer than or equal 3, such as Camino, Iceweasel, Seamonkey and Iceape.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_VML"></a>IS_VML</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_VML: navigator.appName.toUpperCase()</td></tr></table></blockquote><p>True if the browser supports VML.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_SVG"></a>IS_SVG</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_SVG: navigator.appName.toUpperCase() !</td></tr></table></blockquote><p>True if the browser supports SVG.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.NO_FO"></a>NO_FO</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=2>NO_FO: !document.createElementNS || document.createElementNS(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>'http://www.w3.org/2000/svg',</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>'foreignObject'</td></tr><tr><td class="PAfterParameters prettyprint "colspan=2>) !</td></tr></table></td></tr></table></blockquote><p>True if foreignObject support is not available.&nbsp; This is the case for Opera, older SVG-based browsers and all versions of IE.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_WIN"></a>IS_WIN</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>IS_WIN: navigator.appVersion.indexOf(</td><td class="PParameter prettyprint " nowrap>'Win'</td><td class="PAfterParameters prettyprint "nowrap>) &gt; 0</td></tr></table></td></tr></table></blockquote><p>True if the client is a Windows.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_MAC"></a>IS_MAC</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>IS_MAC: navigator.appVersion.indexOf(</td><td class="PParameter prettyprint " nowrap>'Mac'</td><td class="PAfterParameters prettyprint "nowrap>) &gt; 0</td></tr></table></td></tr></table></blockquote><p>True if the client is a Mac.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_CHROMEOS"></a>IS_CHROMEOS</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>IS_CHROMEOS: /\bCrOS\b/.test(</td><td class="PParameter prettyprint " nowrap>navigator.appVersion</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>True if the client is a Chrome OS.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_TOUCH"></a>IS_TOUCH</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_TOUCH: 'ontouchstart' in document.documentElement</td></tr></table></blockquote><p>True if this device supports touchstart/-move/-end events (Apple iOS, Android, Chromebook and Chrome Browser on touch-enabled devices).</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_POINTER"></a>IS_POINTER</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_POINTER: window.PointerEvent !</td></tr></table></blockquote><p>True if this device supports Microsoft pointer events (always false on Macs).</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_LOCAL"></a>IS_LOCAL</h3><div class=CBody><p>True if the documents location does not start with <a href="http://" class=LURL target=_top>http://</a> or <a href="https://" class=LURL target=_top>https://</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.defaultBundles"></a>defaultBundles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">defaultBundles: []</td></tr></table></blockquote><p>Contains the base names of the default bundles if mxLoadResources is false.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxClient.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxClient.isBrowserSupported"></a>isBrowserSupported</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">isBrowserSupported: function()</td></tr></table></blockquote><p>Returns true if the current browser is supported, that is, if <a href="#mxClient.IS_VML" class=LVariable id=link37 onMouseOver="ShowTip(event, 'tt19', 'link37')" onMouseOut="HideTip('tt19')">mxClient.IS_VML</a> or <a href="#mxClient.IS_SVG" class=LVariable id=link38 onMouseOver="ShowTip(event, 'tt20', 'link38')" onMouseOut="HideTip('tt20')">mxClient.IS_SVG</a> is true.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">if (!mxClient.isBrowserSupported())
{
mxUtils.error('Browser is not supported!', 200, false);
}</pre></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxClient.link"></a>link</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>link: function(</td><td class="PParameter prettyprint " nowrap>rel,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>href,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doc,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a link node to the head of the document.&nbsp; Use this to add a stylesheet to the page as follows:</p><blockquote><pre class="prettyprint">mxClient.link('stylesheet', filename);</pre></blockquote><p>where filename is the (relative) URL of the stylesheet.&nbsp; The charset is hardcoded to ISO-8859-1 and the type is text/css.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rel</td><td class=CDLDescription>String that represents the rel attribute of the link node.</td></tr><tr><td class=CDLEntry>href</td><td class=CDLDescription>String that represents the href attribute of the link node.</td></tr><tr><td class=CDLEntry>doc</td><td class=CDLDescription>Optional parent document of the link node.</td></tr><tr><td class=CDLEntry>id</td><td class=CDLDescription>unique id for the link element to check if it already exists</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxClient.loadResources"></a>loadResources</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>loadResources: function(</td><td class="PParameter prettyprint " nowrap>fn,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>lan</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to load the default bundles if mxLoadResources is false.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>fn</td><td class=CDLDescription>Function to call after all resources have been loaded.</td></tr><tr><td class=CDLEntry>lan</td><td class=CDLDescription>Optional string to pass to <a href="util/mxResources-js.html#mxResources.add" class=LFunction id=link39 onMouseOver="ShowTip(event, 'tt34', 'link39')" onMouseOut="HideTip('tt34')">mxResources.add</a>.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxClient.include"></a>include</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>include: function(</td><td class="PParameter prettyprint " nowrap>src</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Dynamically adds a script node to the document header.</p><p>In production environments, the includes are resolved in the mxClient.js file to reduce the number of requests required for client startup.&nbsp; This function should only be used in development environments, but not in production systems.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxClient.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.mxLoadResources"></a>mxLoadResources</h3><div class=CBody><p>Optional global config variable to toggle loading of the two resource files in <a href="view/mxGraph-js.html#mxGraph" class=LClass id=link40 onMouseOver="ShowTip(event, 'tt32', 'link40')" onMouseOut="HideTip('tt32')">mxGraph</a> and <a href="editor/mxEditor-js.html#mxEditor" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt33', 'link41')" onMouseOut="HideTip('tt33')">mxEditor</a>.&nbsp; Default is true.&nbsp; NOTE: This is a global variable, not a variable of mxClient.&nbsp; If this is false, you can use <a href="#mxClient.loadResources" class=LFunction id=link42 onMouseOver="ShowTip(event, 'tt30', 'link42')" onMouseOut="HideTip('tt30')">mxClient.loadResources</a> with its callback to load the default bundles asynchronously.</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
var mxLoadResources = false;
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;/path/to/core/directory/js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.mxForceIncludes"></a>mxForceIncludes</h3><div class=CBody><p>Optional global config variable to force loading the JavaScript files in development mode.&nbsp; Default is undefined.&nbsp; NOTE: This is a global variable, not a variable of mxClient.</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
var mxLoadResources = true;
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;/path/to/core/directory/js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.mxResourceExtension"></a>mxResourceExtension</h3><div class=CBody><p>Optional global config variable to specify the extension of resource files.&nbsp; Default is true.&nbsp; NOTE: This is a global variable, not a variable of mxClient.</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
var mxResourceExtension = '.txt';
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;/path/to/core/directory/js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.mxLoadStylesheets"></a>mxLoadStylesheets</h3><div class=CBody><p>Optional global config variable to toggle loading of the CSS files when the library is initialized.&nbsp; Default is true.&nbsp; NOTE: This is a global variable, not a variable of mxClient.</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
var mxLoadStylesheets = false;
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;/path/to/core/directory/js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.basePath"></a>basePath</h3><div class=CBody><p>Basepath for all URLs in the core without trailing slash.&nbsp; Default is &lsquo;.&rsquo;.&nbsp; Set mxBasePath prior to loading the mxClient library as follows to override this setting:</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
mxBasePath = '/path/to/core/directory';
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;/path/to/core/directory/js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote><p>When using a relative path, the path is relative to the URL of the page that contains the assignment.&nbsp; Trailing slashes are automatically removed.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.imageBasePath"></a>imageBasePath</h3><div class=CBody><p>Basepath for all images URLs in the core without trailing slash.&nbsp; Default is <a href="#mxClient.basePath" class=LVariable id=link43 onMouseOver="ShowTip(event, 'tt35', 'link43')" onMouseOut="HideTip('tt35')">mxClient.basePath</a> + &lsquo;/images&rsquo;.&nbsp; Set mxImageBasePath prior to loading the mxClient library as follows to override this setting:</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
mxImageBasePath = '/path/to/image/directory';
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;/path/to/core/directory/js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote><p>When using a relative path, the path is relative to the URL of the page that contains the assignment.&nbsp; Trailing slashes are automatically removed.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.language"></a>language</h3><div class=CBody><p>Defines the language of the client, eg. en for english, de for german etc.&nbsp; The special value &lsquo;none&rsquo; will disable all built-in internationalization and resource loading.&nbsp; See <a href="util/mxResources-js.html#mxResources.getSpecialBundle" class=LFunction id=link44 onMouseOver="ShowTip(event, 'tt36', 'link44')" onMouseOut="HideTip('tt36')">mxResources.getSpecialBundle</a> for handling identifiers with and without a dash.</p><p>Set mxLanguage prior to loading the mxClient library as follows to override this setting:</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
mxLanguage = 'en';
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote><p>If internationalization is disabled, then the following variables should be overridden to reflect the current language of the system.&nbsp; These variables are cleared when i18n is disabled.&nbsp; <a href="editor/mxEditor-js.html#mxEditor.askZoomResource" class=LVariable id=link45 onMouseOver="ShowTip(event, 'tt37', 'link45')" onMouseOut="HideTip('tt37')">mxEditor.askZoomResource</a>, <a href="editor/mxEditor-js.html#mxEditor.lastSavedResource" class=LVariable id=link46 onMouseOver="ShowTip(event, 'tt38', 'link46')" onMouseOut="HideTip('tt38')">mxEditor.lastSavedResource</a>, <a href="editor/mxEditor-js.html#mxEditor.currentFileResource" class=LVariable id=link47 onMouseOver="ShowTip(event, 'tt39', 'link47')" onMouseOut="HideTip('tt39')">mxEditor.currentFileResource</a>, <a href="editor/mxEditor-js.html#mxEditor.propertiesResource" class=LVariable id=link48 onMouseOver="ShowTip(event, 'tt40', 'link48')" onMouseOut="HideTip('tt40')">mxEditor.propertiesResource</a>, <a href="editor/mxEditor-js.html#mxEditor.tasksResource" class=LVariable id=link49 onMouseOver="ShowTip(event, 'tt41', 'link49')" onMouseOut="HideTip('tt41')">mxEditor.tasksResource</a>, <a href="editor/mxEditor-js.html#mxEditor.helpResource" class=LVariable id=link50 onMouseOver="ShowTip(event, 'tt42', 'link50')" onMouseOut="HideTip('tt42')">mxEditor.helpResource</a>, <a href="editor/mxEditor-js.html#mxEditor.outlineResource" class=LVariable id=link51 onMouseOver="ShowTip(event, 'tt43', 'link51')" onMouseOut="HideTip('tt43')">mxEditor.outlineResource</a>, <a href="handler/mxElbowEdgeHandler-js.html#mxElbowEdgeHandler.doubleClickOrientationResource" class=LVariable id=link52 onMouseOver="ShowTip(event, 'tt44', 'link52')" onMouseOut="HideTip('tt44')">mxElbowEdgeHandler.doubleClickOrientationResource</a>, <a href="util/mxUtils-js.html#mxUtils.errorResource" class=LVariable id=link53 onMouseOver="ShowTip(event, 'tt45', 'link53')" onMouseOut="HideTip('tt45')">mxUtils.errorResource</a>, <a href="util/mxUtils-js.html#mxUtils.closeResource" class=LVariable id=link54 onMouseOver="ShowTip(event, 'tt46', 'link54')" onMouseOut="HideTip('tt46')">mxUtils.closeResource</a>, <a href="view/mxGraphSelectionModel-js.html#mxGraphSelectionModel.doneResource" class=LVariable id=link55 onMouseOver="ShowTip(event, 'tt47', 'link55')" onMouseOut="HideTip('tt47')">mxGraphSelectionModel.doneResource</a>, <a href="view/mxGraphSelectionModel-js.html#mxGraphSelectionModel.updatingSelectionResource" class=LVariable id=link56 onMouseOver="ShowTip(event, 'tt48', 'link56')" onMouseOut="HideTip('tt48')">mxGraphSelectionModel.updatingSelectionResource</a>, <a href="view/mxGraphView-js.html#mxGraphView.doneResource" class=LVariable id=link57 onMouseOver="ShowTip(event, 'tt49', 'link57')" onMouseOut="HideTip('tt49')">mxGraphView.doneResource</a>, <a href="view/mxGraphView-js.html#mxGraphView.updatingDocumentResource" class=LFunction id=link58 onMouseOver="ShowTip(event, 'tt50', 'link58')" onMouseOut="HideTip('tt50')">mxGraphView.updatingDocumentResource</a>, &lt;mxCellRenderer.collapseExpandResource&gt;, <a href="view/mxGraph-js.html#mxGraph.containsValidationErrorsResource" class=LVariable id=link59 onMouseOver="ShowTip(event, 'tt51', 'link59')" onMouseOut="HideTip('tt51')">mxGraph.containsValidationErrorsResource</a> and <a href="view/mxGraph-js.html#mxGraph.alreadyConnectedResource" class=LVariable id=link60 onMouseOver="ShowTip(event, 'tt52', 'link60')" onMouseOut="HideTip('tt52')">mxGraph.alreadyConnectedResource</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.defaultLanguage"></a>defaultLanguage</h3><div class=CBody><p>Defines the default language which is used in the common resource files.&nbsp; Any resources for this language will only load the common resource file, but not the language-specific resource file.&nbsp; Default is &lsquo;en&rsquo;.</p><p>Set mxDefaultLanguage prior to loading the mxClient library as follows to override this setting:</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
mxDefaultLanguage = 'de';
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.languages"></a>languages</h3><div class=CBody><p>Defines the optional array of all supported language extensions.&nbsp; The default language does not have to be part of this list.&nbsp; See <a href="util/mxResources-js.html#mxResources.isLanguageSupported" class=LFunction id=link61 onMouseOver="ShowTip(event, 'tt53', 'link61')" onMouseOut="HideTip('tt53')">mxResources.isLanguageSupported</a>.</p><blockquote><pre class="prettyprint">&lt;script type=&quot;text/javascript&quot;&gt;
mxLanguages = ['de', 'it', 'fr'];
&lt;/script&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;js/mxClient.js&quot;&gt;&lt;/script&gt;</pre></blockquote><p>This is used to avoid unnecessary requests to language files, ie. if a 404 will be returned.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<div id=Menu><div class=MEntry><div class=MFile><a href="index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxHandle-js.html">mxHandle</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxPopupMenuHandler-js.html">mxPopupMenuHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxModelCodec-js.html">mxModelCodec</a></div>
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([1], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">VERSION: '4.2.2'</td></tr></table></blockquote>Contains the current version of the mxGraph library. </div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_IE: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Internet Explorer 10 or below. </div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_IE6: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Internet Explorer 6.x.</div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_IE11: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Internet Explorer 11.x.</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_EDGE: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Microsoft Edge.</div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_QUIRKS: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Internet Explorer and it is in quirks mode.</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=2>IS_EM: 'spellcheck' in document.createElement(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>'textarea'</td></tr><tr><td class="PAfterParameters prettyprint "colspan=2>) &amp;&amp; document.documentMode</td></tr></table></td></tr></table></blockquote>True if the browser is IE11 in enterprise mode (IE8 standards mode).</div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">VML_PREFIX: 'v'</td></tr></table></blockquote>Prefix for VML namespace in node names. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">OFFICE_PREFIX: 'o'</td></tr></table></blockquote>Prefix for VML office namespace in node names. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_NS: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Netscape (including Firefox).</div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_OP: navigator.userAgent !</td></tr></table></blockquote>True if the current browser is Opera.</div></div><div class=CToolTip id="tt12"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_OT: navigator.userAgent !</td></tr></table></blockquote>True if -o-transform is available as a CSS style, ie for Opera browsers based on a Presto engine with version 2.5 or later.</div></div><div class=CToolTip id="tt13"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">IS_SF: /Apple Computer</td></tr></table></blockquote>True if the current browser is Safari.</div></div><div class=CToolTip id="tt14"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>