mathlive

module "mathlive"astToLatex()Permalink

Converts a MathJSON Abstract Syntax Tree to a LaTeX string.

See Also: latexToAST()

module "mathlive"latexToAST()Permalink

Converts a LaTeX string to an MathJSON Abstract Syntax Tree

See Also: latexToAST()

module "mathlive"latexToMarkup()Permalink

Converts a LaTeX string to a string of HTML markup.

module "mathlive"latexToSpeakableText()Permalink

Converts a LaTeX string to a textual representation ready to be spoken

console.log(MathLive.latexToSpeakableText('\\frac{1}{2}'));
// 'half'

module "mathlive"getOriginalContent()Permalink

After calling renderMathInElement or makeMathField the original content can be retrieved by calling this function.

Given the following markup:

<span id='equation'>$f(x)=sin(x)$</span>

The following code:

MathLive.renderMathInElement('equation');
console.log(MathLive.getOriginalContent('equation'));

will output:

$f(x)=sin(x)$

module "mathlive"renderMathInDocument()Permalink

Transform all the elements in the document body that contain LaTeX code into typeset math.

Note: This is a very expensive call, as it needs to parse the entire DOM tree to determine which elements need to be processed. In most cases this should only be called once per document, once the DOM has been loaded. To render a specific element, use renderMathInElement()

Read Getting Started.

import MathLive from 'https://unpkg.com/mathlive/dist/mathlive.mjs';
document.addEventListener("load", () => {
    MathLive.renderMathInDocument();
});

module "mathlive"renderMathInElement()Permalink

Transform all the children of element, recursively, that contain LaTeX code into typeset math.

Read Getting Started.

module "mathlive"revertToOriginalContent()Permalink

module "mathlive"latexToMathML()Permalink

Converts a LaTeX string to a string of MathML markup.

module "mathlive"makeMathField()Permalink

Convert a DOM element into an editable mathfield.

After the DOM element has been created, the value element.mathfield will return a reference to the mathfield object. This value is also returned by makeMathField

module "mathlive"AutoRenderOptionsPermalink

module "mathfield"interface MathfieldPermalink

$applyStyle Permalink (style: Style): void

Updates the style (color, bold, italic, etc…) of the selection or sets the style to be applied to future input.

If there is a selection, the style is applied to the selection

If the selection already has this style, remove it. If the selection has the style partially applied (i.e. only some sections), remove it from those sections, and apply it to the entire selection.

If there is no selection, the style will apply to the next character typed.

$blur Permalink (): void

$clearSelection Permalink (): void

$el Permalink (): HTMLElement

Return the DOM element associated with this mathfield.

Note that this.$el().mathfield === this

$focus Permalink (): void

$hasFocus Permalink (): boolean

$insert Permalink (s: string, options?: InsertOptions): boolean

Inserts a block of text at the current insertion point.

This method can be called explicitly or invoked as a selector with $perform("insert").

After the insertion, the selection will be set according to the options.selectionMode.

$keystroke Permalink (keys: string, evt?: KeyboardEvent): boolean

$latex Permalink (text?: string, options?: InsertOptions): string

Sets or gets the content of the mathfield.

If text is not empty, sets the content of the mathfield to the text interpreted as a LaTeX expression.

If text is empty (or omitted), return the content of the mathfield as a LaTeX expression.

$perform Permalink (command: Selector | any[]): boolean

Performs a command defined by a selector.

$revertToOriginalContent Permalink (): void

Reverts this mathfield to its original content.

After this method has been called, no other methods can be called on the object.

To turn the element back into a mathfield, call MathLive.makeMathField() on the element again to get a new mathfield object.

$select Permalink (): void

$selectedText Permalink (format?: OutputFormat): string

Returns a textual representation of the selection in the mathfield.

$selectionAtEnd Permalink (): boolean

Checks if the selection extends to the end of the selection group.

$selectionAtStart Permalink (): boolean

Checks if the selection starts at the beginning of the selection group.

$selectionDepth Permalink (): number

Returns the depth of the selection group.

If the selection is at the root level, returns 0.

If the selection is a portion of the numerator of a fraction which is at the root level, return 1. Note that in that case, the numerator would be the “selection group”.

$selectionIsCollapsed Permalink (): boolean

Checks if the selection is collapsed.

$setConfig Permalink (config: MathfieldConfig): void

$text Permalink (format?: OutputFormat): string

Returns a textual representation of the mathfield.

$typedText Permalink (text: string): void

Simulates a user typing the keys indicated by text.

getConfig Permalink (keys: keyof MathfieldConfig): any

getConfig Permalink (keys: string[]): MathfieldConfig

getConfig Permalink (keys: keyof MathfieldConfig | string[]): any | MathfieldConfig

module "mathfield"InsertOptionsPermalink

module "mathfield"OutputFormatPermalink

module "config"interface MathfieldHooksPermalink

These methods provide an opportunity to intercept or modify an action. Their return value indicate whether the default handling should proceed.

onKeystroke?: (sender: Mathfield, keystroke: string, ev: KeyboardEvent): boolean Permalink

A hook invoked when a keystroke is about to be processed.

• keystroke: a string describing the keystroke
• ev: the native keyboard event

Return false to stop the handling of the event.

onMoveOutOf?: (sender: Mathfield, direction: "forward" | "backward"): boolean Permalink

A hook invoked when keyboard navigation would cause the insertion point to leave the mathfield.

• direction indicates the direction of the navigation, either "forward" or "backward".

Return false to prevent the move, true to wrap around to the start of the field.

By default, the insertion point will wrap around.

onTabOutOf?: (sender: Mathfield, direction: "forward" | "backward"): boolean Permalink

A hook invoked when pressing tab (or shift-tab) would cause the insertion point to leave the mathfield.

direction indicates the direction of the navigation, either "forward" or "backward".

By default, the insertion point jumps to the next/previous focussable element.

module "config"interface MathfieldListenersPermalink

The methods provide a notification that an event is about to occur or has occured.

onBlur?: (sender: Mathfield): void Permalink

The mathfield has lost keyboard focus

onContentDidChange?: (sender: Mathfield): void Permalink

onContentWillChange?: (sender: Mathfield): void Permalink

onFocus?: (sender: Mathfield): void Permalink

The mathfield has gained keyboard focus

onModeChange?: (sender: Mathfield, mode: ParseMode): void Permalink

onReadAloudStatus?: (sender: Mathfield): void Permalink

onSelectionDidChange?: (sender: Mathfield): void Permalink

onSelectionWillChange?: (sender: Mathfield): void Permalink

onUndoStateDidChange?: UndoStateChangeListener Permalink

onUndoStateWillChange?: UndoStateChangeListener Permalink

onVirtualKeyboardToggle?: (sender: Mathfield, visible: boolean, keyboardElement: HTMLElement): void Permalink

module "config"EditingOptionsPermalink

module "config"InlineShortcutsOptionsPermalink

module "config"LayoutOptionsPermalink

module "config"LocalizationOptionsPermalink

module "config"MathfieldConfigPermalink

• namespace Namespace that is added to data- attributes to avoid collisions with other libraries.

It is empty by default.

The namespace should be a string of lowercase letters.

• onError An optional listener function that will be invoked when an error is encountered while parsing some Latex. This could be the initial value of the mathfield, a value inserted programmatically later, or through a user interaction (pasting in the mathfield for example). See ParserErrorCode for the list of possible errors.

• substituteTextArea A function that returns a focusable element that can be used to capture text input.

An (invisible) DOM element is used to capture the keyboard events. By default, this element is a <textarea> on desktop and a <span> on mobile devices, to prevent the device virtual keyboard from being displayed.

This function provides the option of substituting the DOM element used for keyboard capture.

Alternatively, the ID of a DOM element can be provided.

module "config"TextToSpeechOptionsPermalink

module "config"UndoStateChangeListenerPermalink

module "config"VirtualKeyboardOptionsPermalink

module "commands"SelectorPermalink

module "commands"SpeechScopePermalink

How much of the formula should be spoken:

module "shortcuts"InlineShortcutDefinitionPermalink

An inline shortcut can be specified as a simple string or as an object literal with additional options:

    config.inlineShortcuts = {
     half: '\\frac{1}{2}',
     in: {
         mode: 'math',
         after: 'space+letter+digit+symbol+fence',
         value: '\\in',
     },
 };

When using a string, the shortcut will apply in any mode, and regardless of the characters surrounding it.

When using an object literal the value key is required an indicate the shortcut substitution.

The mode key, if present, indicate which mode this shortcut will apply in, either 'math' or 'text'. If the key is not present the shortcut apply in all modes.

The 'after' key, if present, indicate in what context (surrounding characters) the shortcut will apply. One or more values can be specified, separated by a ‘+’ sign. If any of the values match, the shortcut will be applicable.

Possible values are:

module "core"interface StylePermalink

backgroundColor?: string Permalink

color?: string Permalink

cssClass?: string Permalink

cssId?: string Permalink

fontFamily?: string Permalink

fontSeries?: FontSeries Permalink

fontShape?: FontShape Permalink

fontSize?: string Permalink

letterShapeStyle?: "tex" | "french" | "iso" | "upright" | "auto" Permalink

mode?: ParseMode | string Permalink

variant?: Variant Permalink

variantStyle?: VariantStyle Permalink

module "core"FontSeriesPermalink

module "core"FontShapePermalink

module "core"MacroDefinitionPermalink

module "core"MacroDictionaryPermalink

A dictionary of LaTeX macros to be used to interpret and render the content.

For example:

mf.$setConfig({
macros: {
smallfrac: '^{#1}\\!\\!/\\!_{#2}',
},
});

The code above will support the following notation:

\smallfrac{5}{16}

module "core"ParseModePermalink

The mode that indicates how a portion of content is interpreted

module "core"ParserErrorCodePermalink

Error code passed to the ParserErrorListener function.

See MathfieldConfig, latexToMarkup, latexToMathML, latexToAST,

module "core"ParserErrorListenerPermalink

module "core"VariantPermalink

Variants indicate a stylistic alternate for some characters.

Typically, those are controlled with explicit commands, such as \mathbb{} or \mathfrak{}. This type is used with the applyStyle function to change the styling of a range of selected characters.

In mathematical notation these variants are used not only for visual presentation, but they may have semantic significance.

For example, the set ℂ should not be confused with the physical unit 𝖢 (Coulomb).

When rendered, these variants can map to some built-in fonts. Latex supports a limited set of characters. However, MathLive will map characters not supported by Latex fonts(double-stuck variant for digits for example) to a Unicode character (see Mathematical Alphanumeric Symbols on Wikipedia ).

normal is a synthetic variant that maps either to main (roman) or math (italic) depending on the symbol and the letterShapeStyle.

The math variant has italic characters as well as slightly different letter shape and spacing (a bit more space after the “f” for example), so it’s not completely equivalent to a main variant with italic variant style applied.

module "core"VariantStylePermalink

Some variants support stylistic variations.

Note that these stylistic variations support a limited set of characters, typically just uppercase and lowercase letters, and digits 0-9 in some cases.

module "model"interface ModelPermalink

mathfield: Mathfield Permalink