com.wiris.quizzes.api.ui

Interface MathViewer

public interface MathViewer

Helper class for displaying MathML and graphic content. In some technology or integration contexts it may be preferable to use the MathType Plugin to display MathML content. See http://www.wiris.com/plugins/docs for more information.

Method Summary

Modifier and Type	Method and Description
void	filter(java.lang.Object root) Render all the MathML expressions and plot all the constructions inside a HTML page.
void	filterConstructions(java.lang.Object root) Plot all the Graph constructions inside a HTML page.
void	filterMathML(java.lang.Object root) Render all the MathML expressions inside a HTML page.
java.lang.Object	graph(java.lang.String construction) Use Wiris Graph to create a live view of the construction, presented in the GeometryFile format.
java.lang.Object	graph(java.lang.String construction, java.lang.String initialContent)
java.lang.Object	plot(java.lang.String construction) Draw a construction, presented in the GeometryFile format, with Wiris Graph.
java.lang.Object	plot(java.lang.String construction, java.lang.String width, java.lang.String height) Same as plot(String) but allows customization of the plotter dimensions.
java.lang.Object	render(java.lang.String mathml) Draw a MathML expression using MathType so it can be displayed.
java.lang.Object	renderCorrectAnswer(QuestionInstance instance, Slot slot, AuthorAnswer authorAnswer) Render the value of the correct answer contained in the given author answer, using the syntax of the given slot.
java.lang.Object	thumbnail(java.lang.String construction) Does the same as then plot(String) function but the resulting plot has a reduced image that acts as a thumbnail of the actual plot, rather than being full-scale.

Method Detail

renderCorrectAnswer

java.lang.Object renderCorrectAnswer(QuestionInstance instance,
                                     Slot slot,
                                     AuthorAnswer authorAnswer)

Render the value of the correct answer contained in the given author answer, using the syntax of the given slot. If the author answer contains variables that could be expanded using the data in the question instance, expand them. This is a helper function that calls either render(String) or plot(String) depending on whether Slot.getSyntax() is SyntaxName.MATH or SyntaxName.GRAPHIC.

Returns:

An HTML element in JavaScript.

Since:

4.1.0.

render

java.lang.Object render(java.lang.String mathml)

Draw a MathML expression using MathType so it can be displayed.

Returns:

An HTML element in JavaScript.

plot

java.lang.Object plot(java.lang.String construction)

Draw a construction, presented in the GeometryFile format, with Wiris Graph. Only available in JavaScript.

Parameters:

construction - A construction in the GeometryFile format.

Returns:

A HTML element containing the canvas with the plotter. This element does only contain the canvas with the plot. It does not allow the user to perform any actions such as zoom in or out, animate the construction or to pan over the it.

See Also:

graph(String), thumbnail(String), plot(String, String, String)

plot

java.lang.Object plot(java.lang.String construction,
                      java.lang.String width,
                      java.lang.String height)

Same as plot(String) but allows customization of the plotter dimensions.

Parameters:

width - The desired width, in pixels.

height - The desired height, in pixels.

Since:

4.3.0

thumbnail

java.lang.Object thumbnail(java.lang.String construction)

Does the same as then plot(String) function but the resulting plot has a reduced image that acts as a thumbnail of the actual plot, rather than being full-scale.

See Also:

plot(String), graph(String)

graph

java.lang.Object graph(java.lang.String construction)

Use Wiris Graph to create a live view of the construction, presented in the GeometryFile format. This allows the user to zoom in or out, to animate the construction or to pan over it. Only available in JavaScript.

Parameters:

construction - A construction in the GeometryFile format.

Returns:

A HTML element containing a live graph with the given construction.

See Also:

plot(String), graph(String)

graph

java.lang.Object graph(java.lang.String construction,
                       java.lang.String initialContent)

filter

void filter(java.lang.Object root)

Render all the MathML expressions and plot all the constructions inside a HTML page. It calls the methods filterMathML(java.lang.Object) and filterConstructions(java.lang.Object). Only available in JavaScript.

Parameters:

root - The HTML document to be rendered.

filterMathML

void filterMathML(java.lang.Object root)

Render all the MathML expressions inside a HTML page. Only available in JavaScript.

Parameters:

root - The HTML document to be rendered.

filterConstructions

void filterConstructions(java.lang.Object root)

Plot all the Graph constructions inside a HTML page. Only available in JavaScript.

Parameters:

root - The HTML document to be rendered.