Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

mapir-angular-component

1.0.1 • Public • Published

MapirAngularComponent

npm version

Map.ir Angular wrapper for mapbox-gl-js. Expose a bunch of component meant to be simple to use for Angular.

Get API Key

🔑 You should first get api key from Map.ir

Installation

npm i mapir-angular-component mapbox-gl

If using typescript, add mapbox-gl types:

npm install @types/mapbox-gl

Add mapbox-gl CSS

Load the css of mapbox-gl (and mapbox-gl-geocoder if mglGeocoder is used)

For example, with angular-cli projects add this in angular.json:

"styles"[
  "./node_modules/mapbox-gl/dist/mapbox-gl.css",
  "./node_modules/@mapbox/mapbox-gl-geocoder/lib/mapbox-gl-geocoder.css"
  ]

Or in global css (called styles.css for example in angular-cli)

@import "~mapbox-gl/dist/mapbox-gl.css";
@import "~@mapbox/mapbox-gl-geocoder/lib/mapbox-gl-geocoder.css";

Add Polyfill

Add this in your polyfill.ts file (Wykks/ngx-mapbox-gl/issues/136#issuecomment-496224634):

(window as any).global = window;

Quick start

Import module

in app.module.ts file:

import { NgxMapboxGLModule } from 'mapir-angular-component';
 
@NgModule({
  imports: [
    NgxMapboxGLModule
  ]
})
export class AppModule {}

Set API Key

in app.component.ts file:

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {
  title = 'mapir-angular-test';
  center:Array<number> = [35.712706, 51.367918];
+  apiKey:string = "<YOUR API KEY>";
}

Generate Component

in app.component.html file:

<mgl-map
  [zoom]="[2]"
  [center]="center"
  [centerWithPanTo]="true"
  [interactive]="true"
  [apiKey]="apiKey"
></mgl-map>

📖 English Documentation

Install

npm i mapir-angular-component

DownloadsWeekly Downloads

8

Version

1.0.1

License

MIT

Unpacked Size

2.41 MB

Total Files

89

Last publish

Collaborators

  • avatar
  • avatar
  • avatar