GM.getResourceUrl

From GreaseSpot Wiki
Revision as of 01:59, 12 December 2007 by Marti (talk | contribs) (→‎<code>resourceName</code>: Some redundancy dumped)
Jump to navigationJump to search

Template:Underscore


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.

Examples | Notes

Syntax

GM_getResourceURL( resourceName )

Value: Function
Returns: String
Compatibility: Greasemonkey 0.8.0+
Parameters
Properties
resourceName

top

Properties


resourceName

Value: String
Usage: resourceName = "metadata-resource-name[1]";
  • 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.

top | back

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);

top

Notes

[1] While the variable names here are non-semantic, it is assumed that it should be compatible with JavaScript variable naming conventions and XML/CSS naming conventions to help keep things consistent.

top