MapOverview

All of:

• Map

• object

  • projectIdstringor null

    The project this map is in: on the caller's own map always, a project they no longer reach included, and on anyone else's the project through which the caller reaches it; null = in no project. Never part of the published view.

  • layerCountinteger

  • layerColorsarray of string

    One representative CSS color per layer, in draw order — what the maps screen renders as layer dots.

  • pictureStatestring

    The server picture work state. It names no dataset or private reason, even when this reader cannot be served the picture.

    One of current, waiting, failed, unsupported, unavailable

  • pictureVersionstringor null

    An opaque version of the served picture for the image URL v parameter. Changes when a new complete picture lands, including data-only and requested refreshes. Null when no picture is served.

  • hasThumbnailboolean

    Whether the map has a card image the caller is served: GET /api/maps/{id}/thumbnail answers one. False until the server first pictures the map, and while every image it has drew a dataset beyond the caller's reach. A card asks for the image only when this is true.

  • thumbnailBasemapobjector null

    The basemap that card image was drawn on, recorded when the image was saved: the style's address, its kind, whether the map's own style (a library or single-map style) drew it rather than one of the instance's, and the credit it claimed then. A page of card images credits their basemaps from it, so an image keeps its credit when the map, the imagery or the instance's styles change, until the map is captured again. Null while hasThumbnail is false, and for an image that recorded none (one saved before images recorded it, or a picture of a template on Satellite, whose template names no imagery), which is credited by the map's basemap now.

    • urlstringrequired

    • kindstringrequired

      One of vector, imagery

    • custombooleanrequired

    • attributionBasemapAttributionrequired

• MapPresence