API and agentsAPI reference
PublishedView
object
namestringviewportViewportthemestringThe authored default theme: the mode the publisher stated or was composing in when the map was published. Publications made before this field existed read dark until published anew. A reader may switch locally for the current page load only (the remembered per-link override was retired); the switch never changes this value, and the next load starts from it again.
One of
light,darkbasemapUrlstringResolved basemap style URL for the authored theme — the published page's first render uses exactly this.
basemapForThemeobjector nullNon-null when the basemap follows the effective theme (a genuine Auto with no deployment override): the style URL for each mode (
light,dark), so a reader theme switch swaps styles without another round trip. Null for an explicit basemap or an overridden Auto. In the builder every explicit basemap stays fixed in both themes; on the published viewer the Dark and Light styles are excepted, and the reader's theme control moves them as a pair — they are the two modes. Streets and Satellite stay fixed there too.basemapKeystringor nullThe authored basemap choice; null = Auto. The reader's picker marks its card from this and resolves a return to Auto — the resolved URL alone cannot say whether Auto or an explicit style sharing that URL was authored. Note the published Dark/Light exception described on
basemapForTheme: a reader's theme control moves those two as a pair.One of
dark,light,streets,satellite,nullcustomBasemapCustomBasemapThe map's custom basemap style; null = none. When set, basemapUrl is its URL in both themes, the attribution is its saved snapshot, and the reader's picker marks no built-in card — a reader who switches to one has no way back within the load.
basemapPinnedbooleanWhether this deployment pins Auto in both themes. A reader's theme switch leaves a pinned Auto alone; an explicit reader pick still applies for that page load.
basemapKindstringThe resolved style's kind — group toggles act on vector styles only.
One of
vector,imagerybasemapAttributionBasemapAttributionbasemapLayersBasemapLayersnoteMapNotelegendCornerLegendCornerlegendOrderLegendOrdertimelineobjector nullThe docked playback timeline, resolved for the viewer: layerId, field, speed, the settled window, the field's full extent (ISO-8601), and its histogram bins. Null when no timeline is docked or the dock no longer resolves.
layersarray of objectEach layer carries its style, render data, and
liveFilters: resolved range/time filters the render shipped without — the viewer enforces their settled ranges client-side.widgetsWidgetListThe map's visible widgets, present when the map ships widgets — the viewer reads values through the published widget-values call. Empty when the toggle is off or no widget resolves.
viewerControlsViewerControlsWhich optional reader controls this publication exposes. A publication that never stated a set reports every control on.
7439201b