GM.getResourceUrl: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (→Description) |
m (Notated a concern about the resourceName variable... note I extrapolated this variable name from the developer group when I created this article... so I didn't do it ;D) |
||
| Line 29: | Line 29: | ||
==== <code>resourceName</code> ==== | ==== <code>resourceName</code> ==== | ||
:Value: String | :Value: String | ||
:Usage: <code>'''resourceName''' = "metadata-resource-name";</code> | :Usage: <code>'''resourceName''' = "metadata-resource-name<sup>[[#Notes|[1]]]</sup>";</code> | ||
:* This value is used to retrieve the [[Metadata_block |metadata block @resource]] name URI which will be retrieved, base64 encoded into the data: URL scheme and returned upon completion of this API method. | :* This value is used to retrieve the [[Metadata_block |metadata block @resource]] name URI which will be retrieved, base64 encoded into the data: URL scheme and returned upon completion of this API method. | ||
| Line 59: | Line 59: | ||
== Notes == | == Notes == | ||
<sup>[[#resourceName|[1]]]</sup> While the variable name described here has hyphens in it, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent. | |||
[[#top|top]] | [[#top|top]] | ||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 09:15, 11 December 2007
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-resource-name[1]";
- This value is used to retrieve the metadata block @resource name URI which will be retrieved, base64 encoded into the data: URL scheme and returned upon completion of this API method.
Examples
// ==UserScript==
// @name I CAN HAS MOCHIKIT?
// @namespace http://youngpup.net/userscripts
// @description Simple library loading test which makes the Google logo pulsate.
// @include http://www.google.com/
// @require mochikit-packed.js
// @resource better-logo http://wiki.greasespot.net/skins/common/images/gm-wiki-logo.png
// ==/UserScript==
/* Go to http://www.google.com to see this in action. */
var logo = document.evaluate(
'/html/body/center/img', document, null, 9, null
).singleNodeValue;
logo.src = GM_getResourceURL("better-logo");
pulsate(logo);
Notes
[1] While the variable name described here has hyphens in it, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.
