Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

MapUpdate

object

  • namestring

  • viewportViewport

  • basemapstringor null

    dark | light | streets | satellite; null returns the map to Auto (follows the app theme in the builder; published views use the deployment default).

  • customBasemapobjector null

    Set or replace the map's custom basemap style; null removes it and reveals the stored key again. The server inspects the URL before saving: a valid style saves with its attribution snapshot; unreachable or policy-blocked URLs save only with force: true (every reader's browser fetches the style itself, so they may still work); non-style URLs never save. { libraryStyle } takes a style the instance's basemap library offers, by its id (GET /api/config lists them as basemapStyles): the map keeps its own copy of the style's name, address and credit, nothing is fetched, and hiding or removing the style later changes no map. A hidden or unknown id is refused. While the basemaps.singleMapStyles setting is off, a url the library does not offer is refused with basemap_not_offered, before it is read, unless the map already holds it.

    • libraryStylestring

      A basemap library style's id; given alone, without url, name or force.

    • urlstring

    • namestringor null

      Display name for the picker tile; absent shows the URL's hostname.

    • forceboolean

      Save despite an unreachable or blocked verdict.

    Any of:

  • basemapLayersBasemapLayers

  • legendCornerLegendCorner

  • legendOrderLegendOrder

  • timelineMapTimeline

  • widgetsWidgetList

  • widgetsPublishedboolean

    Whether widgets ship with the published view. A publication setting: only the map's owner changes it, and anyone else's write that would change it is refused whole with forbidden.

  • layerOrderarray of string

    All the map's layer ids, bottom to top — the draw order.

Dezfil · Apache-2.0docs from 7439201b