| Name | Description |
|---|---|
| options Object | |
options.accessToken string (default null) | If specified, map will use this token instead of the one defined in mapboxgl.accessToken . |
options.antialias boolean (default false) | If true , the gl context will be created with MSAA antialiasing . This is false by default as a performance optimization. |
options.attributionControl boolean (default true) | If true , an AttributionControl will be added to the map. |
options.bearing number (default 0) | The initial bearing (rotation) of the map, measured in degrees counter-clockwise from north. If bearing is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to 0 . |
options.bearingSnap number (default 7) | The threshold, measured in degrees, that determines when the map's bearing will snap to north. For example, with a bearingSnap of 7, if the user rotates the map within 7 degrees of north, the map will automatically snap to exact north. |
options.bounds LngLatBoundsLike (default null) | The initial bounds of the map. If bounds is specified, it overrides center and zoom constructor options. |
options.boxZoom boolean (default true) | If true , the "box zoom" interaction is enabled (see BoxZoomHandler ). |
options.center LngLatLike (default [0,0]) | The initial geographical centerpoint of the map. If center is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to [0, 0] Note: Mapbox GL uses longitude, latitude coordinate order (as opposed to latitude, longitude) to match GeoJSON. |
options.clickTolerance number (default 3) | The max number of pixels a user can shift the mouse pointer during a click for it to be considered a valid click (as opposed to a mouse drag). |
options.collectResourceTiming boolean (default false) | If true , Resource Timing API information will be collected for requests made by GeoJSON and Vector Tile web workers (this information is normally inaccessible from the main Javascript thread). Information will be returned in a resourceTiming property of relevant data events. |
options.config Object (default null) | The initial configuration options for the style fragments. Each key in the object is a fragment ID (e.g., basemap ) and each value is a configuration object. |
| options.container (HTMLElement | string) | The HTML element in which Mapbox GL JS will render the map, or the element's string id . The specified element must have no children. |
| options.cooperativeGestures boolean? | If true , scroll zoom will require pressing the ctrl or ⌘ key while scrolling to zoom map, and touch pan will require using two fingers while panning to move the map. Touch pitch will require three fingers to activate if enabled. |
options.crossSourceCollisions boolean (default true) | If true , symbols from multiple sources can collide with each other during collision detection. If false , collision detection is run separately for the symbols in each source. |
options.customAttribution (string | Array<string>) (default null) | String or strings to show in an AttributionControl . Only applicable if options.attributionControl is true . |
options.doubleClickZoom boolean (default true) | If true , the "double click to zoom" interaction is enabled (see DoubleClickZoomHandler ). |
options.dragPan (boolean | Object) (default true) | If true , the "drag to pan" interaction is enabled. An Object value is passed as options to DragPanHandler#enable . |
options.dragRotate boolean (default true) | If true , the "drag to rotate" interaction is enabled (see DragRotateHandler ). |
options.fadeDuration number (default 300) | Controls the duration of the fade-in/fade-out animation for label collisions, in milliseconds. This setting affects all symbol layers. This setting does not affect the duration of runtime styling transitions or raster tile cross-fading. |
options.failIfMajorPerformanceCaveat boolean (default false) | If true , map creation will fail if the performance of Mapbox GL JS would be dramatically worse than expected (a software renderer would be used). |
options.fitBoundsOptions Object (default null) | A Map#fitBounds options object to use only when fitting the initial bounds provided above. |
options.fontstackCompositing ("client" | "server") (default 'client') | Controls how multi-font fontstacks are composited. When 'client' (the default), each font in a comma-separated fontstack is loaded individually and missing glyphs are filled from subsequent fallback fonts on the client. When 'server' , the full fontstack string is passed as-is to the glyph server, which must support server-side fontstack composition. |
options.hash (boolean | string) (default false) | If true , the map's position (zoom, center latitude, center longitude, bearing, and pitch) will be synced with the hash fragment of the page's URL. For example, http://path/to/my/page.html#2.59/39.26/53.07/-24.1/60 . An additional string may optionally be provided to indicate a parameter-styled hash, for example http://path/to/my/page.html#map=2.59/39.26/53.07/-24.1/60&foo=bar , where foo is a custom parameter and bar is an arbitrary hash distinct from the map hash. |
options.interactive boolean (default true) | If false , no mouse, touch, or keyboard listeners will be attached to the map, so it will not respond to interaction. |
options.keyboard boolean (default true) | If true , keyboard shortcuts are enabled (see KeyboardHandler ). |
options.language ("auto" | string | Array<string>) (default null) | A string with a BCP 47 language tag, or an array of such strings representing the desired languages used for the map's labels and UI components. Languages can only be set on Mapbox vector tile sources. By default, GL JS will not set a language so that the language of Mapbox tiles will be determined by the vector tile source's TileJSON. Valid language strings must be a BCP-47 language code . Unsupported BCP-47 codes will not include any translations. Invalid codes will result in an recoverable error. If a label has no translation for the selected language, it will display in the label's local language. If option is set to auto , GL JS will select a user's preferred language as determined by the browser's window.navigator.language property. If the locale property is not set separately, this language will also be used to localize the UI for supported languages. |
options.locale Object (default null) | A patch to apply to the default localization table for UI strings such as control tooltips. The locale object maps namespaced UI string IDs to translated strings in the target language; see src/ui/default_locale.js for an example with all supported string IDs. The object may specify all UI strings (thereby adding support for a new translation) or only a subset of strings (thereby patching the default translation table). |
options.localFontFamily string (default null) | Defines a CSS font-family for locally overriding generation of all glyphs. Font settings from the map's style will be ignored, except for font-weight keywords (light/regular/medium/bold). If set, this option overrides the setting in localIdeographFontFamily. |
options.localIdeographFontFamily string (default 'sans-serif') | Defines a CSS font-family for locally overriding generation of glyphs in the 'CJK Unified Ideographs', 'Hiragana', 'Katakana', 'Hangul Syllables' and 'CJK Symbols and Punctuation' ranges. In these ranges, font settings from the map's style will be ignored, except for font-weight keywords (light/regular/medium/bold). Set to false , to enable font settings from the map's style for these glyph ranges. Note that Mapbox Studio sets this value to false by default. The purpose of this option is to avoid bandwidth-intensive glyph server requests. For an example of this option in use, see Use locally generated ideographs . |
options.logoPosition string (default 'bottom-left') | A string representing the position of the Mapbox wordmark on the map. Valid options are top-left , top-right , bottom-left , bottom-right . |
options.maxBounds LngLatBoundsLike (default null) | If set, the map will be constrained to the given bounds. |
options.maxPitch number (default 85) | The maximum pitch of the map (0-85). |
options.maxTileCacheSize number (default null) | The maximum number of tiles stored in the tile cache for a given source. If omitted, the cache will be dynamically sized based on the current viewport. |
options.maxZoom number (default 22) | The maximum zoom level of the map (0-24). |
options.minPitch number (default 0) | The minimum pitch of the map (0-85). |
options.minTileCacheSize number (default null) | The minimum number of tiles stored in the tile cache for a given source. Larger viewports use more tiles and need larger caches. Larger viewports are more likely to be found on devices with more memory and on pages where the map is more important. If omitted, the cache will be dynamically sized based on the current viewport. |
options.minZoom number (default 0) | The minimum zoom level of the map (0-24). |
options.performanceMetricsCollection boolean (default true) | If true , mapbox-gl will collect and send performance metrics. |
options.pitch number (default 0) | The initial pitch (tilt) of the map, measured in degrees away from the plane of the screen (0-85). If pitch is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to 0 . |
options.pitchRotateKey ("Control" | "Alt" | "Shift" | "Meta") (default 'Control') | Allows overriding the keyboard modifier key used for pitch/rotate interactions from Control to another modifier key. |
options.pitchWithRotate boolean (default true) | If false , the map's pitch (tilt) control with "drag to rotate" interaction will be disabled. |
options.preserveDrawingBuffer boolean (default false) | If true , the map's canvas can be exported to a PNG using map.getCanvas().toDataURL() . This is false by default as a performance optimization. |
options.projection ProjectionSpecification (default 'mercator') | The projection the map should be rendered in. Supported projections are:
|
options.refreshExpiredTiles boolean (default true) | If false , the map won't attempt to re-request tiles once they expire per their HTTP cacheControl / expires headers. |
options.renderWorldCopies boolean (default true) | If true , multiple copies of the world will be rendered side by side beyond -180 and 180 degrees longitude. If set to false :
|
options.respectPrefersReducedMotion boolean (default true) | If set to true , the map will respect the user's prefers-reduced-motion browser setting and apply a reduced motion mode, minimizing animations and transitions. When set to false , the map will always ignore the prefers-reduced-motion settings, regardless of the user's preference, making all animations essential. |
options.scaleFactor number (default 1) | The scale factor for text and icon sizes in symbol layers. A value greater than 1 increases label sizes, useful for improving accessibility or adjusting for high-density displays. The scale factor is clamped per-layer by text-size-scale-range and icon-size-scale-range style properties. This option is experimental and may change in future releases. |
options.scrollZoom (boolean | Object) (default true) | If true , the "scroll to zoom" interaction is enabled. An Object value is passed as options to ScrollZoomHandler#enable . |
options.style (Object | string) (default 'mapbox://styles/mapbox/standard') | The map's Mapbox style. This must be an a JSON object conforming to the schema described in the Mapbox Style Specification , or a URL to such JSON. Can accept a null value to allow adding a style manually. To load a style from the Mapbox API, you can use a URL of the form
Tilesets hosted with Mapbox can be style-optimized if you append |
options.testMode boolean (default false) | Silences errors and warnings generated due to an invalid accessToken, useful when using the library to write unit tests. |
options.touchPitch (boolean | Object) (default true) | If true , the "drag to pitch" interaction is enabled. An Object value is passed as options to TouchPitchHandler . |
options.touchZoomRotate (boolean | Object) (default true) | If true , the "pinch to rotate and zoom" interaction is enabled. An Object value is passed as options to TouchZoomRotateHandler#enable . |
options.trackResize boolean (default true) | If true , the map will automatically resize when the browser window resizes. |
options.transformRequest RequestTransformFunction (default null) | A callback run before the Map makes a request for an external URL. The callback can be used to modify the url, set headers, or set the credentials property for cross-origin requests. Expected to return a RequestParameters object with a url property and optionally headers and credentials properties, or a Promise resolving to one. Returning a Promise lets the callback resolve values asynchronously before each request, for example to refresh an auth token. The callback receives a third options argument with an optional signal ( AbortSignal ) that aborts when the request is cancelled. |
options.worldview string (default null) | Sets the map's worldview. A worldview determines the way that certain disputed boundaries are rendered. By default, GL JS will not set a worldview so that the worldview of Mapbox tiles will be determined by the vector tile source's TileJSON. Valid worldview strings must be an ISO alpha-2 country code . Unsupported ISO alpha-2 codes will fall back to the TileJSON's default worldview. Invalid codes will result in a recoverable error. |
options.zoom number (default 0) | The initial zoom level of the map. If zoom is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to 0 . |