dotted-map 2.2.3 → 3.1.0

package/README.md

@@ -7,6 +7,8 @@
 
   <img src="https://raw.githubusercontent.com/NTag/dotted-map/master/images/world-diagonal-circle-dark.svg" width="100%" />
 
+  <img src="https://raw.githubusercontent.com/NTag/dotted-map/master/images/world-orthographic-circle-dark.svg" width="100%" />
+
   <img src="https://raw.githubusercontent.com/NTag/dotted-map/master/images/france-diagonal-hexagon-light.svg" height="150px" />
   <img src="https://raw.githubusercontent.com/NTag/dotted-map/master/images/italy-diagonal-hexagon-light.svg" height="150px" />
   <img src="https://raw.githubusercontent.com/NTag/dotted-map/master/images/uk-diagonal-hexagon-light.svg" height="150px" />
@@ -16,7 +18,7 @@
 
 ## Installation
 
-Requires NodeJS ≥ 13.
+Requires NodeJS ≥ 18.
 
 ```bash
 npm i dotted-map
@@ -25,9 +27,8 @@ npm i dotted-map
 ## Usage
 
 ```js
-const fs = require('fs');
-const DottedMap = require('dotted-map').default;
-// Or in the browser: import DottedMap from 'dotted-map';
+import fs from 'fs';
+import DottedMap from 'dotted-map';
 
 const map = new DottedMap({ height: 60, grid: 'diagonal' });
 
@@ -54,13 +55,15 @@ fs.writeFileSync('./map.svg', svgMap);
 
 If you use a large number of points (height or width ≥ 100), it may take a bit of time to compute the map (from 1 to 30 seconds depending on your device and number of points). This is why the result grid is cached. If you don’t change the parameters of `new DottedMap`, the next maps will be a lot faster to generate. You can however change the pins and the SVG options.
 
+It’s also possible to use it in **Leaflet**, see [an example here](https://github.com/NTag/colivings/blob/main/src/App.js).
+
 ### Precomputing the map
 
 Because the previous operation can be expansive (especially if you want to use DottedMap in a browser or React Native app), it’s possible to precompute the grid. You will still be able to add pins on-the-fly, in real time. This also allows you to import a lighter version of the library. This is especially useful if you always use the same map parameters, but only change the pins.
 
 ```js
 // So you do this first step only once, when developing your app
-const getMapJSON = require('dotted-map').getMapJSON;
+import { getMapJSON } from 'dotted-map';
 
 // This function accepts the same arguments as DottedMap in the example above.
 const mapJsonString = getMapJSON({ height: 60, grid: 'diagonal' });
@@ -123,9 +126,10 @@ import DottedMap from 'dotted-map';
 const map = new DottedMap({
   height,
   width, // just specify either height or width, so the ratio of the map is correct
-  countries: ['FRA'] // look into `countries.geo.json` to see which keys to use. You can also omit this parameter and the whole world will be used
+  countries: [‘FRA’] // look into `countries.geo.json` to see which keys to use. You can also omit this parameter and the whole world will be used
   region: { lat: { min, max }, lng: { min, max } }, // if not present, it will fit the countries (and if no country is specified, the whole world)
-  grid: 'vertical' | 'diagonal', // how points should be aligned
+  grid: ‘vertical’ | ‘diagonal’, // how points should be aligned
+  projection: { name, center }, // optional, see below
   avoidOuterPins: false | true, // if it’s true, prevent adding pins when they are outside of region/countries
 });
 
@@ -151,6 +155,39 @@ map.getSVG({
 // <svg><circle … /><circle …></svg>
 ```
 
+### Projection
+
+By default, the map uses the Mercator projection. You can optionally pass a `projection` parameter to use a different one:
+
+```js
+const map = new DottedMap({
+  height: 60,
+  grid: 'diagonal',
+  projection: { name: 'robinson' },
+});
+```
+
+Available projections: `mercator` (default), `equirectangular`, `robinson`, `equalEarth`, `mollweide`, `miller`, `sinusoidal`, `orthographic`, `gallPeters`, `vanDerGrinten`.
+
+You can also pass a `center` to shift the map's center point. This is especially useful for `orthographic` (which shows a single hemisphere) but works with any projection:
+
+```js
+// Orthographic projection centered on North America
+const map = new DottedMap({
+  height: 60,
+  grid: 'diagonal',
+  projection: { name: 'orthographic', center: { lat: 40, lng: -100 } },
+});
+
+// Robinson projection centered on the Pacific
+const map = new DottedMap({
+  height: 60,
+  projection: { name: 'robinson', center: { lat: 0, lng: 150 } },
+});
+```
+
+Note: for `orthographic`, pins on the back side of the globe (not visible) will be ignored.
+
 ## Acknowledgments
 
 Countries are from https://github.com/johan/world.geo.json.

package/dist/chunk-C0xms8kb.cjs

@@ -0,0 +1,34 @@
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});