FormulaNode¶

Overview¶

Displays a LaTeX-style mathematical formula with KaTeX.

IMPORTANT: Using this will require including the KaTeX preloads, and may require generation of a custom bundle for the simulation. Currently two preloads will be needed, one for the CSS/font-files, and one for the JS, e.g.: - katex-0.11.0-css-all.js - katex-0.11.0.min.js

IMPORTANT: See packageKatexCSS.js for more information, particularly about generating a particular customized preload file that includes only the font-files needed.

@author Jonathan Olson <jonathan.olson@colorado.edu> @author Saurabh Totey

Class FormulaNode¶

import { FormulaNode } from 'scenerystack/scenery-phet';

Constructor¶

new FormulaNode( formula, options )¶

Instance Methods¶

calculateDOMBounds()¶

We need to have a fairly custom bounds measurement method, since it's a block-level element. @protected @override

@returns {Bounds2}

setFormula( formula )¶

Updates the formula to display. It should be a string, formatted with the general LaTeX style. Particular function support is available at https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX. @public

@param {string} formula - The particular formula to display.

getFormula()¶

@public

@returns {string} - The string for the formula that is currently displayed.

setDisplayMode( mode )¶

Updates the {boolean} display mode. @private

@param {boolean} mode If true, the formula will be displayed in the display-mode ($$ in LaTeX) style, which is typically separated from other text, and on its own line. If false, the formula will be displayed in the 'inline math' ($ in LaTeX) style, which is typically meant to be embedded within flowed text.

getDisplayMode()¶

Whether the displayMode is currently true. @public

@returns {boolean}

updateFormula()¶

Updates the displayed formula and its bounds. @private

Source Code¶

See the source for FormulaNode.js in the scenery-phet repository.