Leaflet TimeDimension

Add time dimension capabilities on a Leaflet map.

!screenshot

- Examples and basic usage
- API
- L.Map
- L.TimeDimension
- L.TimeDimension.Layer
- L.TimeDimension.Layer.WMS
- L.TimeDimension.Layer.GeoJSON
- L.Control.TimeDimension
- L.TimeDimension.Player
- TimeDimension update modes
- Requisites
- Talks
- Bugs, issues and contributions

Examples and basic usage

Checkout the Leaflet TimeDimension Demos.

Basic usage:

``html
















`

`javascript
// example.js
var map = L.map('map', {
zoom: 10,
center: [38.705, 1.15],
timeDimension: true,
timeDimensionOptions: {
timeInterval: "2014-09-30/2014-10-30",
period: "PT1H"
},
timeDimensionControl: true,
});

var wmsUrl = "http://thredds.socib.es/thredds/wms/observational/hf_radar/hf_radar_ibiza-scb_codarssproc001_aggregation/dep0001_hf-radar-ibiza_scb-codarssproc001_L1_agg.nc"
var wmsLayer = L.tileLayer.wms(wmsUrl, {
layers: 'sea_water_velocity',
format: 'image/png',
transparent: true,
attribution: 'SOCIB HF RADAR | sea_water_velocity'
});

// Create and add a TimeDimension Layer to the map
var tdWmsLayer = L.timeDimension.layer.wms(wmsLayer);
tdWmsLayer.addTo(map);
`

For more control over each object creation, you can create timeDimension objects manually, see Example 9

API

$3

This plugin will attach to a Map a TimeDimension object and a related TimeDimension Control if timeDimension and timeDimensionControl options are included.

Option | Type | Default | Description
------------------------------|-----------|---------|------------
timeDimension | Boolean | false | Automatically creates a new TimeDimension object linked to the map if set to true.
timeDimensionOptions | Object | {} | Options for the TimeDimension object.
timeDimensionControl | Boolean | false | Automatically adds a TimeDimension Control to the map if set to true.
timeDimensionControlOptions | Object | {} | Options for the TimeDimension Control object.




$3

TimeDimension object manages the time component of a layer. It can be shared among different layers and it can be added to a map, and become the default timedimension component for any layer added to the map.

In order to include a TimeDimension in the map, add timeDimension: true as an option when creating the map.

#### Usage example

`javascript
L.timeDimension().addTo(map);
`

#### Creation

Factory | Description
-------------------------------------|------------
L.timeDimension(