CnObjectGeoWidget

View and edit an OpenRegister object's geographical metadata (@self.geo) on a map. It renders the object's location as a marker on the CnMapWidget primitive, wrapped in the CnWidgetWrapper chrome (Widget family — carries the shared overflow Actions menu). When editable, clicking the map places or moves the location marker and a footer offers Save / Cancel / Remove location.

Registered as the built-in object-geo widget key and as a detail-page Add-widget type ("Location / map"), so a type: "detail" page can place it via widgetKey: "object-geo" or a user can add it in-app from the Buildiq edit menu.

Storage shape

The location is stored as a GeoJSON Point geometry in the object's @self.geo:

{ "type": "Point", "coordinates": [5.2913, 52.1326] }

Note GeoJSON coordinate order is [longitude, latitude]. Reading is tolerant — a bare Point geometry, a Feature, a FeatureCollection (first feature is used), or a plain { lat, lng } / { latitude, longitude } object are all accepted.

Persistence

Save issues a PATCH /apps/openregister/api/objects/{register}/{schema}/{id} whose body is only { "@self": { "geo": <point|null> } } — the object's own properties are never touched. Remove location persists @self.geo = null. The OpenRegister save path applies @self.geo on both create and update; geo is client-writable (it drives no security or lifecycle decision).

Usage

<!-- Standalone -->
<CnObjectGeoWidget
  :object-data="object"
  :register="register"
  :schema="schema"
  @saved="onGeoSaved" />

Map options

All of these are editable in-app from the widget's config form (CnObjectGeoWidgetForm), and are stored on the widget's content blob.

Prop	Default	What it does
editable	true	Click the map to place/move the marker; footer offers Save / Cancel / Remove. false renders a read-only map.
addressSearch	false	Adds a search box that geocodes a place name and drops the marker there. Requires editable.
basemap	'standard'	Background map: standard, humanitarian or terrain.
allowBasemapSwitch	false	Renders a base-map switcher so users can change the background themselves.
fitControl	true	"Recenter" button — re-centres on the marker.
locateControl	true	"Locate me" button (browser geolocation).
fullscreenControl	true	Fullscreen toggle.
height	'360px'	Map container height.
defaultZoom	7	Zoom used while the object has no location. Once it has one, the map zooms to it.

Passing a custom tile entry via layers (e.g. the Dutch PDOK BRT achtergrondkaart) takes over the background and disables basemap / the switcher, so existing consumers keep their own basemap.

Content-Security-Policy (required)

Both the base maps and the address search reach third-party hosts, and Nextcloud's default CSP blocks them. A CSP-blocked tile issues no network request at all — the map just renders blank — so check the browser console, not the network tab, when a base map doesn't appear.

The consuming app must allowlist what it uses:

// lib/AppInfo/Application.php — boot()
$policy = new ContentSecurityPolicy();
// Base maps (img-src) — one entry per basemap you offer:
$policy->addAllowedImageDomain('https://*.tile.openstreetmap.org');   // standard
$policy->addAllowedImageDomain('https://*.tile.openstreetmap.fr');    // humanitarian
$policy->addAllowedImageDomain('https://*.tile.opentopomap.org');     // terrain
// Address search (connect-src):
$policy->addAllowedConnectDomain('https://nominatim.openstreetmap.org');
$server->get(IContentSecurityPolicyManager::class)->addDefaultPolicy($policy);

Keep the allowlist and the basemaps you enable in step — a base map the user can pick from the switcher but whose host isn't allowed renders blank.

Address search uses OpenStreetMap Nominatim. Its usage policy caps requests at roughly one per second, so lookups are debounced (600 ms) and capped at 5 results. A failed lookup (CSP, rate limit, offline) surfaces a message rather than throwing.

// In a manifest type:"detail" page
{ "id": "location", "widgetKey": "object-geo", "title": "Location" }

On a CnDetailPage, the widget resolves the page's loaded object automatically (register / schema / object-id / object-data are supplied by the page context); the manifest entry needs no props.

Props

Prop	Type	Default	Description
title	String	'Location'	Widget title shown in the header
object-data	Object	{}	The object data. Its @self.geo seeds the marker; @self also supplies register / schema / id fallbacks. May be null while the object loads (guarded)
object-id	String|Number	''	The object's id. Explicit prop wins over object-data['@self'].id
register	String|Number	''	OpenRegister register slug/id. When omitted, derived from object-data['@self'].register
schema	String|Number	''	OpenRegister schema slug/id. When omitted, derived from object-data['@self'].schema
editable	Boolean	true	Whether the map is editable (click to set, footer Save / Remove). Read-only when false
height	String|Number	'360px'	Map container height (forwarded to CnMapWidget)
default-center	Array	[52.132633, 5.291266]	Map centre [lat, lng] used when the object has no location yet (defaults to the centre of the Netherlands)
default-zoom	Number	7	Zoom used when the object has no location yet
layers	Array	OpenStreetMap tile layer	Base layer stack forwarded to CnMapWidget ({ type, url, options }[]). Defaults to the OpenStreetMap standard tiles; override for a different basemap (e.g. the Dutch PDOK BRT achtergrondkaart). On CSP-hardened instances the basemap's tile host must be allow-listed
documentation-url	String	''	Documentation link for the overflow Actions menu
widget-id	String	''	Stable id forwarded to the widget chrome

Events

Event	Payload	Description
@saved	GeoJSON Point or null	Emitted after @self.geo is persisted (placed / moved / removed)
@update:geo	GeoJSON Point or null	Sibling of @saved for .sync-style consumers