GM.getResourceUrl

Greasemonkey Manual
Using Greasemonkey
Installing Scripts
Monkey Menu
Getting Help
User Script Authoring
Editing
Environment
API

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

• All properties are optional except resourceName.

top

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.

top | back

Examples

// ==UserScript==
// @name          My Script
// @namespace     http://www.example.com/gmscripts/
// @description   Scripting is fun
// @include       http://www.example.com/*
// @resource      fooLogo http://www.example.com/logo.png
// ==/UserScript==

(function()
{
  // some code

  var fooLogo = GM_getResourceURL("fooLogo");

  // some code

})();

top

Notes

top