Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

Map

object

  • editRevisionstringpattern ^[0-9a-f]{32}$

    Opaque durable revision paired with this document state. Camera and derived writes do not change it.

  • lastChangedAtstringor nullformat date-time

    Time of the last accepted covered change, independent of camera and cache clocks.

  • lastChangedBy

    A named actor has display and fixed SQL names. { deleted: true } explicitly identifies a deleted actor and carries no names or profile fields. Null explicitly means unknown. Never inferred from ownership.

    One of:

    • object

      • namestringrequired

      • sqlNamestringrequired

      No other keys.

    • object

      • deletedbooleanalways truerequired

      No other keys.

    • or null

  • idstring

  • namestring

  • viewportViewport

  • basemapstringor null

    dark | light | streets | satellite; null is Auto โ€” the builder follows the app theme (a deployment basemap override pins it), and published views render the deployment default.

  • customBasemapCustomBasemap

    The map's custom basemap style; null = none. When set it wins over the key in every surface; the key survives underneath and returns when this clears.

  • basemapLayersBasemapLayers

  • noteMapNote

    Legacy: always null โ€” the map's old note field migrated into a note widget. Kept for pre-migration undo images.

  • legendCornerLegendCorner

  • legendOrderLegendOrder

  • timelineMapTimeline

  • widgetsWidgetList

  • widgetsPublishedboolean

    Whether widgets ship with the published view.

  • publishTokenstringor null

    The published link's token, the map owner's alone: null to anyone else who reaches the map, and null while unpublished. Handing the link out is publishing, which stays the owner's act.

  • publishedAtstringor null

  • publishedboolean

    Whether a publication is live, for everyone who reaches the map; publishedAt says since when.

  • createdAtstring

  • updatedAtstring

All of:

  • object

    • editRevisionstringrequiredpattern ^[0-9a-f]{32}$

      Opaque durable revision paired with this document state. Camera and derived writes do not change it.

    • lastChangedAtstringor nullrequiredformat date-time

      Time of the last accepted covered change, independent of camera and cache clocks.

    • lastChangedByrequired

      A named actor has display and fixed SQL names. { deleted: true } explicitly identifies a deleted actor and carries no names or profile fields. Null explicitly means unknown. Never inferred from ownership.

      One of:

      • object

        • namestringrequired

        • sqlNamestringrequired

        No other keys.

      • object

        • deletedbooleanalways truerequired

        No other keys.

      • or null

Dezfil ยท Apache-2.0docs from 7439201b