Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

Layer

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

  • mapIdstring

  • namestring

  • sqlstring

    Only one read-only SELECT over named datasets is accepted. File readers, file-relation shorthand and engine path or definition discovery are refused before binding with sql_rejected, including nested SQL and computed targets. File-referencing PROJ coordinate definitions are also refused before native projection use, including computed or per-row values; EPSG identifiers and inline definitions without files remain supported. Unknown tables receive the same sql_error whether hidden or nonexistent, without catalogue suggestions. Engine errors do not expose filesystem paths or internal statements; input positions are retained when available. Existing saved SQL is retained unchanged; affected saved and published queries fail.

  • styleStyle

  • visibleboolean

  • tooltiparray of stringor null

    Fields shown in the hover tooltip; null = automatic.

  • popuparray of stringor null

    Fields shown in the click pop-up; null = automatic.

  • publishedFieldsarray of stringor null

    The author's explicit published-field list; null = the derived minimal projection (style, label, tooltip/pop-up, live-filter, timeline and published-widget fields). Published responses carry exactly the effective set; fields the published map needs to render are always published, whatever this lists.

  • inLegendboolean

    Whether the layer contributes to the legend.

  • vizViz

  • filtersarray of LayerFilter

    Refinements applied before aggregation; the SQL stays the source of truth and [] restores it exactly.

  • legendTitlestringor null

    Legend title override; null = the layer name.

  • legendLabelsarray of string or nullor null

    Per-entry legend label overrides; null entries (and null itself) keep the automatic labels.

  • legendAttrsobjector null

    Per-channel legend attribute-name overrides, keyed by channel (fill, stroke, radius, width). Three states per channel: a missing key (and null itself) keeps the automatic attribute name, a string overrides it, and a null value hides that channel's attribute line. An override drops automatically when its channel's driving attribute changes.

  • ordinalinteger

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