maps
Reference for the maps tool of Author: world maps, with every action and the arguments you can pass.
World maps: places pinned on a picture or a drawing, with routes and distances. Routes give the travel check its distances.
Call it as geenius_author(tool: "maps", action: "<action>", args: {...}) through Geenius OS.
Actions#
| Action | What it does |
|---|---|
list | The world maps (of one book, or all). Rules: book_id?. |
get | One map: its pins, routes and drawing. Rules: map_id. |
create | A new world map. Rules: name, book_id?, image_file_id? (a picture uploaded in the Author app), width?, height? (map units), km_per_unit?. |
update | Change a map. Rules: map_id + any of those (those of map_create). |
delete | Delete a map. Rules: map_id. |
pin | Pin a place profile on a map. Rules: map_id, profile_id (a place or city), x, y, label?. |
unpin | Take a place's pin off a map. Rules: map_id, profile_id. |
route | A route between two pinned places, with its distance. Rules: map_id, from_id, to_id (pinned profiles), km? (measured on the map when omitted), mode?, label?. |
unroute | Remove a route. Rules: map_id, route_id. |
draw | Replace a map's drawing with strokes. Rules: map_id, strokes [{points:[x0,y0,x1,y1,…], color?, width?, fill?}] (replaces the drawing). |
Arguments we have checked#
maps · list#
The world maps (of one book, or all). Rules: book_id?.
book_id
maps · get#
One map: its pins, routes and drawing. Rules: map_id.
map_id(required)
maps · create#
A new world map. Rules: name, book_id?, image_file_id? (a picture uploaded in the Author app), width?, height? (map units), km_per_unit?.
book_idheightimage_file_idkm_per_unitname(required)width
maps · update#
Change a map. Rules: map_id + any of those (those of map_create).
book_idheightimage_file_idkm_per_unitmap_id(required)namewidth
maps · delete#
Delete a map. Rules: map_id.
map_id(required)
maps · pin#
Pin a place profile on a map. Rules: map_id, profile_id (a place or city), x, y, label?.
labelmap_id(required)profile_id(required)x(required)y(required)
maps · unpin#
Take a place's pin off a map. Rules: map_id, profile_id.
map_id(required)profile_id(required)
maps · route#
A route between two pinned places, with its distance. Rules: map_id, from_id, to_id (pinned profiles), km? (measured on the map when omitted), mode?, label?.
from_id(required)kmlabelmap_id(required)modeto_id(required)
maps · unroute#
Remove a route. Rules: map_id, route_id.
map_id(required)route_id(required)
maps · draw#
Replace a map's drawing with strokes. Rules: map_id, strokes [{points:[x0,y0,x1,y1,…], color?, width?, fill?}] (replaces the drawing).
map_id(required)strokes(required)