Timemap.js v.2.0.1

Class TimeMap.loaders.georss

Extends:
TimeMap.loaders.xml
Requires:
loaders/xml.js
param.js
Defined in:
georss.js
See:
GeoRSS Example

GeoRSS loader: Load GeoRSS feeds.

Parsing is complicated by the diversity of GeoRSS formats; this parser handles:

and looks for geographic information in the following formats:

At the moment, this only supports points, polygons, polylines; boxes may be added at some later point.


TimeMap.init({
    datasets: [
        {
            title: "GeoRSS Dataset",
            type: "georss", // Data to be loaded in GeoRSS
            options: {
                url: "mydata.rss" // GeoRSS file to load - must be a local URL
            }
        }
    ],
    // etc...
});

Constructor

TimeMap.loaders.georss(options)

Static Methods

Method
TimeMap.loaders.georss.parse(node)
Static function to parse GeoRSS

Fields

Field
Inherited from TimeMap.loaders.xml
Additional parameters to load
Inherited from TimeMap.loaders.remote
opts :{String}
Object to hold optional settings.
Inherited from TimeMap.loaders.base
scrollTo :{String|Date}
Date to scroll the timeline to on load

Methods

Method
Inherited from TimeMap.loaders.base
cancel()
Cancel the callback function for this loader.
Inherited from TimeMap.loaders.base
getCallback(dataset, callback)
Get a callback function that can be cancelled.
Inherited from TimeMap.loaders.base
getCallbackName(dataset, callback)
Get the name of a callback function that can be cancelled.
Inherited from TimeMap.loaders.xml
load(dataset, callback)
Load function for remote XML files.
parse(node)
Static function to parse GeoRSS
Inherited from TimeMap.loaders.xml
parseExtra(config, node)
Parse any extra tags that have been specified into the config object
Inherited from TimeMap.loaders.base
Function to call on data object before loading
Inherited from TimeMap.loaders.base
Function to call on a single item data object before loading
Class Detail
TimeMap.loaders.georss(options)
Parameters (optional)
options {Object} All options for the loader:
options.url {String} URL of GeoRSS file to load (NB: must be local address)
options[...] {mixed} Other options (see TimeMap.loaders.xml)
Static Method Details
TimeMap.loaders.georss.parse(node) :{TimeMapItem[]}
Static function to parse GeoRSS
Parameters (optional)
node {XML} GeoRSS node to be parsed
Returns:
{TimeMapItem[]} Array of TimeMapItems
Method Details
parse(node) :{TimeMapItem[]}
Static function to parse GeoRSS
Parameters (optional)
node {XML} GeoRSS node to be parsed
Returns:
{TimeMapItem[]} Array of TimeMapItems
©2010 Nick Rabinowitz
Documentation generated by JsDoc Toolkit 2.3.2 on Sat Aug 06 2011 13:40:07 GMT-0700 (PDT)