GM.getResourceUrl: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m Text replace - "[[Metadata_block" to "[[Metadata Block" |
simplify |
||
| Line 3: | Line 3: | ||
== Description == | == Description == | ||
Given a defined [[Metadata Block#.40resource|@resource]], this method returns it as a URL. | |||
Compatibility: [[Version_history#0.8.20080609.0|Greasemonkey 0.8.0+]] | |||
== Syntax == | == Syntax == | ||
{{Function|GM_getResourceURL|resourceName}} | |||
=== Arguments === | |||
; <code>resourceName</code> | |||
: <code>String</code> The name provided when the [[Metadata Block#.40resource|@resource]] was defined, follow that link for valid naming restrictions. | |||
=== Returns === | |||
<code>String</code>. | |||
A base64 encoded <code>data:</code> URI. | |||
: | |||
: | Note: This can be used anywhere a <code>data:</code> URI will work (E.G. <code><img></code> or <code><script></code>). | ||
This does not include <code><object></code> or <code><embed></code>. | |||
=== | === Raises === | ||
Throws an <code>Error</code> when the named resource does not exist. | |||
== Examples == | == Examples == | ||
<pre class='sample'> | <pre class='sample'> | ||
// ==UserScript== | // ==UserScript== | ||
// @resource logo http://www.example.com/logo.png | |||
// @resource | |||
// ==/UserScript== | // ==/UserScript== | ||
( | var img = document.createElement('img'); | ||
img.src = GM_getResourceURL("logo"); | |||
document.body.appendChild(img); | |||
</pre> | </pre> | ||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 21:50, 8 February 2010
Description
Given a defined @resource, this method returns it as a URL.
Compatibility: Greasemonkey 0.8.0+
Syntax
function GM_getResourceURL( resourceName )
Arguments
resourceNameStringThe name provided when the @resource was defined, follow that link for valid naming restrictions.
Returns
String.
A base64 encoded data: URI.
Note: This can be used anywhere a data: URI will work (E.G. <img> or <script>).
This does not include <object> or <embed>.
Raises
Throws an Error when the named resource does not exist.
Examples
// ==UserScript==
// @resource logo http://www.example.com/logo.png
// ==/UserScript==
var img = document.createElement('img');
img.src = GM_getResourceURL("logo");
document.body.appendChild(img);
