Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

LayerRender

object

  • layerIdstring

  • okboolean

  • modestring

    inline carries the GeoJSON itself; tiled points at served vector tiles (a points-viz result over the render cap or Bytes drawn per layer).

    One of inline, tiled

  • geojsonobject

    Inline GeoJSON. Feature properties are the columns the audience reads: on a builder render, what the layer and its map use; on a published render, the effective published field set. Non-point features carry a reserved __anchor property — an interior [lng, lat] that labels anchor on; it never shows in tooltips or pop-ups.

  • featureCountinteger

  • geometryTypestringor null

    Canonical geometry family of the effective render result, independent of inline or tiled delivery. Multi-geometry variants collapse into their simple family; null means the result is empty or its family is unknown.

    One of POINT, LINESTRING, POLYGON, MIXED, null

  • tilesLayerTiles

  • liveFilteredboolean

    True when the data ships without the layer's live filters (range/time filters on non-aggregated layers) — the builder canvas enforces them client-side, so slider and playback moves never refetch. Absent when every filter is already applied in the SQL.

  • errorobject

    Present when ok is false: why the layer cannot render right now. code is one of the documented error codes (query_timeout, sql_error, render_cap_exceeded, render_bytes_exceeded, tiler_unavailable, tile_build_failed, …) and is what truth surfaces present; message carries the detail. Both builder and published viewer show an errored layer as a visible failed state, never as silent absence.

    • codestring

    • messagestring

Dezfil · Apache-2.0docs from 7439201b