Geocoding: Add place search to map
This tutorial shows how to use the geocoding control module to add a place search box to your map or another application.
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.1.0/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_HERE'; const map = new maptilersdk.Map({ container: 'map', // container's id or the HTML element to render the map style: maptilersdk.MapStyle.STREETS, center: [16.62662018, 49.2125578], // starting position [lng, lat] zoom: 14, // starting zoom }); -
Replace
YOUR_MAPTILER_API_KEY_HEREwith 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. -
Install the Geocoding control using npm.
npm install --save @maptiler/geocoding-control -
Import the Geocoding control component and CSS in your mapping application.
import * as maptilersdk from '@maptiler/sdk'; import { GeocodingControl } from "@maptiler/geocoding-control/maptilersdk"; import "@maptiler/sdk/dist/maptiler-sdk.css"; maptilersdk.config.apiKey = 'YOUR_MAPTILER_API_KEY_HERE'; const map = new maptilersdk.Map({ container: 'map', // container's id or the HTML element to render the map style: maptilersdk.MapStyle.STREETS, center: [16.62662018, 49.2125578], // starting position [lng, lat] zoom: 14, // starting zoom }); -
Add the geocoder control to the map.
const map = new maptilersdk.Map({ container: 'map', // container's id or the HTML element to render the map style: maptilersdk.MapStyle.STREETS, center: [16.62662018, 49.2125578], // starting position [lng, lat] zoom: 14, // starting zoom }); const gc = new GeocodingControl(); map.addControl(gc, 'top-left');
Related examples
Geocoding search results by proximity to a specific point
ExamplesRank geocoding search results higher based on proximity.
Geocoding search results to specified country(ies)
ExamplesLimit geocoding control search results to specific countries.