Legacy

Mapbox.js is no longer in active development. To learn more about our newer mapping tools see Mapbox GL JS.

You are viewing an older version of Mapbox.js. Check out v3.3.1 for the latest.

L.mapbox.map(element, id|url|tilejson, options)

Create and automatically configure a map with layers, markers, and interactivity.

Extends: L.Map

Options Value Description
element (required) string Must be the id of an element, or a DOM element reference.
id or url or tilejson string if id or url object if tilejson url can be
  • a map id string examples.map-foo
  • a URL to TileJSON, like https://api.mapbox.com/v3/examples.map-0l53fhk2.json
  • a TileJSON object, from your own Javascript code
options object If provided, it is the same options as provided to L.Map with the following additions:

Example:

// map refers to a <div> element with the ID map
// examples.map-4l7djmvo is the ID of a map on Mapbox.com
var map = L.mapbox.map('map', 'examples.map-4l7djmvo');

// map refers to a <div> element with the ID map
// This map will have no layers initially
var map = L.mapbox.map('map');

Returns: a map object

Class: L.mapbox.Map

map.getTileJSON()

Returns this map's TileJSON object which determines its tile source, zoom bounds and other metadata.

Returns: the TileJSON object