# world-map

> World map using d3

Latest version **0.0.9** (published 2016-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install world-map
pnpm add world-map
yarn add world-map
bun add world-map
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2016-11-19 |
| First published | 2016-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Santiago H. Cardona |
| Maintainers | santiagohecar |
| Keywords | d3, world, map |

## Links

- npm: https://www.npmjs.com/package/world-map
- Repository: https://github.com/santiagohecar/world-map
- Homepage: https://github.com/santiagohecar/world-map#readme
- Issues: https://github.com/santiagohecar/world-map/issues
- npm.io page: https://npm.io/package/world-map

## Dependencies (2)

- [d3](https://npm.io/package/d3.md) ^4.3.0
- [topojson](https://npm.io/package/topojson.md) ^1.6.27

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 0.0.9 (latest) — 2016-11-19
- 0.0.8 — 2016-11-19
- 0.0.7 — 2016-11-18
- 0.0.6 — 2016-11-18
- 0.0.5 — 2016-11-16
- 0.0.4 — 2016-11-12
- 0.0.3 — 2016-11-10
- 0.0.2 — 2016-11-07
- 0.0.1 — 2016-11-07

## README

# World map

Create and add world maps to your pages, enable zoom to get a more interactive views of the lands, and load additional resources to draw and customize the maps.

![alt tag](https://raw.githubusercontent.com/santiagohecar/world-map/master/example/world-map.png)

See on [bl.ocks.org](http://bl.ocks.org/santiagohecar/ddd1470b88e1e57d2ec1f7273185f018).

## Usage

Download the [latest release](https://github.com/santiagohecar/world-map/releases/latest), copy `world-map.js` or `world-map.min.js` (for minified version) from the dist folder into your project and simply load the file in a script tag

```html
<script type="text/javascript" src="worl-map.min.js"></script>
```

You can also install with npm
    
    npm install world-map --save

Then require it in your code 

```javascript
var WorldMap = require("world-map");
```    
To create a new map, first add the container where can be loaded

```html
<div id="my-map"></div>
```
Pass the id as first parameter of the constructor, and that's all!  

```javascript
var map = new WorldMap("my-map");
```

A optional object of options can be passed as second parameter

```javascript
WorldMap("my-map", 
{
  width: 960,
  height: 480,
  zoom: false,                             // enable/disable dragging and zooming
  resources:                               // load additional resources to customize the maps 
  [
    { 
      name: 'stations',                    // when loaded can access as map.resources.stations
      type: 'json',                        // also could be 'csv' 
      src: 'example.com/a.json',           // path to the resource
      onLoad: function (map, resource) {}, // called after the resource is loaded
      row: myOtherFunction,                // called for all row of the resource, used whit csv  
    }
  ], 
  onLoad: function (map) {},               // called when all resources loading is complete
  hideAntarctic: true,                       
  landsColor: '#ddd',
  landsBorder: '#fff',
  onDraw: function (map) {}                // draw additional canvas shapes inside
});
```

Take a look to a [live example](http://plnkr.co/edit/sOvkiTxQMgwtRFERq4qr?p=preview).

For a more advanced example [flights-map](https://github.com/santiagohecar/flights-map) can be useful, see working [here](http://bl.ocks.org/santiagohecar/2f8be5c36ac9a08168b10b5a10a916e4).

## License
Copyright &copy; 2016 [Santiago H. Cardona](https://github.com/santiagohecar).
Licensed under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/world-map · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._