For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
How to display your custom map on the web page.
This tutorial shows the process of displaying a customized map on a webpage by utilizing MapTiler.
With MapTiler’s customization tool, you can craft fully customized interactive web maps. Stand out from your competitors and enhance the quality of your web mapping applications. Take your mapping experience to the next level.
To create your first custom map, see the Map design guides.
NPM module setup
-
Install the npm package.
npm install --save @maptiler/sdk -
Include the CSS file.
If you have a bundler that can handle CSS, you can
importthe CSSimport "@maptiler/sdk/dist/maptiler-sdk.css";or include it with a
<link />in the head of the document via the CDN<link href='https://cdn.maptiler.com/maptiler-sdk-js/v4.2.1/maptiler-sdk.css' rel='stylesheet' /> -
Include the following code in your JavaScript file (Example: app.js).
import * as maptilersdk from '@maptiler/sdk'; maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY'; const map = new maptilersdk.Map({ container: 'map', // container's id or the HTML element to render the map style: maptilersdk.MapStyle.STREETS, center: [10.989249486220501, 46.948652944430734], // starting position [lng, lat] zoom: 11, // starting zoom }); -
Replace
YOUR_MAPTILER_API_KEYwith your own API key. Make sure to secure the key before you publish it. -
The next is up to you. You can center your map wherever you desire (modifying the
starting position) and set an appropriate zoom level (modifying thestarting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating thesource URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application. -
Replace the style with your custom map style. Check how to get the style ID of your map and use it in place of
YOUR_CUSTOM_MAP_ID.const map = new maptilersdk.Map({ container: 'map', // container id style: `YOUR_CUSTOM_MAP_ID`, center: [10.989249486220501, 46.948652944430734], // starting position [lng, lat] zoom: 11 // starting zoom });
Learn more
To learn more about customizing maps, check out the Map design tutorials.