planetary.js/site/public/documentation/builtin_borders.md
2013-12-25 23:25:35 -08:00

1.0 KiB

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.

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: