Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

MapWidget

object

One dashboard card: a formula (headline aggregate), category (top 5 + Other ranking; clicking a row EXCLUDES it), histogram (distribution with a brushable range), or note (authored title + body, no data). Data types are computed server-side over their layer's effective query. field is the aggregated/grouping/binned field (null for a count formula and for notes); agg is count | sum | avg | min | max (category ranking allows count | sum | avg; histogram and note ignore it — send count); aggField is the field a category sum/avg ranks by (null otherwise); unit/note/format are formula presentation (note doubles as a note widget's body); layerId is null exactly for notes.

  • idstringrequired

    Unique within the map.

  • typestringrequired

    One of formula, category, histogram, note

  • layerIdstringor nullrequired

    The layer the widget reads — and the only layer its selection filters. Null for notes.

  • titlestringrequired

    Card heading (≤ 60).

  • fieldstringor nullrequired

  • aggstringrequired

    One of count, sum, avg, min, max

  • aggFieldstringor nullrequired

  • unitstringor nullrequired

    Formula: text after the number (≤ 20).

  • notestringor nullrequired

    Formula: caption under the number; note widget: the body (≤ 2000).

  • formatstringor nullrequired

    Formula number formatting; null = automatic.

    One of compact, percent, percent2, integer, decimal1, decimal2, null

  • visiblebooleanrequired

Dezfil · Apache-2.0docs from 7439201b