Bases:Layer

TheSceneLayer class represents a Web scene layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.PointCloudLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

Bases:_GISResource

TheSceneLayerManager class allows administration (if access permits) of ArcGIS Online hosted scene layers.ASceneLayerManager offers access to map and layer content.

cancel_job(job_id:str)→dict|None

Thecancel_job operation supports cancelling a job while updatetiles is running from a hosted feature service. The result of thisoperation is a response indicating success or failure with errorcode and description.

Parameter	Description
job_id	Required String. The job id to cancel.

edit(item:str|Item)→dict|None

Theedit method edits from anItem object.

Parameter	Description
item	Required ItemId orItem object. The TPK file’s item id.This TPK file contains to-be-extracted bundle fileswhich are then merged into an existing cache service.

Returns:

A dictionary

import_package(item:str|Item)→dict|None

Theimport method imports from anItem object.

Parameter	Description
item	Required ItemId orItem object. The TPK file’s item id.This TPK file contains to-be-extracted bundle fileswhich are then merged into an existing cache service.

Returns:

A dictionary

job_statistics(job_id:str)→dict|None

Returns the job statistics for the given jobId

jobs()→dict|None

The tile service job summary (jobs) resource represents asummary of all jobs associated with a vector tile service.Each job contains a jobid that corresponds to the specificjobid run and redirects you to the Job Statistics page.

rebuild_cache(layers:int|list[int])→dict|None

The rebuild_cache operation update the scene layer cache to reflectany changes made to the feature layer used to publish this scene layer.The results of the operation is a response indicating success, whichredirects you to the Job Statistics page, or failure.

Parameter	Description
layers	Required int or list of int. Comma separated values indicatingthe id of the layers to rebuild in the cache. Ex: [0,1,2]

refresh()→dict|None

Therefresh operation refreshes a service, which clears the webserver cache for the service.

rerun_job(job_id:str,code:str)→dict|None

Thererun_job operation supports re-running a canceled job from ahosted map service. The result of this operation is a responseindicating success or failure with error code and description.

Parameter	Description
code	Required string, parameter used to re-run a givenjobs with a specific errorcode:ALL|ERROR|CANCELED
job_id	Required string, job to reprocess

Returns:

A boolean or dictionary

swap(target_service_name:str)→dict|None

The swap operation replaces the current service cache with an existing one.

Note

Theswap operation is for ArcGIS Online only.

Parameter	Description
target_service_name	Required string. Name of service you want to swap with.

Returns:

dictionary indicating success or error

update()→dict|None

Theupdate method starts update generation for ArcGIS Online. It updatesthe underlying source dataset for the service, essentially refreshing theunderlying package data.

Returns:

Dictionary.

update_attribute(layers:int|list[int])→dict|None

Update atrribute is a “light rebuild” where attributes ofthe layers selected are updated and can be used for change tracking.The results of the operation is a response indicating success, whichredirects you to the Job Statistics page, or failure.

Parameter	Description
layers	Required int or list of int. Comma separated values indicatingthe id of the layers to update in the cache. Ex: [0,1,2]

update_cache(layers:int|list[int])→dict|None

Update Cache is a “light rebuild” where attributes and geometries ofthe layers selected are updated and can be used for change tracking onthe feature layer to only update nodes with dirty tiles.The results of the operation is a response indicating success, whichredirects you to the Job Statistics page, or failure.

Parameter	Description
layers	Required int or list of int. Comma separated values indicatingthe id of the layers to update in the cache. Ex: [0,1,2]

Bases:_GISResource

TheEnterpriseSceneLayerManager class allows administration (if access permits) of ArcGIS Enterprise hosted scene layers.ASceneLayer offers access to layer content.

change_provider(provider:str)

Allows for the switching of the service provide and how it is hosted on the ArcGIS Server instance.

Values:

• ‘ArcObjects’ means the service is running under the ArcMap runtime i.e. published from ArcMap

• ‘ArcObjects11’: means the service is running under the ArcGIS Pro runtime i.e. published from ArcGIS Pro

• ‘DMaps’: means the service is running in the shared instance pool (and thus running under the ArcGIS Pro provider runtime)

Returns:

Boolean

delete()

deletes a service from arcgis server

edit(service_dictionary:dict)

To edit a service, you need to submit the complete JSONrepresentation of the service, which includes the updates to theservice properties. Editing a service causes the service to berestarted with updated properties.

Returns:

boolean

rebuild_cache(layer:list[int]|None=None,extent:dict|None=None,area_of_interest:dict|None=None)→str

The rebuild_cache operation update the scene layer cache to reflectany changes made to the feature layer used to publish this scene layer.The results of the operation is the url to the scene service once it isdone rebuilding.

Parameter	Description
layer	Optional list of integers. The list of layers to cook.
extent	Optional dict. The updated extent to be used. If nothing is specified,the default extent is used.
area_of_interest	Optional dict representing a feature. Specify the updated areaof interest. Syntax: { “displayFieldName”: “”,“geometryType”: “esriGeometryPolygon”,“spatialReference”: {“wkid”: 54051,“latestWkid”: 54051},“fields”: [{“name”: “OID”,“type”: “esriFieldTypeOID”,“alias”: “OID”},{“name”: “updateGeom_Length”,“type”: “esriFieldTypeDouble”,“alias”: “updateGeom_Length”},{“name”: “updateGeom_Area”,“type”: “esriFieldTypeDouble”,“alias”: “updateGeom_Area”}],“features”: [],“exceededTransferLimit”: False }

Returns:

If successful, the url to the scene service

start()

starts the specific service

stop()

stops the specific service

update_attribute(layer:list[int]|None=None,extent:dict|None=None,area_of_interest:dict|None=None)→str

Update atrribute is a “light rebuild” where attributes ofthe layers selected are updated and can be used for change tracking.The results of the operation is the url to the scene service once it isdone updating.

Parameter	Description
layer	Optional list of integers. The list of layers to cook.
extent	Optional dict. The updated extent to be used. If nothing is specified,the default extent is used.
area_of_interest	Optional dict representing a feature. Specify the updated areaof interest. Syntax: { “displayFieldName”: “”,“geometryType”: “esriGeometryPolygon”,“spatialReference”: {“wkid”: 54051,“latestWkid”: 54051},“fields”: [{“name”: “OID”,“type”: “esriFieldTypeOID”,“alias”: “OID”},{“name”: “updateGeom_Length”,“type”: “esriFieldTypeDouble”,“alias”: “updateGeom_Length”},{“name”: “updateGeom_Area”,“type”: “esriFieldTypeDouble”,“alias”: “updateGeom_Area”}],“features”: [],“exceededTransferLimit”: false }

Returns:

If successful, the url to the scene service

update_cache(layer:list[int]|None=None,extent:dict|None=None,area_of_interest:dict|None=None)→str

Update Cache is a “light rebuild” where attributes and geometries ofthe layers selected are updated and can be used for change tracking onthe feature layer to only update nodes with dirty tiles,.The results of the operation is the url to the scene service once it isdone updating.

Parameter	Description
layer	Optional list of integers. The list of layers to cook.
extent	Optional dict. The updated extent to be used. If nothing is specified,the default extent is used.
area_of_interest	Optional dict representing a feature. Specify the updated areaof interest. Syntax: { “displayFieldName”: “”,“geometryType”: “esriGeometryPolygon”,“spatialReference”: {“wkid”: 54051,“latestWkid”: 54051},“fields”: [{“name”: “OID”,“type”: “esriFieldTypeOID”,“alias”: “OID”},{“name”: “updateGeom_Length”,“type”: “esriFieldTypeDouble”,“alias”: “updateGeom_Length”},{“name”: “updateGeom_Area”,“type”: “esriFieldTypeDouble”,“alias”: “updateGeom_Area”}],“features”: [],“exceededTransferLimit”: False }

Returns:

If successful, the url to the scene service

Bases:Layer

TheBuildingLayer class represents a Web building layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.BuildingLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

propertymanager:SceneLayerManager|EnterpriseSceneLayerManager

Themanager property returns an instance ofSceneLayerManager classorEnterpriseSceneLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

TheIntegratedMeshLayer class represents a Web scene Integrated Mesh layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.Point3DLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

propertymanager:SceneLayerManager|EnterpriseSceneLayerManager

Themanager property returns an instance ofSceneLayerManager classorEnterpriseSceneLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

TheTiles3DLayer class represents a Web scene 3D Tile Service Layer.

propertymanager:Tiles3DLayerManager

Themanager property returns an instance ofTiles3DLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

TheObject3DLayer represents a Web scene 3D Object layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.Point3DLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

propertymanager:SceneLayerManager|EnterpriseSceneLayerManager

Themanager property returns an instance ofSceneLayerManager classorEnterpriseSceneLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

ThePoint3DLayer class represents a Web scene 3D Point layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.Point3DLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

propertymanager:SceneLayerManager|EnterpriseSceneLayerManager

Themanager property returns an instance ofSceneLayerManager classorEnterpriseSceneLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

ThePointCloudLayer class represents a Web scene Point Cloud layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.PointCloudLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

propertymanager:SceneLayerManager|EnterpriseSceneLayerManager

Themanager property returns an instance ofSceneLayerManager classorEnterpriseSceneLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

TheVoxelLayer class represents a Web Scene Voxel layer.

# USAGE EXAMPLE 1: Instantiating a SceneLayer objectfromarcgis.layersimportSceneLayers_layer=SceneLayer(url='https://your_portal.com/arcgis/rest/services/service_name/SceneServer/')type(s_layer)>>arcgis.layers.VoxelLayerprint(s_layer.properties.layers[0].name)>>'your layer name'

propertymanager:SceneLayerManager|EnterpriseSceneLayerManager

Themanager property returns an instance ofSceneLayerManager classorEnterpriseSceneLayerManager classwhich provides methods and properties for administering this service.

Bases:Layer

TheMapServiceLayer class is a factory that generates the Map Service Layers.

# USAGE EXAMPLE 1: Instantiating a Map Service Layer objectfromarcgis.layersimportMapServiceLayerms_layer=MapServiceLayer(url='https://your_portal.com/arcgis/rest/services/service_name/MapServer/0')type(ms_layer)>>arcgis.layers.MapTableprint(ms_layer.properties.name)>>'pipe_properties'

Bases:Layer

TheMapFeatureLayer class represents Map Feature Layers.Map Feature Layers can be added to and visualized using maps.

Map Feature Layers are created by publishing feature data to aGIS, and are exposed as abroader resource (Item) in theGIS.MapFeatureLayer objects can be obtained through the layers attribute on map image service Items in theGIS.

attachements

Deprecated since version 2.4.1:Use the attachments property instead.

Deprecated since version 2.4.1:Use the attachments property instead.

propertyattachments:AttachmentManager

Theattachments property provides a manager to work with attachments if theMapFeatureLayersupports this functionality.

propertycontainer:MapImageLayer

Thecontainer property represents theMapImageLayer to which this layer belongs.

export_attachments(output_folder:str,label_field:str|None=None)→str

Theexport_attachments method exports attachments from the map feature layer inImagenet format usingtheoutput_label_field.

Parameter	Description
output_folder	Required String. Output folder path where the attachments will be stored.
label_field	Optional. Field which contains the label/category of each feature.If None, a default folder is created.

Returns:

A path to the exported attachments

classmethodfromitem(item:Item,layer_id:int=0)→MapImageLayer

Thefromitem method creates aMapFeatureLayer from a GISItem.

Parameter	Description
item	RequiredItem object. The type of item should beaMapServiceLayer object.
layer_id	Optional integer. The id of the layer in the Map Service’s Layer.The default is 0.

Returns:

AMapFeatureLayer object

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer,MapFeatureLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>map_feature_layer=MapFeatureLayer.fromitem(item=map_image_item,layer_id=2)>>>print(f"{map_feature_layer.properties.name:30}{type(map_feature_layer)}")<StateBoundaries<class'arcgis.layers._msl.layer.MapFeatureLayer'>>

generate_renderer(definition:dict[str,Any],where:str|None=None)→dict[str,Any]

Thegenerate_renderer operation groups data using the supplied definition(classification definition) and an optional where clause. Theresult is a renderer object. UsebaseSymbol andcolorRamp to definethe symbols assigned to each class.

Note

If the operation is performedon a table, the result is a renderer object containing the dataclasses and no symbols.

Parameter	Description
definition	Required dict. The definition using the renderer that is generated.Use either class breaks or unique value classification definitions.See theclassification definitionspage in the ArcGIS REST API documentation for more information.
where	Optional string. A where clause for which the data needs to beclassified. Any legal SQL where clause operating on the fields inthe dynamic layer/table is allowed.

Returns:

dictionary

get_html_popup(oid:str)→dict|str

Theget_html_popup resource provides details about the HTML pop-upauthored by the user using ArcGIS Pro or ArcGIS Desktop.

Parameter	Description
oid	Optional string. Object id of the feature to get the HTML popup.

Returns:

A string

get_unique_values(attribute:str,query_string:str='1=1')→list

Theget_unique_values method retrieves a list of unique values for a given attribute.

Parameter	Description
attribute	Required string. The map feature layer attribute to query.
query_string	Optional string. SQL Query that will be used to filter attributesbefore unique values are returned.

Returns:

A List

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer,MapFeatureLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>map_feature_layer=MapFeatureLayer.fromitem(item=map_image_item,layer_id=2)>>>unique_values=map_feature_layer.get_unique_values(attribute="Name",query_string="name_2 like '%K%'")>>>type(unique_values)<List>

query(where:str='1=1',text:str|None=None,out_fields:str|list[str]='*',time_filter:list[int]|list[_dt.datetime]|dict[str,_dt.datetime]|None=None,geometry_filter:GeometryFilter|None=None,return_geometry:bool=True,return_count_only:bool=False,return_ids_only:bool=False,return_distinct_values:bool=False,return_extent_only:bool=False,group_by_fields_for_statistics:str|None=None,statistic_filter:StatisticFilter|None=None,result_offset:int|None=None,result_record_count:int|None=None,object_ids:str|None=None,distance:int|None=None,units:str|None=None,max_allowable_offset:float|None=None,out_sr:int|None=None,geometry_precision:int|None=None,gdb_version:str|None=None,order_by_fields:str|None=None,out_statistics:list[dict[str,Any]]|None=None,return_z:bool=False,return_m:bool=False,multipatch_option=None,quantization_parameters:dict[str,Any]|None=None,return_centroid:bool=False,return_all_records:bool=True,result_type:str|None=None,historic_moment:int|_dt.datetime|None=None,sql_format:str|None=None,return_true_curves:bool=False,return_exceeded_limit_features:bool|None=None,as_df:bool=False,datum_transformation:int|dict[str,Any]|None=None,range_values:dict[str,Any]|None=None,parameter_values:dict[str,Any]|None=None,**kwargs)→_features.FeatureSet|int|dict|pd.DataFrame

Thequery method queries a map feature layer based on a sql statement.

Parameter	Description
where	Optional string. The default is 1=1. The selection sql statement.
text	Optional String. A literal search text. If the layer has a displayfield associated with it, the server searches for this text in thisfield.
out_fields	Optional List of field names to return. Field names can be specifiedeither as a List of field names or as a comma separated string.The default is “*”, which returns all the fields.
object_ids	Optional string. The object IDs of this layer or table to be queried.The object ID values should be a comma-separated string.
distance	Optional integer. The buffer distance for the input geometries.The distance unit is specified by units. For example, if thedistance is 100, the query geometry is a point, units is set tometers, and all points within 100 meters of the point are returned.
units	Optional string. The unit for calculating the buffer distance. Ifunit is not specified, the unit is derived from the geometry spatialreference. If the geometry spatial reference is not specified, theunit is derived from the feature service data spatial reference.This parameter only applies ifsupportsQueryWithDistance istrue. Value options: esriSRUnit_Meter |esriSRUnit_StatuteMile |esriSRUnit_Foot |esriSRUnit_Kilometer |esriSRUnit_NauticalMile |esriSRUnit_USNauticalMile
time_filter	Optional list ofstartTime andendTime values.:Syntax: >>>time_filter=[<startTime>,<endTime>] Note Specified as_dt.datetime.date,_dt.datetime._dt.datetime ortimestamp in milliseconds
geometry_filter	Optionalfilter object. Allows forthe information to be filtered on spatial relationship with anothergeometry.
max_allowable_offset	Optional float. This option can be used to specify themax_allowable_offset to be used for generalizing geometriesreturned by the query operation in the units ofout_sr. Ifout_sr is not specified, the value is in units of the spatialreference of the layer.
out_sr	Optional Integer. The WKID for the spatial reference of the returnedgeometry.
geometry_precision	Optional Integer. This option can be used to specify the number ofdecimal places in the response geometries returned by the queryoperation.This applies to X and Y values only (not m or z-values).
gdb_version	Optional string. The geodatabase version to query. This parameterapplies only if theisDataVersioned property of the layer is true.If not specified, the query will apply to the published map’sversion.
return_geometry	Optional boolean. Iftrue, geometry is returned with the query.Default istrue.
return_distinct_values	Optional boolean. IfTrue, it returns distinct values based onfields specified inout_fields. This parameter applies only if thesupportsAdvancedQueries property of the layer is true.
return_ids_only	Optional boolean. Default isFalse. IfTrue, the response onlyincludes an array of object IDs. Otherwise, the response is aFeatureSet.
return_count_only	Optional boolean. IfTrue, the response only includes the countof features/records satisfying the query. Otherwise, the response isaFeatureSet. The default isFalse. Thisoption supersedes thereturns_ids_only parameter. IfreturnCountOnly=True , the response will return both the countand the extent.
return_extent_only	Optional boolean. IfTrue, the response only includes the extentof the features satisfying the query. IfreturnCountOnly=true, theresponse will return both the count and the extent. The default isFalse. This parameter applies only if thesupportsReturningQueryExtent property of the layer istrue.
order_by_fields	Optional string. One or more field names by which to order theresults. UseASC orDESC for ascendingor descending, respectively, following every field to be ordered: >>>order_by_fields="STATE_NAME ASC, RACE DESC, GENDER ASC"
group_by_fields_for_statistics	Optional string. One or more field names on which to group resultsfor calculating the statistics. >>>group_by_fields_for_statiscits="STATE_NAME, GENDER"
out_statistics	Optional List. The definitions for one or more field-basedstatistics to be calculated. Syntax: >>>out_statistics=[ { "statisticType": "<count | sum | min | max | avg | stddev | var>", "onStatisticField": "Field1", "outStatisticFieldName": "Out_Field_Name1" }, { "statisticType": "<count | sum | min | max | avg | stddev | var>", "onStatisticField": "Field2", "outStatisticFieldName": "Out_Field_Name2" } ]
return_z	Optional boolean. IfTrue, Z values are included in the results ifthe features have Z values. Otherwise, Z values are not returned.The default isFalse.
return_m	Optional boolean. IfTrue, M values are included in the results ifthe features have M values. Otherwise, M values are not returned.The default isFalse.
multipatch_option	Optional x/y footprint. This option dictates how the geometry ofa multipatch feature will be returned.
result_offset	Optional integer. This option can be used for fetching query resultsby skipping the specified number of records and starting from thenext record (that is,resultOffset + ith value). This option isignored ifreturn_all_records isTrue (i.e. by default).This parameter cannot be specified if the service does not support pagination.
result_record_count	Optional integer. This option can be used for fetching query resultsup to theresult_record_count specified. Whenresult_offset isspecified but this parameter is not, the map service defaults it tomax_record_count. The maximum value for this parameter is the valueof the layer’smaxRecordCount property. This option is ignored ifreturn_all_records is True (i.e. by default).This parameter cannot be specified if the service does not support pagination.
quantization_parameters	Optional dict. Used to project the geometry onto a virtual grid,likely representing pixels on the screen.
return_centroid	Optional boolean. Used to return the geometry centroid associatedwith each feature returned. IfTrue, the result includes thegeometry centroid. The default isFalse.
return_all_records	Optional boolean. WhenTrue, the query operation will call theservice until all records that satisfy thewhere_clause arereturned. Note result_offset andresult_record_count will beignored if set toTrue. Ifreturn_count_only,return_ids_only,orreturn_extent_only areTrue, this parameter is ignored.
result_type	Optional string. Controls the number of features returned by theoperation.Options:None |standard |tile Note SeeQuery (Feature Service/Layer)for full explanation.
historic_moment	Optional integer. The historic moment to query. This parameterapplies only if the layer is archiving enabled and thesupportsQueryWithHistoricMoment property is set totrue. Thisproperty is provided in the layer’sproperties resource. Ifnot specified, the query will apply to the current features.
sql_format	Optional string. Thesql_format parameter can be either standardSQL92 or it can use the native SQL of the underlyingdatastore. The default isNone, which means it depends on theuseStandardizedQuery layer property.Values:None |standard |native
return_true_curves	Optional boolean. When set toTrue, returns true curves in outputgeometries. When set toFalse, curves are converted to densifiedpolylines or polygons.
return_exceeded_limit_features	Optional boolean. Optional parameter which is true by default. Whenset to true, features are returned even when the results includetheexceededTransferLimit: True property. When set toFalse and querying withresultType = tile, featuresare not returned when the results includeexceededTransferLimit: True. This allows a client to find theresolution in which the transfer limit is no longer exceeded withoutmaking multiple calls.
as_df	Optional boolean. IfTrue, the results are returned as aDataFrame instead of aFeatureSet.
datum_transformation	Optional Integer/Dictionary. This parameter applies a datum transformation whileprojecting geometries in the results when out_sr is different than the layer’s spatialreference. When specifying transformations, you need to think about which datumtransformation best projects the layer (not the feature service) to theoutSR andsourceSpatialReference property in the layer properties. For a list of valid datumtransformation ID values ad well-known text strings, seeCoordinate systems andtransformations.For more information on datum transformations, please see the transformationparameter in theProject operation. Example: Inputs Description WKID Integer. >>>datum_transformation=4326 WKT Dict. >>>datum_transformation={"wkt":"<WKT>"} Composite Dict. >>>datum_transformation={"geoTransforms":[ {"wkid" : "<id>", "forward" : True | False}, {"wkt" : "WKT", "forward" : True: False} ] }
range_values	Optional List. Allows you to filter features from the layer that arewithin the specified range instant or extent. >>>range_values=[ { "name": "range name" , # single value or a value-range "value": <value> or [ <value1>, <value2> ] }, { "name": "range name 2", "value": <value> or [ <value3>, <value4> ] } ] Note None is allowed in value-range case to indicate infinity # all features with values <= 1500>>>range_values=[{"name":"range name","value":[None,1500]}]# all features with values >= 1000>>>range_values=[{"name":"range name","value":[1000,None]}]
parameter_values	Optional Dict. Allows you to filter the layers by specifyingvalue(s) to an array of pre-authored parameterized filters for thoselayers. When value is not specified for any parameter in a request,the default value, that is assigned during authoring time, gets usedinstead. When aparameterInfo allows multiple values, you must pass them inan array. Note CheckparameterValues at theQuery (Map Service/Layer)for details on parameterized filters.
kwargs	Optional dict. Optional parameters that can be passed to the Queryfunction. This will allow users to pass additional parameters notexplicitly implemented on the function. A complete list of functionsavailable is documented atQuery (Feature Service/Layer).

Returns:

AFeatureSet containing the features matching the query unless another

return type is specified, such ascount.

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer,MapFeatureLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>map_feature_layer=MapFeatureLayer.fromitem(item=map_image_item,layer_id=2)>>>query_count=map_feature_layer.query(where"1=1",text="Hurricane Data",units="esriSRUnit_Meter",return_count_only=True,out_statistics=[{"statisticType":"count","onStatisticField":"Field1","outStatisticFieldName":"Out_Field_Name1"},{"statisticType":"avg","onStatisticField":"Field2","outStatisticFieldName":"Out_Field_Name2"}],range_values=[{"name":"range name","value":[None,1500]},{"name":"range name 2","value":[1000,None]}}])>>>query_count<149>

query_related_records(object_ids:str,relationship_id:str,out_fields:str|list[str]='*',definition_expression:str|None=None,return_geometry:bool=True,max_allowable_offset:float|None=None,geometry_precision:int|None=None,out_wkid:int|None=None,gdb_version:str|None=None,return_z:bool=False,return_m:bool=False,historic_moment:int|_dt.datetime|None=None,return_true_curve:bool=False)→dict

Thequery_related_records operation is performed on aMapFeatureLayerresource. The result of this operation areFeatureSet objects groupedby source layer/table object IDs. EachFeatureSet containsFeature objects including the values for the fields requested bythe user.

Note

For related layers, if you request geometryinformation, the geometry of each feature is also returned inthe feature set. For related tables, the feature set does notinclude geometries.

Note

See thequery method for more information.

Parameter	Description
object_ids	Required string. The object IDs of the table/layer to be queried
relationship_id	Required string. The ID of the relationship to be queried.
out_fields	Required string. the list of fields from the related table/layerto be included in the returned feature set. This list is a commadelimited list of field names. If you specify the shape field in thelist of return fields, it is ignored. To request geometry, setreturn_geometry to true. You can also specify the wildcard “*” asthe value of this parameter. In this case, the results will includeall the field values.
definition_expression	Optional string. The definition expression to be applied to therelated table/layer. From the list of objectIds, only those recordsthat conform to this expression are queried for related records.
return_geometry	Optional boolean. If true, the feature set includes the geometryassociated with each feature. The default is true.
max_allowable_offset	Optional float. This option can be used to specify themax_allowable_offset to be used for generalizing geometries returnedby the query operation. The max_allowable_offset is in the units ofthe outSR. If out_wkid is not specified, then max_allowable_offsetis assumed to be in the unit of the spatial reference of the map.
geometry_precision	Optional integer. This option can be used to specify the number ofdecimal places in the response geometries.
out_wkid	Optional Integer. The spatial reference of the returned geometry.
gdb_version	Optional string. The geodatabase version to query. This parameterapplies only if the isDataVersioned property of the layer queried istrue.
return_z	Optional boolean. If true, Z values are included in the results ifthe features have Z values. Otherwise, Z values are not returned.The default is false.
return_m	Optional boolean. If true, M values are included in the results ifthe features have M values. Otherwise, M values are not returned.The default is false.
historic_moment	Optional Integer/_dt.datetime. The historic moment to query. This parameterapplies only if the supportsQueryWithHistoricMoment property of thelayers being queried is set to true. This setting is provided in thelayer resource. If historic_moment is not specified, the query will apply to thecurrent features. Syntax: historic_moment=<Epoch time in milliseconds>
return_true_curves	Optional boolean. Optional parameter that is false by default. Whenset to true, returns true curves in output geometries; otherwise,curves are converted to densified polylines or polygons.

Returns:

dict

propertyrenderer:dict|None

Get/Set the Renderer of the Map Feature Layer.

Note

Therenderer property overrides the default symbology when displaying it on aMap.

Returns:

Adict object used to update and alter JSON

propertytime_filter:str

Starting at Enterprise 10.7.1+, instead of querying time-enabledmap service layers or time-enabled feature service layers, atime filter can be set using thetime_filter property.Time can be filtered as Python_dt.datetime,objects or strings representing Unix epoch values in milliseconds.An extent can be specified by separating the start and stop valuescomma.

>>>import_dt.datetimeasdt>>>map_feature_lyr.time_filter=[dt._dt.datetime(2021,1,1),dt._dt.datetime(2022,1,10)]

Bases:MapFeatureLayer

TheMapRasterLayer class represents a geo-referenced image hosted in aMapService.

Bases:Layer

TheMapImageLayer allows you to display and analyze data from sublayers defined in a map service,exporting images instead of features. Map service images are dynamically generated on the server based on a request,which includes an LOD (level of detail), a bounding box, dpi, spatial reference and other options.The exported image is of the entire map extent specified.

create_dynamic_layer(layer:dict[str,Any])→FeatureLayer|None

Thecreate_dynamic_layer method creates a dynamic layer.A dynamic layer / table represents a single layer / table of a map service published by ArcGIS Serveror of a registered workspace. This resource is supported only when the map image layersupports dynamic layers, as indicated bysupportsDynamicLayers onthe map image layer properties.

Parameter

Description

layer

Required dict. Dynamic layer/table source definition. Syntax: { “id”: <layerOrTableId>, “source”: <layer source>, //required “definitionExpression”: “<definitionExpression>”, “drawingInfo”: { “renderer”: <renderer>, “transparency”: <transparency>, “scaleSymbols”: <true,false>, “showLabels”: <true,false>, “labelingInfo”: <labeling info> }, “layerTimeOptions”: //supported only for time enabled map layers { “useTime” : <true,false>, “timeDataCumulative” : <true,false>, “timeOffset” : <timeOffset>, “timeOffsetUnits” : “<esriTimeUnitsCenturies,esriTimeUnitsDays, esriTimeUnitsDecades,esriTimeUnitsHours, esriTimeUnitsMilliseconds,esriTimeUnitsMinutes, esriTimeUnitsMonths,esriTimeUnitsSeconds, esriTimeUnitsWeeks,esriTimeUnitsYears | esriTimeUnitsUnknown>” } }

Returns:

FeatureLayer or None (if not enabled)

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>layer_to_add={"id":<layerId>,"source":<layersource>"definitionExpression":"<definitionExpression>","drawingInfo":{"renderer":<renderer>,"transparency":<transparency>,"scaleSymbols":<true>,"showLabels":<true>,"labelingInfo":<labelinginfo>},"layerTimeOptions":{"useTime":<true,false>,"timeDataCumulative":<true>,"timeOffset":<timeOffset>,"timeOffsetUnits":"<esriTimeUnitsCenturies>"}}>>>new_layer=map_image_item.create_dynamic_layer(layer=layer_to_add)>>>type(new_layer)<arcgis.features.FeatureLayer>

estimate_export_tiles_size(export_by:str,levels:str,tile_package:bool=False,export_extent:str='DEFAULT',area_of_interest:dict[str,Any]|Polygon|None=None,asynchronous:bool=True,**kwargs)→dict

Theestimate_export_tiles_size method is an asynchronous task thatallows estimation of the size of the tile package or the cache dataset that you download using theexport_tiles operation. Thisoperation can also be used to estimate the tile count in a tilepackage and determine if it will exceed themaxExportTileCountlimit set by the administrator of the service. The result of thisoperation isMapServiceJob. This job response contains referencetoMapServiceResult resource that returns the total size of thecache to be exported (in bytes) and the number of tiles that willbe exported.

Parameter	Description
export_by	Required string. The criteria that will be used to select the tileservice levels to export. The values can be Level IDs, cache scalesor the Resolution (in the case of image services).Values: “levelId” | “resolution” | “scale”
levels	Required string. Specify the tiled service levels for which you wantto get the estimates. The values should correspond to Level IDs,cache scales or the Resolution as specified in export_by parameter.The values can be comma separated values or a range. Example 1: 1,2,3,4,5,6,7,8,9Example 2: 1-4,7-9
tile_package	Optional boolean. Allows estimating the size for either a tilepackage or a cache raster data set. Specify the value true for tilepackages format and false for Cache Raster data set. The defaultvalue is False
export_extent	The extent (bounding box) of the tile package or the cache datasetto be exported. If extent does not include a spatial reference, theextent values are assumed to be in the spatial reference of the map.The default value is full extent of the tiled map service.Syntax: <xmin>, <ymin>, <xmax>, <ymax>Example: -104,35.6,-94.32,41
area_of_interest	Optional dictionary or Polygon. This allows exporting tiles withinthe specified polygon areas. This parameter supersedes extentparameter. Example: { “features”: [{“geometry”:{“rings”:[[[-100,35], [-100,45],[-90,45],[-90,35],[-100,35]]], “spatialReference”:{“wkid”:4326}}}]}
asynchronous	Optional boolean. The estimate function is run asynchronouslyrequiring the tool status to be checked manually to force it torun synchronously the tool will check the status until theestimation completes. The default is True, which means the statusof the job and results need to be checked manually. If the valueis set to False, the function will wait until the task completes.

Returns:

dictionary

export_map(bbox:str,bbox_sr:int|None=None,size:str='600,550',dpi:int=200,image_sr:int|None=None,image_format:int='png',layer_defs:dict[str,Any]|None=None,layers:str|None=None,transparent:bool=False,time_value:list[int]|list[_dt.datetime._dt.datetime]|None=None,time_options:dict[str,Any]|None=None,dynamic_layers:dict[str,Any]|None=None,gdb_version:str|None=None,scale:float|None=None,rotation:float|None=None,transformation:list[int]|list[dict[str,Any]]|None=None,map_range_values:list[dict[str,Any]]|None=None,layer_range_values:list[dict[str,Any]]|None=None,layer_parameter:list[dict[str,Any]]|None=None,f:str='json',save_folder:str|None=None,save_file:str|None=None,**kwargs)→str

Theexport_map operation is performed on a map service resource.The result of this operation is a map image resource. Thisresource provides information about the exported map image suchas its URL, its width and height, extent and scale.

Parameter	Description
bbox	Required string. The extent (bounding box) of the exported image.Unless the bbox_sr parameter has been specified, the bbox is assumedto be in the spatial reference of the map.
bbox_sr	Optional integer,SpatialReference. The spatial reference of the bbox.
size	Optional string. size - size of image in pixels
dpi	Optional integer. dots per inch
image_sr	Optional integer,SpatialReference.The spatial reference of the output image.
image_format	Optional string. The format of the exported image.The default format is .png.Values: png | png8 | png24 | jpg | pdf | bmp | gif | svg | svgz | emf | ps | png32
layer_defs	Optional dict. Allows you to filter the features of individuallayers in the exported map by specifying definition expressions forthose layers. Definition expression for a layer that ispublished with the service will be always honored.
layers	Optional string. Determines which layers appear on the exported map.There are four ways to specify which layers are shown: show: Only the layers specified in this list will be exported. hide: All layers except those specified in this list will be exported. include: In addition to the layers exported by default, the layers specified in this list will be exported. exclude: The layers exported by default excluding those specified in this list will be exported.
transparent	Optional boolean. If true, the image will be exported with thebackground color of the map set as its transparent color. Thedefault is false. Note Only the .png and .gif formats supporttransparency.
time_value	Optional list. The time instant or the time extent of the featuresto be identified.
time_options	Optional dict. The time options per layer. Users can indicatewhether or not the layer should use the time extent specified by thetime parameter or not, whether to draw the layer featurescumulatively or not and the time offsets for the layer.
dynamic_layers	Optional dict. Use dynamicLayers property to reorder layers andchange the layer data source. dynamicLayers can also be used to addnew layer that was not defined in the map used to create the mapservice. The new layer should have its source pointing to one of theregistered workspaces that was defined at the time the map servicewas created.The order of dynamicLayers array defines the layer drawing order.The first element of the dynamicLayers is stacked on top of allother layers. When defining a dynamic layer, source is required.
gdb_version	Optional string. Switch map layers to point to an alternategeodatabase version.
scale	Optional float. Use this parameter to export a map image at aspecific map scale, with the map centered around the center of thespecified bounding box (bbox)
rotation	Optional float. Use this parameter to export a map image rotated ata specific angle, with the map centered around the center of thespecified bounding box (bbox). It could be positive or negativenumber.
transformations	Optional list. Use this parameter to apply one or more datumtransformations to the map when sr is different than the mapservice’s spatial reference. It is an array of transformationelements.
map_range_values	Optional list. Allows you to filter features in the exported mapfrom all layer that are within the specified range instant orextent.
layer_range_values	Optional dictionary. Allows you to filter features for eachindividual layer that are within the specified range instant orextent. Note: Check range infos at the layer resources for theavailable ranges.
layer_parameter	Optional list. Allows you to filter the features of individuallayers in the exported map by specifying value(s) to an array ofpre-authored parameterized filters for those layers. When value isnot specified for any parameter in a request, the default value,that is assigned during authoring time, gets used instead.

Returns:

A string, image of the map.

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>map_image_item.export_map(bbox="-104,35.6,-94.32,41",bbox_sr=4326,image_format="png",layers="include",transparent=True,scale=40.0,rotation=-45.0)

export_tiles(levels:str,export_by:str='LevelID',tile_package:bool=True,export_extent:dict[str,Any]|str|None=None,optimize_for_size:bool=True,compression:int=75,area_of_interest:dict[str,Any]|Polygon|None=None,asynchronous:bool=False,storage_format:str|None=None,**kwargs)→str|dict

Theexport_Tiles operation is performed as an asynchronous task andallows client applications to download map tiles from a server foroffline use. This operation is performed on aMapService thatallows clients to export cache tiles. The result of this operationis aMapServiceJob. This job response contains a reference to theMapServiceResult resource, which returns a URL to the resultingtile package (.tpk) or a cache raster dataset.export_Tiles can be enabled in a service by using ArcGIS Desktopor the ArcGIS Server Administrator Directory. In ArcGIS Desktopmake an admin or publisher connection to the server, go to serviceproperties, and enableAllowClients toExportCacheTiles in theadvanced caching page of theServiceEditor. You can also specifythe maximum tiles clients will be allowed to download.

Note

The default maximum allowed tile count is 100,000. To enable this capabilityusing the Administrator Directory, edit the service, and set thepropertiesexportTilesAllowed =True andmaxExportTilesCount = 100000.

Note

In ArcGIS Server 10.2.2 and later versions, exportTiles is supported as anoperation of the Map Server. The use of thehttp://Map_Service/exportTiles/submitJob operation is deprecated.You can provide arguments to the exportTiles operation as definedin the following parameters table:

Parameter	Description
levels	Required string. Specifies the tiled service levels to export. Thevalues should correspond to Level IDs, cache scales. or theresolution as specified in export_by parameter. The values can becomma separated values or a range. Make sure tiles are present atthe levels where you attempt to export tiles.Example 1: 1,2,3,4,5,6,7,8,9Example 2: 1-4,7-9
export_by	Required string. The criteria that will be used to select the tileservice levels to export. The values can be Level IDs, cache scales.or the resolution. The default is ‘LevelID’.Values: levelId | resolution | scale
tile_package	Optional boolean. Allows exporting either a tile package or a cacheraster data set. If the value is true, output will be in tilepackage format, and if the value is false, a cache raster dataset is returned. The default value is True.
export_extent	Optional dictionary or string. The extent (bounding box) of the tilepackage or the cache dataset to be exported. If extent does notinclude a spatial reference, the extent values are assumed to be inthe spatial reference of the map. The default value is full extentof the tiled map service.Syntax: <xmin>, <ymin>, <xmax>, <ymax> Example 1: -104,35.6,-94.32,41Example 2: {“xmin” : -109.55, “ymin” : 25.76, “xmax” : -86.39, “ymax” : 49.94, “spatialReference” : {“wkid” : 4326}}
optimize_for_size	Optional boolean. Use this parameter to enable compression of JPEGtiles and reduce the size of the downloaded tile package or thecache raster data set. Compressing tiles slightly compromises thequality of tiles but helps reduce the size of the download. Trysample compressions to determine the optimal compression beforeusing this feature.The default value is True.
compression=75,	Optional integer. When optimize_for_size=true, you can specify acompression factor. The value must be between 0 and 100. The valuecannot be greater than the default compression already set on theoriginal tile. For example, if the default value is 75, the valueof compressionQuality must be between 0 and 75. A value greaterthan 75 in this example will attempt to up sample an alreadycompressed tile and will further degrade the quality of tiles.
area_of_interest	Optional dictionary, Polygon. The area_of_interest polygon allowsexporting tiles within the specified polygon areas. This parametersupersedes the exportExtent parameter. Example: { “features”: [{“geometry”:{“rings”:[[[-100,35], [-100,45],[-90,45],[-90,35],[-100,35]]], “spatialReference”:{“wkid”:4326}}}]}
asynchronous	Optional boolean. Default False, this value ensures the returns arereturned to the user instead of the user having the check the jobstatus manually.
storage_format	Optional string. Specifies the type of tile package that will be created. tpk - Tiles are stored using Compact storage format. It is supported across the ArcGIS platform. tpkx - Tiles are stored using CompactV2 storage format, which provides better performance on network shares and cloud store directories. This improved and simplified package structure type is supported by newer versions of ArcGIS products such as ArcGIS Online 7.1, ArcGIS Enterprise 10.7, and ArcGIS Runtime 100.5. This is the default.

Returns:

A path to download file is asynchronous isFalse. IfTrue, a dictionary is returned.

find(search_text:str,layers:str,contains:bool=True,search_fields:str|None=None,sr:dict[str,Any]|str|SpatialReference|None=None,layer_defs:dict[str,Any]|None=None,return_geometry:bool=True,max_offset:int|None=None,precision:int|None=None,dynamic_layers:dict[str,Any]|None=None,return_z:bool=False,return_m:bool=False,gdb_version:str|None=None,return_unformatted:bool=False,return_field_name:bool=False,transformations:list[int]|list[dict[str,Any]]|None=None,map_range_values:list[dict[str,Any]]|None=None,layer_range_values:dict[str,Any]|None=None,layer_parameters:list[dict[str,Any]]|None=None,**kwargs)→dict

Thefind method performs the map servicefind operation.

Parameter	Description
search_text	Required string.The search string. This is the text that is searchedacross the layers and fields the user specifies.
layers	Optional string. The layers to perform the identify operation on.There are three ways to specify which layers to identify on: top: Only the top-most layer at the specified location. visible: All visible layers at the specified location. all: All layers at the specified location.
contains	Optional boolean. If false, the operation searches for an exactmatch of the search_text string. An exact match is case sensitive.Otherwise, it searches for a value that contains the search_textprovided. This search is not case sensitive. The default is true.
search_fields	Optional string. List of field names to look in.
sr	Optional dict, string, or SpatialReference. The well-known ID of thespatial reference of the input and output geometries as well as themap_extent. If sr is not specified, the geometry and the map_extentare assumed to be in the spatial reference of the map, and theoutput geometries are also in the spatial reference of the map.
layer_defs	Optional dict. Allows you to filter the features of individuallayers in the exported map by specifying definition expressions forthose layers. Definition expression for a layer that ispublished with the service will be always honored.
return_geometry	Optional boolean. If true, the resultset will include the geometriesassociated with each result. The default is true.
max_offset	Optional integer. This option can be used to specify the maximumallowable offset to be used for generalizing geometries returned bythe identify operation.
precision	Optional integer. This option can be used to specify the number ofdecimal places in the response geometries returned by the identifyoperation. This applies to X and Y values only (not m or z-values).
dynamic_layers	Optional dict. Use dynamicLayers property to reorder layers andchange the layer data source. dynamicLayers can also be used to addnew layer that was not defined in the map used to create the mapservice. The new layer should have its source pointing to one of theregistered workspaces that was defined at the time the map servicewas created.The order of dynamicLayers array defines the layer drawing order.The first element of the dynamicLayers is stacked on top of allother layers. When defining a dynamic layer, source is required.
return_z	Optional boolean. If true, Z values will be included in the resultsif the features have Z values. Otherwise, Z values are not returned.The default is false.
return_m	Optional boolean.If true, M values will be included in the resultsif the features have M values. Otherwise, M values are not returned.The default is false.
gdb_version	Optional string. Switch map layers to point to an alternategeodatabase version.
return_unformatted	Optional boolean. If true, the values in the result will not beformatted i.e. numbers will be returned as is and dates will bereturned as epoch values.
return_field_name	Optional boolean. If true, field names will be returned instead offield aliases.
transformations	Optional list. Use this parameter to apply one or more datumtransformations to the map when sr is different from the mapservice’s spatial reference. It is an array of transformationelements.
map_range_values	Optional list. Allows you to filter features in the exported mapfrom all layer that are within the specified range instant orextent.
layer_range_values	Optional dictionary. Allows you to filter features for eachindividual layer that are within the specified range instant orextent. Note: Check range infos at the layer resources for theavailable ranges.
layer_parameters	Optional list. Allows you to filter the features of individuallayers in the exported map by specifying value(s) to an array ofpre-authored parameterized filters for those layers. When value isnot specified for any parameter in a request, the default value,that is assigned during authoring time, gets used instead.

Returns:

A dictionary

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>search_results=map_image_item.find(search_text="Hurricane Data",contains=True,layers="top",return_geometry=False,max_offset=100,return_z=True,return_m=False,)>>>type(search_results)<Dictionary>

classmethodfromitem(item:Item)→MapImageLayer

Thefromitem method returns the layer at the specified index from a layerItem object.

Parameter	Description
item	Required Item. An item containing layers.
index	Optional int. The index of the layer amongst the item’s layers

Returns:

The layer at the specified index.

# Usage Example>>>layer.fromitem(item="9311d21a9a2047d19c0faaebd6f2cca6",index=3)

generate_kml(save_location:str,name:str,layers:str,options:str='composite')→str

Thegenerate_Kml operation is performed on a map service resource.The result of this operation is a KML document wrapped in a KMZfile.

Note

The document contains a network link to the KML Serviceendpoint with properties and parameters you specify.

Parameter	Description
save_location	Required string. Save folder.
name	Required string. The name of the resulting KML document.This is the name that appears in the Places panel of Google Earth.
layers	Required string. the layers to perform the generateKML operation on.The layers are specified as a comma-separated list of layer ids.
options	Required string. The layer drawing options. Based on the optionchosen, the layers are drawn as one composite image, as separateimages, or as vectors. When the KML capability is enabled, theArcGIS Server administrator has the option of setting the layeroperations allowed. If vectors are not allowed, then the caller willnot be able to get vectors. Instead, the caller receives a singlecomposite image.values: composite, separateImage, nonComposite

Returns:

A string to the file path

identify(geometry:Geometry|list,map_extent:str,image_display:str|None=None,geometry_type:str='Point',sr:dict[str,Any]|str|SpatialReference=None,layer_defs:dict[str,Any]|None=None,time_value:list[str]|str=None,time_options:dict|None=None,layers:str='all',tolerance:int|None=None,return_geometry:bool=True,max_offset:int|None=None,precision:int=4,dynamic_layers:dict[str,Any]|None=None,return_z:bool=False,return_m:bool=False,gdb_version:str|None=None,return_unformatted:bool=False,return_field_name:bool=False,transformations:list[dict]|list[int]|None=None,map_range_values:list[dict[str,Any]]|None=None,layer_range_values:dict[str,Any]|None=None,layer_parameters:list[dict[str,Any]]|None=None,**kwargs)→dict

Theidentify operation is performed on a map service resourceto discover features at a geographic location. The result of thisoperation is an identify results resource.

Note

Each identified result includes itsname,layerID,layername,geometry,geometrytype, and other attributes of that result as name-value pairs.

Parameter	Description
geometry	RequiredGeometry or list. The geometryto identify on. The type of the geometry is specified by thegeometryType parameter. The structure of the geometries is same asthe structure of the JSON geometry objects returned by the API (SeeGeometry Objects).In addition to the JSON structures, for points and envelopes, youcan specify the geometries with a simpler comma-separated syntax.
geometry_type	Required string.The type of geometry specified by the geometryparameter. The geometry type could be a point, line, polygon, or anenvelope.Values: “Point” | “Multipoint” | “Polyline” | “Polygon” | “Envelope”
map_extent	Required string. The extent or bounding box of the map currentlybeing viewed.
sr	Optional dict, string, or SpatialReference. The well-known ID of thespatial reference of the input and output geometries as well as themap_extent. If sr is not specified, the geometry and the map_extentare assumed to be in the spatial reference of the map, and theoutput geometries are also in the spatial reference of the map.
layer_defs	Optional dict. Allows you to filter the features of individuallayers in the exported map by specifying definition expressions forthose layers. Definition expression for a layer that ispublished with the service will be always honored.
time_value	Optional list. The time instant or the time extent of the featuresto be identified.
time_options	Optional dict. The time options per layer. Users can indicatewhether or not the layer should use the time extent specified by thetime parameter or not, whether to draw the layer featurescumulatively or not and the time offsets for the layer.
layers	Optional string. The layers to perform the identify operation on.There are three ways to specify which layers to identify on: top: Only the top-most layer at the specified location. visible: All visible layers at the specified location. all: All layers at the specified location.
tolerance	Optional integer. The distance in screen pixels from the specifiedgeometry within which theidentify operation should be performed. The value forthe tolerance is an integer.
image_display	Optional string. The screen image display parameters (width, height,and DPI) of the map being currently viewed. The mapExtent and theimage_display parameters are used by the server to determine thelayers visible in the current extent. They are also used tocalculate the distance on the map to search based on the tolerancein screen pixels. Syntax: <width>, <height>, <dpi>
return_geometry	Optional boolean. If true, the result set will include the geometriesassociated with each result. The default is true.
max_offset	Optional integer. This option can be used to specify the maximumallowable offset to be used for generalizing geometries returned bythe identify operation.
precision	Optional integer. This option can be used to specify the number ofdecimal places in the response geometries returned by the identifyoperation. This applies to X and Y values only (not m or z-values).
dynamic_layers	Optional dict. Use dynamicLayers property to reorder layers andchange the layer data source. dynamicLayers can also be used to addnew layer that was not defined in the map used to create the mapservice. The new layer should have its source pointing to one of theregistered workspaces that was defined at the time the map servicewas created.The order of dynamicLayers array defines the layer drawing order.The first element of the dynamicLayers is stacked on top of allother layers. When defining a dynamic layer, source is required.
return_z	Optional boolean. If true, Z values will be included in the resultsif the features have Z values. Otherwise, Z values are not returned.The default is false.
return_m	Optional boolean.If true, M values will be included in the resultsif the features have M values. Otherwise, M values are not returned.The default is false.
gdb_version	Optional string. Switch map layers to point to an alternategeodatabase version.
return_unformatted	Optional boolean. If true, the values in the result will not beformatted i.e. numbers will be returned as is and dates will bereturned as epoch values. The default is False.
return_field_name	Optional boolean. Default is False. If true, field names will bereturned instead of field aliases.
transformations	Optional list. Use this parameter to apply one or more datumtransformations to the map when sr is different than the mapservice’s spatial reference. It is an array of transformationelements.Transformations specified here are used to project features fromlayers within a map service to sr.
map_range_values	Optional list of dictionary(ies). Allows for the filtering features inthe exported map from all layer that are within the specified rangeinstant or extent.
layer_range_values	Optional Dictionary. Allows for the filtering of featuresfor each individual layer that are within the specified range instant orextent.
layer_parameters	Optional list of dictionary(ies). Allows for the filtering of thefeatures of individual layers in the exported map by specifying value(s)to an array of pre-authored parameterized filters for those layers. Whenvalue is not specified for any parameter in a request, the defaultvalue, that is assigned during authoring time, gets used instead.

Returns:

A dictionary

# USAGE EXAMPLE>>>fromarcgis.layersimportMapImageLayer>>>fromarcgis.gisimportGIS# connect to your GIS and get the web map item>>>gis=GIS(url,username,password)>>>map_image_item=gis.content.get("2aaddab96684405880d27f5261125061")>>>identified=map_image_item.identify(geometry=geom1,geometry_type="Multipoint",image_display="width",return_geometry=True,return_z=True,return_m=True,return_field_name=True,)>>>type(identified)<Dictionary>