ExportImageDefinition

object

An image export, fully resolved: exact output pixels (the aspect is entailed), the camera, how large the map is drawn, bounded placement and a size step for every element, the included widgets, an optional title, and an optional basemap override for this image alone. The builder's export card edits exactly this and the server renderer consumes exactly this, so the two roads cannot drift.

• mapScalenumberminimum 0.25maximum 16

  Output pixels per composition pixel: how large the map itself is drawn. A smaller value lays the map out across more composition pixels, so its labels, roads and symbols take a smaller share of the image: the look of a screenshot of a very large screen. Output width is then only density: a wider image is the same picture more sharply. Required, unless the deprecated name overlayScale is given instead.

• overlayScalenumberminimum 0.25maximum 16

  Deprecated name for mapScale, accepted so definitions written before the rename keep rendering. Give one or the other.

• widgetSizestring

  How large the widget rail is drawn. Absent means m.

  One of xs, s, m, l

• creditobject

  Where the basemap attribution sits and how large. It has no visibility: the basemap licence requires it in every image, and it never renders below a legible floor whatever the step. Absent means bottom-right at m.

  • cornerstringrequired

    One of top-left, top-right, bottom-left, bottom-right

  • sizestringrequired

    One of xs, s, m, l

  No other keys.

• basemapLayersobjector null

  The basemap layer groups THIS image draws: resolved, not a difference from the map's stored choice, so the definition renders the same tomorrow as today. A missing key means visible. Null means every group is visible; absence means the map's own stored choice. Vector styles only: imagery has no groups to hide.

  • labelsboolean

  • roadsboolean

  • bordersboolean

  • buildingsboolean

  • waterboolean

  • landboolean

  No other keys.

• appearancestringrequired

  The author's active theme at export: captured state, so the server renders exactly what the card's client capture always exported implicitly.

  One of light, dark

• viewportobjectrequired

  • lngnumberrequiredminimum -540maximum 540

  • latnumberrequiredminimum -85.051129maximum 85.051129

  • zoomnumberrequiredminimum 0maximum 24

  • pitchnumberrequiredminimum 0maximum 60

    Degrees; 0 = flat.

  • bearingnumberrequiredminimum -360maximum 360

    Degrees; 0 = north-up.

  No other keys.

• sizeobjectrequired

  • widthintegerrequiredminimum 480maximum 4096

    At least the width a legible basemap credit needs: an image too narrow to carry its attribution is refused, not exported without it.

  • heightintegerrequiredminimum 64maximum 4096

  No other keys.

• legendobjectrequired

  • visiblebooleanrequired

  • cornerstringrequired

    One of top-left, top-right, bottom-left, bottom-right

  • sizestringrequired

    One of xs, s, m, l

  No other keys.

• widgetsarray of stringrequired

  Ids of the included widgets, in rail order.

• titleobjector nullrequired

  • textstringrequiredmax length 200

  • sizestringrequired

    One of xs, s, m, l

  No other keys.

No other keys.