andy/planetary.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
d873121c08
planetary.js/site/public/documentation/builtin_borders.md

1.1 KiB
Raw Blame History

Borders Plugin

The borders plugin renders the borders around (and between) countries. It uses TopoJSON data published to planet.plugins.topojson.world by the TopoJSON plugin. It uses the feature at objects.countries in the TopoJSON object to calculate the borders.

API

planetaryjs.plugins.borders([config])

Valid keys for config are:

  • stroke: the strokeStyle to use for the context; defaults to "gray"
  • lineWidth the lineWidth to set on the context; defaults to no value, and the context's lineWidth is not modified
  • type: valid options are "internal", "external", or "both". "internal" draws borders between countries but not coastlines; "external" does the opposite. "both", unsurprisingly, draws both. Defaults to "internal".
JavaScript
planetaryjs.plugins.borders({
  stroke: '#008000', lineWidth: 0.25, type: 'both'
});

See also: