LaTeX math formulas rendering | Python via .NET

Rendering a LaTeX math formula to PNG

If needed, take a look at the API reference section for this topic. In fact, the best way to demonstrate the LaTeX math formula rendering feature is to start with an example. Here it is:

Set ASPOSE_TEX_OUTPUT_DIR to your output directory, or use the default output folder. All LaTeX input is included in the examples; no external input files are needed. Apply a license first as described in Licensing.

# Render a highlighted LaTeX math formula to PNG.
import os
from pathlib import Path
from aspose.pydrawing import Color
from aspose.tex.features import PngMathRenderer, PngMathRendererOptions

# Set an output directory, or use the default output folder.
output_dir = Path(os.environ.get("ASPOSE_TEX_OUTPUT_DIR", "output")).resolve()
output_dir.mkdir(parents=True, exist_ok=True)

# Create rendering options setting the image resolution to 150 dpi.
options = PngMathRendererOptions()
options.resolution = 150
# Specify the preamble.
options.preamble = r"""\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{color}"""
# Specify the scaling factor 300%.
options.scale = 3000
# Leave space around the rendered fragment.
options.margin = 5
# Specify the foreground color.
options.text_color = Color.black
# Specify the background color.
options.background_color = Color.white
# Specify whether to show the terminal output on the console or not.
options.show_terminal = False

# Create binary streams for the rendering log and formula image.
with (output_dir / "math-formula.png.log").open("wb") as log_stream, \
        (output_dir / "math-formula.png").open("wb") as stream:
    options.log_stream = log_stream
    # Run rendering.
    size = PngMathRenderer().render(r"""\begin{equation*}
e^x = x^{\color{red}0} + x^{\color{red}1} + \frac{x^{\color{red}2}}{2} + \frac{x^{\color{red}3}}{6} + \cdots = \sum_{n\geq 0} \frac{x^{\color{red}n}}{n!}
\end{equation*}""", stream, options)

# Show other results.
print(options.error_report or "No rendering errors.")
print()
print(f"Size: {size.width}x{size.height}")

Let’s get to the details. Firstly, we initiate a rendering options object, similar to the TeX/LaTeX typesetting, which includes the specification for the desired output image resolution.

Next, we specify the preamble. The default preamble is:

\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}

which offers enhanced support for mathematical formulas compared to standard LaTeX. For instance, you can include the color package to customize the highlighting in the formula, as demonstrated in the provided code example.

Then we set scale = 3000 for 300% scaling and margin = 5 to leave space around the rendered fragment. The PNG example uses resolution = 150 DPI.

The next two options determine the foreground and background colors. Any parts of the formula that are not affected by the custom highlighting will be displayed in the text_color color.

The example assigns a binary file stream to log_stream, saving the rendering log as math-formula.png.log beside math-formula.png. Both streams are closed automatically by the with statement.

The show_terminal option controls terminal output in the console. These examples set it to False; the log is still written to the file.

The actual rendering process is carried out by the MathRenderer.render() method, which returns the size of the formula in points.

The second argument is the binary output stream opened for the image. The third argument supplies the rendering options.

And finally, the MathRenderer.render() method is invoked, with the options being passed as the third argument. The LaTeX code of the formula is provided as the first argument.

The final lines print the rendering error report, or No rendering errors. when it is empty, followed by the width and height in points.

Here is the result of the rendering.

This represents the most common and broad application of the LaTeX math formula rendering functionality.

You can also explore the free web app, which utilizes the implemented feature of the Aspose.TeX for .NET API.

Rendering a LaTeX math formula to SVG

Similarly, we can convert a LaTeX math formula into SVG format using the same approach.

# Render a highlighted LaTeX math formula to SVG.
import os
from pathlib import Path
from aspose.pydrawing import Color
from aspose.tex.features import SvgMathRenderer, SvgMathRendererOptions

# Set an output directory, or use the default output folder.
output_dir = Path(os.environ.get("ASPOSE_TEX_OUTPUT_DIR", "output")).resolve()
output_dir.mkdir(parents=True, exist_ok=True)

# Create rendering options.
options = SvgMathRendererOptions()
# Specify the preamble.
options.preamble = r"""\usepackage{amsmath}
\usepackage{amsfonts}
\usepackage{amssymb}
\usepackage{color}"""
# Specify the scaling factor 300%.
options.scale = 3000
# Leave space around the rendered fragment.
options.margin = 5
# Specify the foreground color.
options.text_color = Color.black
# Specify the background color.
options.background_color = Color.white
# Specify whether to show the terminal output on the console or not.
options.show_terminal = False

# Create binary streams for the rendering log and formula image.
with (output_dir / "math-formula.svg.log").open("wb") as log_stream, \
        (output_dir / "math-formula.svg").open("wb") as stream:
    options.log_stream = log_stream
    # Run rendering.
    size = SvgMathRenderer().render(r"""\begin{equation*}
e^x = x^{\color{red}0} + x^{\color{red}1} + \frac{x^{\color{red}2}}{2} + \frac{x^{\color{red}3}}{6} + \cdots = \sum_{n\geq 0} \frac{x^{\color{red}n}}{n!}
\end{equation*}""", stream, options)

# Show other results.
print(options.error_report or "No rendering errors.")
print()
print(f"Size: {size.width}x{size.height}")

This example creates math-formula.svg and its rendering log, math-formula.svg.log, in the same output directory.

The differences are:

• Instead of using the PngMathRendererOptions class, we utilize the SvgMathRendererOptions class.
• We don’t specify resolution.
• Instead of using the PngMathRenderer class, we use the SvgMathRenderer class.

Here is the result:

You can also explore the free web app, which utilizes the implemented feature of the Aspose.TeX for .NET API.