Difference between revisions of "GM.getResourceUrl"

From GreaseSpot Wiki
Jump to navigationJump to search
m (Misc symmetry)
m (→‎Syntax: Corrected orphaned version link to point to Arantius' changes in the Version History)
Line 14: Line 14:
:Value: Function
:Value: Function
:Returns: String
:Returns: String
:Compatibility: [[Version_history#0.8.0|Greasemonkey 0.8.0+]]
:Compatibility: [[Version_history#0.8.20080609.0|Greasemonkey 0.8.0+]]


:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"
:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"

Revision as of 18:41, 3 December 2008

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_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