Class TimeMap.loaders.basic

Extends:: TimeMap.loaders.base
Defined in:: timemap.js
See:: Basic Example

Basic loader class, for pre-loaded data. Other types of loaders should take the same parameter.

TimeMap.init({
    datasets: [
        {
            type: "basic",
            options: {
                data: [
                    // object literals for each item
                    {
                        title: "My Item",
                        start: "2009-10-06",
                        point: {
                            lat: 37.824,
                            lon: -122.256
                        }
                    },
                    // etc...
                ]
            }
        }
    ],
    // etc...
});

Constructor

TimeMap.loaders.basic(options)

Fields

	Field
	data :{Object[]} Array of item data to load.
	scrollTo :{String\|Date} Date to scroll the timeline to on load

Methods

	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 javascript literal data.
	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.basic(options)

Parameters (optional)
options	{Object}	All options for the loader
options.data	{Array}	Array of items to load
options[...]	{mixed}	Other options (see TimeMap.loaders.base)

Field Details

data :{Object[]}

Array of item data to load.

Default Value:: []

Method Details

load(dataset, callback)

Load javascript literal data. New loaders should implement a load function with the same signature.

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

Timemap.js v.2.0.1

Class TimeMap.loaders.basic

Constructor

Fields

Methods