Location · Modules | Program

Modules · Connectivity · Location

Coordinates, addresses, routes and maps. Location models a geographic point as a Location.Coordinate , pairs it with a postal Location.Address to make a Location.Place , and links places into a Location.Route . It geocodes addresses into places and back, streams the device's live GPS position, and renders maps with draggable Location.Marker pins. Live readings are reactive: a position or a lookup arrives asynchronously, so it is usually held in a STATE LOCKED cell that stays pending until the device or service replies.

A postal address: a display line together with optional structured parts.

A geographic point as a latitude and longitude in degrees.

A pin on a map: a coordinate with an optional title, text, and draggability.

A resolved place: a coordinate together with an optional address.

A journey from a start place to an end place, with optional waypoints in between.

Decodes an address from a JSON value.

Returns Location.Address — the decoded address.

Decodes an optional address from a JSON value, or none when absent.

Returns Collection.Optional(Location.Address) — the decoded address, or none.

Encodes an address as a JSON value.

Returns Code.Language.Json.Value — the address as a JSON object.

A single display line for an optional address, falling back to "Location" when none.

Returns Text — the formatted address line, or "Location" when there is no address.

Looks up a single place for a query through the backend geocoding service.

Returns Collection.Optional(Location.Place) — the matched place, or none.

Searches the backend geocoding service, returning every matching place.

Returns Collection.Array(Location.Place) — all matching places, empty when there are none.

Reverse-geocodes a latitude and longitude into a place through the backend.

Returns Collection.Optional(Location.Place) — the place at that point, or none.

Fetches the app's public Google Maps API key from the backend.

Returns Text — the maps API key, or the empty string when unavailable.

The public Google Maps API key configured for the app.

Returns Text — the maps API key.

Groups map content so its markers and routes share one enclosing element.

A block of map content — markers and routes — grouped together.

Returns nothing — it runs its block as one group.

Decodes a coordinate from a JSON value.

Returns Location.Coordinate — the decoded coordinate, defaulting to zero when a field is missing.

Encodes a coordinate as a JSON value.

Returns Code.Language.Json.Value — the coordinate as a JSON object with latitude and longitude .

Decodes a place from a JSON value.

Returns Location.Place — the decoded place, defaulting fields that are missing.

Geocodes an address string into a place, or none when nothing matches.

Places a non-draggable marker on the map at a fixed coordinate.

A block of Location.MapMarker.Title and Location.MapMarker.Text entries describing the marker.

Returns nothing — it renders a marker on the enclosing map.

Places a draggable marker whose coordinate is bound two-way to a cell.

Returns nothing — it renders a draggable marker on the enclosing map.

Sets the description text on the enclosing marker.

Returns nothing — it records the description on the enclosing marker.

Sets the title on the enclosing marker.

Returns nothing — it records the title on the enclosing marker.

Draws a straight line between two coordinates on the map.

Returns nothing — it draws a line on the enclosing map.

Parses a place from a JSON string, or none when the string is absent.

Returns Collection.Optional(Location.Place) — the parsed place, or none.

Streams the device's live GPS position, updating as it moves.

Returns Collection.Optional(Location.Coordinate) — the latest reading, or none until the device reports its first fix.

Reverse-geocodes a coordinate into a place with an address, or none when nothing matches.

Decodes a route from a JSON value.

Returns Location.Route — the decoded route.

Decodes an optional route from a JSON value, or none when absent.

Returns Collection.Optional(Location.Route) — the decoded route, or none.

Encodes a route as a JSON value.

Returns Code.Language.Json.Value — the route as a JSON object.

Emits the device's current coordinate into the LocationService streaming pipeline.

Returns nothing — it streams position to the location server over an open session.

Encodes a place as a JSON value.

Returns Code.Language.Json.Value — the place as a JSON object.

Recommended articles