# svgeo > Convert TopoJSON into semantic SVG Latest version **0.3.5** (published 2016-07-29) · CC0-1.0 license · 0 weekly downloads ## Install ```sh npm install svgeo pnpm add svgeo yarn add svgeo bun add svgeo ``` Provides the command `svgeo`. ## 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.3.5 | | Published | 2016-07-29 | | First published | 2016-04-28 | | Weekly downloads | 0 | | License | CC0-1.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 7 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 24 | | Author | Shawn Allen | | Maintainers | shawnbot | | Keywords | svg, topojson, geo | ## Links - npm: https://www.npmjs.com/package/svgeo - Repository: https://github.com/shawnbot/svgeo - Homepage: https://github.com/shawnbot/svgeo#readme - Issues: https://github.com/shawnbot/svgeo/issues - npm.io page: https://npm.io/package/svgeo ## Dependencies (7) - [d3](https://npm.io/package/d3.md) ^3.5.16 - [fof](https://npm.io/package/fof.md) ^1.2.0 - [async](https://npm.io/package/async.md) ^1.5.2 - [jsdom](https://npm.io/package/jsdom.md) ^8.4.1 - [optimist](https://npm.io/package/optimist.md) ^0.6.1 - [topojson](https://npm.io/package/topojson.md) ^1.6.24 - [require-relative](https://npm.io/package/require-relative.md) ^0.8.7 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 0.3.5 (latest) — 2016-07-29 - 0.3.4 — 2016-07-29 - 0.3.3 — 2016-07-29 - 0.3.2 — 2016-07-29 - 0.3.1 — 2016-04-28 - 0.3.0 — 2016-04-28 - 0.2.2 — 2016-04-28 - 0.2.1 — 2016-04-28 - 0.2.0 — 2016-04-28 - 0.1.0 — 2016-04-28 ## README # svgeo This is a Node.js module and command line tool for converting [TopoJSON] into semantic SVG. The resulting SVG contains `` elements for each layer ("object") in the topology, and one for each feature in each layer. Layers can be selected by name (and re-ordered), and features can be filtered with [fof]-compatible expressions. For example: ```sh # assuming we've installed topojson and found a Shapefile of US states... topojson states=path/to/states.shp > states.json # isolate features by id with --only-features svgeo --only-features CA,OR,WA --zoom auto states.json > west-coast.svg # exclude features by id with --exclude-features svgeo --exclude-features AS,GU,PR --zoom auto states.json > no-territories.svg ``` You can also generate meshes (connected outlines) of all or individual layers, which makes styling borders much nicer. If you've ever been frustrated with the jaggies that result from putting a stroke on two abutting features, then this is for you. ```sh svgeo --mesh -- states.json > states.svg ``` ### Great, now what do I do with these SVGs? I'm glad you asked. Debugging TopoJSON can be tricky; `svgeo` might just be a handy tool for ensuring that your topologies look the way you expect them to. But you can also use the resulting SVGs as web assets, either with regular old `` tags: ```html ``` or, if you want to get fancy, the [SVG `` element][use] lets you selectively import elements by ID and style them individually: ```html ``` You can also add styles to the SVG document with `--style`, which takes a CSS string like `'.feature { fill: #eee; } .mesh { stroke: #000; }'`. You can reference an external CSS file with `--style '@import url("path/to/style.css")'`. ## Installation ``` npm install [-g] svgeo ``` ## Command Line ``` svgeo [options] [input] [-o output] Options: --projection The d3.geo projection to use (use "null" or -C for cartesian) [default: "mercator"] --cartesian, -C Assume Cartesian coordinates (no geographic projection) --layers A comma-separated list of keys to whitelist from topology.objects [default: null] --feature-filter, --ff Filter features by this dot or fat arrow expression --only-features, --of Only include the features with these comma-separated IDs --exclude-features, --ef Exclude the features with these comma-separated IDs --mesh, -m Include mesh (connected outline) layers for comma-separated IDs, or "*" --style, --css Include (literal) CSS styles in your SVG. To import a URL, use --style "@import url(style.css);" --zoom, -z The layer or feature id to zoom to --id The feature ID accessor (dotmap or fat arrow expression) [default: "id"] --properties A comma-separated list of feature properties to convert to data attributes, or "*" (or as a boolean flag) [default: null] --bounds, -b The geographic bounds to zoom to, in the form "west north east south" --viewbox, -V The SVG viewBox, in the form "left top width height" (projected pixels) -o Write the resulting SVG to this file (otherwise, write to stdout) -h, --help Show this helpful message ``` ## API Coming soon! [TopoJSON]: https://github.com/mbostock/topojson [fof]: https://github.com/shawnbot/fof [use]: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/use --- _Source: https://npm.io/package/svgeo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._