Class TimeMap.loaders.kml

Extends:: TimeMap.loaders.xml
Requires:: loaders/xml.js; param.js
Defined in:: kml.js
See:: KML Example; KML ExtendedData Example

KML loader: load KML files.

This is a loader class for KML files. Currently supports all geometry types (point, polyline, polygon, and overlay) and multiple geometries. Supports loading ExtendedData through the extendedData parameter.


TimeMap.init({
    datasets: [
        {
            title: "KML Dataset",
            type: "kml",
            options: {
                url: "mydata.kml"   // Must be local
            }
        }
    ],
    // etc...
});

Constructor

TimeMap.loaders.kml(options)

Static Methods

	Method
	TimeMap.loaders.kml.parse(kml) Static function to parse KML with time data.

Fields

	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

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 function for remote XML files.
	parse(kml) Static function to parse KML with time data.
	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.kml(options)

Parameters (optional)
options	{Object}	All options for the loader
options.url	{String}	URL of KML file to load (NB: must be local address)
options.extendedData	{String[]}	Array of names for ExtendedData data elements
options[...]	{mixed}	Other options (see TimeMap.loaders.xml)

Returns:: {TimeMap.loaders.xml} Loader configured for KML

Static Method Details

TimeMap.loaders.kml.parse(kml) :{TimeMapItem Array}

Static function to parse KML with time data.

Parameters (optional)
kml	{XML}	KML node to be parsed

Returns:: {TimeMapItem Array} Array of TimeMapItems

Method Details

parse(kml) :{TimeMapItem Array}