Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    leaflet-control-geocoderpublic

    A few words on diversity in tech

    I need to take some of your time. I can't believe we let shit like the Kathy Sierra incident or what happened to Brianna Wu happen over and over again. I can't believe we, the open source community, let sexist, misogynous shit happen over and over again.

    I strongly believe that it is my — and your — duty to make the open source community, as well as the tech community at large, a community where everyone feel welcome and is accepted. At the very minimum, that means making sure the community and its forums both are safe, and are perceived as safe. It means being friendly and inclusive, even when you disagree with people. It means not shrugging off discussions about sexism and inclusiveness with handwaving about censorship and free speech. For a more elaborate document on what that means, the NPM Code of Conduct is a good start, Geek Feminism's resources for allies contains much more.

    While I can't force anyone to do anything, if you happen to disagree with this, I ask of you not to use any of the open source I have published. Nor am I interested in contributions from people who can't accept or act respectfully towards other humans regardless of gender identity, sexual orientation, disability, ethnicity, religion, age, physical appearance, body size, race, or similar personal characteristics. If you think feminism, anti-racism or the LGBT movement is somehow wrong, disturbing or irrelevant, I ask you to go elsewhere to find software.

    Leaflet Control Geocoder NPM version Leaflet 1.0.0 compatible!

    A simple geocoder for Leaflet that by default uses OSM/Nominatim.

    The plugin supports many different data providers:

    The plugin can easily be extended to support other providers. Current extensions:

    See the Leaflet Control Geocoder Demo.

    Usage

    Download latest release. Load the CSS and Javascript, located in the dist folder:

    <link rel="stylesheet" href="Control.Geocoder.css" />
    <script src="Control.Geocoder.js"></script>

    Add the control to a map instance:

    var map = L.map('map').setView([0, 0], 2);
    L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png', {
        attribution: '&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
    }).addTo(map);
    L.Control.geocoder().addTo(map);

    Customizing

    By default, when a geocoding result is found, the control will center the map on it and place a marker at its location. This can be customized by listening to the control's markgeocode event. To remove the control's default handler for marking a result, set the option defaultMarkGeocode to false.

    For example:

    var geocoder = L.Control.geocoder({
            defaultMarkGeocode: false
        })
        .on('markgeocode', function(e) {
            var bbox = e.geocode.bbox;
            var poly = L.polygon([
                 bbox.getSouthEast(),
                 bbox.getNorthEast(),
                 bbox.getNorthWest(),
                 bbox.getSouthWest()
            ]).addTo(map);
            map.fitBounds(poly.getBounds());
        })
        .addTo(map);

    This will add a polygon representing the result's boundingbox when a result is selected.

    API

    L.Control.Geocoder

    This is the geocoder control. It works like any other Leaflet control, and is added to the map.

    Constructor

    L.Control.Geocoder(options)

    Options

    Option Type Default Description
    collapsed Boolean true Collapse control unless hovered/clicked
    expand String "touch" How to expand a collapsed control: touch click hover
    position String "topright" Control position
    placeholder String "Search..." Placeholder text for text input
    errorMessage String "Nothing found." Message when no result found / geocoding error occurs
    geocoder IGeocoder new L.Control.Geocoder.Nominatim() Object to perform the actual geocoding queries
    showResultIcons Boolean false Show icons for geocoding results (if available); supported by Nominatim

    Methods

    Method Returns Description
    markGeocode( result) this Marks a geocoding result on the map

    L.Control.Geocoder.Nominatim

    Uses Nominatim to respond to geocoding queries. This is the default geocoding service used by the control, unless otherwise specified in the options. Implements IGeocoder.

    Unless using your own Nominatim installation, please refer to the Nominatim usage policy.

    Constructor

    L.Control.Geocoder.Nominatim(options)

    Options

    Option Type Default Description
    serviceUrl String "http://nominatim.openstreetmap.org/" URL of the service
    geocodingQueryParams Object {} Additional URL parameters (strings) that will be added to geocoding requests; can be used to restrict results to a specific country for example, by providing the countrycodes parameter to Nominatim
    reverseQueryParams Object {} Additional URL parameters (strings) that will be added to reverse geocoding requests
    htmlTemplate function special A function that takes an GeocodingResult as argument and returns an HTML formatted string that represents the result. Default function breaks up address in parts from most to least specific, in attempt to increase readability compared to Nominatim's naming

    L.Control.Geocoder.Bing

    Uses Bing Locations API to respond to geocoding queries. Implements IGeocoder.

    Note that you need an API key to use this service.

    Constructor

    L.Control.Geocoder.Bing(<String> key)
    

    IGeocoder

    An interface implemented to respond to geocoding queries.

    Methods

    Method Returns Description
    geocode( query, callback, context) GeocodingResult[] Performs a geocoding query and returns the results to the callback in the provided context
    reverse(<L.LatLng> location, scale, callback, context) GeocodingResult[] Performs a reverse geocoding query and returns the results to the callback in the provided context

    GeocodingResult

    An object that represents a result from a geocoding query.

    Properties

    Property Type Description
    name String Name of found location
    bbox L.LatLngBounds The bounds of the location
    center L.LatLng The center coordinate of the location
    icon String URL for icon representing result; optional
    html String (optional) HTML formatted representation of the name

    install

    npm i leaflet-control-geocoder

    Downloadsweekly downloads

    937

    version

    1.5.8

    license

    BSD-2-Clause

    repository

    githubgithub

    last publish

    collaborators

    • avatar