Map

classarcgis.map.Map(**kwargs:Any)

propertybasemap:BasemapManager

Returns a BasemapManager object that can be used to handlebasemap related properties and methods on the Map.

propertybookmarks:Bookmarks

Get an instance of the Bookmarks that can be seen in your Map. This classcan be used to add and remove bookmarks as well as edit them. You can alsoenable and disable the bookmark widget on the rendered map in Jupyter Lab.

center

Get/Set the center of the rendered Map.

Parameter	Description
center	A[lat, long] list that represents the JSON of the map widget’s center.

Returns:

A list that represents the latitude and longitude of the map’s center.

# Usage example: Sets the center of the map to the given lat/longmap.center=[34.05,-118.24]

propertycontent:MapContent

Returns a MapContent object that can be used to access the layers and tablesin the map. This is useful for adding, updating, getting, and removing contentfrom the Map.

export_to_html(path_to_file:str,title:str|None=None)→bool

Theexport_to_html method takes the current state of the rendered map and exports it to astandalone HTML file that can be viewed in any web browser.

By default, only publicly viewable layers will be visible in anyexported html map. Specifycredentials_prompt=True to have a userbe prompted for their credentials when opening the HTML page to viewprivate content.

Warning

Follow best security practices when sharing any HTML page thatprompts a user for a password.

Note

You cannot successfully authenticate if you open the HTML page in abrowser locally likefile://path/to/file.html. The credentialsprompt will only properly function if served over a HTTP/HTTPSserver.

Parameter	Description
path_to_file	Required string. The path to save the HTML file on disk.
title	Optional string. The HTML title tag used for the HTML file.

extent

Get/Set the map’s extent.

Note

You must include the spatial reference in the extent dictionary.

Parameter	Description
value	Required dict.map.extent = { ‘spatialReference’: {‘latestWkid’: 3857, ‘wkid’: 102100},‘xmax’: 5395723.072123609,‘xmin’: -137094.78326911852,‘ymax’: 10970767.576996306,‘ymin’: 7336034.007980572 }

Returns:

A dictionary representing the extent

# Usage example: Sets the extent of the map to the given extentmap.extent={"xmin":-124.35,"ymin":32.54,"xmax":-114.31,"ymax":41.95"spatialReference":{"wkid":102100}}

js_api_path

A trait for unicode strings.

js_requirement()

Return the JS API version needed to work with the current version of the mapping module in a disconnected environment.

Returns:

A string representing the JS API version.

propertylayer_list:LayerList

Get an instance of the LayerList class. You can use this class to enable or disablethe layer list widget. Best used inside of Jupyter Lab.

propertylegend:Legend

Get an instance of the Legend class. You can use this class to enable or disablethe legend widget. Best used inside of Jupyter Lab.

propertyoffline_areas:OfflineMapAreaManager|None

Theoffline_areas property is the resource manager for offline areas cached for theWebMap object.

Returns:

TheOfflineMapAreaManager for theWebMap object.

print(file_format:str,extent:dict[str,Any],dpi:int=92,output_dimensions:tuple[float]=(500,500),scale:float|None=None,rotation:float|None=None,spatial_reference:dict[str,Any]|None=None,layout_template:str='MAP_ONLY',time_extent:tuple[int]|list[int]|None=None,layout_options:dict[str,Any]|None=None)→str

Theprint method prints theMap object to a printable file such as a PDF, PNG32, JPG.

Note

The render and print operations happenserver side (ArcGIS Online or Enterprise) and not on the client.

Theprint method takes the state oftheMap, renders and returns either a page layout or a map without page surrounds of the specified extentin raster or vector format.

Parameter	Description
file_format	Required String. Specifies the output file format. Valid types: PNG8 |PNG32 |JPG |GIF |PDF |EPS|SVG |SVGZ.
extent	Required Dictionary. Specify the extent to be printed. # Example Usage:>>>extent={'spatialReference':{'latestWkid':3857,'wkid':102100},'xmin':-15199645.40582486,'ymin':3395607.5273594954,'xmax':-11354557.134968376,'ymax':5352395.451459487} The spatial reference of the extent object is optional; when it isnot provided, it is assumed to be in the map’s spatial reference.When the aspect ratio of the map extent is different than the sizeof the map on the output page or theoutput_dimensions,you might notice more features on the output map.
dpi	Optional integer. Specify the print resolution of the output file.dpi stands fordots per inch. A higher number implies better resolution and alarger file size.
output_dimensions	Optional tuple. Specify the dimensions of the output file in pixels. If thelayout_template is notMAP_ONLY, the specific layouttemplate chosen takes precedence over this parameter.
scale	Optional float. Specify the map scale to be printed. The map scale at which youwant your map to be printed. This parameter is optional butrecommended for optimal results. Thescale property isespecially useful when map services in the web map havescale-dependent layers or reference scales set. Since the map thatyou are viewing on the web app may be smaller than the size of theoutput map (for example, 8.5 x 11 in. or A4 size), the scale of theoutput map will be different and you could see differences infeatures and/or symbols in the web application as compared withthe output map. When scale is used, it takes precedence over the extent, but theoutput map is drawn at the requested scale centered on the centerof the extent.
rotation	Optional float. Specify the number of degrees by which the map frame will berotated, measured counterclockwise from the north. To rotateclockwise, use a negative value.
spatial_reference	Optional Dictionary.Specify the spatial reference in which map should be printed. Whennot specified, the following is the order of precedence: read from theextent parameter read from the base map layer of your web map read from thelayout_template chosen
layout_template	Optional String. The default valueMAP_ONLY does not use any template.
time_extent	Optional List . If there is a time-aware layer and you want itto be drawn at a specified time, specify this property. This orderlist can have one or two elements. Add two elements (startTimefollowed byendTime) to represent a time extent, or provideonly one time element to represent a time instant.Times are always in UTC. # Example Usage to represent Tues. Jan 1, 2008 00:00:00 UTC:# to Thurs. Jan 1, 2009 00:00:00 UTC.>>>time_extent=[1199145600000,1230768000000]
layout_options	Optional Dictionary. This defines settings for different available page layout elementsand is only needed when an availablelayout_template is chosen.Page layout elements includetitle,copyrighttext,scalebar,authorname, andcustomtextelements.For more details, seeExportWebMap specification.

Returns:

A URL to the file which can be downloaded and printed.

# USAGE EXAMPLE 1: Printing a web map to a JPG file of desired extent.fromarcgis.mapimportMapfromarcgis.gisimportGIS# connect to your GIS and get the web map itemgis=GIS(url,username,password)wm_item=gis.content.get('1234abcd_web map item id')# create a WebMap object from the existing web map itemwm=Map(item=wm_item)# create an empty web mapwm2=Map()wm2.content.add(<desiredItemorLayerobject>)# set extentredlands_extent={'spatialReference':{'latestWkid':3857,'wkid':102100},'xmin':-13074746.000753032,'ymin':4020957.451106308,'xmax':-13014666.49652086,'ymax':4051532.26242039}# printprinted_file_url=wm.print(file_format='JPG',extent=redlands_extent)printed_file2_url=wm2.print(file_format='PNG32',extent=redlands_extent)# Display the result in a notebook:fromIPython.displayimportImageImage(printed_file_url)# Download file to diskimportrequestswithrequests.get(printed_file_url)asresp:withopen('./output_file.png','wb')asfile_handle:file_handle.write(resp.content)

rotation

Get/Set the rotation of the rendered Map.

Parameter	Description
value	Required int. The rotation angle in degrees.

Returns:

The int value of the rotation angle

# Usage example: Sets the rotation angle of the map to 45 degreesmap.rotate=45

save(item_properties:dict[str,Any],thumbnail:str|None=None,metadata:str|None=None,owner:str|None=None,folder:str|None=None)→Item

Saves theMap object as a new Web Map Item in yourGIS.

Note

If you started with aMap object from an existing web map item,calling this method will create a new item with your changes. If you want toupdate the existingMap item found in your portal with your changes, call theupdate method instead.

Parameter	Description
item_properties	Required dictionary. See table below for the keys and values.The three required keys are: ‘title’, ‘tag’, ‘snippet’.
thumbnail	Optional string. Either a path or URL to a thumbnail image.
metadata	Optional string. Either a path or URL to the metadata.
owner	Optional string. Defaults to the logged in user.
folder	Optional string. Name of the folder into which the web map should besaved.

Key:Value Dictionary Options for Argument item_properties

Key	Value
title	Required string. Name label of the item.
tags	Required string. Tags listed as comma-separated values, or a list of strings.Used for searches on items.
snippet	Required string. Provide a short summary (limit to max 250 characters) of the what the item is.
typeKeywords	Optional string. Provide a lists all subtypes, see URL 1 below for valid values.
description	Optional string. Description of the item.
extent	Optional dict. The extent of the item.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string. Any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values are private, shared, org, or public.
commentsEnabled	Optional boolean. Default is true, controls whether comments are allowed (true)or not allowed (false).
culture	Optional string. Language and country information.

The above are the most common item properties (metadata) that you set. To get a complete list, seetheCommon Parameterspage in the ArcGIS REST API documentation.

Returns:

Item object corresponding to the new web map Item created.

# save the web mapwebmap_item_properties = {‘title’:’Ebola incidents and facilities’,

’snippet’:’Map created using Python API showing locations of Ebola treatment centers’,‘tags’:[‘automation’, ‘ebola’, ‘world health’, ‘python’],‘extent’: {‘xmin’: -122.68, ‘ymin’: 45.53, ‘xmax’: -122.45, ‘ymax’: 45.6, ‘spatialReference’: {‘wkid’: 4326}}}

new_wm_item = wm.save(webmap_item_properties, thumbnail=’./webmap_thumbnail.png’)

scale

Get/Set the map scale at the center of the rendered Map. If set to X, the scaleof the map would be 1:X.

Parameter	Description
value	Required int.

Returns:

The int value of the scale

# Usage example: Sets the scale to 1:24000map.scale=24000

sync_navigation(map:Map|list[Map])→None

Thesync_navigation method synchronizes the navigation from one rendered Map toanother rendered Map instance so panning/zooming/navigating in one will update the other.

Note

Users can sync more than two instances together by passing in a list of Map instances tosync. The syncing will be remembered

Parameter	Description
map	Either a single Map instance, or a list ofMapinstances to synchronize to.

theme

Get/Set the widget theme when displaying in a Jupyter environment.

Values can be “light” or “dark”

propertytime_slider:TimeSlider

Get an instance of the TimeSlider class. You can use this class to enable or disable thetime slider on the widget. Best used inside of Jupyter Lab

unsync_navigation(map:Map|list[Map]|None=None)→None

Theunsync_navigation method unsynchronizes connections made to other rendered Map instancesmade via the sync_navigation method.

Parameter	Description
map	Optional, either a singleMap instance, or a list ofMap instances to unsynchronize. If not specified, willunsynchronize all syncedMap instances.

update(item_properties:dict[str,Any]|None=None,thumbnail:str|None=None,metadata:str|None=None)→bool

Theupdate method updates the Web Map Item in yourGISwith the changes you made to theMap object. In addition, you can updateother item properties, thumbnail and metadata.

Note

If you started with aMap object from an existing web map item, calling this method will update the itemwith your changes.

If you started out with a fresh Map object (without a web map item), calling this method will raise aRuntimeError exception. If you want to save the Map object into a new web map item, call thesave method instead.

Foritem_properties, pass in arguments for the properties you want to be updated.All other properties will be untouched. For example, if you want to update only theitem’s description, then only provide the description argument initem_properties.

Parameter	Description
item_properties	Optional dictionary. See table below for the keys and values.
thumbnail	Optional string. Either a path or URL to a thumbnail image.
metadata	Optional string. Either a path or URL to the metadata.

Key:Value Dictionary Options for Argument item_properties

Key	Value
typeKeywords	Optional string. Provide a lists all sub-types, see URL 1 below for valid values.
description	Optional string. Description of the item.
title	Optional string. Name label of the item.
tags	Optional string. Tags listed as comma-separated values, or a list of strings.Used for searches on items.
snippet	Optional string. Provide a short summary (limit to max 250 characters) of the what the item is.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string. Any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values are private, shared, org, or public.
commentsEnabled	Optional boolean. Default is true, controls whether comments are allowed (true)or not allowed (false).

The above are the most common item properties (metadata) that you set. To get a complete list, seethecommon parameterspage in the ArcGIS REST API documentation.

Returns:

A boolean indicating success (True) or failure (False).

zoom

Get/Set the level of zoom applied to the rendered Map.

Parameter	Description
value	Required int... note: Thehigherthenumber,themorezoomedinyouare.

Returns:

Int value that represent the zoom level

# Usage examplemap.zoom=10

zoom_to_layer(item:Item|dict|FeatureSet|FeatureLayer)→None

Thezoom_to_layer method snaps the map to the extent of the providedItem object(s).

Zoom to layer is modifying the rendered map’s extent. It is best to run this method callin a separate cell from the map rendering cell to ensure the map is rendered before the extent is set.

Parameter	Description
item	The item at which you want to zoom your map to.This can be a single extent or anItem,Layer ,DataFrame ,FeatureSet, orFeatureCollectionobject.

Map Classes

Scene

classarcgis.map.Scene(**kwargs:Any)

The Scene can be displayed in a Jupyter Lab environment.

The commands will be sent from the Scene class and all the methods in this classwill affect what will be seen on the scene. The underlying web scene dictionary will be transformed in theScene class.

A Scene contains layers of geographic data that are displayed in 3D. Scenes allow you to displayreal-world visualizations of landscapes, objects, buildings, and other 3D objects.

propertybasemap:BasemapManager

Returns a BasemapManager object that can be used to handlebasemap related properties and methods on the Scene.

camera

Get/Set the camera of the rendered Scene.

Parameter

Description

camera

A dictionary that represents the JSON of the scenewidget’s camera. The dictionary included the keys: “position”, “heading”, and “tilt”The position indicates the x, y, and z coordinates for the camera. The heading isthe heading of the camera in degrees. The tilt is the degrees with respect to thesurface as projected down. Example:scene.camera = { “position”:{ ‘x’: -5938587.158752469,‘y’: -2827970.414173906,‘z’: 46809.31127560418 },“heading”: 400,“tilt”: 0.5 }

Returns:

A dictionary that represents the x,y, and z of the rendered Scene.

# Usage examplescene.camera={"position":{'x':-5938587.158752469,'y':-2827970.414173906,'z':46809.31127560418},"heading":400,"tilt":0.5}

center

Get/Set the center of the rendered Scene.

Parameter	Description
center	A[lat, long] list that represents the JSON of the scene widget’s center.

Returns:

A list that represents the latitude and longitude of the scene’s center.

# Usage examplescene.center=[34.05,-118.24]

propertycontent:SceneContent

Returns a SceneContent object that can be used to access the layers and tablesin the scene. This is useful for adding, updating, getting, and removing contentfrom the Scene.

propertyenvironment:Environment

Get an instance of the Environment class. You can use this class to enable or disablewidgets such as weather and daylight. You can also set these properties using python code.

extent

Get/Set the rendered map’s extent.

Note

Must provide a spatial reference key in the extent dictionary.

Parameter	Description
value	Required dict.map.extent = { ‘spatialReference’: {‘latestWkid’: 3857, ‘wkid’: 102100},‘xmax’: 5395723.072123609,‘xmin’: -137094.78326911852,‘ymax’: 10970767.576996306,‘ymin’: 7336034.007980572 }

Returns:

A dictionary representing the extent

propertyheading:float

Get/Set the heading of the camera in degrees. Heading is zero when north is the top of the screen.It increases as the view rotates clockwise.

Parameter	Description
heading	A float that represents the heading in degrees.

js_api_path

A trait for unicode strings.

js_requirement()

Return the JS API version needed to work with the current version of the mapping module in a disconnected environment.

Returns:

A string representing the JS API version.

propertylayer_list:LayerList

Get an instance of the LayerList class. You can use this class to enable or disablethe layer list widget. Best used inside of Jupyter Lab.

propertylegend:Legend

Get an instance of the Legend class. You can use this class to enable or disablethe legend widget. Best used inside of Jupyter Lab.

save(item_properties:dict[str,Any],thumbnail:str|None=None,metadata:str|None=None,owner:str|None=None,folder:str|None=None)→Item

Saves theScene object as a new Web Scene Item in yourGIS.

Note

If you started with aScene object from an existing web scene item,calling this method will create a new item with your changes. If you want toupdate the existingScene item found in your portal with your changes, call theupdate method instead.

Parameter	Description
item_properties	Required dictionary. See table below for the keys and values.The three required keys are: ‘title’, ‘tag’, ‘snippet’.
thumbnail	Optional string. Either a path or URL to a thumbnail image.
metadata	Optional string. Either a path or URL to the metadata.
owner	Optional string. Defaults to the logged in user.
folder	Optional string. Name of the folder into which the web scene should besaved.

Key:Value Dictionary Options for Argument item_properties

Key	Value
title	Required string. Name label of the item.
tags	Required string. Tags listed as comma-separated values, or a list of strings.Used for searches on items.
snippet	Required string. Provide a short summary (limit to max 250 characters) of the what the item is.
typeKeywords	Optional string. Provide a lists all subtypes, see URL 1 below for valid values.
description	Optional string. Description of the item.
extent	Optional dict. The extent of the item.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string. Any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values are private, shared, org, or public.
commentsEnabled	Optional boolean. Default is true, controls whether comments are allowed (true)or not allowed (false).
culture	Optional string. Language and country information.

The above are the most common item properties (metadata) that you set. To get a complete list, seetheCommon Parameterspage in the ArcGIS REST API documentation.

Returns:

Item object corresponding to the new web scene Item created.

# save the web scenewebscene_item_properties = {‘title’:’Ebola incidents and facilities’,

’snippet’:’Scene created using Python API showing locations of Ebola treatment centers’,‘tags’:[‘automation’, ‘ebola’, ‘world health’, ‘python’],‘extent’: {‘xmin’: -122.68, ‘ymin’: 45.53, ‘xmax’: -122.45, ‘ymax’: 45.6, ‘spatialReference’: {‘wkid’: 4326}}}

new_ws_item = webscene.save(webscene_item_properties, thumbnail=’./webscene_thumbnail.png’)

scale

Get/Set the scene scale at the center of the rendered Scene. If set to X, the scaleof the scene would be 1:X.

Parameter	Description
value	Required int.

Returns:

The int value of the scale

# Usage example: Sets the scale to 1:24000scene.scale=24000

sync_navigation(scene:Scene|list[Scene])→None

Thesync_navigation method synchronizes the navigation from one rendered Scene toanother rendered Scene instance so panning/zooming/navigating in one will update the other.

Note

Users can sync more than two instances together by passing in a list of Scene instances tosync. The syncing will be remembered

Parameter	Description
scene	Either a single Scene instance, or a list ofSceneinstances to synchronize to.

theme

Get/Set the widget theme when displaying in a Jupyter environment.

Values can be “light” or “dark”

propertytilt:float

Get/Set the tilt of the rendered Scene.The tilt of the camera in degrees with respect to the surface as projected downfrom the camera position. Tilt is zero when looking straight down at the surfaceand 90 degrees when the camera is looking parallel to the surface.

Parameter	Description
tilt	A float that represents the tilt.

Returns:

A float that represents the tilt value.

propertytime_slider:TimeSlider

Get an instance of the TimeSlider class. You can use this class to enable or disable thetime slider on the widget. Best used inside of Jupyter Lab

unsync_navigation(scene:Scene|list[Scene]|None=None)→None

Theunsync_navigation method unsynchronizes connections made to other rendered Scene instancesmade via the sync_navigation method.

Parameter	Description
scene	Optional, either a singleScene instance, or a list ofScene instances to unsynchronize. If not specified, willunsynchronize all syncedScene instances.

update(item_properties:dict[str,Any]|None=None,thumbnail:str|None=None,metadata:str|None=None)→bool

Theupdate method updates the Web Scene Item in yourGISwith the changes you made to theScene object. In addition, you can updateother item properties, thumbnail and metadata.

Note

If you started with aScene object from an existing web scene item, calling this method will update the itemwith your changes.

If you started out with a fresh Scene object (without a web scene item), calling this method will raise aRuntimeError exception. If you want to save the Scene object into a new web scene item, call thesave method instead.

Foritem_properties, pass in arguments for the properties you want to be updated.All other properties will be untouched. For example, if you want to update only theitem’s description, then only provide the description argument initem_properties.

Parameter	Description
item_properties	Optional dictionary. See table below for the keys and values.
thumbnail	Optional string. Either a path or URL to a thumbnail image.
metadata	Optional string. Either a path or URL to the metadata.

Key:Value Dictionary Options for Argument item_properties

Key	Value
typeKeywords	Optional string. Provide a lists all sub-types, see URL 1 below for valid values.
description	Optional string. Description of the item.
title	Optional string. Name label of the item.
tags	Optional string. Tags listed as comma-separated values, or a list of strings.Used for searches on items.
snippet	Optional string. Provide a short summary (limit to max 250 characters) of the what the item is.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string. Any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values are private, shared, org, or public.
commentsEnabled	Optional boolean. Default is true, controls whether comments are allowed (true)or not allowed (false).

The above are the most common item properties (metadata) that you set. To get a complete list, seethecommon parameterspage in the ArcGIS REST API documentation.

Returns:

A boolean indicating success (True) or failure (False).

propertyviewing_mode:str

Get/Set the viewing mode.

The viewing mode (local or global). Global scenes render the earth as a sphere. Local scenesrender the earth on a flat plane and allow for navigation and feature display in a localizedor clipped area. Users may also navigate the camera of a local scene below the surface of a basemap.

• “global” : Global scenes allow the entire globe to render in the view, showing the curvature of the earth.

• “local” : Local scenes render the earth on a flat surface. They can be constrained to only show a “local”

area by setting the clippingArea property. Local scenes also allow for displaying and exploring data thatwould otherwise be hidden by the surface of the earth.

Parameter	Description
mode	A string that represents the mode. Either “global” or “local”. Defaultis “global”.

Returns:

String that represents the viewing mode.

zoom

Get/Set the level of zoom applied to the rendered Scene.

Parameter	Description
value	Required int... note: Thehigherthenumber,themorezoomedinyouare.

Returns:

Int value that represent the zoom level

# Usage examplescene.zoom=10

zoom_to_layer(item:arcgis.gis.Item|features.FeatureSet|features.FeatureCollection|features.Layer|features.DataFrame|str)→None

Thezoom_to_layer method snaps the scene to the extent of the providedItem object(s).

Parameter	Description
item	The item at which you want to zoom your scene to.This can be a single extent or anItem,Layer ,DataFrame ,FeatureSet, orFeatureCollectionobject.

Scene Classes

Common Classes (Map and Scene)

GroupLayer

classarcgis.map.GroupLayer(layer:Layer,map:Map|Scene,parent:GroupLayer|Map|Scene)

The Group Layer class provides the ability to organize several sublayers into onecommon layer. Suppose there are several FeatureLayers that all representwater features in different dimensions.For example, wells (points), streams (lines), and lakes (polygons).The GroupLayer provides the functionality to treat them as one layercalled “Water Features” even though they are stored as separate featurelayers.

Note

This class should now be created by a user but rather accessed throughindexing using thelayers property on a Map instance.

form(index:int)→FormInfo

Get an instance of the FormInfo class for the layer specified. Specify the layer through it’sposition in the list of layers. The list of layers can be accessed with thelayers property.

Parameter	Description
index	Required integer specifying the layer who’s form to get. Layer has to bein list of layers of the Group Layer instance. You can get the list of layersby calling thelayers property on your Group Layer instance. Forms are only supported for Feature Layers, Tables, and Oriented Imagery Layers.

Returns:

FormInfo dataclass for the layer specified.

To see this dataclass, see the forms module where it is defined. You can also get the dataclass as a dictby calling thedict method on the dataclass.

layer_visibility(index:int)→LayerVisibility

Get an instance of the LayerVisibility class for the layer specified. Specify the layer through it’sposition in the list of layers. The list of layers can be accessed with thelayers property.

Parameter	Description
index	Required integer specifying the layer who’s layer visibility to get. Layer has to bein list of layers of the Group Layer instance. You can get the list of layersby calling thelayers property on your Group Layer instance.

propertylayers:list

Get the list of layers in the group layer.

move(index:int,group:GroupLayer|None=None)→None

Move a layer from it’s group into another GroupLayer or into ‘No Group’ which means it will bemoved to the main Map’s layers.

You can use this method on a GroupLayer and the entire GroupLayer will be added to another groupor be added to the main Map’s layers.

Parameter	Description
index	Required int. The index of the layer you want to move. You can see thelist of layers by calling thelayers property on your Group Layer instance.
group	Optional GroupLayer. The group layer you want to move the layer to.If you want to move the layer to the main Map’s layers, pass in None

popup(index:int)→PopupManager

Get an instance of the PopupManager class for the layer specified. Specify the layer through it’sposition in the list of layers. The list of layers can be accessed with thelayers property.

Parameter	Description
index	Required integer specifying the layer who’s popup to get. Layer has to bein list of layers of the Group Layer instance. You can get the list of layersby calling thelayers property on your Group Layer instance.

remove_layer(index:int)→None

Remove a layer from the Group Layer’s layers. You can do this by specifying the index of the currentlayer you want to remove.

Parameter	Description
index	Required int. The index of the layer you want to remove.You can see the list of layers by calling thelayers property on yourGroup Layer instance.

renderer(index:int)→RendererManager

Get an instance of the RendererManager class for the layer specified. Specify the layer through it’sposition in the list of layers. The list of layers can be accessed with thelayers property.

Parameter	Description
index	Required integer specifying the layer who’s renderer to get. Layer has to bein list of layers of the Group Layer instance. You can get the list of layersby calling thelayers property on your Group Layer instance.

reposition(current_index:int,new_index:int)→None

Reposition a layer in the Group Layer’s layers. You can do this by specifying the index of the currentlayer you want to move and what index it should be at.

This method is useful if you have overlapping layers and you want to manage the order in whichthey are rendered on your map.

Parameter	Description
current_index	Required int. The index of where the layer currently is in the list of layers.You can see the list of layers by calling thelayers property on yourGroup Layer instance.
new_index	Required int. The index you want to move the layer to.

propertytitle:str

Get/Set the title of the group layer.

ungroup()→None

Ungroup a GroupLayer. This will send the layer to the parent’s layers.If the parent is Map, then all the layers in the GroupLayer will be sent to the Map’s layers and the GroupLayer removed.If the parent is another GroupLayer, then all the layers in the GroupLayer will be sent to the parent’s layers and the GroupLayer removed.

update_layer(index,labeling_info=None,renderer=None,scale_symbols=None,transparency=None,options=None,form=None)→None

This method can be used to update certain properties found in a layer within a group layer in your map.

Parameter	Description
index	Optional integer specifying the index for the layer you want to update.To see a list of layers use the layers property. This cannot be a group layer.To update a layer in a GroupLayer, use theupdate_layer method in the group layer class.
labeling_info	Optional list of dictionaries. Defines the properties used for labeling the layer. Example of some properties:labeling_info = [{ “labelExpression”: ‘[FAA_ID]’,“maxScale”: 0,“minScale”: 10000,“symbol”: <Symbol Dataclass>} }]
renderer	Optional dictionary representing the renderer properties for the layerto be updated with. Example:renderer = SimpleRenderer(**{ ‘type’: ‘simple’,‘symbol’: { ‘type’: ‘esriPMS’,‘url’: ‘RedSphere.png’,‘imageData’: ‘{data}’,‘contentType’: ‘image/png’,‘width’: 15,‘height’: 15} })
scale_symbols	Optional bool. Indicates whether symbols should stay the same size inscreen units as you zoom in. False means the symbols stay the same sizein screen units regardless of the map scale.
transparency	Optional int. Value ranging between 0 (no transparency) to 100 (completely transparent).
options	Optional dictionary. Pass in key, value pairs that will edit the layer properties.This is useful for updating the layer properties that are not exposed throughthe other parameters. For example, you can update the layer title, opacity, or otherproperties that are applicable for the type of layer.
form	Optional FormInfo Dataclass. See the forms module where all the dataclasses are defined.You can get the current FormInfo by calling theform property and indicating the indexof the layer you want to get the form for.Forms are only supported for Feature Layers, Tables, and Oriented Imagery Layers.

SmartMappingManager

classarcgis.map.SmartMappingManager(source,layer)

A class to manage smart mapping methods. Smart MappingONLY works with a rendered map.

Warning

There are a few points to note with these methods:- You need to make sure that the layer has been loaded before calling a method on it.- The map can take a few seconds to reflect the changes from the renderer creation.- Calling any other methods or properties need to be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

class_breaks_renderer(break_type:str,field:str|None=None,normalization_field:str|None=None,normalization_type:str|None=None,normalization_total:int|None=None,classification_method:str|None=None,standard_deviation_interval:float|None=None,num_classes:int|None=None,value_expression:str|None=None,value_expression_title:str|None=None,sql_expression:str|None=None,sql_where:str|None=None,outline_optimization_enabled:bool=False,min_value:int|None=None,max_value:int|None=None,default_symbol_enabled:bool=True,for_binning:bool|None=None)→None

ClassBreaksRenderer defines the symbol of each feature in a Layer based on the value of a numeric attribute.Symbols are assigned based on classes or ranges of data. Each feature is assigned a symbol based on theclass break in which the value of the attribute falls.

The resulting renderer defines the symbol size of each feature based on the value of the given field value.A default size scheme is determined based on the background of the view. Depending on the classificationMethod,class breaks (or data ranges) are generated based on the statistics of the data. Each feature is assigned a sizebased on the class break in which the value of the field falls.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
break_type	Required string. The type of class breaks to generate. This valuedetermines how class breaks are generated. Values are: “size” or “color”.
field	Optional string. The name of the field whose data will be queried forstatistics and used for the basis of the data-driven visualization.If a value_expression is set, this field is ignored.The field should represent numeric types.
normalization_field	Optional string. The name of the field to normalize the values ofthe given field. Providing a normalization field helps minimize somevisualization errors and standardizes the data so all features arevisualized with minimal bias due to area differences or count variation.This option is commonly used when visualizing densities.
normalization_type	Optional string. Indicates how the data is normalized. The data valueobtained from the field is normalized in one of the following waysbefore it is compared with the class breaks. Values:- “log” : Computes the base 10 logarithm of each data value. This can be useful because it reduces the influence of very large data values. “percent-of-total”Divides each data value by the sum of all data values then multiplies by 100. “field” : Divides each data value by the value of the normalization_field.
normalization_total	Optional integer. The total of all data values. This is used whennormalization_type is “percent-of-total”.
classification_method	Optional string. The method for classifying the data. This valuedetermines how class breaks are generated. When the value is “equal-interval”,class breaks are generated such that the difference between any twobreaks is the same. When the value is “natural-breaks”, class breaksare generated based on natural groupings of the data. When the valueis “quantile”, class breaks are generated such that the total numberof data values in each class is the same. When the value is “standard-deviation”,class breaks are generated based on the standard deviation of the data.
standard_deviation_interval	Optional float. The standard deviation interval. This value is usedwhen classification_method is “standard-deviation”.
num_classes	Optional integer. The number of classes. This is ignored whenwhen “standard-deviation” is specified.
value_expression	Optional string. An Arcade expression following the specificationdefined by the Arcade Visualization Profile. Expressions may referencefield values using the $feature profile variable and must return a number.This property overrides the field property and therefore is used insteadof an input field value.
value_expression_title	Optional string. The title used to describe the value_expression in the Legend.
sql_expression	Optional string. A SQL expression evaluating to a number.
sql_where	Optional string. A where clause for the query. Used to filter features forthe statistics query.
outline_optimization_enabled	Optional boolean. Indicates whether the polygon’s background fill symboloutline width should vary based on view scale. Only for polygon layers.
min_value	Optional integer. A custom minimum value set by the user. Use thisin conjunction with max_value to generate statistics between lower andupper bounds. This will be the lowest stop in the returned visual variables.
max_value	Optional integer. A custom maximum value set by the user. Use thisin conjunction with min_value to generate statistics between lower andupper bounds. This will be the highest stop in the returned visual variables.
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assignsit to features with no value or that fall outside of the prescribed class breaks.
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction propertyof the layer.

dot_density_renderer(attributes:dict,dot_value_optimization_enabled:bool=True,dot_blending_enabled:bool=True,outline_optimization_enabled:bool=False,scheme:dict|None=None,for_binning:bool|None=None)→None

DotDensityRenderer allows you to create dot density visualizations for polygon layers.Dot density visualizations randomly draw dots within each polygon to visualize thedensity of a population or some other variable. Each dot represents a fixed numericvalue of an attribute or a subset of attributes. Unlike choropleth maps, field valuesused in dot density visualizations don’t need to be normalized because the size ofthe polygon, together with the number of dots rendered within its boundaries,indicate the spatial density of that value.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
attributes	Required list of dictionaries. A set of complementary numeric fields/expressionsused as the basis of the dot density visualization. For example,if creating an election map, you would indicate the names of each fieldrepresenting the candidate or political party where total votes are stored. Keys:- “field”: The name of a numeric field.- “label” : The label used to describe the field in the Legend.- “valueExpression”: An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions may referencefield values using the $feature profile variable and must return a number.This property overrides the field property and therefore is used insteadof an input field value. “valueExpressionTitle”: Text describing the value returned from the ‘valueExpression’.
dot_value_optimization_enabled	Optional boolean. Indicates whether to enable dot value optimization.When enabled, the renderer attempts to find the best dot value for eachpolygon based on the polygon’s size and the number of dots rendered within it.
dot_blending_enabled	Optional boolean. Indicates whether to enable dot blending.When enabled, the renderer blends dots together where they overlap.
outline_optimization_enabled	Optional boolean. Indicates whether to enable outline optimization.When enabled, the renderer attempts to find the best outline color foreach polygon based on the polygon’s size and the number of dots rendered within it.
scheme	Optional dictionary. A pre-defined dot density scheme. Use this parameter toavoid generating a new scheme based on the background of the Map. # Example dictionaryscheme={"name":"Reds 5","tags":["Single Color","Red"],"id":<themeName>/<basemapName>/<schemeName>,"colors":[[255,245,240],[254,224,210],[252,187,161],[252,146,114],[222,45,38]],"outline":{"color":[0,0,0,0.5],"width":0.75},"opacity":0.75}
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction propertyof the layer.

heatmap_renderer(field:str|None=None,scheme:dict|None=None,statistics:dict|None=None,fade_ratio:float|None=None,fade_to_transparent:bool=True,radius:int|None=None,min_ratio:float|None=None,max_ratio:float|None=None)→None

The HeatmapRenderer uses kernel density to render point features in FeatureLayers, CSVLayers,GeoJSONLayers and OGCFeatureLayers as a raster surface.

To create this visual, the HeatmapRenderer fits a smoothly curved surface over each point.The surface value is highest at the location of the point and decreases proportionally to thedistance from the point, reaching zero at the distance from the point specified in radius.The value of the surface equals the field value for the point, or 1 if no field is provided.The density at each pixel is calculated by adding the values of all the kernel surfaces where they overlay.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
field	Optional string. The name of the field whose data will be queried forstatistics and used for the basis of the data-driven visualization.The value of the field is used as a multiplier in the heatmap,making areas with high field values hotter than areas where the featureshave low field values.
scheme	Optional dictionary. A pre-defined heatmap scheme. Use this parameter toavoid generating a new scheme based on the background of the Map. # Example dictionaryscheme={"name":"Heatmap Blue 2","tags":["Heatmap","Blue"],"id":<themeName>/<basemapName>/<schemeName>,"colors":[[0,0,255,0.2],[0,0,255,0.4],[0,0,255,0.6],[0,0,255,0.8],[0,0,255,1]],opacity:0.75}
statistics	Optional dictionary. If statistics for the field have already been generated,then pass the object here to avoid making a second statistics query to the server.
fade_ratio	Optional float. Indicates how much to fade the lower color stops withtransparency to create a fuzzy boundary on the edge of the heatmap.A value of 0 makes a discrete boundary on the lower color stop.
fade_to_transparent	Optional boolean. Indicates whether to fade the lower color stops withtransparency to create a fuzzy boundary on the edge of the heatmap.If False, the fade_ratio is ignored.
radius	Optional integer. The radius in points that determines the area ofinfluence of each point. A higher radius indicates points have moreinfluence on surrounding points.
min_ratio	Optional float. The minimum ratio used to normalize the heatmap intensity values.
max_ratio	Optional float. The maximum ratio used to normalize the heatmap intensity values.

pie_chart_renderer(attributes:dict,shape:str|None=None,include_size_variable:bool|None=None,outline_optimization_enabled:bool=False,size_optimization_enabled:bool=False,scheme:dict|None=None,for_binning:bool|None=None)→None

PieChartRenderer allows you to create a pie chart for each feature in the layer.The value and color of each pie slice is specified in the attributes property.You can vary the size of each pie based on data with any other field value orArcade expression using visualVariables.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
attributes	Required list of dictionaries. A set of complementary numeric fields/expressionsused to create the charts. For example, if creating an election map,you would indicate the name of each field representing the candidateor political party where their total counts are stored. Keys:- “field”: The name of a numeric field.- “label” : The label used to describe the field in the Legend.- “valueExpression”: An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions may referencefield values using the $feature profile variable and must return a number.This property overrides the field property and therefore is used insteadof an input field value. “valueExpressionTitle”: Text describing the value returned from the ‘valueExpression’.
shape	Optional string. The shape used for the pie chart. Values: “pie” | “donut”
include_size_variable	Optional boolean. Indicates whether to include data-driven size inthe final renderer. If true, features will be assigned a sized basedon the sum of all values in the attributes param. Features withsmall total counts will be sized with small charts and features withlarge total counts will be sized with large charts. Enabling thisoption is good for visualizing how influential a particular featureis compared to the dataset as a whole. It removes bias introducedby features with large geographic areas, but relatively small data values.
outline_optimization_enabled	Optional boolean. Only for polygon layers. Indicates whether thepolygon’s background fill symbol outline width should vary based onview scale.
size_optimization_enabled	Optional boolean. Indicates whether symbol sizes should vary based on view scale.
scheme	Optional dictionary. A pre-defined pie chart scheme. Use this parameter toavoid generating a new scheme based on the background of the Map. # Example dictionaryscheme={"name":"Reds 5","tags":["Single Color","Red"],"colors":[[255,245,240],[254,224,210],[252,187,161],[252,146,114],[222,45,38]],"colorForOthersCategory":[200,200,200,255],"outline":{"color":[0,0,0,0.5],"width":0.75},"size":75,}
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction propertyof the layer.

predominance_renderer(fields:list,include_opacity_variable:bool|None=None,include_size_variable:bool|None=None,outline_optimization_enabled:bool=False,size_optimization_enabled:bool=False,statistics:dict|None=None,sort_by:str|None=None,scheme:dict|None=None,default_symbol_enabled:bool|None=True,for_binning:bool|None=None)→None

This object contains a helper method for generating a predominance visualization.Visualizing predominance involves coloring a layer’s features based on which attributeamong a set of competing numeric attributes wins or beats the others in total count.Common applications of this include visualizing election results, survey results,and demographic majorities.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
fields	Required list of dictionaries. A set of competing numeric fields used as the basisof the predominance visualization. A minimum of 2 fields are required. # Example listfields=[{"name":"POP2010","label":"Population 2010",(optional)},{"name":"POP2011","label":"Population 2011",(optional)},]
include_opacity_variable	Optional boolean. Indicates whether to include data-driven opacityin the final renderer. If true, features where the predominant valuebeats all others by a large margin are given a high opacity.Features where the predominant value beats others by a small marginwill be assigned a low opacity, indicating that while the feature hasa winning value, it doesn’t win by much.
include_size_variable	Optional boolean. Indicates whether to include data-driven size inthe final renderer. If true, features will be assigned a sized basedon the sum of all competing values in the fields param. Features withsmall total counts will be sized with small icons or lines dependingon the geometry type of the layer, and features with large total countswill be sized with large icons or lines. Enabling this option is goodfor visualizing how influential a particular feature is compared to thedataset as a whole. It removes bias introduced by features with largegeographic areas, but relatively small data values.
outline_optimization_enabled	Optional boolean. Indicates whether the polygon’s background fill symboloutline width should vary based on view scale. Only for polygon layers.
size_optimization_enabled	Optional boolean. Indicates whether symbol sizes should vary based on view scale.
statistics	Optional dictionary. If statistics for the field have already been generated,then pass the object here to avoid making a second statistics query to the server.
sort_by	Optional string. Indicates how to sort the fields in the legend.If count, unique values/types will be sorted from highest to lowestbased on the count of features that fall in each category. If value,unique values/types will be sorted in the order they were specified inthe fields parameter. Values: “count” | “value”
scheme	Optional dictionary. A pre-defined predominance scheme. Use this parameter toavoid generating a new scheme based on the background of the Map.For more information on what to include in the scheme see this url:https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#PredominanceScheme
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assignsit to features with no value.
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction propertyof the layer.

relationship_renderer(field1:dict,field2:dict,classification_method:str|None=None,focus:str|None=None,num_classes:int|None=None,outline_optimization_enabled:bool=False,size_optimization_enabled:bool=False,legend_options:dict|None=None,relationship_scheme:dict|None=None,default_symbol_enabled:bool=True,for_binning:bool|None=None)→None

This method utilizes the JS API create_renderer method to create a relationship renderer. This can only be accomplished with a rendered map.A relationship renderer helps explore the relationship between two numeric fields. The relationship is visualized using a bivariate choropleth visualization.This renderer classifies each variable in either 2, 3, or 4 classes along separate color ramps.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
field1	Required dictionary. A numeric field that will be used to explore itsrelationship with field2. In the default visualization, the values ofthis field are rendered along the vertical axis of the Legend. # Example dictionaryfield1={"field":"POP2010",#required"normalizationField":"SQMI","maxValue":1000000,"minValue":1000,"label":"Population 2010",}
field2	Required dictionary. A numeric field that will be used to explore itsrelationship with field1. In the default visualization, the values ofthis field are rendered along the horizontal axis of the Legend.
classification_method	Optional string. The method for classifying each field’s data values.Values: “quantile”, “equal-interval”, “natural-breaks”
focus	Optional string. Determines the orientation of the Legend. This valuedoes not change the renderer or symbology of any features in the layer.This affects the legend only. See the table at thislinkfor more information. Values: None, “HH”, “HL”, “LH”, “LL”If None, the legend renders as a square.
num_classes	Optional integer. Indicates the number of classes by which to breakup the values of each field. More classes give you more detail,but more colors, making the visualization more difficult to understand.There are only three possible values: 2, 3, or 4.
outline_optimization_enabled	Optional boolean. For polygon layers only. Indicates whether the polygonoutline width should vary based on view scale.
size_optimization_enabled	Optional boolean. For point and polyline layers only. Indicates whethersymbol sizes should vary based on view scale.
legend_options	Optional dictionary. Provides options for modifying Legend propertiesdescribing the visualization. # Example dictionarylegend_options={"title":"Population 2010","showLegend":True,}
relationship_scheme	Optional dictionary. In authoring apps, the user may select a pre-definedrelationship scheme. Pass the scheme object to this property to avoidgetting one based on the background of the Map.
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assignsit to features with no value or that fall outside of the prescribed class breaks.
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction property of the layer.

unique_values_renderer(field:str|None=None,field2:str|None=None,field3:str|None=None,num_types:int|None=None,sort_by:str|None=None,value_expression:str|None=None,value_expression_title:str|None=None,outline_optimization_enabled:bool=False,size_optimization_enabled:bool=False,legend_options:dict|None=None,default_symbol_enabled:bool=True,statistics:dict|None=None,for_binning:bool|None=None)→None

Generates data-driven visualizations with unique types (or categories) based on a field value from features in a Layer.This renderer works with Feature Layers, CSV Layers, GeoJSON Layers, WFS Layers, Oriented Imagery Layer, and OGC Feature Layers.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
field	Optional string. The name of the field from which to extract uniquevalues that will be used for the basis of the data-driven visualization.This property is ignored if a valueExpression is used.
field2	Optional string. Specifies the name of a second attribute field usedto categorize features. All combinations of field, field2, and field3values are unique categories and may have their own symbol.This property is ignored if a valueExpression is used.
field3	Optional string. Specifies the name of a third attribute field usedto categorize features. All combinations of field, field2, and field3values are unique categories and may have their own symbol.This property is ignored if a valueExpression is used.
num_types	Optional integer. The number of unique types (or categories) displayedby teh renderer. Use -1 to display all unique types. The default is 10.
sort_by	Optional string. Indicates how to sort the fields in the legend.If count, unique values/types will be sorted from highest to lowestbased on the count of features that fall in each category. If value,unique values/types will be sorted in the order they were specified inthe fields parameter. If none, unique values/types will be returned in thesame order they are defined in the statistics parameter or returned from theuniqueValues statistics query (if the statistics parameter is not defined). Values: “count” | “value” | “none”
value_expression	Optional string. An Arcade expression following the specificationdefined by the Arcade Visualization Profile. Expressions may referencefield values using the $feature profile variable and must return a number.This property overrides the field property and therefore is used insteadof an input field value.
value_expression_title	Optional string. The title used to describe the value_expression in the Legend.
outline_optimization_enabled	Optional boolean. Indicates whether the polygon’s background fill symboloutline width should vary based on view scale. Only for polygon layers.
size_optimization_enabled	Optional boolean. Indicates whether symbol sizes should vary based on view scale.
legend_options	Optional dictionary. Options for configuring the legend. # Example dictionarylegend_options={"title":<string>,}
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assignsit to features with no value.
statistics	Optional dictionary. If statistics for the field have already been generated,then pass the object here to avoid making a second statistics query to the server.
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction propertyof the layer.

univariate_color_size_renderer(field:str|None=None,normalization_field:str|None=None,value_expression:str|None=None,value_expression_title:str|None=None,theme:str|None=None,sql_expression:str|None=None,sql_where:str|None=None,statistics:dict|None=None,min_value:int|None=None,max_value:int|None=None,default_symbol_enabled:bool=None,color_options:dict|None=None,size_options:dict|None=None,symbol_options:dict|None=None,legend_options:dict|None=None,for_binning:bool|None=None)→None

This method utilizes the JS API create_renderer method to create a univariate color and size renderer. This can only be accomplished with a rendered map.A univariate color and size renderer visualizes quantitative data by adjusting the color and size of each feature proportionally to a data value.

Executing this method will automatically update your layer renderer on the map.

Warning

There are a few points to note with this method:- You need to make sure that the layer has been loaded before calling this method.- The map can take a few seconds to reflect the changes from the renderer.- Calling thesave orupdate method must be done in a separate cell from this method call due to asynchronous conflicts.- If you do not see the layer update, check the console log for any JavaScript errors.

Argument	Description
field	Optional string. The name of the field whose data will be queried forstatistics and used for the basis of the data-driven visualization.If a value_expression is set, this field is ignored.
normalization_field	Optional string. The name of the field to normalize the values ofthe given field. Providing a normalization field helps minimize somevisualization errors and standardizes the data so all features arevisualized with minimal bias due to area differences or count variation.This option is commonly used when visualizing densities.
value_expression	Optional string. An Arcade expression following the specificationdefined by the Arcade Visualization Profile. Expressions may referencefield values using the $feature profile variable and must return a number.This property overrides the field property and therefore is used insteadof an input field value.
value_expression_title	Optional string. The title used to describe the value_expression in the Legend.
theme	Optional string. Sets the size stops and colors based on meaningful data values.For more information on each value, see the table at thislink Values: “high-to-low”, “above”, “below”, “above-and-below”
sql_expression	Optional string. A SQL expression evaluating to a number.
sql_where	Optional string. A where clause for the query. Used to filter features forthe statistics query.
statistics	Optional dictionary. If statistics for the field have already been generated,then pass the dictionary here to avoid making a second statistics query to the server. # Example dictionarystatistics={"average":<int>,"count":<int>,"max":<int>,"min":<int>,"median":<int>,"stddev":<int>,"sum":<int>,"variance":<int>,"nullCount":<int>,#optional}
min_value	Optional integer. A custom minimum value set by the user. Use thisin conjunction with max_value to generate statistics between lower andupper bounds. This will be the lowest stop in the returned visual variables.
max_value	Optional integer. A custom maximum value set by the user. Use thisin conjunction with min_value to generate statistics between lower andupper bounds. This will be the highest stop in the returned visual variables.
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assignsit to features with no value or that fall outside of the prescribed class breaks.
color_options	Optional dictionary. Options for configuring the color portion of the visualization. # Example dictionarycolor_options={"colorScheme":{},#depends on layer type"isContinuous":<boolean>,}
size_options	Optional dictionary. Options for configuring the size portion of the visualization. # Example dictionarysize_options={"sizeScheme":{},#depends on geometry type of layer"sizeOptimizationEnabled":<boolean>,}
symbol_options	Optional dictionary. Options for configuring the symbol with “above-and-below” theme. ‘symbolStyle’ Values: “caret”, “circle-caret”, “arrow”, “circle-arrow”, “plus-minus”, “circle-plus-minus”, “square”, “circle”, “triangle”, “happy-sad”, “thumb” # Example dictionarysymbol_options={"symbolStyle":<string>,#see values above"symbols":{"above":<dict>,#symbol dictionary"below":<dict>,#symbol dictionary}}
legend_options	Optional dictionary. Options for configuring the legend. # Example dictionarylegend_options={"title":<string>,"showLegend":<boolean>,}
for_binning	Optional boolean. Indicates whether the generated renderer is for abinning visualization. If true, then the input field(s) in this methodshould refer to aggregate fields defined in the featureReduction propertyof the layer.