Attention
Version 3 is now the current version of MathJax. This document is for version 2.
The SVG output processor¶
The options below control the operation of the SVG output
processor that is run when you include "output/SVG"
in the
jax array of your configuration or load a combined configuration
file that includes the SVG output jax. They are listed with their default
values. To set any of these options, include an SVG
section
in your MathJax.Hub.Config()
call. For example
MathJax.Hub.Config({
SVG: {
scale: 120
}
});
would set the scale
option to 120%.
-
scale: 100
The scaling factor (as a percentage) of math with respect to the surrounding text. The SVG output processor tries to match the ex-size of the mathematics with that of the text where it is placed, but you may want to adjust the results using this scaling factor. The user can also adjust this value using the contextual menu item associated with the typeset mathematics.
-
minScaleAdjust: 50
This gives a minimum scale (as a percent) for the scaling used by MathJax to match the equation to the surrounding text. This will prevent MathJax from making the mathematics too small.
-
font: "TeX"
This is the font to use for rendering the mathematics. The possible values are
TeX
,STIX-Web
,Asana-Math
,Neo-Euler
,Gyre-Pagella
,Gyre-Termes
andLatin-Modern
. Note that not all mathematical characters are available in all fonts (e.g., Neo-Euler does not include italic characters), so some mathematics may work better in some fonts than in others. TheSTIX-Web
font is the most complete.
-
blacker: 1
This is the stroke width to use for all character paths (1em = 1000 units). This is a cheap way of getting slightly lighter or darker characters, but remember that not all displays will act the same, so a value that is good for you may not be good for everyone.
-
undefinedFamily: "STIXGeneral, 'Arial Unicode MS', serif"
This is the font-family CSS value used for characters that are not in the selected font (e.g., this is where to look for characters not included in the MathJax TeX fonts). IE will stop looking after the first font that exists on the system (even if it doesn’t contain the needed character), so order these carefully.
-
mtextFontInherit: false
This setting controls whether
<mtext>
elements will be typeset using the math fonts or the font of the surrounding text. Whenfalse
, the font formathvariant="normal"
will be used; whentrue
, the font will be inherited from the surrounding paragraph.
-
addMMLclasses: false
This controls whether the MathML structure is retained and CSS classes are added to mark the original MathML elements (as in the output from the HTML-CSS output jax). By default, the SVG output jax removes unneeded nesting in order to produce a more efficient markup, but if you want to use CSS to style the elements as if they were MathML, you might need to set this to true.
-
useFontCache: true
This controls whether the SVG output uses
<use>
elements to re-use font paths rather than repeat paths every time. IfuseGlobalCache
(see below) is set tofalse
, this will still reduce duplication of paths while keeping each SVG self-contained.
-
useGlobalCache: true
When set to
true
the SVG Output stores paths (corresponding to “fonts” in the SVG output) in a global SVG object using<defs>
elements so that it can re-use them in all equations via<use>
elements (much like a font file allows re-use of characters across the document). While set totrue
by default, it will have no effect ifuseFontCache
is set tofalse
.
-
EqnChunk: 50
-
EqnChunkFactor: 1.5
-
EqnChunkDelay: 100
These values control how “chunky” the display of mathematical expressions will be; that is, how often the equations will be updated as they are processed.
EqnChunk
is the number of equations that will be typeset before they appear on screen. Larger values make for less visual flicker as the equations are drawn, but also mean longer delays before the reader sees anything.EqChunkFactor
is the factor by which theEqnChunk
will grow after each chunk is displayed.EqChunkDelay
is the time (in milliseconds) to delay between chunks (to allow the browser to respond to other user interaction).Set
EqnChunk
to 1,EqnChunkFactor
to 1, andEqnChunkDelay
to 10 to get the behavior from MathJax v1.1 and below.
-
matchFontHeight: true
This option indicates whether MathJax should try to adjust the x-height of equations to match the x-height of the surrounding text. See the MatchWebFonts options for finer control, especially if you are using Web fonts.
-
linebreaks: {}
This is an object that configures automatic linebreaking in the SVG output. In order to be backward compatible with earlier versions of MathJax, only explicit line breaks are performed by default, so you must enable line breaks if you want automatic ones. The object contains the following values:
-
automatic: false
This controls the automatic breaking of expressions: when
false
, onlylinebreak="newline"
is processed; whentrue
, line breaks are inserted automatically in long expressions.
-
width: "container"
This controls how wide the lines of mathematics can be.
Use an explicit width like
"30em"
for a fixed width. Use"container"
to compute the size from the containing element. Use"nn% container"
for a portion of the container. Use"nn%"
for a portion of the window size.The container-based widths may be slower, and may not produce the expected results if the layout width changes due to the removal of previews or inclusion of mathematics during typesetting.
-
-
styles: {}
This is a list of CSS declarations for styling the SVG output. See the definitions in
jax/output/SVG/config.js
for some examples of what are defined by default. See CSS Style Objects for details on how to specify CSS style in a JavaScript object.
-
tooltip: { ... }
This sets the configuration options for
<maction>
elements withactiontype="tooltip"
. (See also the#MathJax_Tooltip
style setting injax/output/SVG/config.js
, which can be overridden using thestyles
option above.)The
tooltip
section can contain the following options:-
delayPost: 600
The delay (in milliseconds) before the tooltip is posted after the mouse is moved over the
maction
element.
-
delayClear: 600
The delay (in milliseconds) before the tooltop is cleared after the mouse moves out of the
maction
element.
-
offsetX: 10
-
offsetY: 5
These are the offset from the mouse position (in pixels) where the tooltip will be placed.
-