arcgis.map module

Map

class arcgis.map.Map(**kwargs: Any)

property basemap: BasemapManager

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

property bookmarks: Bookmarks

Get an instance of the Bookmarks that can be seen in your Map. This class can be used to add and remove bookmarks as well as edit them. You can also enable 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/long
map.center = [34.05, -118.24]

property content: MapContent

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

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

The export_to_html method takes the current state of the rendered map and exports it to a standalone HTML file that can be viewed in any web browser.

By default, only publicly viewable layers will be visible in any exported html map. Specify credentials_prompt=True to have a user be prompted for their credentials when opening the HTML page to view private content.

Warning

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

Note

You cannot successfully authenticate if you open the HTML page in a browser locally like file://path/to/file.html. The credentials prompt will only properly function if served over a HTTP/HTTPS server.

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 extent
map.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.

property layer_list: LayerList

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

property legend: Legend

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

property offline_areas: OfflineMapAreaManager | None

The offline_areas property is the resource manager for offline areas cached for the WebMap object.

Returns:

The OfflineMapAreaManager for the WebMap 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

The print method prints the Map object to a printable file such as a PDF, PNG32, JPG.

Note

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

The print method takes the state of the Map, renders and returns either a page layout or a map without page surrounds of the specified extent in 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 is not provided, it is assumed to be in the map’s spatial reference. When the aspect ratio of the map extent is different than the size of the map on the output page or the output_dimensions, you might notice more features on the output map.
dpi	Optional integer. Specify the print resolution of the output file. dpi stands for dots per inch. A higher number implies better resolution and a larger file size.
output_dimensions	Optional tuple. Specify the dimensions of the output file in pixels. If the layout_template is not MAP_ONLY, the specific layout template chosen takes precedence over this parameter.
scale	Optional float. Specify the map scale to be printed. The map scale at which you want your map to be printed. This parameter is optional but recommended for optimal results. The scale property is especially useful when map services in the web map have scale-dependent layers or reference scales set. Since the map that you are viewing on the web app may be smaller than the size of the output map (for example, 8.5 x 11 in. or A4 size), the scale of the output map will be different and you could see differences in features and/or symbols in the web application as compared with the output map. When scale is used, it takes precedence over the extent, but the output map is drawn at the requested scale centered on the center of the extent.
rotation	Optional float. Specify the number of degrees by which the map frame will be rotated, measured counterclockwise from the north. To rotate clockwise, use a negative value.
spatial_reference	Optional Dictionary.Specify the spatial reference in which map should be printed. When not specified, the following is the order of precedence: read from the extent parameter read from the base map layer of your web map read from the layout_template chosen
layout_template	Optional String. The default value MAP_ONLY does not use any template.
time_extent	Optional List . If there is a time-aware layer and you want it to be drawn at a specified time, specify this property. This order list can have one or two elements. Add two elements (startTime followed by endTime) to represent a time extent, or provide only 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 elements and is only needed when an available layout_template is chosen. Page layout elements include title, copyright text, scale bar, author name, and custom text elements. For more details, see ExportWebMap 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.

from arcgis.map import Map
from arcgis.gis import GIS

# connect to your GIS and get the web map item
gis = GIS(url, username, password)
wm_item = gis.content.get('1234abcd_web map item id')

# create a WebMap object from the existing web map item
wm = Map(item=wm_item)

# create an empty web map
wm2 = Map()
wm2.content.add(<desired Item or Layer object>)

# set extent
redlands_extent = {'spatialReference': {'latestWkid': 3857, 'wkid': 102100},
                     'xmin': -13074746.000753032,
                     'ymin': 4020957.451106308,
                     'xmax': -13014666.49652086,
                     'ymax': 4051532.26242039}

# print
printed_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:
from IPython.display import Image
Image(printed_file_url)

# Download file to disk
import requests
with requests.get(printed_file_url) as resp:
    with open('./output_file.png', 'wb') as file_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 degrees
map.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 the Map object as a new Web Map Item in your GIS.

Note

If you started with a Map object from an existing web map item, calling this method will create a new item with your changes. If you want to update the existing Map item found in your portal with your changes, call the update 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 be saved.

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, see the Common Parameters page in the ArcGIS REST API documentation.

Returns:

Item object corresponding to the new web map Item created.

# save the web map webmap_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 scale of 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:24000
map.scale = 24000

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

The sync_navigation method synchronizes the navigation from one rendered Map to another 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 to sync. The syncing will be remembered

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

theme

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

Values can be “light” or “dark”

property time_slider: TimeSlider

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

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

The unsync_navigation method unsynchronizes connections made to other rendered Map instances made via the sync_navigation method.

Parameter	Description
map	Optional, either a single Map instance, or a list of Map instances to unsynchronize. If not specified, will unsynchronize all synced Map instances.

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

The update method updates the Web Map Item in your GIS with the changes you made to the Map object. In addition, you can update other item properties, thumbnail and metadata.

Note

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

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

For item_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 the item’s description, then only provide the description argument in item_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, see the common parameters page 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: The higher the number, the more zoomed in you are.

Returns:

Int value that represent the zoom level

# Usage example
map.zoom = 10

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

The zoom_to_layer method snaps the map to the extent of the provided Item object(s).

Zoom to layer is modifying the rendered map’s extent. It is best to run this method call in 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 an Item, Layer , DataFrame , FeatureSet, or FeatureCollection object.

Map Classes

Scene

class arcgis.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 class will affect what will be seen on the scene. The underlying web scene dictionary will be transformed in the Scene class.

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

property basemap: BasemapManager

Returns a BasemapManager object that can be used to handle basemap 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 scene widget’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 is the heading of the camera in degrees. The tilt is the degrees with respect to the surface 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 example
scene.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 example
scene.center = [34.05, -118.24]

property content: SceneContent

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

property environment: Environment

Get an instance of the Environment class. You can use this class to enable or disable widgets 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

property heading: 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.

property layer_list: LayerList

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

property legend: Legend

Get an instance of the Legend class. You can use this class to enable or disable the 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 the Scene object as a new Web Scene Item in your GIS.

Note

If you started with a Scene object from an existing web scene item, calling this method will create a new item with your changes. If you want to update the existing Scene item found in your portal with your changes, call the update 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 be saved.

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, see the Common Parameters page in the ArcGIS REST API documentation.

Returns:

Item object corresponding to the new web scene Item created.

# save the web scene webscene_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 scale of 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:24000
scene.scale = 24000

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

The sync_navigation method synchronizes the navigation from one rendered Scene to another 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 to sync. The syncing will be remembered

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

theme

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

Values can be “light” or “dark”

property tilt: float

Get/Set the tilt of the rendered Scene. The tilt of the camera in degrees with respect to the surface as projected down from the camera position. Tilt is zero when looking straight down at the surface and 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.

property time_slider: TimeSlider

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

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

The unsync_navigation method unsynchronizes connections made to other rendered Scene instances made via the sync_navigation method.

Parameter	Description
scene	Optional, either a single Scene instance, or a list of Scene instances to unsynchronize. If not specified, will unsynchronize all synced Scene instances.

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

The update method updates the Web Scene Item in your GIS with the changes you made to the Scene object. In addition, you can update other item properties, thumbnail and metadata.

Note

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

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

For item_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 the item’s description, then only provide the description argument in item_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, see the common parameters page in the ArcGIS REST API documentation.

Returns:

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

property viewing_mode: str

Get/Set the viewing mode.

The viewing mode (local or global). Global scenes render the earth as a sphere. Local scenes render the earth on a flat plane and allow for navigation and feature display in a localized or 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 that would otherwise be hidden by the surface of the earth.

Parameter	Description
mode	A string that represents the mode. Either “global” or “local”. Default is “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: The higher the number, the more zoomed in you are.

Returns:

Int value that represent the zoom level

# Usage example
scene.zoom = 10

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

The zoom_to_layer method snaps the scene to the extent of the provided Item object(s).

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

Scene Classes

Common Classes (Map and Scene)

GroupLayer

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

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

Note

This class should now be created by a user but rather accessed through indexing using the layers 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’s position in the list of layers. The list of layers can be accessed with the layers property.

Parameter	Description
index	Required integer specifying the layer who’s form to get. Layer has to be in list of layers of the Group Layer instance. You can get the list of layers by calling the layers 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 dict by calling the dict 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’s position in the list of layers. The list of layers can be accessed with the layers property.

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

property layers: 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 be moved to the main Map’s layers.

You can use this method on a GroupLayer and the entire GroupLayer will be added to another group or 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 the list of layers by calling the layers 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’s position in the list of layers. The list of layers can be accessed with the layers property.

Parameter	Description
index	Required integer specifying the layer who’s popup to get. Layer has to be in list of layers of the Group Layer instance. You can get the list of layers by calling the layers 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 current layer 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 the layers property on your Group Layer instance.

renderer(index: int) → RendererManager

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

Parameter	Description
index	Required integer specifying the layer who’s renderer to get. Layer has to be in list of layers of the Group Layer instance. You can get the list of layers by calling the layers 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 current layer 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 which they 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 the layers property on your Group Layer instance.
new_index	Required int. The index you want to move the layer to.

property title: 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 the update_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 layer to 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 in screen units as you zoom in. False means the symbols stay the same size in 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 through the other parameters. For example, you can update the layer title, opacity, or other properties 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 the form property and indicating the index of the layer you want to get the form for. Forms are only supported for Feature Layers, Tables, and Oriented Imagery Layers.

SmartMappingManager

class arcgis.map.SmartMappingManager(source, layer)

A class to manage smart mapping methods. Smart Mapping ONLY 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 the class 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 size based 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 the save or update 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 value determines how class breaks are generated. Values are: “size” or “color”.
field	Optional string. The name of the field whose data will be queried for statistics 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 of the given field. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized 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 value obtained from the field is normalized in one of the following ways before 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 when normalization_type is “percent-of-total”.
classification_method	Optional string. The method for classifying the data. This value determines how class breaks are generated. When the value is “equal-interval”, class breaks are generated such that the difference between any two breaks is the same. When the value is “natural-breaks”, class breaks are generated based on natural groupings of the data. When the value is “quantile”, class breaks are generated such that the total number of 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 used when classification_method is “standard-deviation”.
num_classes	Optional integer. The number of classes. This is ignored when when “standard-deviation” is specified.
value_expression	Optional string. An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions may reference field values using the $feature profile variable and must return a number. This property overrides the field property and therefore is used instead of 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 for the statistics query.
outline_optimization_enabled	Optional boolean. Indicates whether the polygon’s background fill symbol outline width should vary based on view scale. Only for polygon layers.
min_value	Optional integer. A custom minimum value set by the user. Use this in conjunction with max_value to generate statistics between lower and upper 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 this in conjunction with min_value to generate statistics between lower and upper bounds. This will be the highest stop in the returned visual variables.
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assigns it 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 a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of 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 the density of a population or some other variable. Each dot represents a fixed numeric value of an attribute or a subset of attributes. Unlike choropleth maps, field values used in dot density visualizations don’t need to be normalized because the size of the 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 the save or update 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/expressions used as the basis of the dot density visualization. For example, if creating an election map, you would indicate the names of each field representing 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 reference field values using the $feature profile variable and must return a number. This property overrides the field property and therefore is used instead of 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 each polygon 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 for each 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 to avoid generating a new scheme based on the background of the Map. # Example dictionary scheme = { "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 a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of 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 the distance 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 the save or update 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 for statistics 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 features have low field values.
scheme	Optional dictionary. A pre-defined heatmap scheme. Use this parameter to avoid generating a new scheme based on the background of the Map. # Example dictionary scheme = { "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 with transparency 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 with transparency 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 of influence of each point. A higher radius indicates points have more influence 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 or Arcade 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 the save or update 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/expressions used to create the charts. For example, if creating an election map, you would indicate the name of each field representing the candidate or 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 reference field values using the $feature profile variable and must return a number. This property overrides the field property and therefore is used instead of 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 in the final renderer. If true, features will be assigned a sized based on the sum of all values in the attributes param. Features with small total counts will be sized with small charts and features with large total counts will be sized with large charts. Enabling this option is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by features with large geographic areas, but relatively small data values.
outline_optimization_enabled	Optional boolean. Only for polygon layers. Indicates whether the polygon’s background fill symbol outline width should vary based on view 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 to avoid generating a new scheme based on the background of the Map. # Example dictionary scheme = { "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 a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of 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 attribute among 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 the save or update 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 basis of the predominance visualization. A minimum of 2 fields are required. # Example list fields = [ { "name": "POP2010", "label": "Population 2010", (optional) }, { "name": "POP2011", "label": "Population 2011", (optional) }, ]
include_opacity_variable	Optional boolean. Indicates whether to include data-driven opacity in the final renderer. If true, features where the predominant value beats all others by a large margin are given a high opacity. Features where the predominant value beats others by a small margin will be assigned a low opacity, indicating that while the feature has a winning value, it doesn’t win by much.
include_size_variable	Optional boolean. Indicates whether to include data-driven size in the final renderer. If true, features will be assigned a sized based on the sum of all competing values in the fields param. Features with small total counts will be sized with small icons or lines depending on the geometry type of the layer, and features with large total counts will be sized with large icons or lines. Enabling this option is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by features with large geographic areas, but relatively small data values.
outline_optimization_enabled	Optional boolean. Indicates whether the polygon’s background fill symbol outline 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 lowest based on the count of features that fall in each category. If value, unique values/types will be sorted in the order they were specified in the fields parameter. Values: “count” | “value”
scheme	Optional dictionary. A pre-defined predominance scheme. Use this parameter to avoid 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 assigns it to features with no value.
for_binning	Optional boolean. Indicates whether the generated renderer is for a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of 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 the save or update 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 its relationship with field2. In the default visualization, the values of this field are rendered along the vertical axis of the Legend. # Example dictionary field1 = { "field": "POP2010", #required "normalizationField": "SQMI", "maxValue": 1000000, "minValue": 1000, "label": "Population 2010", }
field2	Required dictionary. A numeric field that will be used to explore its relationship with field1. In the default visualization, the values of this 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 value does not change the renderer or symbology of any features in the layer. This affects the legend only. See the table at this link for 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 break up 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 polygon outline width should vary based on view scale.
size_optimization_enabled	Optional boolean. For point and polyline layers only. Indicates whether symbol sizes should vary based on view scale.
legend_options	Optional dictionary. Provides options for modifying Legend properties describing the visualization. # Example dictionary legend_options = { "title": "Population 2010", "showLegend": True, }
relationship_scheme	Optional dictionary. In authoring apps, the user may select a pre-defined relationship scheme. Pass the scheme object to this property to avoid getting one based on the background of the Map.
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assigns it 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 a binning visualization. If true, then the input field(s) in this method should 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 the save or update 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 unique values 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 used to categorize features. All combinations of field, field2, and field3 values 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 used to categorize features. All combinations of field, field2, and field3 values 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) displayed by 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 lowest based on the count of features that fall in each category. If value, unique values/types will be sorted in the order they were specified in the fields parameter. If none, unique values/types will be returned in the same order they are defined in the statistics parameter or returned from the uniqueValues statistics query (if the statistics parameter is not defined). Values: “count” | “value” | “none”
value_expression	Optional string. An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions may reference field values using the $feature profile variable and must return a number. This property overrides the field property and therefore is used instead of 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 symbol outline 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 dictionary legend_options = { "title": <string>, }
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assigns it 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 a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of 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 the save or update 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 for statistics 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 of the given field. Providing a normalization field helps minimize some visualization errors and standardizes the data so all features are visualized 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 specification defined by the Arcade Visualization Profile. Expressions may reference field values using the $feature profile variable and must return a number. This property overrides the field property and therefore is used instead of 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 this link 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 for the 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 dictionary statistics = { "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 this in conjunction with max_value to generate statistics between lower and upper 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 this in conjunction with min_value to generate statistics between lower and upper bounds. This will be the highest stop in the returned visual variables.
default_symbol_enabled	Optional boolean. Enables the defaultSymbol on the renderer and assigns it 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 dictionary color_options = { "colorScheme": {}, #depends on layer type "isContinuous": <boolean>, }
size_options	Optional dictionary. Options for configuring the size portion of the visualization. # Example dictionary size_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 dictionary symbol_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 dictionary legend_options = { "title": <string>, "showLegend": <boolean>, }
for_binning	Optional boolean. Indicates whether the generated renderer is for a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of the layer.