Skip to content
This repository was archived by the owner on Feb 28, 2022. It is now read-only.

Repository files navigation

Angular OSM

NPM

Travis CICodacy Badgesemantic-releaseCommitizen friendly

QualityCoverage Status [![Circle CI] circle-icon ]circle-url

dependenciesdevdependencies

Angular OSM is a set of angular services to use OSM APIs.

Please show me examples

Example : OSM APISource

Example : base64 adapterSource

Example : nominatimSource

Example : oauth adapterSource

Example : osrmSource

Example : overpassSource

Example : taginfoSource

Example : togeojsonSource

Example : fullSource

How to add angular openstreetmap to my project

First add it to your dependencies:

npm install --save angular-osm

Next it depends what you want to do. The release provide many distributed files:

node_modules/angular-osm
├── README.md
├── dist
│ ├── osm-api.js
│ ├── osm-api.min.js
│ ├── osm-base64.js
│ ├── osm-base64.min.js
│ ├── osm-full.js
│ ├── osm-full.min.js
│ ├── osm-nominatim.js
│ ├── osm-nominatim.min.js
│ ├── osm-oauth.js
│ ├── osm-oauth.min.js
│ ├── osm-osrm.js
│ ├── osm-osrm.min.js
│ ├── osm-overpass.js
│ ├── osm-overpass.min.js
│ ├── osm-taginfo.js
│ ├── osm-taginfo.min.js
│ ├── osm-togeojson.js
│ ├── osm-togeojson.min.js

Each build provides one osm api integration so you can just pick the one you want.

If you want all API just include osm-full.min.js.

So you may need more dependencies dependening on what you want to do. Here is the dependencies table of angular-osm builds:

distdependencies to install
osm-apinpm install --save x2js
osm-base64npm install --save angular-base64 x2js
osm-oauthnpm install --save osm-auth x2js
osm-nominatim
osm-osrm
osm-overpass
osm-taginfo
osm-togeojson

Now you have choose this you can plug the component into your angular app:

angular.module('example', ['osm.api'])

If you want, most of provided service can be configured using corresponding providers

angular.module('example', ['osm.api'])
.config(function (osmAPIProvider) {
osmAPIProvider.options = {
url: 'http://api06.dev.openstreetmap.org/api'
};
});

The complete list of injectable services:

moduleservice
osm.apiosmAPI
osm.base64osmBase64
osm.oauthosmAuthService
osm.nominatimosmNominatim
osm.osrmosrmAPI
osm.overpassosmOverpassAPI
osm.taginfoosmTagInfoAPI
osm.togeojsonosmtogeojson

About

AngularJS lib to make it easier to works with OSM ecosystem

Resources

Contributing

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages