maxGraph/docs/js-api/files/mxClient-js.html

136 lines
60 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><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.5 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
2013-05-23 16:14:48 +00:00
<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" >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=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">IS_IE</a></td><td class=SDescription>True if the current browser is Internet Explorer.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_IE6" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">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_QUIRKS" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">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.VML_PREFIX" >VML_PREFIX</a></td><td class=SDescription>Prefix for VML namespace in node names. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.OFFICE_PREFIX" >OFFICE_PREFIX</a></td><td class=SDescription>Prefix for VML office namespace in node names. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_NS" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">IS_NS</a></td><td class=SDescription>True if the current browser is Netscape (including Firefox).</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_OP" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">IS_OP</a></td><td class=SDescription>True if the current browser is Opera.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_OT" >IS_OT</a></td><td class=SDescription>True if -o-transform is available as a CSS style. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_SF" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">IS_SF</a></td><td class=SDescription>True if the current browser is Safari.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_GC" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">IS_GC</a></td><td class=SDescription>True if the current browser is Google Chrome.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.IS_MT" >IS_MT</a></td><td class=SDescription>True if -moz-transform is available as a CSS style. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxClient.IS_SVG" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">IS_SVG</a></td><td class=SDescription>True if the browser supports SVG.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxClient.NO_FO" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">NO_FO</a></td><td class=SD
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxClient.Variables"></a>Variables</h3></div></div>
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.VERSION"></a>VERSION</h3><div class=CBody><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 2.0.0.1.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_IE: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'MSIE'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote><p>True if the current browser is Internet Explorer.</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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_IE6: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'MSIE 6'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote><p>True if the current browser is Internet Explorer 6.x.</p></div></div></div>
2012-07-20 10:35:30 +00:00
<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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_QUIRKS: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'MSIE'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote><p>True if the current browser is Internet Explorer and it is in quirks mode.</p></div></div></div>
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.VML_PREFIX"></a>VML_PREFIX</h3><div class=CBody><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><p>Prefix for VML office namespace in node names.&nbsp; Default is &lsquo;o&rsquo;.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_NS: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Mozilla/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_OP: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Opera/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></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><p>True if -o-transform is available as a CSS style.&nbsp; This is the case for Opera browsers that use Presto/2.5 and 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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_SF: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'AppleWebKit/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></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_GC"></a>IS_GC</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_GC: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Chrome/'</td><td class=PAfterParameters nowrap>) &gt;</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_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_SVG"></a>IS_SVG</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_SVG: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Firefox/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote><p>True if the browser supports SVG.</p></div></div></div>
2013-05-23 16:14:48 +00:00
<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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=2>NO_FO: !document.createElementNS || document.createElementNS(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class=PParameter nowrap width=100%>'http://www.w3.org/2000/svg',</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class=PParameter nowrap width=100%>'foreignObject'</td></tr><tr><td class=PAfterParameters colspan=2>) !</td></tr></table></td></tr></table></blockquote><p>True if foreignObject support is not available.&nbsp; This is the case for Opera and older SVG-based browsers.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<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 prettyprint"><tr><td>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_MAC"></a>IS_MAC</h3><div class=CBody><p>True if the client is a Mac.</p></div></div></div>
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.IS_TOUCH"></a>IS_TOUCH</h3><div class=CBody><p>True if this device supports touchstart/-move/-end events (Apple iOS, Android and Chromebook).</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><p>True if this device supports MS pointer events.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<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="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxClient.Functions"></a>Functions</h3></div></div>
2012-07-20 10:35:30 +00:00
<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 prettyprint"><tr><td>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=link19 onMouseOver="ShowTip(event, 'tt10', 'link19')" onMouseOut="HideTip('tt10')">mxClient.IS_VML</a> or <a href="#mxClient.IS_SVG" class=LVariable id=link20 onMouseOver="ShowTip(event, 'tt8', 'link20')" onMouseOut="HideTip('tt8')">mxClient.IS_SVG</a> is true.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">if (!mxClient.isBrowserSupported())
2012-05-21 20:32:26 +00:00
{
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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>link: function(</td><td class=PParameter nowrap>rel,</td></tr><tr><td></td><td class=PParameter nowrap>href,</td></tr><tr><td></td><td class=PParameter nowrap>doc</td><td class=PAfterParameters 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></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 prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>include: function(</td><td class=PParameter nowrap>src</td><td class=PAfterParameters 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>
2013-02-14 13:13:16 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxClient.dispose"></a>dispose</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>dispose: function()</td></tr></table></blockquote><p>Frees up memory in IE by resolving cyclic dependencies between the DOM and the JavaScript objects.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxClient.Variables"></a>Variables</h3></div></div>
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxClient.CSS_PREFIX"></a>CSS_PREFIX</h3><div class=CBody><p>Optional prefix for CSS transforms if CSS transforms are supported by this browser.&nbsp; Can be used as follows.</p><blockquote><pre class="prettyprint">node.style[mxClient.CSS_PREFIX + 'TransformOrigin'] = '0% 0%';</pre></blockquote></div></div></div>
2012-07-20 10:35:30 +00:00
<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=link21 onMouseOver="ShowTip(event, 'tt15', 'link21')" onMouseOut="HideTip('tt15')">mxGraph</a> and <a href="editor/mxEditor-js.html#mxEditor" class=LClass id=link22 onMouseOver="ShowTip(event, 'tt16', 'link22')" onMouseOut="HideTip('tt16')">mxEditor</a>.&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;
2012-07-16 15:36:48 +00:00
var mxLoadResources = false;
2012-05-21 20:32:26 +00:00
&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>
2013-05-23 16:14:48 +00:00
<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>
2012-05-21 20:32:26 +00:00
<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;
2012-07-16 15:36:48 +00:00
var mxLoadStylesheets = false;
2012-05-21 20:32:26 +00:00
&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>
2012-07-20 10:35:30 +00:00
<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=link23 onMouseOver="ShowTip(event, 'tt17', 'link23')" onMouseOut="HideTip('tt17')">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;
2012-05-21 20:32:26 +00:00
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>
2012-07-20 10:35:30 +00:00
<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=link24 onMouseOver="ShowTip(event, 'tt18', 'link24')" onMouseOut="HideTip('tt18')">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;
2012-05-21 20:32:26 +00:00
mxLanguage = 'en';
&lt;/script&gt;
2012-07-20 10:35:30 +00:00
&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=link25 onMouseOver="ShowTip(event, 'tt19', 'link25')" onMouseOut="HideTip('tt19')">mxEditor.askZoomResource</a>, <a href="editor/mxEditor-js.html#mxEditor.lastSavedResource" class=LVariable id=link26 onMouseOver="ShowTip(event, 'tt20', 'link26')" onMouseOut="HideTip('tt20')">mxEditor.lastSavedResource</a>, <a href="editor/mxEditor-js.html#mxEditor.currentFileResource" class=LVariable id=link27 onMouseOver="ShowTip(event, 'tt21', 'link27')" onMouseOut="HideTip('tt21')">mxEditor.currentFileResource</a>, <a href="editor/mxEditor-js.html#mxEditor.propertiesResource" class=LVariable id=link28 onMouseOver="ShowTip(event, 'tt22', 'link28')" onMouseOut="HideTip('tt22')">mxEditor.propertiesResource</a>, <a href="editor/mxEditor-js.html#mxEditor.tasksResource" class=LVariable id=link29 onMouseOver="ShowTip(event, 'tt23', 'link29')" onMouseOut="HideTip('tt23')">mxEditor.tasksResource</a>, <a href="editor/mxEditor-js.html#mxEditor.helpResource" class=LVariable id=link30 onMouseOver="ShowTip(event, 'tt24', 'link30')" onMouseOut="HideTip('tt24')">mxEditor.helpResource</a>, <a href="editor/mxEditor-js.html#mxEditor.outlineResource" class=LVariable id=link31 onMouseOver="ShowTip(event, 'tt25', 'link31')" onMouseOut="HideTip('tt25')">mxEditor.outlineResource</a>, <a href="handler/mxElbowEdgeHandler-js.html#mxElbowEdgeHandler.doubleClickOrientationResource" class=LVariable id=link32 onMouseOver="ShowTip(event, 'tt26', 'link32')" onMouseOut="HideTip('tt26')">mxElbowEdgeHandler.doubleClickOrientationResource</a>, <a href="util/mxUtils-js.html#mxUtils.errorResource" class=LVariable id=link33 onMouseOver="ShowTip(event, 'tt27', 'link33')" onMouseOut="HideTip('tt27')">mxUtils.errorResource</a>, <a href="util/mxUtils-js.html#mxUtils.closeResource" class=LVariable id=link34 onMouseOver="ShowTip(event, 'tt28', 'link34')" onMouseOut="HideTip('tt28')">mxUtils.closeResource</a>, <a href="view/mxGraphSelectionModel-js.html#mxGraphSelectionModel.doneResource" class=LVariable id=link35 onMouseOver="ShowTip(event, 'tt29', 'link35')" onMouseOut="HideTip('tt29')">mxGraphSelectionModel.doneResource</a>, <a href="view/mxGraphSelectionModel-js.html#mxGraphSelectionModel.updatingSelectionResource" class=LVariable id=link36 onMouseOver="ShowTip(event, 'tt30', 'link36')" onMouseOut="HideTip('tt30')">mxGraphSelectionModel.updatingSelectionResource</a>, <a href="view/mxGraphView-js.html#mxGraphView.doneResource" class=LVariable id=link37 onMouseOver="ShowTip(event, 'tt31', 'link37')" onMouseOut="HideTip('tt31')">mxGraphView.doneResource</a>, <a href="view/mxGraphView-js.html#mxGraphView.updatingDocumentResource" class=LFunction id=link38 onMouseOver="ShowTip(event, 'tt32', 'link38')" onMouseOut="HideTip('tt32')">mxGraphView.updatingDocumentResource</a>, &lt;mxCellRenderer.collapseExpandResource&gt;, <a href="view/mxGraph-js.html#mxGraph.containsValidationErrorsResource" class=LVariable id=link39 onMouseOver="ShowTip(event, 'tt33', 'link39')" onMouseOut="HideTip('tt33')">mxGraph.containsValidationErrorsResource</a> and <a href="view/mxGraph-js.html#mxGraph.alreadyConnectedResource" class=LVariable id=link40 onMouseOver="ShowTip(event, 'tt34', 'link40')" onMouseOut="HideTip('tt34')">mxGraph.alreadyConnectedResource</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<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 &lt;mxResources.isLanguageSupported&gt;.</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-->
2013-05-23 16:14:48 +00:00
<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/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/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></div><div class=MEntry><div class=MFile><a href="io/mxObjectCodec-js.html">mxObjectCodec</a></div></div><div class=MEntry><div class=MFile><a href="io/mxRootChangeCodec-js.html">mxRootChangeCodec</a></div></
2012-05-21 20:32:26 +00:00
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-->
2013-05-23 16:14:48 +00:00
<div class=CToolTip id="tt1"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_IE: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'MSIE'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Internet Explorer.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_IE6: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'MSIE 6'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Internet Explorer 6.x.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_QUIRKS: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'MSIE'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Internet Explorer and it is in quirks mode.</div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_NS: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Mozilla/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Netscape (including Firefox).</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_OP: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Opera/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Opera.</div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_SF: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'AppleWebKit/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Safari.</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_GC: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Chrome/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the current browser is Google Chrome.</div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>IS_SVG: navigator.userAgent.indexOf(</td><td class=PParameter nowrap>'Firefox/'</td><td class=PAfterParameters nowrap>) &gt;</td></tr></table></td></tr></table></blockquote>True if the browser supports SVG.</div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters colspan=2>NO_FO: !document.createElementNS || document.createElementNS(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class=PParameter nowrap width=100%>'http://www.w3.org/2000/svg',</td></tr><tr><td>&nb
2012-05-21 20:32:26 +00:00
<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>