You are viewing an older version of Mapbox.js. Check out v3.3.1 for the latest.
L.mapbox.gridControl(layer, options)
Extends: L.Control
Interaction is what we call interactive parts of maps that are created with the powerful tooltips & regions system in TileMill. Under the hood, it's powered by the open UTFGrid specification.
Options | Value | Description |
---|---|---|
layer | L.mapbox.gridLayer |
The first argument must be a layer created with L.mapbox.gridLayer() |
options | object | Valid options are:
|
Example:
var map = L.mapbox.map('map').setView([38, -77], 5);
var gridLayer = L.mapbox.gridLayer('mapbox.light');
map.addLayer(L.mapbox.tileLayer('mapbox.outdoors'));
map.addLayer(gridLayer);
map.addControl(L.mapbox.gridControl(gridLayer));
Returns: a L.mapbox.gridControl
object.
Class: L.mapbox.GridControl
gridControl.hide()
If a tooltip is currently shown by the gridControl, hide and close it.
Returns: the L.mapbox.gridControl
object.
gridControl.setTemplate(template)
Change the Mustache template used to transform the UTFGrid data in the map's interactivity into HTML for display.
Options | Value | Description |
---|---|---|
template | string | A string of Mustache template code for popups. |
Returns: the L.mapbox.gridControl
object.