Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
create3000 committed Oct 31, 2018
1 parent b79e20d commit 8423e07
Showing 1 changed file with 29 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Expand Up @@ -83,39 +83,54 @@ Attributes of the X3DCanvas Tag
The HTML **X3DCanvas tag** defines the main content of the X3D document. The X3DCanvas tag has two attributes that define different behaviours. All of these attributes are optional.


### src
### cache

A String value with the URL that should be loaded on page load. If no src attribute is specified or the src attribute is empty an empty scene is displayed.
A Boolean value (true or false) to indicate whether files transferred over the internet should be cached on the local computer. The default value for the cache attribute is true. It works by appending „_={timestamp}“ to the GET parameters of every request.


### url
### contextMenu

A MFString value with urls that should be loaded on page load. If no url attribute is specified or the attribute is empty an empty scene is displayed. If both src and url attribute are specified the src attribute takes precedence.
A Boolean value (true or false) to indicate whether a context menu should be displayed on right click. The default value for the contextMenu attribute is true.


### splashScreen
### notifications

A Boolean value (true or false) to indicate whether the splash screen should be displayed. The default value for the splashScreen attribute is true. The display of Learn more about how HTML and X3D can operate together.the splash screen can also be toggled via the browser option »SplashScreen« in JavaScript. Call Browser.setBrowserOption(„SplashScreen“, booleanValue) to toggle the display of the splash screen.
A Boolean value (true or false) to indicate whether the notification bubble should be displayed. The default value for the notifications attribute is true.


### notifications
### onerror

A Boolean value (true or false) to indicate whether the notification bubble should be displayed. The default value for the notifications attribute is true.
Type: script code. This event is sent to an X3DCanvas element when an error occurs loading a scene.


### timings
### onload

A Boolean value (true or false) to indicate whether the browser timings bubble should be displayed if the context menu option is enabled. The default value for the timings attribute is true. This attribute changes the facility if browsers timings can be displayed, if browser timings are really displayed is in the hand of the user if he toggles the context menu option to true.
Type: script code. This event handler will be called on the X3DCanvas element when a scene has finished loading. This applies whether the scene is applied via the src attribute or when a scene is loaded or replaced by another world. If you change the scene, the event will fire again when the new scene loads. This event will not bubble up the element tree.


### contextMenu
### onshutdown

A Boolean value (true or false) to indicate whether a context menu should be displayed on right click. The default value for the contextMenu attribute is true.
Type: script code. This event handler will be called on the X3DCanvas element when a scene is unloaded or replaced by another world.


### cache
### src

A Boolean value (true or false) to indicate whether files transferred over the internet should be cached on the local computer. The default value for the cache attribute is true. It works by appending „_={timestamp}“ to the GET parameters of every request.
A String value with the URL that should be loaded on page load. If no src attribute is specified or the src attribute is empty an empty scene is displayed.


### splashScreen

A Boolean value (true or false) to indicate whether the splash screen should be displayed. The default value for the splashScreen attribute is true. The display of Learn more about how HTML and X3D can operate together.the splash screen can also be toggled via the browser option »SplashScreen« in JavaScript. Call Browser.setBrowserOption(„SplashScreen“, booleanValue) to toggle the display of the splash screen.


### timings

A Boolean value (true or false) to indicate whether the browser timings bubble should be displayed if the context menu option is enabled. The default value for the timings attribute is true. This attribute changes the facility if browsers timings can be displayed, if browser timings are really displayed is in the hand of the user if he toggles the context menu option to true.


### url

A MFString value with urls that should be loaded on page load. If no url attribute is specified or the attribute is empty an empty scene is displayed. If both src and url attribute are specified the src attribute takes precedence.


## Example
Expand Down

0 comments on commit 8423e07

Please sign in to comment.