Difference between revisions of "GM.getResourceUrl"

From GreaseSpot Wiki
Jump to navigationJump to search
m (Misc tweaks)
Line 29: Line 29:
==== <code>resourceName</code> ====
==== <code>resourceName</code> ====
:Value: String
:Value: String
:Usage: <code>'''resourceName''' = "metadata-resource-name<sup>[[#Notes|[1]]]</sup>";</code>
:Usage: <code>'''resourceName''' = "metadata_resource_name";</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.
:* 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.


Line 59: Line 59:


== Notes ==
== Notes ==
<sup>[[#resourceName|[1]]]</sup> 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|top]]
[[#top|top]]


[[Category:API_Reference|G]]
[[Category:API_Reference|G]]

Revision as of 06:55, 12 December 2007

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";
  • 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