Class TimeMap.loaders.remote

Generic class for loading remote data with a custom parser function

Constructor

TimeMap.loaders.remote(options)

	Field
	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 files.
	parse() Parser function to turn a string into a JavaScript array
	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.remote(options)

Parameters (optional)
options	{Object}	All options for the loader
options.url	{String}	URL of file to load (NB: must be local address)
options[...]	{mixed}	Other options. In addition to options for TimeMap.loaders.base), any option for jQuery.ajax may be set here

Field Details

opts :{String}

Object to hold optional settings. Any setting for jQuery.ajax should be set on this object before load() is called.

Method Details

load(dataset, callback)

Load function for remote files.

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