add-marker
Puts a labelled marker on the map. The icon is `poi:<name>` for a bundled map icon (e.g. `poi:peak`) or `fa:<name>` for a Font Awesome one; anything else shows as its first two characters.
lat: number, lon: number, label: string?, color: string?, markerType: string?, icon: string?
clear-map
Takes everything the user put on the map off it — searched places, the planned route, drawings, imported tracks.
clear-search-results
Takes the searched places off the map and empties the list.
close-tool
Closes one open tool.
tool: string
describe-place
Says what is at a point on the map: the nearest addressable place, the OSM elements right there, and the areas containing it. Shows them on the map as it does.
lat: number, lon: number
download-map-features
Saves what is on the map to a file in the user's downloads, as GPX, GeoJSON or KML.
format: string, elevation: string?, name: string?
draw-area
Draws a filled area through the given points. The ring is closed on its own — do not repeat the first point.
points: array, label: string?, color: string?, fillColor: string?
draw-line
Draws a line through the given points. Use draw-area for a filled shape.
points: array, label: string?, color: string?, width: number?
find-objects-in-area
Finds POIs of the given categories (from list-object-categories) inside a bounding box, wherever it is — unlike show-objects, which is bound to what the map shows and draws what it finds. This one only reports back…
categories: array, west: number, south: number, east: number, north: number, limit: integer?, deliver: string?
fit-map-to-area
Zooms the map so that the given bounding box fits the screen — the way to show a whole region, town or route extent.
west: number, south: number, east: number, north: number
get-app-guide
Reads the app's own reference guide: what each tool, dialog and map layer does, and how to build a link that opens the map in a given state (viewport, layers, markers, drawn geometry, a planned route). Call it without…
section: string?
get-app-state
Returns what the app is doing right now: the open tools and dialog, the selected feature, the UI language and who is signed in.
get-elevation
Reads the height above sea level of the given points from the terrain model, in metres. A point the model has no data for comes back as null.
points: array
get-map-features
Returns everything the user has on the map — drawings, the planned route, searched places, shown objects, imported tracks — as one GeoJSON FeatureCollection.
deliver: string?
get-map-view
Returns what the map currently shows: its centre, zoom, visible bounding box, the layers that are on, and the shareable URL of this exact state.
get-route-elevation
Climb, drop and the highest and lowest point of the route currently planned, in metres.
get-route-itinerary
Returns the turn-by-turn steps of the route currently planned, with the distance and time of each. Distances are in metres, times in seconds.
list-drawings
Lists what is drawn on the map, with the index each one is removed by.
list-map-layers
Lists the map layers this app offers, with the one-letter code each is switched on by. A "base" layer is the map itself (only one at a time); an "overlay" is drawn on top of it (any number). premiumFromZoom marks a…
list-object-categories
Finds the POI categories the objects tool can show — search them by name in the UI language ("water", "shelter", "castle"). Each row carries the filter that show-objects takes.
search: string?
open-dialog
Opens one of the app's dialogs, for the user to carry on in themselves — signing in, exporting, buying credits, configuring the map. Call get-app-guide for what each one does.
dialog: string
open-drawing-tool
Opens a drawing toolbar so the user can carry on by hand — clicking points onto the map, restyling or labelling what is drawn.
kind: string
open-tool
Opens one of the app's tools — its toolbar, and whatever it takes over map clicks for.
tool: string
plan-route
Plans a route through the given waypoints and draws it on the map, opening the route finder. Returns its length and estimated time. "trip" mode reorders the waypoints into the shortest round of them all; "route" keeps…
points: array, transportType: string?, mode: string?
remove-drawing
Removes one drawn marker, line or area by its index from list-drawings. Removing shifts the indexes of what comes after it, so list them again between removals.
kind: string, index: integer
sample-elevation-grid
Reads the terrain model over a rectangle on a regular grid — one call instead of one per point. Elevations come back row-major from the north-west corner (row 0 is the northern edge), in metres, `null` where the model…
west: number, south: number, east: number, north: number, spacing: number, derivatives: boolean?, deliver: string?
search-places
Searches for a place by name, category, OSM element id (e.g. "way/123"), coordinates, a bounding box or pasted GeoJSON, and fills the app's result list. Results are ranked around the current map view. Show one on the…
query: string, limit: integer?
set-map-layers
Switches map layers on and off by their code (see list-map-layers). Naming overlays replaces the set that is on; leaving them out keeps it.
base: string?, overlays: array?
set-map-view
Moves the map. Give a centre, a zoom (0 = whole world, 19 = a building), or both.
lat: number?, lon: number?, zoom: number?
show-objects
Shows POIs of the given categories (filters from list-object-categories) within the current map view, and returns what was found. The map has to be at zoom 8 or closer, and a wide view finds a lot — zoom in on what is…
categories: array
show-search-result
Draws one result of the last search-places on the map and moves the map to it.
index: integer
redBus2 tools · redbus.in
Turkish Airlines4 tools · turkishairlines.com
AJet14 tools · ajet.com
Thomas Cook3 tools · thomascook.com
eSky.pl4 tools · esky.pl
Entur7 tools · entur.no