Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

hurricane-basemap

mbloch201.3.2

A command line program for generating basemaps in SVG, PNG or HTML format

readme

hurricane-basemap

A command line program for generating basemaps in SVG, PNG or HTML format

Installing

npm i -g newsdev/hurricane-basemap

Running hurricane-basemap

Usage: hurricane-basemap [options]

Options:
  -c, --config <file>  geometry config file or the name of a published config
  -n, --name <name>    name of the output map (should be unique)
  -s, --style <name>   style file (searches styles/) (default: "style1")
  -o, --odir <dir>     directory to save output files
  -d, --debug          save temp files in tmp/ directory for debugging
  -f, --format <list>  output format (png,svg,html) (default: "svg")
  -m, --mixins <list>  file(s) containing map style overrides
  -V, --version        output the version number
  -h, --help           show this help message

Geometry files (--config option)

The required geometry config file

Style rules

See the example file styles/style.json

Indexed style

Example

style: {
    "type": "indexed",
    "default": {
        "fill": "white"
    },
    "index_field": "type",
    "index": {
        "usa": {
            "fill": "red",
            "opacity": 0.5
        }
    }
}