JavaScript API: addImage

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addMathEquation

PREMIUM

TRIAL / ADVANCED

Adds math equation.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to addMathEquation.

Description

addMathEquation (options: Element.OptionsMath): this

interface OptionsMath {
    /** Math equation */
    equation: string;
    /** Math type */
    type: "omml";
}

Code samples

Example #1

import { CreateDocx, OptionsMath, OptionsText, WordFragment } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// add a math equation
docx.addText("A math equation:");
let optionsMath: OptionsMath = {
    equation:
        "<m:oMathPara><m:oMath><m:r><m:t>∪±∞=~×</m:t></m:r></m:oMath></m:oMathPara>",
    type: "omml",
};
docx.addMathEquation(optionsMath);

// add a math equation as inline content
optionsMath = {
    equation:
        "<m:oMathPara><m:oMath><m:r><m:t>∪±∞=~×</m:t></m:r></m:oMath></m:oMathPara>",
    type: "omml",
};
const wordFragmentMath = new WordFragment();
wordFragmentMath.addMathEquation(optionsMath);
const text: OptionsText = {
    text: "The same equation inline: ",
};
docx.addText([text, wordFragmentMath]);

// add a math equation with styles
optionsMath = {
    equation:
        '<m:oMathPara><m:oMathParaPr><m:jc m:val="left"/></m:oMathParaPr><m:oMath><m:r><w:rPr><w:color w:val="FF0000"/><w:sz w:val="44"/><w:szCs w:val="44"/></w:rPr><m:t>∪±∞=~×</m:t></m:r></m:oMath></m:oMathPara>',
    type: "omml",
};
docx.addText("A math equation with styles:");
docx.addMathEquation(optionsMath);

docx.save().then(contents => {
    fs.writeFileSync("addMathEquation_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 16.0:
- new method.