arcgis.apps module

build_collector_url

arcgis.apps.build_collector_url(webmap=None, center=None, feature_layer=None, fields=None, search=None, portal=None, action=None, geometry=None, callback=None, callback_prompt=None)

Creates a url that can be used to open Collector for ArcGIS

Argument

Description

webmap

Optional String, WebMap, Item. The item id, webmap, or item representing the map to open in Collector.

center

Optional String, list, tuple. The “lat,long” in WGS84 of where to center the map

feature_layer

Optional String or FeatureLayer. The feature layer url as string or the feature layer representing the layer to open for collection.

fields

Optional Dict. The feature attributes dictionary {“field”:”value”}

search

Optional String An address, place, coordinate, or feature to search for Requires webmap and action=search to be set. Value must be URL encoded

portal

Optional String, GIS. The URL of the portal the mobile worker must be connected to.

action

Optional String What the app should do, if anything, once open and the user is signed in. The following values are supported: addFeature, center, open, search.

geometry

Optional String. Defines the location for the newly collectoed or edited feature Requires webmap, action=addFeature, and feature_layer. Value is a coordinate containing x, y (z if available)

callback

Optional String. The URL to call when capturing the asset or observation is complete. Requires webmap, action=addFeature, and feature_layer to be set. Optionally, before calling the URL provide a prompt for the user, specified with the callback_prompt parameter.

callback_prompt

Optional String. Prompt the mobile worker before executing the callback, and display this value in the prompt as where the mobile worker will be taken. Requires webmap, action=addFeature, feature_layer, and callback to be specified. Value must be URL encoded

Additional info can be found here: https://github.com/Esri/collector-integration :return: String

build_explorer_url

arcgis.apps.build_explorer_url(webmap=None, search=None, bookmark=None, center=None, scale=None, wkid=None, rotation=None, markup=None, url_type='Web')

Creates a url that can be used to open Explorer for ArcGIS

Argument

Description

webmap

Optional String, WebMap, Item. The item id, webmap, or item representing the map to open in Explorer. Item can be of type Web Map or Mobile Map Package.

search

Optional String. The location to search for.

bookmark

Optional String. The name of the bookmark in the map to open.

center

Optional String, list, tuple. The “lat,long” in WGS84 of where to center the map

scale

Optional Int. The scale at which to open the map.

rotation

Optional Int. The rotation, in degrees, at which to open the map.

markup

Optional Boolean. Determines if the app should open in markup mode.

url_type

Optional String. The type of url to be returned (e.g. ‘Web’ or ‘App’)

Additional info can be found here: https://github.com/Esri/explorer-integration

Returns

String

build_navigator_url

arcgis.apps.build_navigator_url(start=None, stops=None, optimize=None, navigate=None, travel_mode=None, callback=None, callback_prompt=None, url_type='Web', webmap=None, route_item=None)

Creates a url that can be used to open Navigator for ArcGIS

Argument

Description

start

Optional String or Tuple. The starting location. Can be a single string such as ‘45,-77’ or a tuple containing the location and the name (‘45,-77’,’Home’)

stops

Optional List. The list of locations. A location can be either a single string or a tuple containing the location and the name (‘45,-77’, ‘Home’).

optimize

Optional Boolean. Determines if the route should be optimized.

navigate

Optional Boolean. Determines if navigation should begin immediately.

travel_mode

Optional String. The travel mode to use (e.g. ‘Walking Time’)

callback

Optional String. The url to open when the route completes.

callback_prompt

Optional String. The text to show when the route finishes and the callback is about to be invoked.

url_type

Optional String. The type of url to be returned (e.g. ‘Web’ or ‘App’)

webmap

Optional String, Item. The item id or item representing the map to open in Navigator. Item can be of type Mobile Map Package.

route_item

Optional String, Item. The item id or item representing the route layer to open.

Additional info can be found here: https://github.com/Esri/navigator-integration

Returns

String

build_survey123_url

arcgis.apps.build_survey123_url(survey=None, center=None, fields=None)

Creates a url that can be used to open Survey123 for ArcGIS

Argument

Description

survey

Optional String or Item. The item id or item representing the survey to open.

center

Optional String. The “lat,long” in WGS84 of where to center the map

fields

Optional Dict. The feature attributes dictionary {“field”:”value”}

Additional info can be found here: https://doc.arcgis.com/en/survey123/reference/integratewithotherapps.htm

Returns

String

build_tracker_url

arcgis.apps.build_tracker_url(portal_url=None)

Creates a url that can be used to open Tracker for ArcGIS

Argument

Description

portal_url

Optional String The portal that should be used when tracker is launched via the url scheme.

Returns

String