File: variable.rst

package info (click to toggle)
mathjax-docs 2.7+20171212-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,100 kB
  • sloc: sh: 22; python: 19; makefile: 8
file content (92 lines) | stat: -rw-r--r-- 2,757 bytes parent folder | download | duplicates (3)
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
********************
The MathJax variable
********************

MathJax has a single global variable, ``MathJax``, in which all its
data, and the data for loaded components, are stored.  The MathJax
variable is a nested structure, with its top-level properties being
objects themselves.


Main MathJax Components
=======================

.. describe:: MathJax.Hub

    Contains the MathJax hub code and variables, including the startup
    code, the onload handler, the browser data, and so forth.
    
.. describe:: MathJax.Ajax

    Contains the code for loading external modules and creating
    stylesheets.  Most of the code that causes MathJax to
    operate asynchronously is handled here.

.. describe:: MathJax.Message

   Contains the code to handle the intermittent message window that
   periodically appears in the lower left-hand corner of the window.

.. describe:: MathJax.HTML

   Contains support code for creating HTML elements dynamically from
   descriptions stored in JavaScript objects.
    
.. describe:: MathJax.CallBack

    Contains the code for managing MathJax callbacks, queues and
    signals.

.. describe:: MathJax.Extension

    Initially empty, this is where extensions can load their code.
    For example, the `tex2jax` preprocessor creates
    ``MathJax.Extension.tex2jax`` for its code and variables.

.. describe:: MathJax.Menu

    Initially null, this is where the MathJax contextual menu is
    stored, when ``extensions/MathMenu.js`` is loaded.

.. describe:: MathJax.Object

    Contains the code for the MathJax object-oriented programming model.


.. describe:: MathJax.InputJax

    The base class for all input `jax` objects.  Subclasses for
    specific input jax are created as sub-objects of
    ``MathJax.InputJax``. For example, the TeX input jax loads itself
    as ``MathJax.InputJax.TeX``.

.. describe:: MathJax.OutputJax

    The base class for all output `jax` objects.  Subclasses for
    specific output jax are created as sub-objects of
    ``MathJax.OutputJax``.  For example, the HTML-CSS output jax loads
    itself as ``MathJax.OutputJax["HTML-CSS"]``.

.. describe:: MathJax.ElementJax

    The base class for all element `jax` objects.  Subclasses for
    specific element jax are created as sub-objects of
    ``MathJax.ElementJax``.  For example, the mml element jax loads
    itself as ``MathJax.ElementJax.mml``.


Properties
==========

.. describe:: MathJax.version

    The version number of the MathJax library as a whole.

.. describe:: MathJax.fileversion

    The version number of the ``MathJax.js`` file specifically.

.. describe:: MathJax.isReady

    This is set to ``true`` when MathJax is set up and ready to
    perform typesetting actions (and is ``null`` otherwise).