ng-worldmap v1.2.2

ng-worldmap

A component wrapping gardaud/worldmap-canvas in an Angular component.

TL-DR

Plunker Link

Installing

Install the npm package:

npm install --save ng-worldmap

Bootstraping

In your module declaration file, import the module:

import { WorldMapModule } from "ng-worldmap";
@NgModule({
  imports: [
    ...,
    WorldMapModule
  ]
})

Usage

Now in your template, just use the component:

  <world-map></world-map>

Customization

// Class used to customize specific countries' rendering
class CountryCustomization {
  public color: string;          // Foreground color
  public highlightColor: string; // Highlight color
  public borderColor: string;    // Border color
  public borderWidth: number;    // Border width
}

class WorldMapComponent {
  // Sets the component's background color. Also configurable via CSS.
  // Default: #c2c2c2
  public setBackgroundColor(color: string);
  // Sets the countries default foreground color.
  // Default: #e2e2e2
  public setForegroundColor(color: string);
  // Sets the countries default highlight color.
  // Default: #f93
  public setHighlightColor(color: string);
  // Sets the default border color.
  // Default: #a0a0a0
  public setBorderColor(color: string);
  // Sets the default border width.
  public setBorderWidth(width: number);
  // Sets the rendering customization for a specific country.
  public setCustomization(countryCode: string, customization: CountryCustomization);
  // Clears the rendering customziation for a specific country.
  public resetCustomization(countryCode: string);
  // Sets the countries' rendering customization to an existing map.
  public setCustomizations(customizations: Map<string, CountryCustomization>);
  // Clears the countries' rendering customizations.
  public clearCustomizations();
}

Example of customization

import { Component, ViewChild } from "@angular/core";

@Component({
  selector: "demo",
  template: `<world-map #theMap></world-map>`
})
class DemoComponent {
  @ViewChild("theMap") theMap: WorldMapComponent;

  constructor() {}

  goGreen() {
    this.theMap.setForegroundColor("green");
  }

  goRed() {
    this.theMap.setBackgroundColor("red");
  }

  goBlack() {
    this.theMap.setCustomization("us", new CountryCustomization("black", "gray", "black", 5));
  }
}