<viz:window>.displayHTML

Vizard 8 » Command Index » Vizard modules » viz » <viz:window>.displayHTML

8.0

<viz:window>.displayHTML

This command will display an HTML file on the screen

<viz:window>.displayHTML(
filename
pos = None	# Keyword argument
size = None	# Keyword argument
)

filename

Name of an HTML file or a URL

pos = None

If specified, this sets the position of the HTML window. The position corresponds to the upper left corner of the HTML window relative to the upper left corner of the graphics window.

If not specified, the HTML window will be centered in the graphics window.

size = None

If specified, this sets the size of the HTML window.

If not specified, the size will be set to 2/3 the size of the graphics window.

Remarks

The HTML file will cover the window and appear in the center. This is useful for displaying instructions to the user.

Note: Pressing F1 causes Vizard to automatically display a HTML page called <script>.html, where <script> is the name of your script. If this file is not found then Vizard will search for a file called 'vizhelp.html', if it is located in the current working directory. If no such files are located in that directory, then there is no effect to pressing F1.

Return Value

None

Example

viz.window.displayHTML('help.html')
viz.window.displayHTML('www.worldviz.com')