make readme more consistent

pull/41/head
Dave Conway-Jones 6 years ago
parent 609335d4eb
commit f38556d5c0
No known key found for this signature in database
GPG Key ID: 9E7F9C73F5168CD4

@ -17,13 +17,14 @@ Either use the Manage Palette option in the Editor menu, or run the following co
npm i --save node-red-contrib-web-worldmap
## Usage
Plots "things" on a map. The map will be served from `{httpRoot}/worldmap`
The minimum **msg.payload** must contain `name`, `lat` and `lon` properties, e.g.
{name:"Joe", lat:51, lon:-1.05}
msg.payload = { name:"Joe", lat:51.05, lon:-1.35 }
`name` must be a unique identifier across the whole map. Repeated location updates to the same `name` move the point.
@ -73,7 +74,7 @@ There are also several special icons...
You can use NATO symbols via <a href="https://github.com/spatialillusions/milsymbol" target="_new">milsymbol.js</a>.
To do this you need to supply a `msg.SIDC` instead of an icon, for example:
{ name: "Emergency Medical Operation",
msg.payload = { name: "Emergency Medical Operation",
lat: 51.05,
lon: -1.35,
SIDC:"ENOPA-------",
@ -88,7 +89,7 @@ The OSM Buildings layer is available in the layers menu. You can replace this wi
sending a msg.payload containing a name and a building property. The building property should be
a GeoJSON Feature Collection as per the OSMBuildings spec.
{ name:"My Block", building: {
msg.payload = { name:"My Block", building: {
"type": "FeatureCollection",
"features": [
{
@ -137,7 +138,7 @@ then rather than draw a point and icon it draws the polygon. Likewise if it cont
If the payload contains a **radius** property, as well as name, lat and lon, then rather
than draw a point it will draw a circle. The *radius* property is specified in meters.
{ lat:51.05, lon:-1.35, name:"A3090", radius:3000 }
msg.payload = { lat:51.05, lon:-1.35, name:"A3090", radius:3000 }
As per Areas and Lines you may also specify *iconColor*, and *layer*.

Loading…
Cancel
Save