Class TimeMap.loaders.xml

This is a base loader class for XML files.

Constructor

TimeMap.loaders.xml(options)

	Field
	extraParams :{TimeMap.params.OptionParam[]} Additional parameters to load
	opts :{String} Object to hold optional settings.
	scrollTo :{String\|Date} Date to scroll the timeline to on load

	Method
	cancel() Cancel the callback function for this loader.
	getCallback(dataset, callback) Get a callback function that can be cancelled.
	getCallbackName(dataset, callback) Get the name of a callback function that can be cancelled.
	load(dataset, callback) Load function for remote XML files.
	parse() Parser function to turn a string into a JavaScript array
	parseExtra(config, node) Parse any extra tags that have been specified into the config object
	preload() Function to call on data object before loading
	transform() Function to call on a single item data object before loading

Class Detail

TimeMap.loaders.xml(options)

Parameters (optional)
options	{Object}	All options for the loader
options.url	{String}	URL of XML file to load (NB: must be local address)
options.tagMap	{Object}	Map of tagName:paramName pairs, if you want to load data into a differently-named elements
options[...]	{mixed}	Other options (see TimeMap.loaders.remote)

Field Details

extraParams :{TimeMap.params.OptionParam[]}

Additional parameters to load

Method Details

load(dataset, callback)

Load function for remote XML files.

Parameters (optional)
dataset	{TimeMapDataset}	Dataset to load data into
callback	{Function}	Function to call once data is loaded

parseExtra(config, node)

Parse any extra tags that have been specified into the config object

Parameters (optional)
config	{Object}	Config object to modify
node	{XML NodeList}	Parent node to look for tags in