JSON API - addMathEquation

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addMathEquation

PREMIUM

TRIAL / ADVANCED

Inserts a math equation in OMML or MathML format.

Note

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

JSON data

{
    "equation": "string",
    "type": "string",
    "options": {
        "align": "string",
        "bold": boolean,
        "color": "string",
        "fontSize": number,
        "italic": boolean,
        "underline": "string"
    }
}

Key	Description
equation	The math equation in OMML or MathML format
type	The equation type: omml or mathml
align	left, center, right
bold	Bold style
color	ffffff, ff0000...
fontSize	8, 9, 10...
italic	Italic style
underline	single...

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_math_equation",
            "actions": [
                {
                    "action": "addMathEquation",
                    "data": {
                        "equation": "<m:oMathPara><m:oMath><m:r><m:t>∪±∞=~×</m:t></m:r></m:oMath></m:oMathPara>",
                        "type": "omml"
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "We write a math equation using OMML (the native Word XML standard for math equations):"
            }
        },
        {
            "action": "addMathEquation",
            "data": {
                "equation": "<m:oMathPara><m:oMath><m:r><m:t>∪±∞=~×</m:t></m:r></m:oMath></m:oMathPara>",
                "type": "omml"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": [
                    { "text": "The same equation inline: " },
                    { "text": "wf_math_equation" }
                ]
            }
        }
    ]
}

Example #2

{
    "wordfragments": [
        {
            "name": "wf_math_equation",
            "actions": [
                {
                    "action": "addMathEquation",
                    "data": {
                        "equation": "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><mrow><mi>A</mi><mo>=</mo><mfenced open=\"[\" close=\"]\"><mtable><mtr><mtd><mi>x</mi></mtd><mtd><mn>2</mn></mtd></mtr><mtr><mtd><mn>3</mn></mtd><mtd><mi>w</mi></mtd></mtr></mtable></mfenced></mrow></math>",
                        "type": "mathml"
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "We write a math equation using MathML:"
            }
        },
        {
            "action": "addMathEquation",
            "data": {
                "equation": "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"><mrow><mi>A</mi><mo>=</mo><mfenced open=\"[\" close=\"]\"><mtable><mtr><mtd><mi>x</mi></mtd><mtd><mn>2</mn></mtd></mtr><mtr><mtd><mn>3</mn></mtd><mtd><mi>w</mi></mtd></mtr></mtable></mfenced></mrow></math>",
                "type": "mathml"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": [
                    { "text": "The same equation inline: " },
                    { "text": "wf_math_equation" }
                ]
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.