The Messages API allows the user to control the contents of the output message buffer intended for informing the user about the state of the visualization or for providing directions.
The output buffer will have been specified in the HTML section of the
document. It is defined as an empty paragraph of class
jsavoutput, with one of the following class options.
class="jsavoutput jsavline" indicates a small “line-style”
message buffer where typically each line overwrites the previous one.
class="jsavoutput jsavscroll" indicates a visible textbox with a
scrollbar. The textbox is only cleared when explicitly directed by a
Since this acts as a normal HTML paragraph,
optional standard parameters can be used such as
readonly="readonly" to make
the textbox unwriteable by the user, or to
override the default height and width.
Alternative way to specify where the output buffer element is to use the
output option when initializing the JSAV instance. The value
of the option should be a DOM element, CSS selector string, or a jQuery object.
Add the given message
msg to the message
output. The optional
can be an object whose properties specify the
color property is used (when
present) to change the color of the message.
Use would look something like:
When “line-style” message buffer is used, option
"preserve": true can be used to append the new message
after the previous one instead of clearing the buffer.
fill: <object> can be used to easily insert variable values
to the message. This feature is especially useful when the AV is being
translated to different languages. The message should contain a tag surrounded
by curly brackets where the value should be inserted. The object handed to the
fill option should map the different tags used in the message to their values.
The tags are replaced with regular expression, which means that the tags should
not contain characters such as
$ ^ . + -, or consist only of digits.
Fill option example:
msg is output as standard HTML, the style of
the message text can also be controlled by using HTML commands.
Returns: A JSAV object. Thus, this method may be chained with,
for example, the
Clear the contents of the output message buffer.
The message API will trigger a
jsav-message event on the JSAV
container whenever the output buffer content should change. You
can listen for this event to integrate more complex output behavior.