HTML5 - JavaScript functions: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Clarification and example techniques for accessing getUserData())
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Experimental}}
{{Experimental}}
A special class is available to javascript code running inside html5 pages. It allows access to a few values and functions. 


The class itself is static and is called MapTool.  
A special class is available to JavaScript code running inside HTML5 pages. It allows access to a few values and functions. 
 
The class itself is static and is called {{code|MapTool}}.  


==== Functions ====
==== Functions ====


* getName() - Returns the name of the frame or dialog.  
* {{code|MapTool.log()}} - Anything passed to this method will be sent to the chat window, just like a {{func|broadcast}} to {{code|self}}.  Additionally, {{code|console.log()}} will be redirected to the chat window.
* getKind() - Returns the kind of the frame or dialog (i.e. frame5 or dialog5).
 
* getuserData() - Returns the data passed to the frame via the "Value" option.  
* {{code|MapTool.getName()}} - Returns the name of the panel.
* log() - Anything passed to this method will be sent to the chat window, just like a broadcast to self.
 
* {{code|MapTool.getKind()}} - Returns the kind of panel the JavaScript is inside of: {{func|frame5}} or {{func|dialog5}}.
 
* {{code|MapTool.getUserData()}} - Returns a {{code|Promise}} representing the data passed to the panel via the {{code|value}} option.
 
<syntaxhighlight lang="mtmacro">
[html.frame5("Example Dialog",
            "lib://myAddon/index.html",
            'value={"key": "some arbitrary data"}')]
</syntaxhighlight>
 
The variable {{code|value}} is injected into the JavaScript as a global variable (ie. as a property of the {{code|window}} object), such that it can be accessed as either {{code|window.value}} or just {{code|value}} after the {{code|window}}'s {{code|load}} event is triggered.
 
<syntaxhighlight lang="javascript" line>
// MapTool creates an implied assignment to 'value' here, but
// it doesn't resolve until the document is finished loading...
 
// Technique #1
window.addEventListener("load", function() {
    MapTool.getUserData().then(
        v => console.log(`Method 1\n${MapTool.getKind()}, data: ${v}`)
    );
});


// Technique #2
let v = await MapTool.getUserData();
console.log(`Method 2\n${MapTool.getKind()}, data: ${v}`)
</syntaxhighlight>


[[Category:HTML5 javascript]]
It is not defined which resolves first, the {{code|Promise}} from {{code|getUserData()}} or the {{code|window}}'s {{code|load}} event.  DO NOT rely on any particular order.
[[Category:HTML5 JavaScript]]

Latest revision as of 04:19, 23 April 2024

 This article describes a feature or macro function that is experimental and may be subject to change.

A special class is available to JavaScript code running inside HTML5 pages. It allows access to a few values and functions.

The class itself is static and is called MapTool.

Functions

  • MapTool.log() - Anything passed to this method will be sent to the chat window, just like a broadcast() to self. Additionally, console.log() will be redirected to the chat window.
  • MapTool.getName() - Returns the name of the panel.
  • MapTool.getKind() - Returns the kind of panel the JavaScript is inside of: frame5() or dialog5().
  • MapTool.getUserData() - Returns a Promise representing the data passed to the panel via the value option.
[html.frame5("Example Dialog",
             "lib://myAddon/index.html",
             'value={"key": "some arbitrary data"}')]

The variable value is injected into the JavaScript as a global variable (ie. as a property of the window object), such that it can be accessed as either window.value or just value after the window's load event is triggered.

// MapTool creates an implied assignment to 'value' here, but
// it doesn't resolve until the document is finished loading...

// Technique #1
window.addEventListener("load", function() {
    MapTool.getUserData().then(
        v => console.log(`Method 1\n${MapTool.getKind()}, data: ${v}`)
    );
});

// Technique #2
let v = await MapTool.getUserData();
console.log(`Method 2\n${MapTool.getKind()}, data: ${v}`)

It is not defined which resolves first, the Promise from getUserData() or the window's load event. DO NOT rely on any particular order.