GM.getResourceUrl: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
No edit summary |
m Text replace - "{{Core samp" to "{{Samp" |
||
Line 35: | Line 35: | ||
== Examples == | == Examples == | ||
{{ | {{Samp |1=<pre style="border: none; margin: inherit;"> | ||
// ==UserScript== | // ==UserScript== | ||
// @name My Script | // @name My Script |
Revision as of 19:36, 3 February 2010
Description
This API method loads an external resource, such as an image, and returns the string containing the base64 encoded data: URL scheme for use in the DOM.
Syntax
GM_getResourceURL( resourceName )
- Value: Function
- Returns: String
- Compatibility: Greasemonkey 0.8.0+
Parameters Properties resourceName
- All properties are optional except resourceName.
Properties
resourceName
- Value: String
- Usage:
resourceName = "metadata_block_resourceName";
- While the resourceName is non-semantic, it is suggested that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
- This value is used in retrieval of the same-named resource specified in the corresponding metadata block @resource key. After it is retrieved, it will be base64 encoded into the "data" URL scheme, and returned upon completion of this API method.