/usr/share/doc/libjs-mathjax-doc/html/api/ajax.html is in libjs-mathjax-doc 2.7+20171212-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>The MathJax.Ajax Object — MathJax 2.7 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="MathJax 2.7 documentation" href="../index.html"/>
<link rel="up" title="The MathJax API" href="index.html"/>
<link rel="next" title="The MathJax.Message Object" href="message.html"/>
<link rel="prev" title="The MathJax.Hub Object" href="hub.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> MathJax
</a>
<div class="version">
2.7
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Basic Usage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../mathjax.html">What is MathJax?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../start.html">Getting Started with MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installing and Testing MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">Loading and Configuring MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../config-files.html">Combined MathJax Configurations</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tex.html">MathJax TeX and LaTeX Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../mathml.html">MathJax MathML Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../asciimath.html">MathJax AsciiMath Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../output.html">MathJax Output Formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="../font-support.html">MathJax Font Support</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../localization.html">MathJax Localization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../safe-mode.html">MathJax Safe-mode</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../community.html">The MathJax Community</a></li>
</ul>
<p class="caption"><span class="caption-text">Configuration options</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../options/index.html">Configuration options</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../advanced/model.html">The MathJax Processing Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/startup.html">The MathJax Startup Sequence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/synchronize.html">Synchronizing Your Code with MathJax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/dynamic.html">Loading MathJax Dynamically</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/typeset.html">Modifying Math on the Page</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/toMathML.html">Obtaining the MathML for an Expression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/extension-writing.html">Writing MathJax Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/debugging-tips.html">Debugging Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced/mathjax-node.html">MathJax on NodeJS</a></li>
</ul>
<p class="caption"><span class="caption-text">The MathJax API</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Details of the MathJax API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="variable.html">The MathJax variable</a></li>
<li class="toctree-l2"><a class="reference internal" href="hub.html">The MathJax.Hub object</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">The MathJax.Ajax object</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="message.html">The MathJax.Message object</a></li>
<li class="toctree-l2"><a class="reference internal" href="html.html">The MathJax.HTML object</a></li>
<li class="toctree-l2"><a class="reference internal" href="callback.html">The MathJax.CallBack class</a></li>
<li class="toctree-l2"><a class="reference internal" href="queue.html">The MathJax.CallBack.Queue class</a></li>
<li class="toctree-l2"><a class="reference internal" href="signal.html">The MathJax.CallBack.Signal class</a></li>
<li class="toctree-l2"><a class="reference internal" href="localization.html">The MathJax.Localization object</a></li>
<li class="toctree-l2"><a class="reference internal" href="inputjax.html">The MathJax.InputJax class</a></li>
<li class="toctree-l2"><a class="reference internal" href="outputjax.html">The MathJax.OutputJax class</a></li>
<li class="toctree-l2"><a class="reference internal" href="elementjax.html">The MathJax.ElementJax class</a></li>
<li class="toctree-l2"><a class="reference internal" href="jax.html">The base Jax class</a></li>
<li class="toctree-l2"><a class="reference internal" href="object.html">The MathJax Object-Oriented Programming Model</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Miscellanea</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../misc/accessibility-features.html">Accessibility features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/browser-compatibility.html">Browser Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/epub.html">EPUB3 Reading Systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/badges.html">MathJax Badges and Logo</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/articles.html">Articles and Presentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/platforms.html">Using MathJax in Web Platforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/faq.html">MathJax FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../misc/mathjax-in-use.html">MathJax in Use</a></li>
</ul>
<p class="caption"><span class="caption-text">Upgrading MathJax</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/index.html">Upgrading MathJax</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference Pages</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/HTML-snippets.html">HTML snippets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/CSS-styles.html">CSS style objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/localization-strings.html">Localization strings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">MathJax</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">The MathJax API</a> »</li>
<li>The MathJax.Ajax Object</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/ajax.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="the-mathjax-ajax-object">
<span id="api-ajax"></span><h1>The MathJax.Ajax Object<a class="headerlink" href="#the-mathjax-ajax-object" title="Permalink to this headline">¶</a></h1>
<p>The <cite>MathJax.Ajax</cite> structure holds the data and functions for handling
loading of external modules. Modules are loaded only once, even if
called for in several places. The loading of files is asynchronous,
and so the code that requests an external module will continue to run
even when that module has not completed loading, so it is important to
be aware of the timing issues this may cause. Similarly, creating or
loading stylesheets is an asynchronous action. In particular, all
actions that rely on the file or stylesheet having been loaded must be
delayed until after the file has been downloaded completely. This is
the reason for the large number of routines that take callback
functions.</p>
<p>Any operation that could cause the loading of a file or stylesheet
must be synchronized with the rest of the code via such callbacks.
Since processing any mathematics might cause files to be loaded (e.g.,
little-used markup might be implemented in an extension that is loaded
only when that markup is used), any code that dynamically typesets
mathematics will need to be structured to use callbacks to guarantee
that the mathematics has been completely processed before the code
tries to use it. See the <a class="reference internal" href="../advanced/synchronize.html#synchronization"><span class="std std-ref">Synchronizing with MathJax</span></a>
documentation for details on how to do this properly.</p>
<div class="section" id="properties">
<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
<dl class="describe">
<dt>
<code class="descname">timeout</code></dt>
<dd><p>Number of milliseconds to wait for a file to load before
it is considered to have failed to load.</p>
<p><em>Default:</em> 15 seconds</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">STATUS.OK</code></dt>
<dd><p>The value used to indicate that a file load has occurred
successfully.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">STATUS.ERROR</code></dt>
<dd><p>The value used to indicate that a file load has caused an error or
a timeout to occur.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">loaded</code></dt>
<dd><p>An object containing the names of the files that have been loaded (or
requested) so far. <code class="docutils literal"><span class="pre">MathJax.Ajax.loaded["file"]</span></code> will be
non-<code class="docutils literal"><span class="pre">null</span></code> when the file has been loaded, with the value being
the <code class="docutils literal"><span class="pre">MathJax.Ajax.STATUS</span></code> value of the load attempt.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">loading</code></dt>
<dd><p>An object containing the files that are currently loading, the
callbacks that are to be run when they load or timeout, and
additional internal data.</p>
</dd></dl>
<dl class="describe">
<dt>
<code class="descname">loadHooks</code></dt>
<dd><p>An object containing the load hooks for the various files, set up by
the <a class="reference internal" href="#LoadHook" title="LoadHook"><code class="xref py py-meth docutils literal"><span class="pre">LoadHook()</span></code></a> method, or by the
<code class="xref py py-meth docutils literal"><span class="pre">MathJax.Hub.Register.LoadHook()</span></code> method.</p>
</dd></dl>
</div>
<div class="section" id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="Require">
<code class="descname">Require</code><span class="sig-paren">(</span><em>file</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Require" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads the given file if it hasn’t been already. The file must be a
JavaScript file or a CSS stylesheet; i.e., it must end in <code class="docutils literal"><span class="pre">.js</span></code>
or <code class="docutils literal"><span class="pre">.css</span></code>. Alternatively, it can be an object with a single
<cite>key:value</cite> pair where the <cite>key</cite> is one of <code class="docutils literal"><span class="pre">js</span></code> or <code class="docutils literal"><span class="pre">css</span></code> and
the <cite>value</cite> is the file of that type to be loaded (this makes it
possible to have the file be created by a CGI script, for example,
or to use a <code class="docutils literal"><span class="pre">data::</span></code> URL). The file must be relative to the
MathJax home directory and can not contain <code class="docutils literal"><span class="pre">../</span></code> file path
components.</p>
<p>When the file is completely loaded and run, the <cite>callback</cite>, if
provided, will be executed passing it the status of the file load.
If there was an error while loading the file, or if the file fails
to load within the time limit given by <code class="docutils literal"><span class="pre">MathJax.Ajax.timout</span></code>,
the status will be <code class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.ERROR</span></code> otherwise it
will be <code class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.OK</span></code>. If the file is already
loaded, the callback will be called immediately and the file will
not be loaded again.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — name of the file to be loaded</li>
<li><strong>callback</strong> — the callback specification</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the callback object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="Load">
<code class="descname">Load</code><span class="sig-paren">(</span><em>file</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Load" title="Permalink to this definition">¶</a></dt>
<dd><p>Used internally to load a given file without checking if it
already has been loaded, or where it is to be found.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — name of the file to be loaded</li>
<li><strong>callback</strong> — the callback specification</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the callback object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="loadComplete">
<code class="descname">loadComplete</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#loadComplete" title="Permalink to this definition">¶</a></dt>
<dd><p>Called from within the loaded files to inform MathJax that the
file has been completely loaded and initialized. The <cite>file</cite>
parameter is the name of the file that has been loaded. This
routine will cause any callback functions registered for the file
or included in the <code class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.Require()</span></code> calls to be
executed, passing them the status of the load
(<code class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.OK</span></code> or <code class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.ERROR</span></code>) as
their last parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — name of the file that has been loaded</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">null</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="loadTimeout">
<code class="descname">loadTimeout</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#loadTimeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the timeout period is over and the file hasn’t loaded.
This indicates an error condition, and the
<code class="xref py py-meth docutils literal"><span class="pre">MathJax.Ajax.loadError()</span></code> method will be executed, then the
file’s callback will be run with <code class="docutils literal"><span class="pre">MathJax.Ajax.STATUS.ERROR</span></code> as
its parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — name of the file that timed out</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">null</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="loadError">
<code class="descname">loadError</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#loadError" title="Permalink to this definition">¶</a></dt>
<dd><p>The default error handler called when a file fails to load. It
puts a warning message into the MathJax message box on screen.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — the name of the file that failed to load</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">null</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="LoadHook">
<code class="descname">LoadHook</code><span class="sig-paren">(</span><em>file</em>, <em>callback</em><span class="sig-paren">)</span><a class="headerlink" href="#LoadHook" title="Permalink to this definition">¶</a></dt>
<dd><p>Registers a callback to be executed when the given file is
loaded. The file load operation needs to be started when this
method is called, so it can be used to register a hook for a file
that may be loaded in the future.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — the name of the file to wait for</li>
<li><strong>callback</strong> — the callback specification</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the callback object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="Preloading">
<code class="descname">Preloading</code><span class="sig-paren">(</span><em>file1</em><span class="optional">[</span>, <em>file2...</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Preloading" title="Permalink to this definition">¶</a></dt>
<dd><p>Used with combined configuration files to indicate what files are
in the configuration file. Marks the files as loading (since there
will never be an explicit <a class="reference internal" href="#Load" title="Load"><code class="xref py py-meth docutils literal"><span class="pre">Load()</span></code></a> or <a class="reference internal" href="#Require" title="Require"><code class="xref py py-meth docutils literal"><span class="pre">Require()</span></code></a> call for
them), so that load-hooks and other load-related events can be
properly processed when the <a class="reference internal" href="#loadComplete" title="loadComplete"><code class="xref py py-meth docutils literal"><span class="pre">loadComplete()</span></code></a> occurs.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file1, file2, …</strong> — the names of the files in the combined file</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal"><span class="pre">null</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="Styles">
<code class="descname">Styles</code><span class="sig-paren">(</span><em>styles</em><span class="optional">[</span>, <em>callback</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Styles" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a stylesheet from the given style data. <cite>styles</cite> can
either be a string containing a stylesheet definition, or an
object containing a <a class="reference internal" href="../reference/CSS-styles.html#css-style-objects"><span class="std std-ref">CSS Style Object</span></a>.
For example:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Ajax</span><span class="p">.</span><span class="nx">Styles</span><span class="p">(</span><span class="s2">"body {font-family: serif; font-style: italic}"</span><span class="p">);</span>
</pre></div>
</div>
<p>and</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">MathJax</span><span class="p">.</span><span class="nx">Ajax</span><span class="p">.</span><span class="nx">Styles</span><span class="p">({</span>
<span class="nx">body</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"font-family"</span><span class="o">:</span> <span class="s2">"serif"</span><span class="p">,</span>
<span class="s2">"font-style"</span><span class="o">:</span> <span class="s2">"italic"</span>
<span class="p">}</span>
<span class="p">});</span>
</pre></div>
</div>
<p>both set the body font family and style.</p>
<p>The callback routine is called when the stylesheet has been
created and is available for use.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>styles</strong> — CSS style object for the styles to set</li>
<li><strong>callback</strong> — the callback specification</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the callback object</p>
</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Internet Explorer has a limit of 32 dynamically created
stylesheets, so it is best to combine your styles into one
large group rather than making several smaller calls.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="fileURL">
<code class="descname">fileURL</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#fileURL" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a complete URL to a file (replacing <code class="docutils literal"><span class="pre">[MathJax]</span></code> with the
actual root URL location).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>file</strong> — the file name possibly including <code class="docutils literal"><span class="pre">[MathJax]</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the full URL for the file</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="message.html" class="btn btn-neutral float-right" title="The MathJax.Message Object" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="hub.html" class="btn btn-neutral" title="The MathJax.Hub Object" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017 The MathJax Consortium.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'2.7',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|