Merge pull request #252 from mathjax/issue219

[main] add option for returning dom objects

Author: pkra

lib/main.js

@@ -54,9 +54,12 @@ var defaults = {
   xmlns: "mml",                   // the namespace to use for MathML
 
   html: false,                    // return HTML output?
+  htmlNode: false,             // DOM element for HTML output?
   css: false,                     // return CSS for HTML output?
   mml: false,                     // return mml output?
+  mmlNode: false,              // DOM element for MML output?
   svg: false,                     // return svg output?
+  svgNode: false,              // DOM element for SVG output?
 
   speakText: false,               // add spoken annotations to svg output?
   speakRuleset: "mathspeak",      // set speech ruleset (default (chromevox rules), mathspeak)
@@ -517,9 +520,12 @@ function AddError(message,nopush) {
 //  into account)
 //
 function GetMML(result) {
-  if (!data.mml && !data.speakText && !data.semantic) return;
+  if (!data.mml && !data.mmlNode && !data.speakText && !data.semantic) return;
   var jax = MathJax.Hub.getAllJax()[0];
-  try {result.mml = jax.root.toMathML('',jax)} catch(err) {
+  try {
+    if (data.mml) result.mml = jax.root.toMathML('',jax);
+    if (data.mmlNode) result.mmlNode = jsdom(result.mml).body.firstChild;
+  } catch(err) {
     if (!err.restart) {throw err;} // an actual error
     return MathJax.Callback.After(window.Array(GetMML,result),err.restart);
   }
@@ -557,7 +563,7 @@ function GetSemantic(result) {
 //  Create HTML and CSS output, if requested
 //
 function GetHTML(result) {
-  if (!data.html) return;
+  if (!data.html && !data.htmlNode) return;
   var jax = MathJax.Hub.getAllJax()[0]; if (!jax) return;
   var script = jax.SourceElement(), html = script.previousSibling;
 
@@ -584,15 +590,16 @@ function GetHTML(result) {
     // otherwise (inline-mode) the frame is the root element
     html.removeAttribute("id");
   }
-  result.html = html.outerHTML;
+  if (data.html) result.html = html.outerHTML;
+  if (data.htmlNode) result.htmlNode = html;
   if (data.css) result.css = CHTMLSTYLES;
 }
 
 //
 //  Create SVG output, if requested
 //
 function GetSVG(result) {
-  if (!data.svg) return;
+  if (!data.svg && !data.svgNode) return;
   var jax = MathJax.Hub.getAllJax()[0]; if (!jax) return;
   var script = jax.SourceElement(),
       svg = script.previousSibling.getElementsByTagName("svg")[0];
@@ -613,22 +620,24 @@ function GetSVG(result) {
     svg.insertBefore(node,svg.firstChild);
   }
 
-  //
-  //  SVG data is modified to add linebreaks for readability,
-  //  and to put back the xlink namespace that is removed in HTML5
-  //
-  var svgdata = svg.outerHTML.replace(/><([^/])/g,">\n<$1")
-                             .replace(/(<\/[a-z]*>)(?=<\/)/g,"$1\n")
-                             .replace(/(<(?:use|image) [^>]*)(href=)/g,' $1xlink:$2');
+  if (data.svg){
+    //
+    //  SVG data is modified to add linebreaks for readability,
+    //  and to put back the xlink namespace that is removed in HTML5
+    //
+    var svgdata = svg.outerHTML.replace(/><([^/])/g,">\n<$1")
+                               .replace(/(<\/[a-z]*>)(?=<\/)/g,"$1\n")
+                               .replace(/(<(?:use|image) [^>]*)(href=)/g,' $1xlink:$2');
 
-  //
-  //  Add the requested data to the results
-  //
-  result.svg = svgdata;
+    //
+    //  Add the requested data to the results
+    //
+    result.svg = svgdata;
+  }
+  if (data.svgNode) result.svgNode = svg;
   result.width = svg.getAttribute("width");
   result.height = svg.getAttribute("height");
   result.style =  svg.style.cssText;
-
 }
 
 /********************************************************************/

test/issue219.js

@@ -0,0 +1,26 @@
+var tape = require('tape');
+var mjAPI = require("../lib/main.js");
+var jsdom = require('jsdom').jsdom;
+
+tape('Basic Check: pass jsdom object to output', function(t) {
+  t.plan(3);
+
+  mjAPI.start();
+  var tex = 'x';
+
+  mjAPI.typeset({
+    math: tex,
+    format: "TeX",
+    html: true,
+    htmlNode: true,
+    svg: true,
+    svgNode: true,
+    mml: true,
+    mmlNode: true
+  }, function(data) {
+    var window = jsdom().defaultView;
+    t.ok(data.htmlNode instanceof window.HTMLElement, 'htmlNode is an HTMLElement');
+    t.ok(data.svgNode instanceof window.HTMLElement, 'svgNode is an HTMLElement');
+    t.ok(data.mmlNode instanceof window.HTMLElement, 'mmlNode is an HTMLElement');
+  });
+});