esri-leaflet-geocoder
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/esri-leaflet-geocoder package

    3.1.1 • Public • Published

    Esri Leaflet Geocoder

    The Esri Leaflet Geocoder is a small series of API helpers and UI controls to interact with the ArcGIS Online geocoding services.

    npm version build status apache licensed jsDelivr Hits

    Example

    Take a look at the live demo.

    Example Image

    <!DOCTYPE html>
    <html>
      <head>
        <meta charset="utf-8" />
        <title>Esri Leaflet Geocoder</title>
        <meta
          name="viewport"
          content="initial-scale=1,maximum-scale=1,user-scalable=no"
        />
    
        <!-- Load Leaflet from CDN-->
        <link rel="stylesheet" href="https://unpkg.com/leaflet/dist/leaflet.css" />
        <script src="https://unpkg.com/leaflet/dist/leaflet-src.js"></script>
    
        <!-- Load Esri Leaflet from CDN -->
        <script src="https://unpkg.com/esri-leaflet"></script>
    
        <!-- Esri Leaflet Geocoder -->
        <link
          rel="stylesheet"
          href="https://unpkg.com/esri-leaflet-geocoder/dist/esri-leaflet-geocoder.css"
        />
        <script src="https://unpkg.com/esri-leaflet-geocoder"></script>
    
        <!-- Make the map fill the entire page -->
        <style>
          #map {
            position: fixed;
            top: 0;
            bottom: 0;
            left: 0;
            right: 0;
          }
        </style>
      </head>
    
      <body>
        <div id="map"></div>
        <script>
          var map = L.map("map").setView([45.5165, -122.6764], 12);
          var tiles = L.esri.basemapLayer("Streets").addTo(map);
    
          // create the geocoding control and add it to the map
          var searchControl = L.esri.Geocoding.geosearch({
            providers: [
              L.esri.Geocoding.arcgisOnlineProvider({
                // API Key to be passed to the ArcGIS Online Geocoding Service
                apikey: 'YOUR_API_KEY'
              })
            ]
          }).addTo(map);
    
          // create an empty layer group to store the results and add it to the map
          var results = L.layerGroup().addTo(map);
    
          // listen for the results event and add every result to the map
          searchControl.on("results", function (data) {
            results.clearLayers();
            for (var i = data.results.length - 1; i >= 0; i--) {
              results.addLayer(L.marker(data.results[i].latlng));
            }
          });
        </script>
      </body>
    </html>

    API Reference

    Controls

    L.esri.Geocoding.geosearch

    a control for auto-complete enabled search

    Services

    L.esri.Geocoding.geocodeService

    A basic wrapper for ArcGIS Online geocoding services. Used internally by L.esri.Geocoding.geosearch.

    Tasks

    L.esri.Geocoding.geocode

    An abstraction for submitting requests to turn addresses into locations.

    L.esri.Geocoding.suggest

    An abstraction for submitting requests for geocoding suggestions.

    L.esri.Geocoding.reverseGeocode

    An abstraction for submitting requests for address candidates associated with a particular location.

    Development Instructions

    1. Fork and clone Esri Leaflet Geocoder
    2. cd into the esri-leaflet-geocoder folder and install the dependencies with npm install
    3. Run npm start from the command line. This will compile minified source in a brand new dist directory, launch a tiny webserver and begin watching the raw source for changes.
    4. The example at debug/sample.html should 'just work'
    5. Make your changes and create a pull request

    Resources

    Issues

    Find a bug or want to request a new feature? Please let us know by submitting an issue.

    Contributing

    Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

    Terms and Conditions

    In order to make use of the ArcGIS Online World Geocoding Service in your web application:

    1. Please sign up for an ArcGIS for Developers account or purchase an ArcGIS Online Organizational Subscription.
    2. Ensure that Powered byEsri is displayed in the map attribution.

    Cost

    1. User search for individual locations within web applications is defined by Esri as Geosearch and it is free. Credits are only consumed when you store results permanently.
    2. To store geocoding results, pass forStorage: true and a valid access token (see #207).
    3. You are not allowed to generate revenue while on a free ArcGIS Developer plan.
    4. If your application generates more than 1 million searches in a month, please contact us.

    Licensing

    Copyright © 2013-2018 Esri

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    A copy of the license is available in the repository's LICENSE file.

    Keywords

    none

    Install

    npm i esri-leaflet-geocoder

    DownloadsWeekly Downloads

    15,853

    Version

    3.1.1

    License

    Apache-2.0

    Unpacked Size

    322 kB

    Total Files

    27

    Last publish

    Collaborators

    • patrickarlt
    • esri_dev
    • gavinr
    • jgravois
    • jwasilgeo