Building Mapbooks

The mapular-admin server creates and configures mapbooks — interactive map dashboards you can share via a link.

Run mapular login once before using these tools.

Typical workflow

session_info → create_mapbook → add_series (repeat) → configure_mapbook → share_mapbook

Add series in dependency order: catalog/mpoi/upoi first, then formula, then analysis. Later types reference earlier ones.

Tools

session_info

Verify authentication and active tenant. Always run first.

list_mapbooks / create_mapbook

List existing mapbooks or create a new one. Returns mapbook_id.

create_mapbook(tenant_id, name, access_level="shared")

add_series(mapbook_id, type, params)

Add a data layer. The type controls the data source:

configure_mapbook(mapbook_id, config_patch)

Set viewport, basemap, and table config:

{
  "viewport": { "longitude": 13.4, "latitude": 52.5, "zoom": 11 },
  "basemap": "dark"
}

share_mapbook(mapbook_id, action?)

Create, list, or delete share links. Default creates a 30-day link.

upload_csv(csv_path, name)

Upload a local CSV as a point dataset. Returns dataframe_id for add_series(type="upoi"). Lat/lon columns are auto-detected.

Inspecting and editing

• inspect_mapbook(mapbook_id) — audit a mapbook's series and config
• update_series — rename, change filters, toggle visibility
• remove_series — remove a layer (remove dependents first)

Deleting

delete_mapbook and delete_dataframe are permanent and irreversible. Verify IDs with inspect_mapbook or list_mapbooks before calling.