Giter Club home page Giter Club logo

mapbox.photon's Introduction

mapbox.photon

badge badge badge badge GitHub

This module adds control for Photon geocoder.

This plugin was inspired from leaflet.photon repository.

Installation

npm i @watergis/mapbox.photon --save

Demo

Try codesandbox.

See demo.

demo

Usage

  • note

This plugin uses komoot's photon API (https://photon.komoot.io/api) as default. However, please consider to have your own photon API if you want to use geocoding heavily in order to avoid many traffics for komoot server.

  • for geocoding
import MapboxPhotonGeocoder from "@watergis/mapbox.photon";
import '@watergis/mapbox.photon/css/styles.css';
import mapboxgl from 'mapbox-gl';

const map = new mapboxgl.Map();
map.addControl(new MapboxPhotonGeocoder({
    placeholder: 'Start typing...',
    minChar: 3,
    limit: 5,
    submitDelay: 300,
    noResultLabel: 'No result',
    feedbackUrl: 'https://github.com/komoot/photon/issues',
    feedbackLabel: 'Feedback',
    // default adds a popup, but you may change the behaviour when the POI was selected.
    onSelected: function(choice) {
      console.log(choice);
    },
    // if you want to customise geocoding function
    doSearch: function(query, callback) {
      console.log(query);
    }
  },
  {
    url: 'https://photon.komoot.io/api?',
    limit: 5,
    // if you want to filter by osm_tag parameter
    osm_tag: 'tourism',
    lang: 'ja',
    bbox: [], //specify minx, miny. maxx, maxy if you want to filter by particular area
    includePosition: true,
    location_bias_scale: 0.2
  },
  {
    // after creating a popup, it will zoom to this default zoom level
    popupZoomLevel: 14,
    // if you want to custmize popup content's html
    createContent: function(feature) {
      return feature.properties.name
    },
  }
}), 'top-left');
  • for reverse geocoding
import { PhotonReverse } from "@watergis/mapbox.photon";

const recverse = new PhotonReverse();
const result = await recverse.reverse(35.8664039, -1.0861514);
console.log(result);

Development

npm run lint # check styling of source code
npm run lint:fix # fix styling by eslint
npm run serve

open http://localhost:8080.

If there are any changes on source code, it will be reflected automatically.

Build package

npm run build

The modules will be generated under dist folder.

Deploy to Github pages

npm run deploy

It will deploy files under example folder to gh-pages.

How to release

npm version patch # it increase patch version 0.0.X
npm version minor # it increase minor version 0.x.0
npm version major # it increase major version x.0.0
git push origin main --tag
# release CI will create draft release in Github pages, then publish it if it is ready.
# publish CI will deploy npmjs and Github Packages.

Contribution

This Mapbox GL Photon Control is still under development. so most welcome any feedbacks and pull request to this repository.

mapbox.photon's People

Contributors

jinigarashi avatar

Stargazers

 avatar digoburigo avatar Daisuke Matsumoto avatar

Watchers

James Cloos avatar  avatar

mapbox.photon's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.