Hogyan állíthat be egyedi Mapbox alaptérkép stílust a React Leaflet és a Leaflet Gatsby Starter segítségével

A térképek építése meglehetősen nagy teljesítményű lehet, de gyakran ragaszkodik a térkép képeinek nyílt forráskódú lehetőségeihez, amelyek nem segíthetik az adatok olvashatóságát. Hogyan használhatjuk ki a Mapbox csempés API-kat, hogy egyéni alaptérképet adjunk a React Leaflet alkalmazásunkhoz?

  • Mit fogunk építeni?
  • Mi a Mapbox?
  • 1. rész: Egyéni Mapbox stílus létrehozása
  • 2. rész: Egyéni TileLayer hozzáadása a React szórólaphoz
  • 3. rész: Egyéni alaptérkép hozzáadása a Gatsby Starter szórólaphoz
  • A Mapbox kulcs biztonságossá tétele
  • Szeretne többet megtudni a térképekről?

Mit fogunk építeni?

Végig fogunk járni egy új alapszintű Mapbox stílus létrehozásával a Mapbox fiókunkban. Miután létrehozta, a Map API-jukat használjuk egy egyedi alaptérkép hozzáadásához a React Leaflet alkalmazásunkhoz.

Térképünkhöz ezt az általam létrehozott Gatsby Starter Leaflet-t fogjuk használni, amely lehetővé teszi, hogy könnyedén felpörgess egy új térképészeti alkalmazást. Mielőtt azonban ezt felpörgetnénk, áttanulmányozom, hogyan lehet hozzáadni, csak a React Leaflet összetevőinek használatával.

Térképező alkalmazás?

Aha! A térképeket világszerte használják földrajzi helyekre vonatkozó adatkészletek tanulmányozására. Fontos eszközök a tudósok és mások számára, akik megpróbálnak segíteni a világon.

Ha többet szeretne megtudni a térkép elkészítéséről és az adatok hozzáadásáról, akkor először megnézheti néhány más cikkemet, például létrehozhat egy Coronavirus (COVID-19) térképet vagy egy Summer Road Trip térképet, valamint egy kicsit inspiráció arról, hogy miért térképezhet bárki.

Mi a Mapbox?

A Mapbox egy olyan térképészeti platform, amely lehetővé teszi ügyfeleinek, hogy egyedi térképészeti megoldásokat hozzanak létre. Emellett számos olyan API-t is kihasználnak, amelyek hatékony képességeket kínálnak a térképfunkciók felépítéséhez.

Céljainkhoz felhasználjuk a Map API-jukat, különösképpen a Static Tiles API-jukat az általunk létrehozott egyedi térképstílus kiszolgálására.

1. rész: Egyéni Mapbox stílus létrehozása

Ahhoz, hogy megkapjuk azt a megjelenést és érzetet, amelyet a térképünkre vágyunk, fontos egy alaptérkép, amely segít abban, hogy adataink zavaró tényezők nélkül jelenjenek meg. Ráadásul néha szórakoztató, ha van egyedi térképe.

Mapbox fiók

Az első dolog, amit be kell állítanunk az egyedi Mapbox stílusunkban, az az, hogy rendelkezünk fiókkal. Nem fogom végigjárni ezt a folyamatot, de áttérhet a Mapbox weboldalára, ahol ingyenesen regisztrálhat: mapbox.com

Új egyedi stílus létrehozása

Új stílus létrehozása a Mapboxban nem olyan nehéz, mint amilyennek hangzik. Bár nagyon összetetté válhat, ha valami egyedi dologra vágyik, a kezdéshez átmásolhatjuk a Mapbox egyik alapértelmezett stílusát.

Először lépjen a Mapbox Studio irányítópultjára, ha bejelentkezéskor a jobb felső sarokban található fiókja linkre kattint.

Miután a Studio irányítópultján vagyunk, ki akarjuk választani az Új stílus gombot.

A gombra kattintás után megjelenik egy modál, amely lehetővé teszi a sablon kiválasztását. Itt kiválaszthat, amit csak akar, de én a Monokrómot választom a Dark variációjával. A sablon kiválasztása után kattintson a Testreszabás gombra.

És most belépünk a testreszabási felhasználói felületünkbe.

Innentől kezdve valóban megteheti, amit szeretne. Rengeteg lehetőség van a térkép testreszabására. Kicsit bonyolultabb itt próbálkozni, de a Mapbox biztosít néhány forrást, amelyek megkönnyítik a produktivitást.

Mapbox token generálása

Ha elégedett vagy új stílusoddal, és minden megjelent, szeretnénk létrehozni egy tokent, amelyet felhasználunk a térképünkhöz való hozzáférés biztosításához.

Menjen át a Mapbox irányítópult Fiók szakaszába.

A Mapbox egy „alapértelmezett” tokent biztosít, amelyet az alkalmazásaiban használhat. Szabadon használhatja ezt, de azt javaslom, hogy hozzon létre egy új tokent, amely egyedi nevet adhat meg, így ha valaha is felülmúlja a Mapbox ingyenes szintjét, nyomon tudja követni a használatát.

Ezenkívül a legjobb, ha minden alkalmazáshoz külön tokent tartunk, így könnyen forgathatunk egy kulcsot anélkül, hogy minden alkalmazást frissítenünk kellene.

Miután rákattint a Token létrehozása gombra, beállíthatja a kulcsot a kívánt módon, a választott hatókörökkel és engedélyekkel, de céljaink érdekében az összes nyilvános hatókört bejelölheti a térképünkhöz, amit alapértelmezés szerint elvégeznek .

Az egyéni végpont konfigurálása

Ehhez az oktatóanyaghoz a Mapbox Statikus csempék szolgáltatását fogjuk használni.

Végpontunk a következőképpen fog kinézni:

//api.mapbox.com/styles/v1/{username}/{style_id}/tiles/256/{z}/{x}/{y}@2x?access_token={access_token} 

Van néhány paraméter, amelyet meg kell értenünk:

  • felhasználónév: ez lesz a Mapbox-fiókod felhasználóneve
  • style_id: ez lesz a korábban létrehozott stílus azonosítója
  • z, x, y: ezek azok a paraméterek, amelyeket a szórólap programozottan felcserél, ezért a jelenlegi állapotunkban szeretnénk hagyni őket
  • access_token: ez a fent létrehozott Mapbox kulcs

To find your username and style ID, we can use the Style URL for our new Mapbox style to get those values.

In my example, my Style URL looks like:

mapbox://styles/colbyfayock/ck8lryjfq0jdo1ip9ctmuhc6p 

colbyfayock is my username and ck8lryjfq0jdo1ip9ctmuhc6p is my style ID.

And once I update my endpoint parameters, the final tilepoint URL will look like:

//api.mapbox.com/styles/v1/colbyfayock/ck8lryjfq0jdo1ip9ctmuhc6p/tiles/256/{z}/{x}/{y}@2x?access_token=MYACCESSTOKEN 

Part 2: Adding a custom TileLayer to React Leaflet

When building a map with React Leaflet, your main component will be a that wraps the entirety of the app. This is what sets up your Map instance for Leaflet.

For our purposes here, we’re going to use the example on the React Leaflet homepage as our starting point.

React Leaflet TileLayer Component

Inside of your component you include a component, which defines the imagery of the world that you base your map upon.

The example on the React Leaflet homepage uses a public version of OpenStreetMap as their TileLayer, which is an open source map project created and updated by people all around the world.


    

This gives you a basic map, but we want to swap in Mapbox so we can set up a custom look and feel for our map.

Custom Mapbox TileLayer

To add our custom style, we’ll want to update the url and attribution props of the TileLayer component.

For URL, it will simply be the custom style endpoint we created earlier, so in my example, it looks like:

//api.mapbox.com/styles/v1/colbyfayock/ck8lryjfq0jdo1ip9ctmuhc6p/tiles/256/{z}/{x}/{y}@2x?access_token=MYACCESSTOKEN 

For attribution, we want to credit Mapbox as the service, so we want to set our attribution as:

Map data © OpenStreetMap contributors, CC-BY-SA, Imagery © Mapbox 

When plugged in to our TileLayer, our code should now look like this:


    

And once we open up our map, we should see our new basemap!

See the code!

If you want to see how I did it, check out the diff commit by commit.

The only caveat there is I created an .env.development.local file in the root of my project in which I stored a new environment variable called REACT_APP_MAPBOX_KEY  to store my Mapbox key.

Part 3: Adding a custom basemap to Gatsby Starter Leaflet

I’ve written a few other articles on how to get started with my Leaflet Gatsby Starter, but for this part, we’ll want to have a basic app spun up that we can use to change our TileLayer endpoint.

Setting up our React Leaflet Gatsby app

To get started, check out the instructions on the Starter github:

//github.com/colbyfayock/gatsby-starter-leaflet

Once you’re ready, you should have a basic mapping app ready to go!

Configuring our Mapbox service

The first thing we’ll want to do is add Mapbox as a service in our src/data/map-services.js file.

Taking our custom endpoint URL that we created in Part 1, let’s set up a new object with a name of Mapbox, and with a url and attribution similar to what we did in Part 2.

export const mapServices = [ { name: ‘OpenStreetMap’, attribution: '© OpenStreetMap contributors’, url: ‘//{s}.tile.openstreetmap.org/{z}/{x}/{y}.png’ }, { name: ‘Mapbox’, attribution: ‘Map data © OpenStreetMap contributors, CC-BY-SA, Imagery © Mapbox’, url: `//api.mapbox.com/styles/v1/colbyfayock/ck8c2foj72lqk1jnug0g2haw0/tiles/256/{z}/{x}/{y}@2x?access_token=MY_ACCESS_TOKEN` } ]; 

Using our Mapbox map service

Once you have your Mapbox service set up, all that’s left is to open up the src/pages/index.js file, find the mapSettings object definition, and update the defaultBaseMap property to Mapbox.

const mapSettings = { center: CENTER, defaultBaseMap: ‘Mapbox’, zoom: DEFAULT_ZOOM, mapEffect }; 

Save that change, refresh the map in your browser, and you should now see your custom basemap style!

See the code!

If you want to see how I did it, check out the diff with the commit.

The only caveat there is I created an .env.development file in the root of my project in which I stored a new environment variable called GATSBY_MAPBOX_KEY  to store my Mapbox key.

Securing your Mapbox key

Environment variables

Part of most development processes that use individual keys will generally set the keys up as environment variables. Environment variables are configured settings that don’t live in the code itself.

This is important because it prevents your key from being checked in to your code, which is bad from a security perspective, but it also allows you to provide a different key for different environments.

When generating your keys, try to keep this in mind, as it can save you in the long run.

Locking down your Mapbox key

In your settings when creating a token or when editing a token, Mapbox allows you to specify only the URLs you want your key to be accessible from.

Though Mapbox has a generous free tier, you probably want to keep it locked down only to the URLs that you’re using it on. You can create multiple keys, where one could be for public use on your website and one would be for your local development.

This is helpful for instance, where you have a key that will never be used publicly for development purposes, but then you have a key that you deploy with, which can be locked down only to that URL.

If someone grabs your key, they could plug it into their own website and use up all of your free tier, potentially running up your bill!

Want to learn more about maps?

You can check out a few of my other resources to get started:

  • How to create a Coronavirus (COVID-19) Dashboard & Map App in React with Gatsby and Leaflet
  • Anyone Can Map! Inspiration and an introduction to the world of mapping
  • How to Create a Summer Road Trip Mapping App with Gatsby and Leaflet
  • How to Create your own Santa Tracker with Gatsby and React Leaflet
  • How to build a mapping app in React the easy way with Leaflet

Follow me for more Javascript, UX, and other interesting things!

  • ? Follow Me On Twitter
  • ?️ Subscribe To My Youtube
  • ✉️ Sign Up For My Newsletter