GM.getResourceUrl: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m Misc tweaks |
m Misc symmetry |
||
| Line 29: | Line 29: | ||
==== <code>resourceName</code> ==== | ==== <code>resourceName</code> ==== | ||
:Value: String | :Value: String | ||
:Usage: <code>'''resourceName''' = " | :Usage: <code>'''resourceName''' = "metadata_block_resourceName";</code> | ||
:* 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. | :* 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 |metadata block @resource]] key. After it is retrieved, it will be base64 encoded into the [http://www.ietf.org/rfc/rfc2397.txt "data" URL scheme], and returned upon completion of this API method. | :* This value is used in retrieval of the same-named resource specified in the corresponding [[Metadata_block |metadata block @resource]] key. After it is retrieved, it will be base64 encoded into the [http://www.ietf.org/rfc/rfc2397.txt "data" URL scheme], and returned upon completion of this API method. | ||
[[#top|top]] | [[#Syntax|back]]'' | [[#top|top]] | [[#Syntax|back]]'' | ||
Revision as of 11:00, 12 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_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.
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
})();
