API Reference | Mapbox GL JS

This reference documentation includes all classes, methods, properties, events, and types available in Mapbox GL JS. Use it to explore the API and find detailed information about how to work with maps, styles, layers, sources, and controls. All reference pages include a search input to quickly find reference items.

Each section of this reference describes different classes or objects as well as their properties, parameters, instance members, and associated events. Many sections also include inline code examples and related resources.

Map

The Map object represents the map on your page. It exposes methods and properties that enable you to programmatically change the map, and fires events as users interact with it.

Properties and options

Includes global mapboxgl properties, including the access token to use, utility functions, and checks for browser compatibility.

Markers and controls

User interface elements that can be aded to the map at runtime, such as custom controls or markers and popups to represent point data.

User interaction handlers

Use handlers to add different kinds of interactivity to the map such as mouse interactivity, touch interactions, and other gestures.

Sources

Sources specify the geographic data to be rendered on the map. Source types include GeoJSON data, vector tilesets, raster tilesets, and more.

Events and event types

Events emitted by Map (and some other classes) in response to user interactions or changes in state.

Geography and geometry

Classes and types for working with geographic coordinates, bounding boxes, and screen positions.

Was this page helpful?