Skip to content

digitregroup/map-location-factory

Repository files navigation

map-location-factory

How to use

Front-end

  • Install the last npm package
  • Import the library
  • use the autocompleteAdapter plugin

Back-end

  • Install the last npm package
  • Import the library
  • use the API public function suggest, geocode, reverse.

The library

Constructor params :

    const engine = new GeocoderEngine(
        'Here', {
            "apiKey":   "API_KEY",
            "cacheEnable": false,
            "cacheUrl": "https://geocoder-stage.digitregroup.io",
            "cacheKey": "CACHE_KEY"
            "lookup": {
              "baseUrl": "https://lookup.search.hereapi.com/v1/",
              "path": "",
              "resource": "lookup"
            },
            "geocode": {
              "baseUrl": "https://geocode.search.hereapi.com/v1/",
              "path": "",
              "resource": "geocode",
              "options": {
                "limit": 2,
                "lang": "fr",
                "country": "FRA,GLP,GUF,MTQ,REU,MYT,BLM,MAF,NCL,PYF,SPM,ATF,WLF"
              }
            },
            "reverse": {
              "baseUrl": "https://revgeocode.search.hereapi.com/v1/",
              "path": "",
              "resource": "revgeocode",
              "options": {
                "limit": 2,
                "lang": "DEU"
            }
        });

Options (suggest, geocode, reverse) :

params type value
options object {}
options.term string Address, city, postalCode,...
options.country array_string or array 'FRA' or 'FRA,DEU' or ['FRA','DEU']
default : 'FRA', 'GLP', 'GUF', 'MTQ', 'REU', 'MYT', 'PYF', 'SPM', 'WLF', 'MAF', 'BLM'
options.types array_string 'area,city,postalCode'
options.limit int 10
options.lang string 'fr'

All options of Here API are accepted, For more information : https://www.here.com/docs/bundle/geocoding-and-search-api-v7-api-reference/page/index.html


Here suggest API

params :

params type value
term string A city or postalCode,...

exemples :

    engine.suggest({
      term: 'Montpellier',
    }, (results, status) => {
      results.map(r => r.label)
          .indexOf('Montpellier')
          .should.equal(-1);

      status.should.be.eql(200);
    });
  })

Here Geocode API

params :

params type value
id string Here ID
text string An address

exemples :

    engine.geocode({
        id: 'here:cm:namedplace:20098349'
    });

    engine.geocode({{
        text: '1 rue de Rivoli, Paris'
    });

Here Reverse API

params :

params type value
latitude number latitude coordinate
longitude number longitude coordinate

exemple :

    engine.reverse({ latitude: 48.8555, longitude: 2.36039 });

About

Map Location Factory is a factory to build autocomplete and map components using Google and/or Here provider

Resources

Stars

Watchers

Forks

Packages

No packages published