Skip to content

Support rendering tex even when global MathJax rendering mode is not SVG #2994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 1, 2018
Merged

Support rendering tex even when global MathJax rendering mode is not SVG #2994

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
951523d
Support rendering tex even when global MathJax rendering mode is not SVG
jonmmease Sep 11, 2018
1dd4fd3
Call final MathJax.Hub.setRenderer directly (not with Queue)
jonmmease Sep 12, 2018
9569648
Don't call setRenderer if renderer is already SVG
jonmmease Sep 12, 2018
8d610e7
Create tmpDiv on the `Queue` just before Typesetting
jonmmease Sep 12, 2018
6cba8e3
Perform MathJax.Hub.Config before each rendering call, and restore co…
jonmmease Sep 12, 2018
b0628b0
A compromise solution
jonmmease Sep 13, 2018
41f7747
Set MathJax.Hub.processSectionDelay to 0 to fix jumping behavior in M…
jonmmease Sep 14, 2018
b02ba17
Add support for a new global window.PlotlyConfig configuration object
jonmmease Sep 14, 2018
6a572fd
Add README description of the new window.PlotlyConfig.MathJaxConfig p…
jonmmease Sep 14, 2018
57e32ba
Move new MathJax instructions to `tasks/stats.js`
jonmmease Sep 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions dist/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@ or the un-minified version as:

You can grab the relevant MathJax files in `./dist/extras/mathjax/`.

By default, plotly.js will modify the global MathJax configuration on load.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dist/README.md is a generated file, you'll need to move this block to

https://github.com/plotly/plotly.js/blob/master/tasks/stats.js

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 57e32ba

This can lead to undesirable behavior if plotly.js is loaded alongside
other libraries that also rely on MathJax. To disable this global configuration
process, set the `MathJaxConfig` property to `'local'` in the `window.PlotlyConfig`
object. This property must be set before the plotly.js script tag, for example:

```html
<script>
window.PlotlyConfig = {MathJaxConfig: 'local'}
</script>
<script src="plotly.min.js"></script>
```

### To include localization

Plotly.js defaults to US English (en-US) and includes British English (en) in the standard bundle.
Expand Down
22 changes: 13 additions & 9 deletions src/fonts/mathjax_config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,20 @@
if(typeof MathJax !== 'undefined') {
exports.MathJax = true;

MathJax.Hub.Config({
messageStyle: 'none',
skipStartupTypeset: true,
displayAlign: 'left',
tex2jax: {
inlineMath: [['$', '$'], ['\\(', '\\)']]
}
});
var globalConfig = (window.PlotlyConfig || {}).MathJaxConfig !== 'local';

if(globalConfig) {
MathJax.Hub.Config({
messageStyle: 'none',
skipStartupTypeset: true,
displayAlign: 'left',
tex2jax: {
inlineMath: [['$', '$'], ['\\(', '\\)']]
}
});
MathJax.Hub.Configured();
}

MathJax.Hub.Configured();
} else {
exports.MathJax = false;
}
60 changes: 52 additions & 8 deletions src/lib/svg_text_utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,48 @@ function cleanEscapesForTex(s) {
}

function texToSVG(_texString, _config, _callback) {
var randomID = 'math-output-' + Lib.randstr({}, 64);
var tmpDiv = d3.select('body').append('div')
.attr({id: randomID})
.style({visibility: 'hidden', position: 'absolute'})
.style({'font-size': _config.fontSize + 'px'})
.text(cleanEscapesForTex(_texString));

MathJax.Hub.Queue(['Typeset', MathJax.Hub, tmpDiv.node()], function() {

var originalRenderer,
originalConfig,
originalProcessSectionDelay,
tmpDiv;

MathJax.Hub.Queue(
function() {
originalConfig = Lib.extendDeepAll({}, MathJax.Hub.config);

originalProcessSectionDelay = MathJax.Hub.processSectionDelay;
if(MathJax.Hub.processSectionDelay !== undefined) {
// MathJax 2.5+
MathJax.Hub.processSectionDelay = 0;
}

return MathJax.Hub.Config({
messageStyle: 'none',
tex2jax: {
inlineMath: [['$', '$'], ['\\(', '\\)']]
},
displayAlign: 'left',
});
},
function() {
// Get original renderer
originalRenderer = MathJax.Hub.config.menuSettings.renderer;
if(originalRenderer !== 'SVG') {
return MathJax.Hub.setRenderer('SVG');
}
},
function() {
var randomID = 'math-output-' + Lib.randstr({}, 64);
tmpDiv = d3.select('body').append('div')
.attr({id: randomID})
.style({visibility: 'hidden', position: 'absolute'})
.style({'font-size': _config.fontSize + 'px'})
.text(cleanEscapesForTex(_texString));

return MathJax.Hub.Typeset(tmpDiv.node());
},
function() {
var glyphDefs = d3.select('body').select('#MathJax_SVG_glyphs');

if(tmpDiv.select('.MathJax_SVG').empty() || !tmpDiv.select('svg').node()) {
Expand All @@ -183,6 +217,16 @@ function texToSVG(_texString, _config, _callback) {
}

tmpDiv.remove();

if(originalRenderer !== 'SVG') {
return MathJax.Hub.setRenderer(originalRenderer);
}
},
function() {
if(originalProcessSectionDelay !== undefined) {
MathJax.Hub.processSectionDelay = originalProcessSectionDelay;
}
return MathJax.Hub.Config(originalConfig);
});
}

Expand Down