Interface WebMapJson

The web map data lists the basemap, operational layers, and bookmarks to be used in the web map. It also contains information about popup windows and layer styling overrides to be used in the web map. A version property allows you to supply the version of the web map JSON format being used.

Part of the Esri web map specification. See http://resources.arcgis.com/en/help/arcgis-web-map-json/. See https://developers.arcgis.com/web-map-specification/objects/webmap/.

interface WebMapJson {
    applicationProperties?: ApplicationPropertiesJson;
    authoringApp?: string;
    authoringAppVersion?: string;
    background?: ColorBackgroundJson;
    baseMap: BasemapJson;
    bookmarks?: BookmarkJson[];
    initialState?: InitialStateJson;
    mapFloorInfo?: MapFloorInfoJson;
    mapRangeInfo?: MapRangeInfoJson;
    operationalLayers?: OperationalLayerJson[];
    presentation?: PresentationJson;
    spatialReference: SpatialReferenceJson;
    tables?: TableJson[];
    timeZone?: string;
    utilityNetworks?: UtilityNetworkJson[];
    version: string;
    widgets?: WidgetsJson;
}

Hierarchy (view full)

Properties

applicationProperties? authoringApp? authoringAppVersion? background? baseMap bookmarks? initialState? mapFloorInfo? mapRangeInfo? operationalLayers? presentation? spatialReference tables? timeZone? utilityNetworks? version widgets?

Properties

OptionalapplicationProperties

applicationProperties?: ApplicationPropertiesJson

The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions.

OptionalauthoringApp

authoringApp?: string

String value indicating the application which authored the webmap.

OptionalauthoringAppVersion

authoringAppVersion?: string

String value indicating the authoring App's version number.

Optionalbackground

background?: ColorBackgroundJson

The background.

baseMap

baseMap: BasemapJson

The map's basemap layer(s). Layers are drawn based on the index position in the array; The first layer in the array is the first layer drawn, the next layer in the array is drawn on top of it, and so on.

Optionalbookmarks

bookmarks?: BookmarkJson[]

Bookmarks that are saved with the map.

OptionalinitialState

initialState?: InitialStateJson

The initial state at which to open the map.

OptionalmapFloorInfo

mapFloorInfo?: MapFloorInfoJson

Contains floor-awareness information for the map.

OptionalmapRangeInfo

mapRangeInfo?: MapRangeInfoJson

Map range information.

OptionaloperationalLayers

operationalLayers?: OperationalLayerJson[]

Operational layers contain your business data. They are used to make thematic maps. Usually, a basemap sits beneath your operational layers to give them geographic context. See https://developers.arcgis.com/web-map-specification/objects/operationalLayers/.

Optionalpresentation

presentation?: PresentationJson

A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc.

spatialReference

spatialReference: SpatialReferenceJson

An object used to specify the spatial reference of the given geometry.

Optionaltables

tables?: TableJson[]

Specify an array of table objects.

OptionaltimeZone

timeZone?: string

TODO: Not yet documented in web map spec, but present in 2.29 web maps generated by Maps SDK 4.28.

OptionalutilityNetworks

utilityNetworks?: UtilityNetworkJson[]

An array of utility network objects the map can use to access utility-related functionality, such as tracing and querying associations.

version

version: string

Root element in the web map specifying a string value indicating the web map version. See https://developers.arcgis.com/web-map-specification/objects/version/.

Optionalwidgets

widgets?: WidgetsJson

The widgets object contains widgets that should be exposed to the user.

Settings

Member Visibility

On This Page

Properties