Skip to content

tcigrand/ng2-map

 
 

Repository files navigation

ng2-map

Angular2 Google Map (ng-map version 2)

  • Imgur

Design Principle

  1. All google properties must be able to be defined in html without Javascript.

    Thus, basic users don't even have to know what Javascript is.

  2. Expose all original Google Maps V3 api to the user without any exception.

    No hiding, nor manipulation. By doing so, programmers don't need to learnthis module. If you know Google Maps V3 API, there shouldn't be no problem using this module.

Usage

  1. Install node_module ng2-map and typings

     $ npm install ng2-map @types/google-maps --save
    
  2. For SystemJs users only, update system.config.js to recognize ng2-map.

     map['ng2-map'] = 'node_modules/ng2-map/dist';
     packages['ng2-map'] = { main: 'ng2-map.umd.js', defaultExtension: 'js' }
    
  3. import Ng2MapeModule to your AppModule

     import { NgModule } from '@angular/core';
     import { FormsModule } from "@angular/forms";
     import { BrowserModule  } from '@angular/platform-browser';
    
     import { AppComponent } from './app.component';
     import { Ng2MapModule} from 'ng2-map';
    
     @NgModule({
       imports: [BrowserModule, FormsModule, Ng2MapModule],
       declarations: [AppComponent],
       bootstrap: [ AppComponent ]
     })
     export class AppModule { }
    
  4. Your Google maps may require API key, then override apiUrl

     import { Component } from '@angular/core';
     import { Ng2MapComponent } from 'ng2-map';
    
     @Component({ ... })
     export class AppComponent {
    
       constructor() {
         Ng2MapComponent['apiUrl'] = 'https://maps.google.com/maps/api/js?key=XXXXXXXXXXXXXXXXXXXXXXXXXX';
       }
     }
    

Use it in your template

<ng2-map center="Brampton, Canada"></ng2-map>

or,

<ng2-map [options]="mapOptions"></ng2-map>

For full example, please check out app directory to see the example of;

  • main.ts
  • and app.component.ts.

This ng2-map module is only improved and maintained by contributors like you;

As a contributor, it's NOT required to be skilled in Javascript nor Angular2. It’s required to be open-minded and interested in helping others. You can contribute to the following;

  • Updating README.md
  • Making more and clearer comments
  • Answering issues and building FAQ
  • Documentation
  • Translation

In result of your active contribution, you will be listed as a core contributor on https://ng2-ui.github.io, and a member of ng2-ui too.

If you are interested in becoming a contributor and/or a member of ng-ui, please send me email to allenhwkim AT gmail.com with your github id.

Google Maps V3 Compatibility Table

Object Options Events Note
Map MapOptions Map Events supported as `ng2-map`
Marker MarkerOptions Marker Events supported as `marker`
InfoWindow InfoWindowOptions InfoWindow Events supported as `info-window`
Circle CircleOptions Circle Events supported as `circle`
Polygon PolygonOptions Polygon Events supported as `polygon`
Polyline PolylineOptions Polyline Events supported as `polyline`
GroundOverlay GroundOverlayOptions GroundOverlay Events supported as `ground-overlay`
FusionTablesLayer FusionTablesLayerOptions FusionTablesLayer Events Coming Soon
HeatMapLayer HeatMapLayerLayerOptions HeatMapLayer Events Coming Soon
KmlLayer KmlLayerLayerOptions KmlLayer Events Coming Soon
Data DataOptions Data Events Coming Soon `map-data`
BicyclingLayer BicyclingLayerOptins BicyclingLayer Events Coming Soon
MapsEngineLayer MapsEngineLayerOptins MapsEngineLayer Events Coming Soon
TrafficLayer TrafficLayerOptions TrafficLayer Events Coming Soon
StreetViewPanorama StreetViewPanoramaOptions StreetViewPanorama Events Coming Soon
DrawingManager DrawingManagerOptions Drawing Manager Events Coming Soon
Autocomplete AutocompleteOptions Autocomplete Events Coming Soon
DirectionsRenderer DirectionsRendererOptions DirectionsRenderer Events Coming Soon

For Developers

To start

$ git clone https://github.com/ng2-ui/ng2-map.git
$ cd ng2-map
$ npm install
$ npm start

List of available npm tasks

  • npm run : List all available tasks
  • npm start: Run app directory for development using webpack-dev-server with port 9001
  • npm run clean: Remove dist folder
  • npm run lint: Lint TypeScript code
  • npm run build:ngc: build ES module
  • npm run build:umd: Build UMD module ng2-map.umd.js
  • npm run build:app: Build app/build/app.js for runnable examples
  • npm run build: Build all(build:ngc, build:umc, and build:app)

About

Angular2 Google Maps Directives

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 88.0%
  • JavaScript 7.4%
  • HTML 4.6%