mapbox-gl-js README

The project's README from github.com/mapbox/mapbox-gl-js. As one markdown file: README.md.

Mapbox logo

Mapbox GL JS is a JavaScript library for interactive, customizable vector maps on the web. It takes map styles that conform to the Mapbox Style Specification, applies them to vector tiles that conform to the Mapbox Vector Tile Specification, and renders them using WebGL.

Mapbox GL JS is part of the cross-platform Mapbox GL ecosystem, which also includes compatible native SDKs for applications on Android, iOS, macOS, and React Native. Mapbox provides building blocks to add location features like maps, search, and navigation into any experience you create. To get started with GL JS or any of our other building blocks, sign up for a Mapbox account.

In addition to GL JS, this repository contains code, issues, and test fixtures that are common to both GL JS and the native SDKs. For code and issues specific to the native SDKs, see the mapbox/mapbox-gl-native repository.

Mapbox GL JS gallery of map images

Caption: (Mapbox GL JS maps, left-to-right, top-to-bottom): Custom styled point clusters, custom style with points, hexbin visualization on a Dark style map with Popups, data-driven circles over a raster layer with satellite imagery, 3D terrain with custom Markers, Mapbox Movement data visualization.

License

Mapbox Web SDK

Copyright © 2021 - 2023 Mapbox, Inc. All rights reserved.

The software and files in this repository (collectively, “Software”) are licensed under the Mapbox TOS for use only with the relevant Mapbox product(s) listed at www.mapbox.com/pricing. This license allows developers with a current active Mapbox account to use and modify the authorized portions of the Software as needed for use only with the relevant Mapbox product(s) through their Mapbox account in accordance with the Mapbox TOS. This license terminates automatically if a developer no longer has a Mapbox account in good standing or breaches the Mapbox TOS. For the license terms, please see the Mapbox TOS at https://www.mapbox.com/legal/tos/ which incorporates the Mapbox Product Terms at www.mapbox.com/legal/service-terms. If this Software is a SDK, modifications that change or interfere with marked portions of the code related to billing, accounting, or data collection are not authorized and the SDK sends limited de-identified location and usage data which is used in accordance with the Mapbox TOS. [Updated 2023-01]

mapbox-gl-js (mapbox/mapbox-gl-js)

interactive
Searching Database…

What is this?Mapbox GL JS is a JavaScript library for rendering interactive, customizable vector maps in the browser using WebGL.
Is this a standalone app or a library I embed in my own site?It is a client-side JavaScript library you embed in a web page; it applies Mapbox Style Specification styles to Mapbox Vector Tiles and renders them with WebGL.
How do I get started with it?Sign up for a Mapbox account and follow the 'Getting started with Mapbox GL JS' guide, then load your styled tiles via the library's API.
Do I need a Mapbox account to use it?Yes, you need an active Mapbox account in good standing; the license is tied to use through that account.
Can I freely modify any part of the code?No — you can't change or interfere with the marked portions of code related to billing, accounting, or data collection; the SDK also sends limited de-identified usage data back to Mapbox.
Does this only work on the web, or also in native mobile apps?GL JS itself targets web browsers; equivalent native SDKs for Android, iOS, macOS, and React Native exist as separate but related projects in the same Mapbox GL ecosystem.
Does the library collect any data from my app?Yes, it sends limited de-identified location and usage data back to Mapbox as part of its billing/accounting mechanism.
What kind of map features can I build with it out of the box?The gallery shows custom styled point clustering, hexbin visualizations with popups, data-driven circle layers over satellite imagery, 3D terrain with custom markers, and movement-data visualizations.
Where do I find map styles to use?README links to open source styles and the Style Specification/documentation, plus Mapbox-hosted style examples you can apply to the vector tiles.
Is this repo also used for native SDKs?Yes, this repository also holds code, issues, and test fixtures shared between GL JS and the native SDKs, though native-SDK-specific code lives in the mapbox-gl-native repo.
Creator
mapbox
Size
757.4 MB
Stars
12.4K
Age
13y
Commits · 90 Days