arcgis.features module

The arcgis.features module contains types and functions for working with features and feature layers in the GIS .

Entities located in space with a geometrical representation (such as points, lines or polygons) and a set of properties can be represented as features. The arcgis.features module is used for working with feature data, feature layers and collections of feature layers in the GIS. It also contains the spatial analysis functions which operate against feature data.

In the GIS, entities located in space with a set of properties can be represented as features. Features are stored as feature classes, which represent a set of features located using a single spatial type (point, line, polygon) and a common set of properties. This is the geographic extension of the classic tabular or relational representation for entities - a set of entities is modelled as rows in a table. Tables represent entity classes with uniform properties. In addition to working with entities with location as features, the system can also work with non-spatial entities as rows in tables. The system can also model relationships between entities using properties which act as primary and foreign keys. A collection of feature classes and tables, with the associated relationships among the entities, is a feature layer collection. FeatureLayerCollection are one of the dataset types contained in a Datastore.

Note

Features are not simply entities in a dataset. Features have a visual representation and user experience - on a map, in a 3D scene, as entities with a property sheet or popups.

arcgis.features.Feature

class arcgis.features.Feature(geometry=None, attributes=None)

Entities located in space with a set of properties can be represented as features.

# Obtain a feature from a feature layer:

feature_set = feature_layer.query(where="OBJECTID=1")
feature = feature_set[0]
property as_dict

Retrieves the feature layer as a dictionary.

Returns

The feature as a dictionary

property as_row

Retrieves the feature as a tuple containing two lists:

List of:

Description

row values

the specific attribute values and geometry for this feature

field names

the name for each attribute field

Returns

A tuple of two lists: row values and field names

property attributes

Get/Set the attribute values for a feature

Argument

Description

value

Required dict.

Returns

A dictionary of feature attribute values with field names as the key

property fields

Retrieves the attribute field names for the feature as a list of strings

Returns

A list of strings

classmethod from_dict(feature, sr=None)

Creates a Feature object from a dictionary.

Returns

A class:~arcgis.features.feature.Feature

classmethod from_json(json_str)

Creates a Feature object from a JSON string.

Returns

A Feature

property geometry

Get/Set the geometry of the feature, if any

Argument

Description

value

Required string. Values: ‘Polyline’ | ‘Polygon’ | ‘Point’

Returns

The feature’s geometry as a string

property geometry_type

Retrieves the geometry type of the Feature as a string.

Returns

The geometry type of the Feature as a string

get_value(field_name)

Retrieves the value for a specified field name.

Argument

Description

field_name

Required String. The name for each attribute field.

Note

feature.fields will return a list of all field names.

Returns

The value for the specified attribute field of the Feature

set_value(field_name, value)

Sets an attribute value for a given field name.

Argument

Description

field_name

Required String. The name of the field to update.

value

Required. Value to update the field with.

Returns

A boolean indicating whether field_name value was updated (True), or not updated (False).

# UsageExample

>>> feat_set = feature_layer.query(where="OBJECTID=1")
>>> feat = feat_set[0]
>>> feat.set_value(field_name = "field_name", value = "new_value")
True

arcgis.features.FeatureLayer

class arcgis.features.FeatureLayer(url, gis=None, container=None, dynamic_layer=None)

The FeatureLayer class is the primary concept for working with Feature objects in a GIS.

User objects create, import, export, analyze, edit, and visualize features, i.e. entities in space as feature layers.

Feature layers can be added to and visualized using maps. They act as inputs to and outputs from feature analysis tools.

Feature layers are created by publishing feature data to a GIS, and are exposed as a broader resource (Item) in the GIS. Feature layer objects can be obtained through the layers attribute on feature layer Items in the GIS.

append(item_id=None, upload_format='featureCollection', source_table_name=None, field_mappings=None, edits=None, source_info=None, upsert=False, skip_updates=False, use_globalids=False, update_geometry=True, append_fields=None, rollback=False, skip_inserts=None, upsert_matching_field=None, upload_id=None, *, return_messages=None, future=False)

The append method is used to update an existing hosted FeatureLayer object. See the Append (Feature Service/Layer) page in the ArcGIS REST API documentation for more information.

Note

The append method is only available in ArcGIS Online and ArcGIS Enterprise 10.8.1+

Argument

Description

item_id

Optional string. The ID for the Portal item that contains the source file. Used in conjunction with editsUploadFormat.

upload_format

Required string. The source append data format. The default is featureCollection. Values: ‘sqlite’ | ‘shapefile’ | ‘filegdb’ | ‘featureCollection’ | ‘geojson’ | ‘csv’ | ‘excel’

source_table_name

Required string. Required even when the source data contains only one table, e.g., for file geodatabase.

# Example usage:
source_table_name=  "Building"

field_mappings

Optional list. Used to map source data to a destination layer. Syntax: field_mappings=[{“name” : <”targetName”>,

“sourceName” : < “sourceName”>}, …]

# Example usage:
field_mappings=[{"name" : "CountyID",
                "sourceName" : "GEOID10"}]

edits

Optional string. Only feature collection json is supported. Append supports all format through the upload_id or item_id.

source_info

Optional dictionary. This is only needed when appending data from excel or csv. The appendSourceInfo can be the publishing parameter returned from analyze the csv or excel file.

upsert

Optional boolean. Optional parameter specifying whether the edits needs to be applied as updates if the feature already exists. Default is false.

skip_updates

Optional boolean. Parameter is used only when upsert is true.

use_globalids

Optional boolean. Specifying whether upsert needs to use GlobalId when matching features.

update_geometry

Optional boolean. The parameter is used only when upsert is true. Skip updating the geometry and update only the attributes for existing features if they match source features by objectId or globalId.(as specified by useGlobalIds parameter).

append_fields

Optional list. The list of destination fields to append to. This is supported when upsert=true or false.

#Values:
["fieldName1", "fieldName2",....]

rollback

Optional boolean. Optional parameter specifying whether the upsert edits needs to be rolled back in case of failure. Default is false.

skip_inserts

Used only when upsert is true. Used to skip inserts if the value is true. The default value is false.

upsert_matching_field

Optional string. The layer field to be used when matching features with upsert. ObjectId, GlobalId, and any other field that has a unique index can be used with upsert. This parameter overrides use_globalids; e.g., specifying upsert_matching_field will be used even if you specify use_globalids = True. Example: upsert_matching_field=”MyfieldWithUniqueIndex”

upload_id

Optional string. The itemID field from an upload() response, corresponding with the appendUploadId REST API argument. This argument should not be used along side the item_id argument.

return_messages

Optional Boolean. When set to True, the messages returned from the append will be returned. If False, the response messages will not be returned. This alters the output to be a tuple consisting of a (Boolean, Dictionary).

future

Optional Boolean. When true, the response is returned as a Future object.

Returns

A boolean indicating success (True), or failure (False). When return_messages is True, the response messages will be return in addition to the boolean as a tuple. If future = True, then the result is a Future object. Call result() to get the response.

# Usage Example

>>> feature_layer.append(source_table_name= "Building",
                        field_mappings=[{"name" : "CountyID",
                                        "sourceName" : "GEOID10"}],
                        upsert = True,
                        append_fields = ["fieldName1", "fieldName2",...., fieldname22],
                        return_messages = False)
<True>
calculate(where, calc_expression, sql_format='standard', version=None, sessionid=None, return_edit_moment=None, future=False)

The calculate operation is performed on a FeatureLayer resource. calculate updates the values of one or more fields in an existing feature service layer based on SQL expressions or scalar values. The calculate operation can only be used if the supportsCalculate property of the layer is True. Neither the Shape field nor system fields can be updated using calculate. System fields include ObjectId and GlobalId.

Inputs

Description

where

Required String. A where clause can be used to limit the updated records. Any legal SQL where clause operating on the fields in the layer is allowed.

calc_expression

Required List. The array of field/value info objects that contain the field or fields to update and their scalar values or SQL expression. Allowed types are dictionary and list. List must be a list of dictionary objects.

Calculation Format is as follows:

{“field” : “<field name>”, “value” : “<value>”}

sql_format

Optional String. The SQL format for the calc_expression. It can be either standard SQL92 (standard) or native SQL (native). The default is standard.

Values: standard, native

version

Optional String. The geodatabase version to apply the edits.

sessionid

Optional String. A parameter which is set by a client during long transaction editing on a branch version. The sessionid is a GUID value that clients establish at the beginning and use throughout the edit session. The sessonid ensures isolation during the edit session. This parameter applies only if the isDataBranchVersioned property of the layer is true.

return_edit_moment

Optional Boolean. This parameter specifies whether the response will report the time edits were applied. If true, the server will return the time edits were applied in the response’s edit moment key. This parameter applies only if the isDataBranchVersioned property of the layer is true.

future

Optional Boolean. If True, the result is returned as a future object and the results are obtained in an asynchronous fashion. False is the default.

This applies to 10.8+ only

Returns

A dictionary with the following format:

{ ‘updatedFeatureCount’: 1, ‘success’: True }

# Usage Example 1:

print(fl.calculate(where="OBJECTID < 2",
                   calc_expression={"field": "ZONE", "value" : "R1"}))
# Usage Example 2:

print(fl.calculate(where="OBJECTID < 2001",
                   calc_expression={"field": "A",  "sqlExpression" : "B*3"}))
property container

Get/Set the FeatureLayerCollection to which this layer belongs.

Argument

Description

value

Required FeatureLayerCollection.

Returns

The Feature Layer Collection where the layer is stored

delete_features(deletes=None, where=None, geometry_filter=None, gdb_version=None, rollback_on_failure=True, return_delete_results=True, future=False)

Deletes features in a FeatureLayer or Table

Argument

Description

deletes

Optional string. A comma separated string of OIDs to remove from the service.

where

Optional string. A where clause for the query filter. Any legal SQL where clause operating on the fields in the layer is allowed. Features conforming to the specified where clause will be deleted.

geometry_filter

Optional SpatialFilter. A spatial filter from arcgis.geometry.filters module to filter results by a spatial relationship with another geometry.

gdb_version

Optional string. A Geodatabase version to apply the edits.

rollback_on_failure

Optional boolean. Optional parameter to specify if the edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

return_delete_results

Optional Boolean. Optional parameter that indicates whether a result is returned per deleted row when the deleteFeatures operation is run. The default is true.

future

Optional Boolean. If future=True, then the operation will occur asynchronously else the operation will occur synchronously. False is the default.

Returns

A dictionary if future=False (default), else a Future object.

# Usage Example with only a "where" sql statement

>>> from arcgis.features import FeatureLayer

>>> gis = GIS("pro")
>>> buck = gis.content.search("owner:"+ gis.users.me.username)
>>> buck_1 =buck[1]
>>> lay = buck_1.layers[0]

>>> la_df = lay.delete_features(where = "OBJECTID > 15")
>>> la_df
{'deleteResults': [
{'objectId': 1, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 2, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 3, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 4, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 5, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 6, 'uniqueId': 6, 'globalId': None, 'success': True},
{'objectId': 7, 'uniqueId': 7, 'globalId': None, 'success': True},
{'objectId': 8, 'uniqueId': 8, 'globalId': None, 'success': True},
{'objectId': 9, 'uniqueId': 9, 'globalId': None, 'success': True},
{'objectId': 10, 'uniqueId': 10, 'globalId': None, 'success': True},
{'objectId': 11, 'uniqueId': 11, 'globalId': None, 'success': True},
{'objectId': 12, 'uniqueId': 12, 'globalId': None, 'success': True},
{'objectId': 13, 'uniqueId': 13, 'globalId': None, 'success': True},
{'objectId': 14, 'uniqueId': 14, 'globalId': None, 'success': True},
{'objectId': 15, 'uniqueId': 15, 'globalId': None, 'success': True}]}
edit_features(adds=None, updates=None, deletes=None, gdb_version=None, use_global_ids=False, rollback_on_failure=True, return_edit_moment=False, attachments=None, true_curve_client=False, session_id=None, use_previous_moment=False, datum_transformation=None, future=False)

Adds, updates, and deletes features to the associated FeatureLayer or Table in a single call.

Note

When making large number (250+ records at once) of edits, append should be used over edit_features to improve performance and ensure service stability.

Inputs

Description

adds

Optional FeatureSet/List. The array of features to be added.

updates

Optional FeatureSet/List. The array of features to be updated.

deletes

Optional FeatureSet/List. string of OIDs to remove from service

use_global_ids

Optional boolean. Instead of referencing the default Object ID field, the service will look at a GUID field to track changes. This means the GUIDs will be passed instead of OIDs for delete, update or add features.

gdb_version

Optional boolean. Geodatabase version to apply the edits.

rollback_on_failure

Optional boolean. Optional parameter to specify if the edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

return_edit_moment

Optional boolean. Introduced at 10.5, only applicable with ArcGIS Server services only. Specifies whether the response will report the time edits were applied. If set to true, the server will return the time in the response’s editMoment key. The default value is false.

attachments

Optional Dict. This parameter adds, updates, or deletes attachments. It applies only when the use_global_ids parameter is set to true. For adds, the globalIds of the attachments provided by the client are preserved. When useGlobalIds is true, updates and deletes are identified by each feature or attachment globalId, rather than their objectId or attachmentId. This parameter requires the layer’s supportsApplyEditsWithGlobalIds property to be true.

Attachments to be added or updated can use either pre-uploaded data or base 64 encoded data.

Inputs

Inputs

Description

adds

List of attachments to add.

updates

List of attachements to update

deletes

List of attachments to delete

See the Apply Edits to a Feature Service layer in the ArcGIS REST API for more information.

true_curve_client

Optional boolean. Introduced at 10.5. Indicates to the server whether the client is true curve capable. When set to true, this indicates to the server that true curve geometries should be downloaded and that geometries containing true curves should be consumed by the map service without densifying it. When set to false, this indicates to the server that the client is not true curves capable. The default value is false.

session_id

Optional String. Introduced at 10.6. The session_id is a GUID value that clients establish at the beginning and use throughout the edit session. The sessonID ensures isolation during the edit session. The session_id parameter is set by a client during long transaction editing on a branch version.

use_previous_moment

Optional Boolean. Introduced at 10.6. The use_previous_moment parameter is used to apply the edits with the same edit moment as the previous set of edits. This allows an editor to apply single block of edits partially, complete another task and then complete the block of edits. This parameter is set by a client during long transaction editing on a branch version.

When set to true, the edits are applied with the same edit moment as the previous set of edits. When set to false or not set (default) the edits are applied with a new edit moment.

datum_transformation

Optional Integer/Dictionary. This parameter applies a datum transformation while projecting geometries in the results when out_sr is different than the layer’s spatial reference. When specifying transformations, you need to think about which datum transformation best projects the layer (not the feature service) to the outSR and sourceSpatialReference property in the layer properties. For a list of valid datum transformation ID values ad well-known text strings, see Using spatial references. For more information on datum transformations please see the transformation parameter in the Project operation documentation.

Examples

Inputs

Description

WKID

Integer. Ex: datum_transformation=4326

WKT

Dict. Ex: datum_transformation={“wkt”: “<WKT>”}

Composite

Dict. Ex: datum_transformation=```{‘geoTransforms’:[{‘wkid’:<id>,’forward’:<true|false>},{‘wkt’:’<WKT>’,’forward’:<True|False>}]}```

future

Optional Boolean. If True and the FeatureLayer has supportsAsyncApplyEdits set to True, then edits can be applied asynchronously.

Returns

A dictionary by default, or EditFeatureJob if future=True.

# Usage Example 1:

feature = [
{
    'attributes': {
        'ObjectId': 1,
        'UpdateDate': datetime.datetime.now(),
    }
}]
lyr.edit_features(updates=feature)
# Usage Example 2:

adds = {"geometry": {"x": 500, "y": 500, "spatialReference":
                    {"wkid": 102100, "latestWkid": 3857}},
        "attributes": {"ADMIN_NAME": "Fake Location"}
        }
lyr.edit_features(adds=[adds])
# Usage Example 3:

lyr.edit_features(deletes=[2542])
property estimates

Returns up-to-date approximations of layer information, such as row count and extent. Layers that support this property will include infoInEstimates information in the layer’s properties.

Currently available with ArcGIS Online and Enterprise 10.9.1+

Returns

Dict[str, Any]

export_attachments(output_folder, label_field=None)

Exports attachments from the FeatureLayer in Imagenet format using the output_label_field.

Argument

Description

output_folder

Required string. Output folder where the attachments will be stored. If None, a default folder is created

label_field

Optional string. Field which contains the label/category of each feature.

Returns

Nothing is returned from this method

classmethod fromitem(item, layer_id=0)

The fromitem method creates a FeatureLayer from an Item object.

Argument

Description

item

Required Item object. The type of item should be a Feature Service that represents a FeatureLayerCollection

layer_id

Required Integer. the id of the layer in feature layer collection (feature service). The default for layer_id is 0.

Returns

A FeatureSet object

# Usage Example

>>> from arcgis.features import FeatureLayer

>>> gis = GIS("pro")
>>> buck = gis.content.search("owner:"+ gis.users.me.username)
>>> buck_1 =buck[1]
>>> buck_1.type
'Feature Service'
>>> new_layer= FeatureLayer.fromitem(item = buck_1)
>>> type(new_layer)
<class 'arcgis.features.layer.FeatureLayer'>
generate_renderer(definition, where=None)

Groups data using the supplied definition (classification definition) and an optional where clause. The result is a renderer object.

Note

Use baseSymbol and colorRamp to define the symbols assigned to each class. If the operation is performed on a table, the result is a renderer object containing the data classes and no symbols.

Argument

Description

definition

Required dict. The definition using the renderer that is generated. Use either class breaks or unique value classification definitions. See Classification Objects for additional details.

where

Optional string. A where clause for which the data needs to be classified. Any legal SQL where clause operating on the fields in the dynamic layer/table is allowed.

Returns

A JSON Dictionary

..code-block:: python

# Example Usage FeatureLayer.generate_renderer(

definition = {“type”:”uniqueValueDef”,

“uniqueValueFields”:[“Has_Pool”], “fieldDelimiter”: “,”, “baseSymbol”:{

“type”: “esriSFS”, “style”: “esriSLSSolid”, “width”:2 },

“colorRamp”:{

“type”:”algorithmic”, “fromColor”:[115,76,0,255], “toColor”:[255,25,86,255], “algorithm”: “esriHSVAlgorithm” }

},

where = “POP2000 > 350000” )

get_html_popup(oid)

The get_html_popup method provides details about the HTML pop-up authored by the User using ArcGIS Pro or ArcGIS Desktop.

Argument

Description

oid

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

Returns

A string

get_unique_values(attribute, query_string='1=1')

Retrieves a list of unique values for a given attribute in the FeatureLayer.

Argument

Description

attribute

Required string. The feature layer attribute to query.

query_string

Optional string. SQL Query that will be used to filter attributes before unique values are returned. ex. “name_2 like ‘%K%’”

Returns

A list of unique values

# Usage Example with only a "where" sql statement

>>> from arcgis.features import FeatureLayer

>>> gis = GIS("pro")
>>> buck = gis.content.search("owner:"+ gis.users.me.username)
>>> buck_1 =buck[1]
>>> lay = buck_1.layers[0]
>>> layer = lay.get_unique_values(attribute = "COUNTY")
>>> layer
['PITKIN', 'PLATTE', 'TWIN FALLS']
property manager

The manager property is a helper object to manage the FeatureLayer, such as updating its definition.

Returns

A FeatureLayerManager

# Usage Example

>>> manager = FeatureLayer.manager
property metadata

Get the Feature Layer’s metadata.

Note

If metadata is disabled on the GIS or the layer does not support metadata, None will be returned.

Returns

String of the metadata, if any

property properties

The properties property retrieves and set properties of this object.

query(where='1=1', out_fields='*', time_filter=None, geometry_filter=None, return_geometry=True, return_count_only=False, return_ids_only=False, return_distinct_values=False, return_extent_only=False, group_by_fields_for_statistics=None, statistic_filter=None, result_offset=None, result_record_count=None, object_ids=None, distance=None, units=None, max_allowable_offset=None, out_sr=None, geometry_precision=None, gdb_version=None, order_by_fields=None, out_statistics=None, return_z=False, return_m=False, multipatch_option=None, quantization_parameters=None, return_centroid=False, return_all_records=True, result_type=None, historic_moment=None, sql_format=None, return_true_curves=False, return_exceeded_limit_features=None, as_df=False, datum_transformation=None, **kwargs)

The query method queries a FeatureLayer based on a sql statement.

Argument

Description

where

Optional string. The default is 1=1. The selection sql statement.

out_fields

Optional List of field names to return. Field names can be specified either 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 the distance is 100, the query geometry is a point, units is set to meters, and all points within 100 meters of the point are returned.

units

Optional string. The unit for calculating the buffer distance. If unit is not specified, the unit is derived from the geometry spatial reference. If the geometry spatial reference is not specified, the unit is derived from the feature service data spatial reference. This parameter only applies if supportsQueryWithDistance is true. Values: `esriSRUnit_Meter | esriSRUnit_StatuteMile |

esriSRUnit_Foot | esriSRUnit_Kilometer | esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile`

time_filter

Optional list. The format is of [<startTime>, <endTime>] using datetime.date, datetime.datetime or timestamp in milliseconds. Syntax: time_filter=[<startTime>, <endTime>] ; specified as

datetime.date, datetime.datetime or timestamp in milliseconds

geometry_filter

Optional from filters. Allows for the information to be filtered on spatial relationship with another geometry.

max_allowable_offset

Optional float. This option can be used to specify the max_allowable_offset to be used for generalizing geometries returned by the query operation. The max_allowable_offset is in the units of out_sr. If out_sr is not specified, max_allowable_offset is assumed to be in the unit of the spatial reference of the layer.

out_sr

Optional Integer. The WKID for the spatial reference of the returned geometry.

geometry_precision

Optional Integer. This option can be used to specify the number of decimal places in the response geometries returned by the query operation. This applies to X and Y values only (not m or z-values).

gdb_version

Optional string. The geodatabase version to query. This parameter applies only if the isDataVersioned property of the layer is true. If this is not specified, the query will apply to the published map’s version.

return_geometry

Optional boolean. If true, geometry is returned with the query. Default is true.

return_distinct_values

Optional boolean. If true, it returns distinct values based on the fields specified in out_fields. This parameter applies only if the supportsAdvancedQueries property of the layer is true.

return_ids_only

Optional boolean. Default is False. If true, the response only includes an array of object IDs. Otherwise, the response is a feature set.

return_count_only

Optional boolean. If true, the response only includes the count (number of features/records) that would be returned by a query. Otherwise, the response is a feature set. The default is false. This option supersedes the returnIdsOnly parameter. If returnCountOnly = true, the response will return both the count and the extent.

return_extent_only

Optional boolean. If true, the response only includes the extent of the features that would be returned by the query. If returnCountOnly=true, the response will return both the count and the extent. The default is false. This parameter applies only if the supportsReturningQueryExtent property of the layer is true.

order_by_fields

Optional string. One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering. example: STATE_NAME ASC, RACE DESC, GENDER

group_by_fields_for_statistics

Optional string. One or more field names on which the values need to be grouped for calculating the statistics. example: STATE_NAME, GENDER

out_statistics

Optional list of dictionaries. The definitions for one or more field-based statistics to be calculated.

Syntax:

[
{

“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”

}

]

statistic_filter

Optional StatisticFilter instance. The definitions for one or more field-based statistics can be added, e.g. statisticType, onStatisticField, or outStatisticFieldName.

Syntax:

sf = StatisticFilter() sf.add(statisticType=”count”, onStatisticField=”1”, outStatisticFieldName=”total”) sf.filter

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

multipatch_option

Optional x/y footprint. This option dictates how the geometry of a multipatch feature will be returned.

result_offset

Optional integer. This option can be used for fetching query results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th). This option is ignored if return_all_records is True (i.e. by default).

result_record_count

Optional integer. This option can be used for fetching query results up to the result_record_count specified. When result_offset is specified but this parameter is not, the map service defaults it to max_record_count. The maximum value for this parameter is the value of the layer’s max_record_count property. This option is ignored if return_all_records is True (i.e. by default).

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 associated with each feature returned. If true, the result includes the geometry centroid. The default is false.

return_all_records

Optional boolean. When True, the query operation will call the service until all records that satisfy the where_clause are returned. Note: result_offset and result_record_count will be ignored if return_all_records is True. Also, if return_count_only, return_ids_only, or return_extent_only are True, this parameter will be ignored.

result_type

Optional string. The result_type parameter can be used to control the number of features returned by the query operation. Values: None | standard | tile

historic_moment

Optional integer. The historic moment to query. This parameter applies only if the layer is archiving enabled and the supportsQueryWithHistoricMoment property is set to true. This property is provided in the layer resource.

If historic_moment is not specified, the query will apply to the current features.

sql_format

Optional string. The sql_format parameter can be either standard SQL92 standard or it can use the native SQL of the underlying datastore native. The default is none which means the sql_format depends on useStandardizedQuery parameter. Values: none | standard | native

return_true_curves

Optional boolean. When set to true, returns true curves in output geometries. When set to false, curves are converted to densified polylines or polygons.

return_exceeded_limit_features

Optional boolean. Optional parameter which is true by default. When set to true, features are returned even when the results include ‘exceededTransferLimit’: True.

When set to false and querying with resultType = tile features are not returned when the results include ‘exceededTransferLimit’: True. This allows a client to find the resolution in which the transfer limit is no longer exceeded without making multiple calls.

as_df

Optional boolean. If True, the results are returned as a DataFrame instead of a FeatureSet.

datum_transformation

Optional Integer/Dictionary. This parameter applies a datum transformation while projecting geometries in the results when out_sr is different than the layer’s spatial reference. When specifying transformations, you need to think about which datum transformation best projects the layer (not the feature service) to the outSR and sourceSpatialReference property in the layer properties. For a list of valid datum transformation ID values ad well-known text strings, see Coordinate systems and transformations. For more information on datum transformations, please see the transformation parameter in the Project operation.

Examples

Inputs

Description

WKID

Integer. Ex: datum_transformation=4326

WKT

Dict. Ex: datum_transformation={“wkt”: “<WKT>”}

Composite

Dict. Ex: datum_transformation=```{‘geoTransforms’:[{‘wkid’:<id>,’forward’:<true|false>},{‘wkt’:’<WKT>’,’forward’:<True|False>}]}```

kwargs

Optional dict. Optional parameters that can be passed to the Query function. This will allow users to pass additional parameters not explicitly implemented on the function. A complete list of functions available is documented on the Query REST API.

Returns

A FeatureSet containing the features matching the query unless another return type is specified, such as return_count_only, return_extent_only, or return_ids_only.

# Usage Example with only a "where" sql statement

>>> feat_set = feature_layer.query(where = "OBJECTID= 1")
>>> type(feat_set)
<arcgis.Features.FeatureSet>
>>> feat_set[0]
<Feature 1>
# Usage Example of an advanced query returning the object IDs instead of Features

>>> id_set = feature_layer.query(where = "OBJECTID1",
                                   out_fields = ["FieldName1, FieldName2"],
                                   distance = 100,
                                   units = 'esriSRUnit_Meter',
                                   return_ids_only = True)

>>> type(id_set)
<Array>
>>> id_set[0]
<"Item_id1">
# Usage Example of an advanced query returning the number of features in the query

>>> search_count = feature_layer.query(where = "OBJECTID1",
                                   out_fields = ["FieldName1, FieldName2"],
                                   distance = 100,
                                   units = 'esriSRUnit_Meter',
                                   return_count_only = True)

>>> type(search_count)
<Integer>
>>> search_count
<149>
# Usage Example with "out_statistics" parameter

>>> stats = [{
        'onStatisticField': "1",
        'outStatisticFieldName': "total",
        'statisticType': "count"
    }]
>>> feature_layer.query(out_statistics=stats, as_df=True) # returns a DataFrame containting total count
# Usage Example with "StatisticFilter" parameter

>>> from arcgis._impl.common._filters import StatisticFilter
>>> sf1 = StatisticFilter()
>>> sf1.add(statisticType="count", onStatisticField="1", outStatisticFieldName="total")
>>> sf1.filter # This is to print the filter content
>>> feature_layer.query(statistic_filter=sf1, as_df=True) # returns a DataFrame containing total count
query_analytics(out_analytics, where='1=1', out_fields='*', analytic_where=None, geometry_filter=None, out_sr=None, return_geometry=True, order_by=None, result_type=None, cache_hint=None, result_offset=None, result_record_count=None, quantization_param=None, sql_format=None, future=True, **kwargs)

The query_analytics exposes the standard SQL windows functions that compute aggregate and ranking values based on a group of rows called window partition. The window function is applied to the rows after the partitioning and ordering of the rows. query_analytics defines a window or user-specified set of rows within a query result set. query_analytics can be used to compute aggregated values such as moving averages, cumulative aggregates, or running totals.

Note

See the query method for a similar function.

SQL Windows Function

A window function performs a calculation across a set of rows (SQL partition or window) that are related to the current row. Unlike regular aggregate functions, use of a window function does not return single output row. The rows retain their separate identities with each calculation appended to the rows as a new field value. The window function can access more than just the current row of the query result.

query_analytics currently supports the following windows functions:
  • Aggregate functions

  • Analytic functions

  • Ranking functions

Aggregate Functions

Aggregate functions are deterministic function that perform a calculation on a set of values and return a single value. They are used in the select list with optional HAVING clause. GROUP BY clause can also be used to calculate the aggregation on categories of rows. query_analytics can be used to calculate the aggregation on a specific range of value. Supported aggregate functions are:

  • Min

  • Max

  • Sum

  • Count

  • AVG

  • STDDEV

  • VAR

Analytic Functions

Several analytic functions available now in all SQL vendors to compute an aggregate value based on a group of rows or windows partition. Unlike aggregation functions, analytic functions can return single or multiple rows for each group.

  • CUM_DIST

  • FIRST_VALUE

  • LAST_VALUE

  • LEAD

  • LAG

  • PERCENTILE_DISC

  • PERCENTILE_CONT

  • PERCENT_RANK

Ranking Functions

Ranking functions return a ranking value for each row in a partition. Depending on the function that is used, some rows might receive the same value as other rows.

  • RANK

  • NTILE

  • DENSE_RANK

  • ROW_NUMBER

Partitioning

Partitions are extremely useful when you need to calculate the same metric over different group of rows. It is very powerful and has many potential usages. For example, you can add partition by to your window specification to look at different groups of rows individually.

partitionBy clause divides the query result set into partitions and the sql window function is applied to each partition. The ‘partitionBy’ clause normally refers to the column by which the result is partitioned. ‘partitionBy’ can also be a value expression (column expression or function) that references any of the selected columns (not aliases).

Argument

Description

out_analytics

Required List. A set of analytics to calculate on the Feature Layer.

The definitions for one or more field-based or expression analytics to be computed. This parameter is supported only on layers/tables that indicate supportsAnalytics is true. Note: If outAnalyticFieldName is empty or missing, the server assigns a field name to the returned analytic field.

Syntax: An array of analytic definitions. An analytic definition specifies the type of analytic, the field or expression on which it is to be computed, and the resulting output field name. Syntax [

{

“analyticType”: “<COUNT | SUM | MIN | MAX | AVG | STDDEV | VAR | FIRST_VALUE, LAST_VALUE, LAG, LEAD, PERCENTILE_CONT, PERCENTILE_DISC, PERCENT_RANK, RANK, NTILE, DENSE_RANK, EXPRESSION>”, “onAnalyticField”: “Field1”, “outAnalyticFieldName”: “Out_Field_Name1”,

“analyticParameters”: {

“orderBy”: “<orderBy expression”, “value”: <double value>,// percentile value “partitionBy”: “<field name or expression>”, “offset”: <integer>, // used by LAG/LEAD “windowFrame”: {

“type”: “ROWS” | “RANGE”, “extent”: {

“extentType”: “PRECEDING” | “BOUNDARY”, “PRECEDING”: {

“type”: <”UNBOUNDED” |
“NUMERIC_CONSTANT” |

“CURRENT_ROW”>

“value”: <numeric constant value>

} “BOUNDARY”: {

“start”: “UNBOUNDED_PRECEDING”,
“NUMERIC_PRECEDING”,

“CURRENT_ROW”,

“startValue”: <numeric constant value>, “end”: <”UNBOUNDED_FOLLOWING” |

“NUMERIC_FOLLOWING” | “CURRENT_ROW”,

“endValue”: <numeric constant value>

}

}

}

}

}

}

]

Example: [{

“analyticType”: “FIRST_VALUE”, “onAnalyticField”: “POP1990”, “analyticParameters”: {

“orderBy”: “POP1990”, “partitionBy”: “state_name”

}, “outAnalyticFieldName”: “FirstValue”

}

]

where

Optional string. The default is 1=1. The selection sql statement.

out_fields

Optional List of field names to return. Field names can be specified either as a List of field names or as a comma separated string. The default is “*”, which returns all the fields.

analytic_where

Optional String. A where clause for the query filter that applies to the result set of applying the source where clause and all other params.

geometry_filter

Optional from arcgis.geometry.filter. Allows for the information to be filtered on spatial relationship with another geometry.

out_sr

Optional Integer. The WKID for the spatial reference of the returned geometry.

out_sr

Optional Integer. The output spatial reference wkid.

return_geometry

Optional boolean. If true, geometry is returned with the query. Default is true.

order_by

Optional string. One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering. example: STATE_NAME ASC, RACE DESC, GENDER

result_type

Optional string. The result_type parameter can be used to control the number of features returned by the query operation. Values: None | standard | tile

cache_hint

Optional Boolean. If you are performing the same query multiple times, a user can ask the server to cache the call to obtain the results quicker. The default is False.

result_offset

Optional integer. This option can be used for fetching query results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th).

result_record_count

Optional integer. This option can be used for fetching query results up to the result_record_count specified. When result_offset is specified but this parameter is not, the map service defaults it to max_record_count. The maximum value for this parameter is the value of the layer’s max_record_count property.

quantization_parameters

Optional dict. Used to project the geometry onto a virtual grid, likely representing pixels on the screen.

sql_format

Optional string. The sql_format parameter can be either standard SQL92 standard or it can use the native SQL of the underlying datastore native. The default is none which means the sql_format depends on useStandardizedQuery parameter. Values: none | standard | native

future

Optional Boolean. This determines if a Future object is returned (True) the method returns the results directly (False).

Returns

A Pandas DataFrame (pd.DataFrame)

The query_related_records operation is performed on a FeatureLayer resource. The result of this operation are feature sets grouped by source layer/table object IDs. Each feature set contains Feature objects including the values for the fields requested by the user. For related layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For related tables, the feature set does not include geometries.

Note

See the query method for a similar function.

Argument

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/layer to be included in the returned feature set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set return_geometry to true. You can also specify the wildcard “*” as the value of this parameter. In this case, the results will include all the field values.

definition_expression

Optional string. The definition expression to be applied to the related table/layer. From the list of objectIds, only those records that conform to this expression are queried for related records.

return_geometry

Optional boolean. If true, the feature set includes the geometry associated with each feature. The default is true.

max_allowable_offset

Optional float. This option can be used to specify the max_allowable_offset to be used for generalizing geometries returned by the query operation. The max_allowable_offset is in the units of the outSR. If out_wkid is not specified, then max_allowable_offset is 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 of decimal 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 parameter applies only if the isDataVersioned property of the layer queried is true.

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

historic_moment

Optional Integer/datetime. The historic moment to query. This parameter applies only if the supportsQueryWithHistoricMoment property of the layers being queried is set to true. This setting is provided in the layer resource.

If historic_moment is not specified, the query will apply to the current features.

Syntax: historic_moment=<Epoch time in milliseconds>

return_true_curves

Optional boolean. Optional parameter that is false by default. When set to true, returns true curves in output geometries; otherwise, curves are converted to densified Polyline or Polygon objects.

Returns

Dictionary of the query results

..code-block:: python

# The query results will return the related records for each objectIds # where TOWNSHIP is the outField and orderByField:

FeatureLayer.query_related_records(object_ids=”7028,7029”,

relationship_id=”1”, out_fields=”TOWNSHIP”, definition_expression=”1=1”, order_by_fields=”TOWNSHIP”, return_count_only=False, return_geometry=False)

query_top_features(top_filter=None, where=None, objectids=None, start_time=None, end_time=None, geometry_filter=None, out_fields='*', return_geometry=True, return_centroid=False, max_allowable_offset=None, out_sr=None, geometry_precision=None, return_ids_only=False, return_extents_only=False, order_by_field=None, return_z=False, return_m=False, result_type=None, as_df=True)

The query_top_features is performed on a FeatureLayer. This operation returns a feature set or spatially enabled dataframe based on the top features by order within a group. For example, when querying counties in the United States, you want to return the top five counties by population in each state. To do this, you can use query_top_features to group by state name, order by desc on the population and return the first five rows from each group (state).

The top_filter parameter is used to set the group by, order by, and count criteria used in generating the result. The operation also has many of the same parameters (for example, where and geometry) as the layer query operation. However, unlike the layer query operation, query_top_feaures does not support parameters such as outStatistics and its related parameters or return distinct values. Consult the advancedQueryCapabilities layer property for more details.

If the feature layer collection supports the query_top_feaures operation, it will include “supportsTopFeaturesQuery”: True, in the advancedQueryCapabilities layer property.

Note

See the query method for a similar function.

Argument

Description

top_filter

Required Dict. The top_filter define the aggregation of the data.

  • groupByFields define the field or fields used to aggregate

your data.

  • topCount defines the number of features returned from the top

features query and is a numeric value.

  • orderByFields defines the order in which the top features will

be returned. orderByFields can be specified in either ascending (asc) or descending (desc) order, ascending being the default.

Example: {“groupByFields”: “worker”, “topCount”: 1,

“orderByFields”: “employeeNumber”}

where

Optional String. A WHERE clause for the query filter. SQL ‘92 WHERE clause syntax on the fields in the layer is supported for most data sources.

objectids

Optional List. The object IDs of the layer or table to be queried.

start_time

Optional Datetime. The starting time to query for.

end_time

Optional Datetime. The end date to query for.

geometry_filter

Optional from arcgis.geometry.filter. Allows for the information to be filtered on spatial relationship with another geometry.

out_fields

Optional String. The list of fields to include in the return results.

return_geometry

Optional Boolean. If False, the query will not return geometries. The default is True.

return_centroid

Optional Boolean. If True, the centroid of the geometry will be added to the output.

max_allowable_offset

Optional float. This option can be used to specify the max_allowable_offset to be used for generalizing geometries returned by the query operation. The max_allowable_offset is in the units of out_sr. If out_sr is not specified, max_allowable_offset is assumed to be in the unit of the spatial reference of the layer.

out_sr

Optional Integer. The WKID for the spatial reference of the returned geometry.

geometry_precision

Optional Integer. This option can be used to specify the number of decimal places in the response geometries returned by the query operation. This applies to X and Y values only (not m or z-values).

return_ids_only

Optional boolean. Default is False. If true, the response only includes an array of object IDs. Otherwise, the response is a feature set.

return_extent_only

Optional boolean. If true, the response only includes the extent of the features that would be returned by the query. If returnCountOnly=true, the response will return both the count and the extent. The default is false. This parameter applies only if the supportsReturningQueryExtent property of the layer is true.

order_by_field

Optional Str. Optional string. One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering. example: STATE_NAME ASC, RACE DESC, GENDER

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

result_type

Optional String. The result_type can be used to control the number of features returned by the query operation. Values: none | standard | tile

as_df

Optional Boolean. If False, the result is returned as a FeatureSet. If True (default) the result is returned as a spatially enabled dataframe.

Returns

Default is a pd.DataFrame, but when `as_df=False` returns a FeatureSet. If `return_count_only=True`, the return type is Integer. If `return_ids_only=True`, a list of value is returned.

property renderer

Get/Set the Renderer of the Feature Layer.

Argument

Description

value

Required dict.

..note::

When set, this overrides the default symbology when displaying it on a webmap.

Returns

`InsensitiveDict`: A case-insensitive dict like object used to update and alter JSON A varients of a case-less dictionary that allows for dot and bracket notation.

property time_filter

The time_filter method is used to set a time filter instead of querying time-enabled map service layers or time-enabled feature service layers, a time filter can be specified. Time can be filtered as a single instant or by separating the two ends of a time extent with a comma.

Note

The time_filter method is supported starting at Enterprise 10.7.1+.

Input

Description

value

Required Datetime/List Datetime. This is a single or list of start/stop date.

Returns

A string of datetime values as milliseconds from epoch

update_metadata(file_path)

The update_metadata updates a FeatureLayer metadata from an xml file.

Argument

Description

file_path

Required String. The path to the .xml file that contains the metadata.

Returns

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

validate_sql(sql, sql_type='where')

The validate_sql operation validates an SQL-92 expression or WHERE clause. The validate_sql operation ensures that an SQL-92 expression, such as one written by a user through a user interface, is correct before performing another operation that uses the expression.

Note

For example, validateSQL can be used to validate information that is subsequently passed in as part of the where parameter of the calculate operation.

validate_sql also prevents SQL injection. In addition, all table and field names used in the SQL expression or WHERE clause are validated to ensure they are valid tables and fields.

Argument

Description

sql

Required String. The SQL expression of WHERE clause to validate. Example: “Population > 300000”

sql_type

Optional String. Three SQL types are supported in validate_sql
  • where (default) - Represents the custom WHERE clause the user can compose when querying a layer or using calculate.

  • expression - Represents an SQL-92 expression. Currently, expression is used as a default value expression when adding a new field or using the calculate API.

  • statement - Represents the full SQL-92 statement that can be passed directly to the database. No current ArcGIS REST API resource or operation supports using the full SQL-92 SELECT statement directly. It has been added to the validateSQL for completeness. Values: where | expression | statement

Returns

A JSON Dictionary indicating ‘success’ or ‘error’

arcgis.features.Table

class arcgis.features.Table(url, gis=None, container=None, dynamic_layer=None)

Table objects represent entity classes with uniform properties. In addition to working with “entities with location” as Feature objects, the GIS can also work with non-spatial entities as rows in tables.

Note

Working with tables is similar to working with :class:`~arcgis.features.FeatureLayer`objects, except that the rows (Features) in a table do not have a geometry, and tables ignore any geometry related operation.

append(item_id=None, upload_format='featureCollection', source_table_name=None, field_mappings=None, edits=None, source_info=None, upsert=False, skip_updates=False, use_globalids=False, update_geometry=True, append_fields=None, rollback=False, skip_inserts=None, upsert_matching_field=None, upload_id=None, *, return_messages=None, future=False)

The append method is used to update an existing hosted FeatureLayer object. See the Append (Feature Service/Layer) page in the ArcGIS REST API documentation for more information.

Note

The append method is only available in ArcGIS Online and ArcGIS Enterprise 10.8.1+

Argument

Description

item_id

Optional string. The ID for the Portal item that contains the source file. Used in conjunction with editsUploadFormat.

upload_format

Required string. The source append data format. The default is featureCollection. Values: ‘sqlite’ | ‘shapefile’ | ‘filegdb’ | ‘featureCollection’ | ‘geojson’ | ‘csv’ | ‘excel’

source_table_name

Required string. Required even when the source data contains only one table, e.g., for file geodatabase.

# Example usage:
source_table_name=  "Building"

field_mappings

Optional list. Used to map source data to a destination layer. Syntax: field_mappings=[{“name” : <”targetName”>,

“sourceName” : < “sourceName”>}, …]

# Example usage:
field_mappings=[{"name" : "CountyID",
                "sourceName" : "GEOID10"}]

edits

Optional string. Only feature collection json is supported. Append supports all format through the upload_id or item_id.

source_info

Optional dictionary. This is only needed when appending data from excel or csv. The appendSourceInfo can be the publishing parameter returned from analyze the csv or excel file.

upsert

Optional boolean. Optional parameter specifying whether the edits needs to be applied as updates if the feature already exists. Default is false.

skip_updates

Optional boolean. Parameter is used only when upsert is true.

use_globalids

Optional boolean. Specifying whether upsert needs to use GlobalId when matching features.

update_geometry

Optional boolean. The parameter is used only when upsert is true. Skip updating the geometry and update only the attributes for existing features if they match source features by objectId or globalId.(as specified by useGlobalIds parameter).

append_fields

Optional list. The list of destination fields to append to. This is supported when upsert=true or false.

#Values:
["fieldName1", "fieldName2",....]

rollback

Optional boolean. Optional parameter specifying whether the upsert edits needs to be rolled back in case of failure. Default is false.

skip_inserts

Used only when upsert is true. Used to skip inserts if the value is true. The default value is false.

upsert_matching_field

Optional string. The layer field to be used when matching features with upsert. ObjectId, GlobalId, and any other field that has a unique index can be used with upsert. This parameter overrides use_globalids; e.g., specifying upsert_matching_field will be used even if you specify use_globalids = True. Example: upsert_matching_field=”MyfieldWithUniqueIndex”

upload_id

Optional string. The itemID field from an upload() response, corresponding with the appendUploadId REST API argument. This argument should not be used along side the item_id argument.

return_messages

Optional Boolean. When set to True, the messages returned from the append will be returned. If False, the response messages will not be returned. This alters the output to be a tuple consisting of a (Boolean, Dictionary).

future

Optional Boolean. When true, the response is returned as a Future object.

Returns

A boolean indicating success (True), or failure (False). When return_messages is True, the response messages will be return in addition to the boolean as a tuple. If future = True, then the result is a Future object. Call result() to get the response.

# Usage Example

>>> feature_layer.append(source_table_name= "Building",
                        field_mappings=[{"name" : "CountyID",
                                        "sourceName" : "GEOID10"}],
                        upsert = True,
                        append_fields = ["fieldName1", "fieldName2",...., fieldname22],
                        return_messages = False)
<True>
calculate(where, calc_expression, sql_format='standard', version=None, sessionid=None, return_edit_moment=None, future=False)

The calculate operation is performed on a FeatureLayer resource. calculate updates the values of one or more fields in an existing feature service layer based on SQL expressions or scalar values. The calculate operation can only be used if the supportsCalculate property of the layer is True. Neither the Shape field nor system fields can be updated using calculate. System fields include ObjectId and GlobalId.

Inputs

Description

where

Required String. A where clause can be used to limit the updated records. Any legal SQL where clause operating on the fields in the layer is allowed.

calc_expression

Required List. The array of field/value info objects that contain the field or fields to update and their scalar values or SQL expression. Allowed types are dictionary and list. List must be a list of dictionary objects.

Calculation Format is as follows:

{“field” : “<field name>”, “value” : “<value>”}

sql_format

Optional String. The SQL format for the calc_expression. It can be either standard SQL92 (standard) or native SQL (native). The default is standard.

Values: standard, native

version

Optional String. The geodatabase version to apply the edits.

sessionid

Optional String. A parameter which is set by a client during long transaction editing on a branch version. The sessionid is a GUID value that clients establish at the beginning and use throughout the edit session. The sessonid ensures isolation during the edit session. This parameter applies only if the isDataBranchVersioned property of the layer is true.

return_edit_moment

Optional Boolean. This parameter specifies whether the response will report the time edits were applied. If true, the server will return the time edits were applied in the response’s edit moment key. This parameter applies only if the isDataBranchVersioned property of the layer is true.

future

Optional Boolean. If True, the result is returned as a future object and the results are obtained in an asynchronous fashion. False is the default.

This applies to 10.8+ only

Returns

A dictionary with the following format:

{ ‘updatedFeatureCount’: 1, ‘success’: True }

# Usage Example 1:

print(fl.calculate(where="OBJECTID < 2",
                   calc_expression={"field": "ZONE", "value" : "R1"}))
# Usage Example 2:

print(fl.calculate(where="OBJECTID < 2001",
                   calc_expression={"field": "A",  "sqlExpression" : "B*3"}))
property container

Get/Set the FeatureLayerCollection to which this layer belongs.

Argument

Description

value

Required FeatureLayerCollection.

Returns

The Feature Layer Collection where the layer is stored

delete_features(deletes=None, where=None, geometry_filter=None, gdb_version=None, rollback_on_failure=True, return_delete_results=True, future=False)

Deletes features in a FeatureLayer or Table

Argument

Description

deletes

Optional string. A comma separated string of OIDs to remove from the service.

where

Optional string. A where clause for the query filter. Any legal SQL where clause operating on the fields in the layer is allowed. Features conforming to the specified where clause will be deleted.

geometry_filter

Optional SpatialFilter. A spatial filter from arcgis.geometry.filters module to filter results by a spatial relationship with another geometry.

gdb_version

Optional string. A Geodatabase version to apply the edits.

rollback_on_failure

Optional boolean. Optional parameter to specify if the edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

return_delete_results

Optional Boolean. Optional parameter that indicates whether a result is returned per deleted row when the deleteFeatures operation is run. The default is true.

future

Optional Boolean. If future=True, then the operation will occur asynchronously else the operation will occur synchronously. False is the default.

Returns

A dictionary if future=False (default), else a Future object.

# Usage Example with only a "where" sql statement

>>> from arcgis.features import FeatureLayer

>>> gis = GIS("pro")
>>> buck = gis.content.search("owner:"+ gis.users.me.username)
>>> buck_1 =buck[1]
>>> lay = buck_1.layers[0]

>>> la_df = lay.delete_features(where = "OBJECTID > 15")
>>> la_df
{'deleteResults': [
{'objectId': 1, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 2, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 3, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 4, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 5, 'uniqueId': 5, 'globalId': None, 'success': True},
{'objectId': 6, 'uniqueId': 6, 'globalId': None, 'success': True},
{'objectId': 7, 'uniqueId': 7, 'globalId': None, 'success': True},
{'objectId': 8, 'uniqueId': 8, 'globalId': None, 'success': True},
{'objectId': 9, 'uniqueId': 9, 'globalId': None, 'success': True},
{'objectId': 10, 'uniqueId': 10, 'globalId': None, 'success': True},
{'objectId': 11, 'uniqueId': 11, 'globalId': None, 'success': True},
{'objectId': 12, 'uniqueId': 12, 'globalId': None, 'success': True},
{'objectId': 13, 'uniqueId': 13, 'globalId': None, 'success': True},
{'objectId': 14, 'uniqueId': 14, 'globalId': None, 'success': True},
{'objectId': 15, 'uniqueId': 15, 'globalId': None, 'success': True}]}
edit_features(adds=None, updates=None, deletes=None, gdb_version=None, use_global_ids=False, rollback_on_failure=True, return_edit_moment=False, attachments=None, true_curve_client=False, session_id=None, use_previous_moment=False, datum_transformation=None, future=False)

Adds, updates, and deletes features to the associated FeatureLayer or Table in a single call.

Note

When making large number (250+ records at once) of edits, append should be used over edit_features to improve performance and ensure service stability.

Inputs

Description

adds

Optional FeatureSet/List. The array of features to be added.

updates

Optional FeatureSet/List. The array of features to be updated.

deletes

Optional FeatureSet/List. string of OIDs to remove from service

use_global_ids

Optional boolean. Instead of referencing the default Object ID field, the service will look at a GUID field to track changes. This means the GUIDs will be passed instead of OIDs for delete, update or add features.

gdb_version

Optional boolean. Geodatabase version to apply the edits.

rollback_on_failure

Optional boolean. Optional parameter to specify if the edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

return_edit_moment

Optional boolean. Introduced at 10.5, only applicable with ArcGIS Server services only. Specifies whether the response will report the time edits were applied. If set to true, the server will return the time in the response’s editMoment key. The default value is false.

attachments

Optional Dict. This parameter adds, updates, or deletes attachments. It applies only when the use_global_ids parameter is set to true. For adds, the globalIds of the attachments provided by the client are preserved. When useGlobalIds is true, updates and deletes are identified by each feature or attachment globalId, rather than their objectId or attachmentId. This parameter requires the layer’s supportsApplyEditsWithGlobalIds property to be true.

Attachments to be added or updated can use either pre-uploaded data or base 64 encoded data.

Inputs

Inputs

Description

adds

List of attachments to add.

updates

List of attachements to update

deletes

List of attachments to delete

See the Apply Edits to a Feature Service layer in the ArcGIS REST API for more information.

true_curve_client

Optional boolean. Introduced at 10.5. Indicates to the server whether the client is true curve capable. When set to true, this indicates to the server that true curve geometries should be downloaded and that geometries containing true curves should be consumed by the map service without densifying it. When set to false, this indicates to the server that the client is not true curves capable. The default value is false.

session_id

Optional String. Introduced at 10.6. The session_id is a GUID value that clients establish at the beginning and use throughout the edit session. The sessonID ensures isolation during the edit session. The session_id parameter is set by a client during long transaction editing on a branch version.

use_previous_moment

Optional Boolean. Introduced at 10.6. The use_previous_moment parameter is used to apply the edits with the same edit moment as the previous set of edits. This allows an editor to apply single block of edits partially, complete another task and then complete the block of edits. This parameter is set by a client during long transaction editing on a branch version.

When set to true, the edits are applied with the same edit moment as the previous set of edits. When set to false or not set (default) the edits are applied with a new edit moment.

datum_transformation

Optional Integer/Dictionary. This parameter applies a datum transformation while projecting geometries in the results when out_sr is different than the layer’s spatial reference. When specifying transformations, you need to think about which datum transformation best projects the layer (not the feature service) to the outSR and sourceSpatialReference property in the layer properties. For a list of valid datum transformation ID values ad well-known text strings, see Using spatial references. For more information on datum transformations please see the transformation parameter in the Project operation documentation.

Examples

Inputs

Description

WKID

Integer. Ex: datum_transformation=4326

WKT

Dict. Ex: datum_transformation={“wkt”: “<WKT>”}

Composite

Dict. Ex: datum_transformation=```{‘geoTransforms’:[{‘wkid’:<id>,’forward’:<true|false>},{‘wkt’:’<WKT>’,’forward’:<True|False>}]}```

future

Optional Boolean. If True and the FeatureLayer has supportsAsyncApplyEdits set to True, then edits can be applied asynchronously.

Returns

A dictionary by default, or EditFeatureJob if future=True.

# Usage Example 1:

feature = [
{
    'attributes': {
        'ObjectId': 1,
        'UpdateDate': datetime.datetime.now(),
    }
}]
lyr.edit_features(updates=feature)
# Usage Example 2:

adds = {"geometry": {"x": 500, "y": 500, "spatialReference":
                    {"wkid": 102100, "latestWkid": 3857}},
        "attributes": {"ADMIN_NAME": "Fake Location"}
        }
lyr.edit_features(adds=[adds])
# Usage Example 3:

lyr.edit_features(deletes=[2542])
property estimates

Returns up-to-date approximations of layer information, such as row count and extent. Layers that support this property will include infoInEstimates information in the layer’s properties.

Currently available with ArcGIS Online and Enterprise 10.9.1+

Returns

Dict[str, Any]

export_attachments(output_folder, label_field=None)

Exports attachments from the FeatureLayer in Imagenet format using the output_label_field.

Argument

Description

output_folder

Required string. Output folder where the attachments will be stored. If None, a default folder is created

label_field

Optional string. Field which contains the label/category of each feature.

Returns

Nothing is returned from this method

classmethod fromitem(item, table_id=0)

The fromitem method creates a Table from a Item object. The table_id is the id of the table in FeatureLayerCollection (feature service).

Argument

Description

item

Required Item object. The type of item should be a Feature Service that represents a FeatureLayerCollection

table_id

Required Integer. The id of the layer in feature layer collection (feature service). The default for table is 0.

Returns

A Table object

generate_renderer(definition, where=None)

Groups data using the supplied definition (classification definition) and an optional where clause. The result is a renderer object.

Note

Use baseSymbol and colorRamp to define the symbols assigned to each class. If the operation is performed on a table, the result is a renderer object containing the data classes and no symbols.

Argument

Description

definition

Required dict. The definition using the renderer that is generated. Use either class breaks or unique value classification definitions. See Classification Objects for additional details.

where

Optional string. A where clause for which the data needs to be classified. Any legal SQL where clause operating on the fields in the dynamic layer/table is allowed.

Returns

A JSON Dictionary

..code-block:: python

# Example Usage FeatureLayer.generate_renderer(

definition = {“type”:”uniqueValueDef”,

“uniqueValueFields”:[“Has_Pool”], “fieldDelimiter”: “,”, “baseSymbol”:{

“type”: “esriSFS”, “style”: “esriSLSSolid”, “width”:2 },

“colorRamp”:{

“type”:”algorithmic”, “fromColor”:[115,76,0,255], “toColor”:[255,25,86,255], “algorithm”: “esriHSVAlgorithm” }

},

where = “POP2000 > 350000” )

get_html_popup(oid)

The get_html_popup method provides details about the HTML pop-up authored by the User using ArcGIS Pro or ArcGIS Desktop.

Argument

Description

oid

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

Returns

A string

get_unique_values(attribute, query_string='1=1')

Retrieves a list of unique values for a given attribute in the FeatureLayer.

Argument

Description

attribute

Required string. The feature layer attribute to query.

query_string

Optional string. SQL Query that will be used to filter attributes before unique values are returned. ex. “name_2 like ‘%K%’”

Returns

A list of unique values

# Usage Example with only a "where" sql statement

>>> from arcgis.features import FeatureLayer

>>> gis = GIS("pro")
>>> buck = gis.content.search("owner:"+ gis.users.me.username)
>>> buck_1 =buck[1]
>>> lay = buck_1.layers[0]
>>> layer = lay.get_unique_values(attribute = "COUNTY")
>>> layer
['PITKIN', 'PLATTE', 'TWIN FALLS']
property manager

The manager property is a helper object to manage the FeatureLayer, such as updating its definition.

Returns

A FeatureLayerManager

# Usage Example

>>> manager = FeatureLayer.manager
property metadata

Get the Feature Layer’s metadata.

Note

If metadata is disabled on the GIS or the layer does not support metadata, None will be returned.

Returns

String of the metadata, if any

property properties

The properties property retrieves and set properties of this object.

query(where='1=1', out_fields='*', time_filter=None, return_count_only=False, return_ids_only=False, return_distinct_values=False, group_by_fields_for_statistics=None, statistic_filter=None, result_offset=None, result_record_count=None, object_ids=None, gdb_version=None, order_by_fields=None, out_statistics=None, return_all_records=True, historic_moment=None, sql_format=None, return_exceeded_limit_features=None, as_df=False, having=None, **kwargs)

The query method queries a Table Layer based on a set of criteria.

Argument

Description

where

Optional string. The default is 1=1. The selection sql statement.

out_fields

Optional List of field names to return. Field names can be specified either 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.

time_filter

Optional list. The format is of [<startTime>, <endTime>] using datetime.date, datetime.datetime or timestamp in milliseconds. Syntax: time_filter=[<startTime>, <endTime>] ; specified as

datetime.date, datetime.datetime or timestamp in milliseconds

gdb_version

Optional string. The geodatabase version to query. This parameter applies only if the isDataVersioned property of the layer is true. If this is not specified, the query will apply to the published map’s version.

return_geometry

Optional boolean. If true, geometry is returned with the query. Default is true.

return_distinct_values

Optional boolean. If true, it returns distinct values based on the fields specified in out_fields. This parameter applies only if the supportsAdvancedQueries property of the layer is true.

return_ids_only

Optional boolean. Default is False. If true, the response only includes an array of object IDs. Otherwise, the response is a feature set.

return_count_only

Optional boolean. If true, the response only includes the count (number of features/records) that would be returned by a query. Otherwise, the response is a feature set. The default is false. This option supersedes the returnIdsOnly parameter. If returnCountOnly = true, the response will return both the count and the extent.

order_by_fields

Optional string. One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering. example: STATE_NAME ASC, RACE DESC, GENDER

group_by_fields_for_statistics

Optional string. One or more field names on which the values need to be grouped for calculating the statistics. example: STATE_NAME, GENDER

out_statistics

Optional string. The definitions for one or more field-based statistics to be calculated.

Syntax:

[
{

“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”

}

]

result_offset

Optional integer. This option can be used for fetching query results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th). This option is ignored if return_all_records is True (i.e. by default).

result_record_count

Optional integer. This option can be used for fetching query results up to the result_record_count specified. When result_offset is specified but this parameter is not, the map service defaults it to max_record_count. The maximum value for this parameter is the value of the layer’s max_record_count property. This option is ignored if return_all_records is True (i.e. by default).

return_all_records

Optional boolean. When True, the query operation will call the service until all records that satisfy the where_clause are returned. Note: result_offset and result_record_count will be ignored if return_all_records is True. Also, if return_count_only, return_ids_only, or return_extent_only are True, this parameter will be ignored.

historic_moment

Optional integer. The historic moment to query. This parameter applies only if the layer is archiving enabled and the supportsQueryWithHistoricMoment property is set to true. This property is provided in the layer resource.

If historic_moment is not specified, the query will apply to the current features.

sql_format

Optional string. The sql_format parameter can be either standard SQL92 standard or it can use the native SQL of the underlying datastore native. The default is none which means the sql_format depends on useStandardizedQuery parameter. Values: none | standard | native

return_exceeded_limit_features

Optional boolean. Optional parameter which is true by default. When set to true, features are returned even when the results include ‘exceededTransferLimit’: True.

When set to false and querying with resultType = tile features are not returned when the results include ‘exceededTransferLimit’: True. This allows a client to find the resolution in which the transfer limit is no longer exceeded without making multiple calls.

as_df

Optional boolean. If True, the results are returned as a DataFrame instead of a FeatureSet.

kwargs

Optional dict. Optional parameters that can be passed to the Query function. This will allow users to pass additional parameters not explicitly implemented on the function. A complete list of functions available is documented on the Query REST API.

Returns

A FeatureSet object or, if `as_df=True`, a Panda’s DataFrame containing the features matching the query unless another return type is specified, such as return_count_only

# Usage Example with only a "where" sql statement

>>> feat_set = feature_layer.query(where = "OBJECTID1")
>>> type(feat_set)
<arcgis.Features.FeatureSet>
>>> feat_set[0]
<Feature 1>
# Usage Example of an advanced query returning the object IDs instead of Features

>>> id_set = feature_layer.query(where = "OBJECTID1",
                                   out_fields = ["FieldName1, FieldName2"],
                                   distance = 100,
                                   units = 'esriSRUnit_Meter',
                                   return_ids_only = True)

>>> type(id_set)
<Array>
>>> id_set[0]
<"Item_id1">
# Usage Example of an advanced query returning the number of features in the query

>>> search_count = feature_layer.query(where = "OBJECTID1",
                                   out_fields = ["FieldName1, FieldName2"],
                                   distance = 100,
                                   units = 'esriSRUnit_Meter',
                                   return_count_only = True)

>>> type(search_count)
<Integer>
>>> search_count
<149>
query_analytics(out_analytics, where='1=1', out_fields='*', analytic_where=None, geometry_filter=None, out_sr=None, return_geometry=True, order_by=None, result_type=None, cache_hint=None, result_offset=None, result_record_count=None, quantization_param=None, sql_format=None, future=True, **kwargs)

The query_analytics exposes the standard SQL windows functions that compute aggregate and ranking values based on a group of rows called window partition. The window function is applied to the rows after the partitioning and ordering of the rows. query_analytics defines a window or user-specified set of rows within a query result set. query_analytics can be used to compute aggregated values such as moving averages, cumulative aggregates, or running totals.

Note

See the query method for a similar function.

SQL Windows Function

A window function performs a calculation across a set of rows (SQL partition or window) that are related to the current row. Unlike regular aggregate functions, use of a window function does not return single output row. The rows retain their separate identities with each calculation appended to the rows as a new field value. The window function can access more than just the current row of the query result.

query_analytics currently supports the following windows functions:
  • Aggregate functions

  • Analytic functions

  • Ranking functions

Aggregate Functions

Aggregate functions are deterministic function that perform a calculation on a set of values and return a single value. They are used in the select list with optional HAVING clause. GROUP BY clause can also be used to calculate the aggregation on categories of rows. query_analytics can be used to calculate the aggregation on a specific range of value. Supported aggregate functions are:

  • Min

  • Max

  • Sum

  • Count

  • AVG

  • STDDEV

  • VAR

Analytic Functions

Several analytic functions available now in all SQL vendors to compute an aggregate value based on a group of rows or windows partition. Unlike aggregation functions, analytic functions can return single or multiple rows for each group.

  • CUM_DIST

  • FIRST_VALUE

  • LAST_VALUE

  • LEAD

  • LAG

  • PERCENTILE_DISC

  • PERCENTILE_CONT

  • PERCENT_RANK

Ranking Functions

Ranking functions return a ranking value for each row in a partition. Depending on the function that is used, some rows might receive the same value as other rows.

  • RANK

  • NTILE

  • DENSE_RANK

  • ROW_NUMBER

Partitioning

Partitions are extremely useful when you need to calculate the same metric over different group of rows. It is very powerful and has many potential usages. For example, you can add partition by to your window specification to look at different groups of rows individually.

partitionBy clause divides the query result set into partitions and the sql window function is applied to each partition. The ‘partitionBy’ clause normally refers to the column by which the result is partitioned. ‘partitionBy’ can also be a value expression (column expression or function) that references any of the selected columns (not aliases).

Argument

Description

out_analytics

Required List. A set of analytics to calculate on the Feature Layer.

The definitions for one or more field-based or expression analytics to be computed. This parameter is supported only on layers/tables that indicate supportsAnalytics is true. Note: If outAnalyticFieldName is empty or missing, the server assigns a field name to the returned analytic field.

Syntax: An array of analytic definitions. An analytic definition specifies the type of analytic, the field or expression on which it is to be computed, and the resulting output field name. Syntax [

{

“analyticType”: “<COUNT | SUM | MIN | MAX | AVG | STDDEV | VAR | FIRST_VALUE, LAST_VALUE, LAG, LEAD, PERCENTILE_CONT, PERCENTILE_DISC, PERCENT_RANK, RANK, NTILE, DENSE_RANK, EXPRESSION>”, “onAnalyticField”: “Field1”, “outAnalyticFieldName”: “Out_Field_Name1”,

“analyticParameters”: {

“orderBy”: “<orderBy expression”, “value”: <double value>,// percentile value “partitionBy”: “<field name or expression>”, “offset”: <integer>, // used by LAG/LEAD “windowFrame”: {

“type”: “ROWS” | “RANGE”, “extent”: {

“extentType”: “PRECEDING” | “BOUNDARY”, “PRECEDING”: {

“type”: <”UNBOUNDED” |
“NUMERIC_CONSTANT” |

“CURRENT_ROW”>

“value”: <numeric constant value>

} “BOUNDARY”: {

“start”: “UNBOUNDED_PRECEDING”,
“NUMERIC_PRECEDING”,

“CURRENT_ROW”,

“startValue”: <numeric constant value>, “end”: <”UNBOUNDED_FOLLOWING” |

“NUMERIC_FOLLOWING” | “CURRENT_ROW”,

“endValue”: <numeric constant value>

}

}

}

}

}

}

]

Example: [{

“analyticType”: “FIRST_VALUE”, “onAnalyticField”: “POP1990”, “analyticParameters”: {

“orderBy”: “POP1990”, “partitionBy”: “state_name”

}, “outAnalyticFieldName”: “FirstValue”

}

]

where

Optional string. The default is 1=1. The selection sql statement.

out_fields

Optional List of field names to return. Field names can be specified either as a List of field names or as a comma separated string. The default is “*”, which returns all the fields.

analytic_where

Optional String. A where clause for the query filter that applies to the result set of applying the source where clause and all other params.

geometry_filter

Optional from arcgis.geometry.filter. Allows for the information to be filtered on spatial relationship with another geometry.

out_sr

Optional Integer. The WKID for the spatial reference of the returned geometry.

out_sr

Optional Integer. The output spatial reference wkid.

return_geometry

Optional boolean. If true, geometry is returned with the query. Default is true.

order_by

Optional string. One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering. example: STATE_NAME ASC, RACE DESC, GENDER

result_type

Optional string. The result_type parameter can be used to control the number of features returned by the query operation. Values: None | standard | tile

cache_hint

Optional Boolean. If you are performing the same query multiple times, a user can ask the server to cache the call to obtain the results quicker. The default is False.

result_offset

Optional integer. This option can be used for fetching query results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th).

result_record_count

Optional integer. This option can be used for fetching query results up to the result_record_count specified. When result_offset is specified but this parameter is not, the map service defaults it to max_record_count. The maximum value for this parameter is the value of the layer’s max_record_count property.

quantization_parameters

Optional dict. Used to project the geometry onto a virtual grid, likely representing pixels on the screen.

sql_format

Optional string. The sql_format parameter can be either standard SQL92 standard or it can use the native SQL of the underlying datastore native. The default is none which means the sql_format depends on useStandardizedQuery parameter. Values: none | standard | native

future

Optional Boolean. This determines if a Future object is returned (True) the method returns the results directly (False).

Returns

A Pandas DataFrame (pd.DataFrame)

The query_related_records operation is performed on a FeatureLayer resource. The result of this operation are feature sets grouped by source layer/table object IDs. Each feature set contains Feature objects including the values for the fields requested by the user. For related layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For related tables, the feature set does not include geometries.

Note

See the query method for a similar function.

Argument

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/layer to be included in the returned feature set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set return_geometry to true. You can also specify the wildcard “*” as the value of this parameter. In this case, the results will include all the field values.

definition_expression

Optional string. The definition expression to be applied to the related table/layer. From the list of objectIds, only those records that conform to this expression are queried for related records.

return_geometry

Optional boolean. If true, the feature set includes the geometry associated with each feature. The default is true.

max_allowable_offset

Optional float. This option can be used to specify the max_allowable_offset to be used for generalizing geometries returned by the query operation. The max_allowable_offset is in the units of the outSR. If out_wkid is not specified, then max_allowable_offset is 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 of decimal 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 parameter applies only if the isDataVersioned property of the layer queried is true.

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

historic_moment

Optional Integer/datetime. The historic moment to query. This parameter applies only if the supportsQueryWithHistoricMoment property of the layers being queried is set to true. This setting is provided in the layer resource.

If historic_moment is not specified, the query will apply to the current features.

Syntax: historic_moment=<Epoch time in milliseconds>

return_true_curves

Optional boolean. Optional parameter that is false by default. When set to true, returns true curves in output geometries; otherwise, curves are converted to densified Polyline or Polygon objects.

Returns

Dictionary of the query results

..code-block:: python

# The query results will return the related records for each objectIds # where TOWNSHIP is the outField and orderByField:

FeatureLayer.query_related_records(object_ids=”7028,7029”,

relationship_id=”1”, out_fields=”TOWNSHIP”, definition_expression=”1=1”, order_by_fields=”TOWNSHIP”, return_count_only=False, return_geometry=False)

query_top_features(top_filter=None, where=None, objectids=None, start_time=None, end_time=None, geometry_filter=None, out_fields='*', return_geometry=True, return_centroid=False, max_allowable_offset=None, out_sr=None, geometry_precision=None, return_ids_only=False, return_extents_only=False, order_by_field=None, return_z=False, return_m=False, result_type=None, as_df=True)

The query_top_features is performed on a FeatureLayer. This operation returns a feature set or spatially enabled dataframe based on the top features by order within a group. For example, when querying counties in the United States, you want to return the top five counties by population in each state. To do this, you can use query_top_features to group by state name, order by desc on the population and return the first five rows from each group (state).

The top_filter parameter is used to set the group by, order by, and count criteria used in generating the result. The operation also has many of the same parameters (for example, where and geometry) as the layer query operation. However, unlike the layer query operation, query_top_feaures does not support parameters such as outStatistics and its related parameters or return distinct values. Consult the advancedQueryCapabilities layer property for more details.

If the feature layer collection supports the query_top_feaures operation, it will include “supportsTopFeaturesQuery”: True, in the advancedQueryCapabilities layer property.

Note

See the query method for a similar function.

Argument

Description

top_filter

Required Dict. The top_filter define the aggregation of the data.

  • groupByFields define the field or fields used to aggregate

your data.

  • topCount defines the number of features returned from the top

features query and is a numeric value.

  • orderByFields defines the order in which the top features will

be returned. orderByFields can be specified in either ascending (asc) or descending (desc) order, ascending being the default.

Example: {“groupByFields”: “worker”, “topCount”: 1,

“orderByFields”: “employeeNumber”}

where

Optional String. A WHERE clause for the query filter. SQL ‘92 WHERE clause syntax on the fields in the layer is supported for most data sources.

objectids

Optional List. The object IDs of the layer or table to be queried.

start_time

Optional Datetime. The starting time to query for.

end_time

Optional Datetime. The end date to query for.

geometry_filter

Optional from arcgis.geometry.filter. Allows for the information to be filtered on spatial relationship with another geometry.

out_fields

Optional String. The list of fields to include in the return results.

return_geometry

Optional Boolean. If False, the query will not return geometries. The default is True.

return_centroid

Optional Boolean. If True, the centroid of the geometry will be added to the output.

max_allowable_offset

Optional float. This option can be used to specify the max_allowable_offset to be used for generalizing geometries returned by the query operation. The max_allowable_offset is in the units of out_sr. If out_sr is not specified, max_allowable_offset is assumed to be in the unit of the spatial reference of the layer.

out_sr

Optional Integer. The WKID for the spatial reference of the returned geometry.

geometry_precision

Optional Integer. This option can be used to specify the number of decimal places in the response geometries returned by the query operation. This applies to X and Y values only (not m or z-values).

return_ids_only

Optional boolean. Default is False. If true, the response only includes an array of object IDs. Otherwise, the response is a feature set.

return_extent_only

Optional boolean. If true, the response only includes the extent of the features that would be returned by the query. If returnCountOnly=true, the response will return both the count and the extent. The default is false. This parameter applies only if the supportsReturningQueryExtent property of the layer is true.

order_by_field

Optional Str. Optional string. One or more field names on which the features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering. example: STATE_NAME ASC, RACE DESC, GENDER

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

result_type

Optional String. The result_type can be used to control the number of features returned by the query operation. Values: none | standard | tile

as_df

Optional Boolean. If False, the result is returned as a FeatureSet. If True (default) the result is returned as a spatially enabled dataframe.

Returns

Default is a pd.DataFrame, but when `as_df=False` returns a FeatureSet. If `return_count_only=True`, the return type is Integer. If `return_ids_only=True`, a list of value is returned.

property renderer

Get/Set the Renderer of the Feature Layer.

Argument

Description

value

Required dict.

..note::

When set, this overrides the default symbology when displaying it on a webmap.

Returns

`InsensitiveDict`: A case-insensitive dict like object used to update and alter JSON A varients of a case-less dictionary that allows for dot and bracket notation.

property time_filter

The time_filter method is used to set a time filter instead of querying time-enabled map service layers or time-enabled feature service layers, a time filter can be specified. Time can be filtered as a single instant or by separating the two ends of a time extent with a comma.

Note

The time_filter method is supported starting at Enterprise 10.7.1+.

Input

Description

value

Required Datetime/List Datetime. This is a single or list of start/stop date.

Returns

A string of datetime values as milliseconds from epoch

update_metadata(file_path)

The update_metadata updates a FeatureLayer metadata from an xml file.

Argument

Description

file_path

Required String. The path to the .xml file that contains the metadata.

Returns

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

validate_sql(sql, sql_type='where')

The validate_sql operation validates an SQL-92 expression or WHERE clause. The validate_sql operation ensures that an SQL-92 expression, such as one written by a user through a user interface, is correct before performing another operation that uses the expression.

Note

For example, validateSQL can be used to validate information that is subsequently passed in as part of the where parameter of the calculate operation.

validate_sql also prevents SQL injection. In addition, all table and field names used in the SQL expression or WHERE clause are validated to ensure they are valid tables and fields.

Argument

Description

sql

Required String. The SQL expression of WHERE clause to validate. Example: “Population > 300000”

sql_type

Optional String. Three SQL types are supported in validate_sql
  • where (default) - Represents the custom WHERE clause the user can compose when querying a layer or using calculate.

  • expression - Represents an SQL-92 expression. Currently, expression is used as a default value expression when adding a new field or using the calculate API.

  • statement - Represents the full SQL-92 statement that can be passed directly to the database. No current ArcGIS REST API resource or operation supports using the full SQL-92 SELECT statement directly. It has been added to the validateSQL for completeness. Values: where | expression | statement

Returns

A JSON Dictionary indicating ‘success’ or ‘error’

arcgis.features.FeatureLayerCollection

class arcgis.features.FeatureLayerCollection(url, gis=None)

A FeatureLayerCollection is a collection of FeatureLayer and Table, with the associated relationships among the entities.

In a web GIS, a feature layer collection is exposed as a feature service with multiple feature layers.

Instances of FeatureLayerCollection can be obtained from feature service Items in the GIS using fromitem, from feature service endpoints using the constructor, or by accessing the dataset attribute of FeatureLayer objects.

``FeatureLayerCollection``s can be configured and managed using their manager helper object.

If the dataset supports the sync operation, the replicas helper object allows management and synchronization of replicas for disconnected editing of the feature layer collection.

Note

You can use the layers and tables property to get to the individual layers and tables in this feature layer collection.

extract_changes(layers, servergen, queries=None, geometry=None, geometry_type=None, in_sr=None, version=None, return_inserts=False, return_updates=False, return_deletes=False, return_ids_only=False, return_extent_only=False, return_attachments=False, attachments_by_url=False, data_format='json', change_extent_grid_cell=None, return_geometry_updates=None)

A change tracking mechanism for applications. Applications can use extract_changes to query changes that have been made to the layers and tables in the service.

Note

For Enterprise geodatabase based feature services published from ArcGIS Pro 2.2 or higher, the ChangeTracking capability requires all layers and tables to be either archive enabled or branch versioned and have globalid columns.

Change tracking can also be enabled for ArcGIS Online hosted feature services. If all layers and tables in the service have the ChangeTracking capability, the extract_changes operation can be used to get changes.

Argument

Description

layers

Required List. The list of layers (by index value) and tables to include in the output.

servergen

Required List. The servergen numbers allow a client to specify the last layer generation numbers (a Unix epoch time value in milliseconds) for the changes received from the server. All changes made after this value will be returned.

  • minServerGen: It is the min generation of the server data changes. Clients with layerServerGens that is less than minServerGen cannot extract changes and would need to make a full server/layers query instead of extracting changes.

  • serverGen: It is the current server generation number of the changes. Every changed feature has a version or a generation number that is changed every time the feature is updated.

Syntax:

servergen= [{“id”: <layerId1>, “serverGen”: <genNum1>}, {“id”: <layerId2>, “serverGen”: <genNum2>}]

The id value for the layer is the index of the layer from the layers attribute on the FeatureLayerCollection. The serverGen value is a Unix epoch timestamp value in milliseconds.

# Usage Example:

servergen= [{"id": 0, "serverGen": 10500},
            {"id": 1, "serverGen": 1100},
            {"id": 2, "serverGen": 1200}]

queries

Optional Dictionary. In addition to the layers and geometry parameters, the queries parameter can be used to further define what changes to return. This parameter allows you to set query properties on a per-layer or per-table basis. If a layer’s ID is present in the layers parameter and missing from layer queries, it’s changed features that intersect with the filter geometry are returned.

The properties include the following:

  • where - Defines an attribute query for a layer or table. The default is no where clause.

  • useGeometry - Determines whether or not to apply the geometry for the layer. The default is true. If set to false, features from the layer that intersect the geometry are not added.

  • includeRelated - Determines whether or not to add related rows. The default is true. The value true is honored only for queryOption=none. This is only applicable if your data has relationship classes. Relationships are only processed in a forward direction from origin to destination.

  • queryOption - Defines whether or how filters will be applied to a layer. The queryOption was added in 10.2. See the Compatibility notes topic for more information. Valid values are None, useFilter, or all. See also the layerQueries column in the Request Parameters table in the Extract Changes (Feature Service) help for details and code samples.

  • When the value is none, no feature are returned based on where and filter geometry.

  • If includeRelated is false, no features are returned.

  • If includeRelated is true, features in this layer (that are related to the features in other layers in the replica) are returned.

  • When the value is useFilter, features that satisfy filtering based on geometry and where are returned. The value of includeRelated is ignored.

# Usage Example:

queries={Layer_or_tableID1:{"where":"attribute query",
                            "useGeometry": true | false,
                            "includeRelated": true | false},
         Layer_or_tableID2: {.}}

geometry

Optional Geometry/Extent. The geometry to apply as the spatial filter for the changes. All the changed features in layers intersecting this geometry will be returned. The structure of the geometry is the same as the structure of the JSON geometry objects returned by the ArcGIS REST API. In addition to the JSON structures, for envelopes and points you can specify the geometry with a simpler comma-separated syntax.

geometry_type

Optional String. The type of geometry specified by the geometry parameter. The geometry type can be an envelope, point, line or polygon. The default geometry type is an envelope.

Values: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, esriGeometryEnvelope

in_sr

Optional Integer. The spatial reference of the input geometry.

out_sr

Optional Integer/String. The output spatial reference of the returned changes.

version

Optional String. If branch versioning is enabled, a user can specify the branch version name to extract changes from.

return_inserts

Optional Boolean. If true, newly inserted features will be returned. The default is false.

return_updates

Optional Boolean. If true, updated features will be returned. The default is false.

return_deletes

Optional Boolean. If true, deleted features will be returned. The default is false.

return_ids_only

Optional Boolean. If true, the response includes an array of object IDs only. The default is false.

return_attachments

Optional Boolean. If true, attachments changes are returned in the response. Otherwise, attachments are not included. The default is false. This parameter is only applicable if the feature service has attachments.

attachments_by_url

Optional Boolean. If true, a reference to a URL will be provided for each attachment returned. Otherwise, attachments are embedded in the response. The default is true.

data_format

Optional String. The format of the changes returned in the response. The default is json. Values: sqllite or json

change_extent_grid_cell

Optional String. To optimize localizing changes extent, the value medium is an 8x8 grid that bound the changes extent. Used only when return_extent_only is true. The default is none. Values: None, large, medium, or small

return_geometry_updates

Optional Boolean. If true, the response includes a ‘hasGeometryUpdates’ property set as true for each layer with updates that have geometry changes. The default is false.

If a layer’s edits include only inserts, deletes, or updates to fields other than geometry, hasGeometryUpdates is not set or is returned as false. When a layer has multiple rows with updates, only one needs to include a geometry changes for hasGeometryUpdates to be set as true.

Returns

A dictionary containing the layerServerGens and an array of edits

#Usage Example for extracting all changes to a feaature layer in a particular version since the time the Feature Layer was created.

from arcgis.gis import GIS
from arcgis.features import FeatureLayerCollection

>>> gis = GIS(<url>, <username>, <password>)

# Search for the Feature Service item
>>> fl_item = gis.content.search('title:"my_feature_layer" type:"Feature Layer"')[0]
>>> created_time = fl_item.created

# Get the Feature Service url
>>> fs=gis.content.search('title:"my_feature_layer" type:"Feature"')[0].url

# Instantiate the a FeatureLayerCollection from the url
>>> flc=FeatureLayerCollection(fs, gis)

# Extract the changes for the version
>>> extracted_changes=flc.extract_changes(layers=[0],
                           servergen=[{"id": 0, "serverGen": created_time}],
                           version="<version_owner>.<version_name>",
                           return_ids_only=True,
                           return_inserts=True,
                           return_updates=True,
                           return_deletes=True,
                           data_format="json")

>>> extracted_changes

{'layerServerGens': [{'id': 0, 'serverGen': 1600713614620}],
 'edits': [{'id': 0,
   'objectIds': {'adds': [], 'updates': [194], 'deletes': []}}]}
classmethod fromitem(item)

The fromitem method is used to create a FeatureLayerCollection from a Item class.

Argument

Description

item

A required Item object. The item needed to convert to a FeatureLayerCollection object.

Returns

A FeatureLayerCollection object.

property manager

A helper object to manage the FeatureLayerCollection, for example updating its definition.

Returns

A FeatureLayerCollectionManager object

property properties

The properties property retrieves and set properties of this object.

query(layer_defs_filter=None, geometry_filter=None, time_filter=None, return_geometry=True, return_ids_only=False, return_count_only=False, return_z=False, return_m=False, out_sr=None)

Queries the current FeatureLayerCollection based on sql statement.

Argument

Description

time_filter

Optional list. The format is of [<startTime>, <endTime>] using datetime.date, datetime.datetime or timestamp in milliseconds. Syntax: time_filter=[<startTime>, <endTime>] ; specified as

datetime.date, datetime.datetime or timestamp in milliseconds

geometry_filter

Optional from arcgis.geometry.filter. Allows for the information to be filtered on spatial relationship with another geometry.

layer_defs_filter

Optional Layer Definition Filter.

return_geometry

Optional boolean. If true, geometry is returned with the query. Default is true.

return_ids_only

Optional boolean. Default is False. If true, the response only includes an array of object IDs. Otherwise, the response is a feature set.

return_count_only

Optional boolean. If true, the response only includes the count (number of features/records) that would be returned by a query. Otherwise, the response is a feature set. The default is false. This option supersedes the returnIdsOnly parameter. If returnCountOnly = true, the response will return both the count and the extent.

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

out_sr

Optional Integer. The WKID for the spatial reference of the returned geometry.

Returns

A FeatureSet of the queried Feature Layer Collection unless return_count_only or return_ids_only is True.

query_domains(layers)

Returns full domain information for the domains referenced by the layers in the FeatureLayerCollection. This operation is performed on a feature layer collection. The operation takes an array of layer IDs and returns the set of domains referenced by the layers.

Note

See the query method for a similar function.

Argument

Description

layers

Required List. An array of layers. The set of domains to return is based on the domains referenced by these layers. Example: [1,2,3,4]

Returns

List of dictionaries

The query_related_records operation is performed on a FeatureLayerCollection resource. The result of this operation are feature sets grouped by source FeatureLayer/Table object IDs. Each feature set contains Feature objects including the values for the fields requested by the User. For related layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For related tables, the feature set does not include geometries.

Note

See the query method for a similar function.

Argument

Description

object_ids

Optional string. the object IDs of the table/layer to be queried.

relationship_id

Optional string. The ID of the relationship to be queried.

out_fields

Optional string.the list of fields from the related table/layer to be included in the returned feature set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set return_geometry to true. You can also specify the wildcard “*” as the value of this parameter. In this case, the results will include all the field values.

definition_expression

Optional string. The definition expression to be applied to the related table/layer. From the list of objectIds, only those records that conform to this expression are queried for related records.

return_geometry

Optional boolean. If true, the feature set includes the geometry associated with each feature. The default is true.

max_allowable_offset

Optional float. This option can be used to specify the max_allowable_offset to be used for generalizing geometries returned by the query operation. The max_allowable_offset is in the units of the outSR. If outSR is not specified, then max_allowable_offset is 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 of decimal 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 parameter applies only if the isDataVersioned property of the layer queried is true.

return_z

Optional boolean. If true, Z values are included in the results if the 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 if the features have M values. Otherwise, M values are not returned. The default is false.

Returns

Dictionary of query results

property relationships

Gets relationship information for the layers and tables in the FeatureLayerCollection object.

The relationships resource includes information about relationship rules from the back-end relationship classes, in addition to the relationship information already found in the individual FeatureLayer and Table.

Feature layer collections that support the relationships resource will have the “supportsRelationshipsResource”: true property on their properties.

Returns

List of Dictionaries

upload(path, description=None, upload_size=None)

The upload method uploads a new item to the server.

Note

Once the operation is completed successfully, item id of the uploaded item is returned.

Argument

Description

path

Optional string. Filepath of the file to upload.

description

Optional string. Descriptive text for the uploaded item.

upload_size

Optional Integer. For large uploads, a user can specify the upload size of each part. The default is 1mb.

Returns

Item id of uploaded item

property versions

Creates a VersionManager to create, update and use versions on a FeatureLayerCollection.

Note

If versioning is not enabled on the service, None is returned.

arcgis.features.FeatureSet

class arcgis.features.FeatureSet(features, fields=None, has_z=False, has_m=False, geometry_type=None, spatial_reference=None, display_field_name=None, object_id_field_name=None, global_id_field_name=None)

A FeatureSet is a set of features with information about their fields, field aliases, geometry type, spatial reference, and more.

FeatureSets are commonly used as input/output with several Geoprocessing Tools, and can be the obtained through the query methods of feature layers. A FeatureSet can be combined with a layer definition to compose a FeatureCollection.

FeatureSet contains Feature objects, including the values for the fields requested by the User . For layers, if you request geometry information, the geometry of each feature is also returned in the FeatureSet. For tables, the FeatureSet does not include geometries.

If a Spatial Reference is not specified at the FeatureSet level, the FeatureSet will assume the SpatialReference of its first feature. If the Spatial Reference of the first feature is also not specified, the spatial reference will be UnknownCoordinateSystem.

property df

Warning

deprecated in v1.5.0 please use sdf

converts the FeatureSet to a Pandas dataframe. Requires pandas

property display_field_name

Get/Set the display field for the Feature Set object.

Argument

Description

value

Required string.

Returns

A String

property features

Gets the Feature objects in the FeatureSet object.

Returns

A list of Feature objects

property fields

Get/Set the fields in the FeatureSet

Argument

Description

value

Required dict.

Returns

A dictionary

static from_arcpy(fs)

Converts an arcpy FeatureSet to an arcgis FeatureSet

Argument

Description

fs

Required arcpy.FeatureSet. The featureset objec to consume.

Returns

A FeatureSet object

static from_dataframe(df)

The from_dataframe method creates a FeatureSet objects from a Pandas’ DataFrame

Argument

Description

df

Required DataFrame.

Returns

A FeatureSet object

static from_dict(featureset_dict)

Creates a Feature Set objects from a dictionary.

Argument

Description

featureset_dict

Required dict. Keys can include: ‘fields’, ‘features’, ‘hasZ’, ‘hasM’, ‘geometryType’, ‘objectIdFieldName’, ‘globalIdFieldName’, ‘displayFieldName’, ‘spatialReference’

Returns

A FeatureSet

static from_geojson(geojson)

Creates a Feature Set objects from a GEO JSON FeatureCollection object

Argument

Description

geojson

Required GEOJSON object

Returns

A FeatureSet object

static from_json(json_str)

Creates a Feature Set objects from a JSON string.

Argument

Description

json_str

Required json style string.

Returns

A FeatureSet object

property geometry_type

Get/Set the Type of the Feature Set object.

Argument

Description

value

Required string. Values: ‘Polygon’ | ‘Polyline’ | ‘Point’

Returns

A string representing the geometry type of the FeatureSet object

property global_id_field_name

Get/Set the global ID field for the Feature Set object.

Argument

Description

value

Required string.

Returns

A string

property has_m

Get/Set the M-property of the Feature Set object.

Argument

Description

value

Required bool. Values: True | False

Returns

The M-value of the FeatureSet object

property has_z

Get/Set the Z-property of the Feature Set object

Argument

Description

value

Required bool. Values: True | False

Returns

The Z-value of the FeatureSet object

property object_id_field_name

Get/Set the object id field of the Feature Set object

Argument

Description

value

Required string.

Returns

A string representing the object id field name

save(save_location, out_name, encoding=None)

The save method saves a Feature Set object to a Feature class on disk.

Argument

Description

save_location

Required string. Path to export the Feature Set to.

out_name

Required string. Name of the saved table.

encoding

Optional string. character encoding is used to represent a repertoire of characters by some kind of encoding system. The default is None.

Returns

A string

# Obtain a feature from a feature layer:

>>> feat_set = feature_layer.save(save_location = "C:\ArcGISProjects"
>>>                               out_name = "Power_Plant_Data")
"C:\ArcGISProjects\Power_Plant_Data"
property sdf

Gets the Feature Set as a Spatially Enabled Pandas dataframe.

Returns

A Spatially Enabled Pandas Dataframe object

property spatial_reference

Get/Set the Feature Set’s spatial reference

Argument

Description

value

Required dict. (e.g. {“wkid” : 4326})

Returns

A SpatialReference

to_dict()

Converts the Feature Set object to a Python dictionary.

Returns

A Python dictionary of the FeatureSet

property to_geojson

Gets the Feature Set object as a GeoJSON.

Returns

A GeoJSON object.

property to_json

Gets the Feature Set object as a JSON string.

Returns

A JSON string of the FeatureSet

property value

Gets the Feature Set object as a dictionary.

Returns

A dictionary of the FeatureSet

arcgis.features.FeatureCollection

class arcgis.features.FeatureCollection(dictdata)

FeatureCollection is an object with a layer definition and a FeatureSet.

It is an in-memory collection of Feature objects with rendering information.

Note

Feature Collections can be stored as Item objects in the GIS, added as layers to a map or scene, passed as inputs to feature analysis tools, and returned as results from feature analysis tools if an output name for a feature layer is not specified when calling the tool.

static from_featureset(fset, symbol=None, name=None)

Creates a FeatureCollection object from a FeatureSet object.

Argument

Description

fset

Required FeatureSet object.

symbol

Optional dict. Specify your symbol as a dictionary. Symbols for points can be picked from the Esri Symbol Page

If not specified, a default symbol will be created.

name

Optional String. The name of the feature collection. This is used when feature collections are being persisted on a WebMap. If None is provided, then a random name is generated. (New at 1.6.1)

Returns

A FeatureCollection object.

# Usage Example

>>> feat_set = feature_layer.query(where="OBJECTID=1")
>>> feat_collect = FeatureCollection.from_featureset(feat_set)
>>> type(feat_collect)
"acrgis.features.FeatureCollection"
query()

Retrieves the data in this feature collection as a FeatureSet. Ex: FeatureCollection.query()

Warning

Filtering by where clause is not supported for feature collections.

Returns

A FeatureSet object

arcgis.features.GeoAccessor

class arcgis.features.GeoAccessor(obj)

The GeoAccessor class adds a spatial namespace that performs spatial operations on the given Pandas DataFrame. The GeoAccessor class includes visualization, spatial indexing, IO and dataset level properties.

property area

The area method retrieves the total area of the GeoAccessor dataframe.

Returns

A float

>>> df.spatial.area
143.23427
property bbox

The bbox property retrieves the total length of the dataframe

Returns

Polygon

>>> df.spatial.bbox
{'rings' : [[[1,2], [2,3], [3,3],....]], 'spatialReference' {'wkid': 4326}}
property centroid

The centroid method retrieves the centroid of the dataframe

Returns

Geometry

>>> df.spatial.centroid
(-14.23427, 39)
distance_matrix(leaf_size=16, rebuild=False)

The distance_matrix creates a k-d tree to calculate the nearest-neighbor problem.

Note

The distance_matrix method requires SciPy

Argument

Description

leafsize

Optional Integer. The number of points at which the algorithm switches over to brute-force. Default: 16.

rebuild

Optional Boolean. If True, the current KDTree is erased. If false, any KD-Tree that exists will be returned.

Returns

scipy’s KDTree class

static from_df(df, address_column='address', geocoder=None, sr=None, geometry_column=None)

The from_df creates a Spatially Enabled DataFrame from a dataframe with an address column.

Argument

Description

df

Required Pandas DataFrame. Source dataset

address_column

Optional String. The default is “address”. This is the name of a column in the specified dataframe that contains addresses (as strings). The addresses are batch geocoded using the GIS’s first configured geocoder and their locations used as the geometry of the spatial dataframe. Ignored if the ‘geometry_column’ is specified.

geocoder

Optional Geocoder. The geocoder to be used. If not specified, the active GIS’s first geocoder is used.

sr

Optional integer. The WKID of the spatial reference.

geometry_column

Optional String. The name of the geometry column to convert to the arcgis.Geometry Objects (new at version 1.8.1)

Returns

Spatially Enabled DataFrame

NOTE: Credits will be consumed for batch_geocoding, from the GIS to which the geocoder belongs.

static from_feather(path, spatial_column='SHAPE', columns=None, use_threads=True)

The from-feather method loads a feather-format object from the file path.

Argument

Description

path

String. Path object or file-like object. Any valid string path is acceptable. The string could be a URL. Valid URL schemes include http, ftp, s3, and file. For file URLs, a host is expected. A local file could be:

file://localhost/path/to/table.feather.

If you want to pass in a path object, pandas accepts any os.PathLike.

By file-like object, we refer to objects with a read() method, such as a file handler (e.g. via builtin open function) or StringIO.

spatial_column

Optional String. The default is SHAPE. Specifies the column containing the geo-spatial information.

columns

Sequence/List/Array. The default is None. If not provided, all columns are read.

use_threads

Boolean. The default is True. Whether to parallelize reading using multiple threads.

Returns

A Pandas DataFrame (pd.DataFrame)

static from_featureclass(location, **kwargs)

The from_featureclass creates a Spatially enabled pandas.DataFrame from a Features class.

Argument

Description

location

Required string or pathlib.Path. Full path to the feature class or URL (shapefile only).

Optional parameters when ArcPy library is available in the current environment:

Optional Argument

Description

sql_clause

sql clause to parse data down. To learn more see ArcPy Search Cursor

where_clause

where statement. To learn more see ArcPy SQL reference

fields

list of strings specifying the field names.

spatial_filter

A Geometry object that will filter the results. This requires arcpy to work.

Optional Parameters are not supported for URL based resources

Returns

A pandas.core.frame.DataFrame object

static from_geodataframe(geo_df, inplace=False, column_name='SHAPE')

The from_geodataframe loads a Geopandas GeoDataFrame into an ArcGIS Spatially Enabled DataFrame.

Note

The from_geodataframe method requires geopandas library be installed in current environment.

Argument

Description

geo_df

GeoDataFrame object, created using GeoPandas library

inplace

Optional Bool. When True, the existing GeoDataFrame is spatially

enabled and returned. When False, a new Spatially Enabled DataFrame object is returned. Default is False.

column_name

Optional String. Sets the name of the geometry column. Default

is SHAPE.

Returns

A Spatially Enabled DataFrame.

static from_layer(layer)

The from_layer method imports a FeatureLayer to a Spatially Enabled DataFrame

Note

This operation converts a FeatureLayer or Table to a Pandas’ DataFrame

Argument

Description

layer

Required FeatureLayer or TableLayer. The service to convert to a Spatially enabled DataFrame.

Usage:

>>> from arcgis.features import FeatureLayer
>>> mylayer = FeatureLayer(("https://sampleserver6.arcgisonline.com/arcgis/rest"
                    "/services/CommercialDamageAssessment/FeatureServer/0"))
>>> df = from_layer(mylayer)
>>> print(df.head())
Returns

A Pandas’ DataFrame

static from_table(filename, **kwargs)

The from_table method allows a User to read from a non-spatial table

Note

The from_table method requires ArcPy

Argument

Description

filename

Required string or pathlib.Path. The path to the table.

Keyword Arguments

Argument

Description

fields

Optional List/Tuple. A list (or tuple) of field names. For a single field, you can use a string instead of a list of strings.

Use an asterisk (*) instead of a list of fields if you want to access all fields from the input table (raster and BLOB fields are excluded). However, for faster performance and reliable field order, it is recommended that the list of fields be narrowed to only those that are actually needed.

Geometry, raster, and BLOB fields are not supported.

where

Optional String. An optional expression that limits the records returned.

skip_nulls

Optional Boolean. This controls whether records using nulls are skipped. Default is True.

null_value

Optional String/Integer/Float. Replaces null values from the input with a new value.

Returns

A Pandas DataFrame (pd.DataFrame)

static from_xy(df, x_column, y_column, sr=4326)

The from_xy method converts a Pandas DataFrame into a Spatially Enabled DataFrame by providing the X/Y columns.

Argument

Description

df

Required Pandas DataFrame. Source dataset

x_column

Required string. The name of the X-coordinate series

y_column

Required string. The name of the Y-coordinate series

sr

Optional int. The wkid number of the spatial reference. 4326 is the default value.

Returns

DataFrame

property full_extent

The full_extent method retrieves the extent of the DataFrame.

Returns

A tuple

>>> df.spatial.full_extent
(-118, 32, -97, 33)
property geometry_type

The geometry_type property retrieves a list of Geometry Types for the DataFrame.

Returns

A List

property has_m

The has_m property determines if the datasets have M values

Returns

A boolean indicating M values (True), or not (False)

property has_z

The has_z property determines if the datasets have Z values

Returns

A boolean indicating Z values (True), or not (False)

join(right_df, how='inner', op='intersects', left_tag='left', right_tag='right')

The join method joins the current DataFrame to another Spatially-Enabled DataFrame based on spatial location based.

Note

The join method requires the Spatially-Enabled DataFrame to be in the same coordinate system

Argument

Description

right_df

Required pd.DataFrame. Spatially enabled dataframe to join.

how

Required string. The type of join:

  • left - use keys from current dataframe and retains only current geometry column

  • right - use keys from right_df; retain only right_df geometry column

  • inner - use intersection of keys from both dfs and retain only current geometry column

op

Required string. The operation to use to perform the join. The default is intersects.

supported perations: intersects, within, and contains

left_tag

Optional String. If the same column is in the left and right dataframe, this will append that string value to the field.

right_tag

Optional String. If the same column is in the left and right dataframe, this will append that string value to the field.

Returns

Spatially enabled Pandas’ DataFrame

property length

The length method retrieves the total length of the DataFrame

Returns

A float

>>> df.spatial.length
1.23427
property name

The name method retrieves the name of the geometry column.

Returns

A string

overlay(sdf, op='union')

The overlay performs spatial operation operations on two spatially enabled dataframes.

Note

The overlay method requires ArcPy or Shapely

Argument

Description

sdf

Required Spatially Enabled DataFrame. The geometry to perform the operation from.

op

Optional String. The spatial operation to perform. The allowed value are: union, erase, identity, intersection. union is the default operation.

Returns

A Spatially enabled DataFrame (pd.DataFrame)

plot(map_widget=None, **kwargs)

The plot draws the data on a web map. The user can describe in simple terms how to renderer spatial data using symbol.

Note

To make the process simpler, a palette for which colors are drawn from can be used instead of explicit colors.

** Render Syntax **

The render syntax allows for users to fully customize symbolizing the data.

** Simple Renderer**

A simple renderer is a renderer that uses one symbol only.

Optional Argument

Description

symbol_type

optional string. This is the type of symbol the user needs to create. Valid inputs are: simple, picture, text, or carto. The default is simple.

symbol_type

optional string. This is the symbology used by the geometry. For example ‘s’ for a Line geometry is a solid line. And ‘-‘ is a dash line.

Point Symbols

  • ‘o’ - Circle (default)

  • ‘+’ - Cross

  • ‘D’ - Diamond

  • ‘s’ - Square

  • ‘x’ - X

Polyline Symbols

  • ‘s’ - Solid (default)

  • ‘-‘ - Dash

  • ‘-.’ - Dash Dot

  • ‘-..’ - Dash Dot Dot

  • ‘.’ - Dot

  • ‘–’ - Long Dash

  • ‘–.’ - Long Dash Dot

  • ‘n’ - Null

  • ‘s-‘ - Short Dash

  • ‘s-.’ - Short Dash Dot

  • ‘s-..’ - Short Dash Dot Dot

  • ‘s.’ - Short Dot

Polygon Symbols

  • ‘s’ - Solid Fill (default)

  • ‘’ - Backward Diagonal

  • ‘/’ - Forward Diagonal

  • ‘|’ - Vertical Bar

  • ‘-‘ - Horizontal Bar

  • ‘x’ - Diagonal Cross

  • ‘+’ - Cross

description

Description of the renderer.

rotation_expression

A constant value or an expression that derives the angle of rotation based on a feature attribute value. When an attribute name is specified, it’s enclosed in square brackets.

rotation_type

String value which controls the origin and direction of rotation on point features. If the rotationType is defined as arithmetic, the symbol is rotated from East in a counter-clockwise direction where East is the 0 degree axis. If the rotationType is defined as geographic, the symbol is rotated from North in a clockwise direction where North is the 0 degree axis.

Must be one of the following values:

  • arithmetic

  • geographic

visual_variables

An array of objects used to set rendering properties.

Heatmap Renderer

The HeatmapRenderer renders point data into a raster visualization that emphasizes areas of higher density or weighted values.

Optional Argument

Description

blur_radius

The radius (in pixels) of the circle over which the majority of each point’s value is spread.

field

This is optional as this renderer can be created if no field is specified. Each feature gets the same value/importance/weight or with a field where each feature is weighted by the field’s value.

max_intensity

The pixel intensity value which is assigned the final color in the color ramp.

min_intensity

The pixel intensity value which is assigned the initial color in the color ramp.

ratio

A number between 0-1. Describes what portion along the gradient the colorStop is added.

Unique Renderer

This renderer symbolizes features based on one or more matching string attributes.

Optional Argument

Description

background_fill_symbol

A symbol used for polygon features as a background if the renderer uses point symbols, e.g. for bivariate types & size rendering. Only applicable to polygon layers. PictureFillSymbols can also be used outside of the Map Viewer for Size and Predominance and Size renderers.

default_label

Default label for the default symbol used to draw unspecified values.

default_symbol

Symbol used when a value cannot be matched.

field1, field2, field3

Attribute field renderer uses to match values.

field_delimiter

String inserted between the values if multiple attribute fields are specified.

rotation_expression

A constant value or an expression that derives the angle of rotation based on a feature attribute value. When an attribute name is specified, it’s enclosed in square brackets. Rotation is set using a visual variable of type rotation info with a specified field or value expression property.

rotation_type

String property which controls the origin and direction of rotation. If the rotation type is defined as arithmetic the symbol is rotated from East in a counter-clockwise direction where East is the 0 degree axis. If the rotation type is defined as geographic, the symbol is rotated from North in a clockwise direction where North is the 0 degree axis. Must be one of the following values:

  • arithmetic

  • geographic

arcade_expression

An Arcade expression evaluating to either a string or a number.

arcade_title

The title identifying and describing the associated Arcade expression as defined in the valueExpression property.

visual_variables

An array of objects used to set rendering properties.

Class Breaks Renderer

A class breaks renderer symbolizes based on the value of some numeric attribute.

Optional Argument

Description

background_fill_symbol

A symbol used for polygon features as a background if the renderer uses point symbols, e.g. for bivariate types & size rendering. Only applicable to polygon layers. PictureFillSymbols can also be used outside of the Map Viewer for Size and Predominance and Size renderers.

default_label

Default label for the default symbol used to draw unspecified values.

default_symbol

Symbol used when a value cannot be matched.

method

Determines the classification method that was used to generate class breaks.

Must be one of the following values:

  • esriClassifyDefinedInterval

  • esriClassifyEqualInterval

  • esriClassifyGeometricalInterval

  • esriClassifyNaturalBreaks

  • esriClassifyQuantile

  • esriClassifyStandardDeviation

  • esriClassifyManual

field

Attribute field used for renderer.

class_count

Number of classes that will be considered in the selected classification method for the class breaks.

min_value

The minimum numeric data value needed to begin class breaks.

normalization_field

Used when normalizationType is field. The string value indicating the attribute field by which the data value is normalized.

normalization_total

Used when normalizationType is percent-of-total, this number property contains the total of all data values.

normalization_type

Determine how the data was normalized.

Must be one of the following values:

  • esriNormalizeByField

  • esriNormalizeByLog

  • esriNormalizeByPercentOfTotal

rotation_expression

A constant value or an expression that derives the angle of rotation based on a feature attribute value. When an attribute name is specified, it’s enclosed in square brackets.

rotation_type

A string property which controls the origin and direction of rotation. If the rotation_type is defined as arithmetic, the symbol is rotated from East in a couter-clockwise direction where East is the 0 degree axis. If the rotationType is defined as geographic, the symbol is rotated from North in a clockwise direction where North is the 0 degree axis.

Must be one of the following values:

  • arithmetic

  • geographic

arcade_expression

An Arcade expression evaluating to a number.

arcade_title

The title identifying and describing the associated Arcade expression as defined in the arcade_expression property.

visual_variables

An object used to set rendering options.

** Symbol Syntax **

Optional Argument

Description

symbol_type

optional string. This is the type of symbol the user needs to create. Valid inputs are: simple, picture, text, or carto. The default is simple.

symbol_type

optional string. This is the symbology used by the geometry. For example ‘s’ for a Line geometry is a solid line. And ‘-‘ is a dash line.

Point Symbols

  • ‘o’ - Circle (default)

  • ‘+’ - Cross

  • ‘D’ - Diamond

  • ‘s’ - Square

  • ‘x’ - X

Polyline Symbols

  • ‘s’ - Solid (default)

  • ‘-‘ - Dash

  • ‘-.’ - Dash Dot

  • ‘-..’ - Dash Dot Dot

  • ‘.’ - Dot

  • ‘–’ - Long Dash

  • ‘–.’ - Long Dash Dot

  • ‘n’ - Null

  • ‘s-‘ - Short Dash

  • ‘s-.’ - Short Dash Dot

  • ‘s-..’ - Short Dash Dot Dot

  • ‘s.’ - Short Dot

Polygon Symbols

  • ‘s’ - Solid Fill (default)

  • ‘’ - Backward Diagonal

  • ‘/’ - Forward Diagonal

  • ‘|’ - Vertical Bar

  • ‘-‘ - Horizontal Bar

  • ‘x’ - Diagonal Cross

  • ‘+’ - Cross

cmap

optional string or list. This is the color scheme a user can provide if the exact color is not needed, or a user can provide a list with the color defined as: [red, green blue, alpha]. The values red, green, blue are from 0-255 and alpha is a float value from 0 - 1. The default value is ‘jet’ color scheme.

cstep

optional integer. If provided, its the color location on the color scheme.

Simple Symbols

This is a list of optional parameters that can be given for point, line or polygon geometries.

Argument

Description

marker_size

optional float. Numeric size of the symbol given in points.

marker_angle

optional float. Numeric value used to rotate the symbol. The symbol is rotated counter-clockwise. For example, The following, angle=-30, in will create a symbol rotated -30 degrees counter-clockwise; that is, 30 degrees clockwise.

marker_xoffset

Numeric value indicating the offset on the x-axis in points.

marker_yoffset

Numeric value indicating the offset on the y-axis in points.

line_width

optional float. Numeric value indicating the width of the line in points

outline_style

Optional string. For polygon point, and line geometries , a customized outline type can be provided.

Allowed Styles:

  • ‘s’ - Solid (default)

  • ‘-‘ - Dash

  • ‘-.’ - Dash Dot

  • ‘-..’ - Dash Dot Dot

  • ‘.’ - Dot

  • ‘–’ - Long Dash

  • ‘–.’ - Long Dash Dot

  • ‘n’ - Null

  • ‘s-‘ - Short Dash

  • ‘s-.’ - Short Dash Dot

  • ‘s-..’ - Short Dash Dot Dot

  • ‘s.’ - Short Dot

outline_color

optional string or list. This is the same color as the cmap property, but specifically applies to the outline_color.

Picture Symbol

This type of symbol only applies to Points, MultiPoints and Polygons.

Argument

Description

marker_angle

Numeric value that defines the number of degrees ranging from 0-360, that a marker symbol is rotated. The rotation is from East in a counter-clockwise direction where East is the 0 axis.

marker_xoffset

Numeric value indicating the offset on the x-axis in points.

marker_yoffset

Numeric value indicating the offset on the y-axis in points.

height

Numeric value used if needing to resize the symbol. Specify a value in points. If images are to be displayed in their original size, leave this blank.

width

Numeric value used if needing to resize the symbol. Specify a value in points. If images are to be displayed in their original size, leave this blank.

url

String value indicating the URL of the image. The URL should be relative if working with static layers. A full URL should be used for map service dynamic layers. A relative URL can be dereferenced by accessing the map layer image resource or the feature layer image resource.

image_data

String value indicating the base64 encoded data.

xscale

Numeric value indicating the scale factor in x direction.

yscale

Numeric value indicating the scale factor in y direction.

outline_color

optional string or list. This is the same color as the cmap property, but specifically applies to the outline_color.

outline_style

Optional string. For polygon point, and line geometries , a customized outline type can be provided.

Allowed Styles:

  • ‘s’ - Solid (default)

  • ‘-‘ - Dash

  • ‘-.’ - Dash Dot

  • ‘-..’ - Dash Dot Dot

  • ‘.’ - Dot

  • ‘–’ - Long Dash

  • ‘–.’ - Long Dash Dot

  • ‘n’ - Null

  • ‘s-‘ - Short Dash

  • ‘s-.’ - Short Dash Dot

  • ‘s-..’ - Short Dash Dot Dot

  • ‘s.’ - Short Dot

outline_color

optional string or list. This is the same color as the cmap property, but specifically applies to the outline_color.

line_width

optional float. Numeric value indicating the width of the line in points

Text Symbol

This type of symbol only applies to Points, MultiPoints and Polygons.

Argument

Description

font_decoration

The text decoration. Must be one of the following values: - line-through - underline - none

font_family

Optional string. The font family.

font_size

Optional float. The font size in points.

font_style

Optional string. The text style. - italic - normal - oblique

font_weight

Optional string. The text weight. Must be one of the following values: - bold - bolder - lighter - normal

background_color

optional string/list. Background color is represented as a four-element array or string of a color map.

halo_color

Optional string/list. Color of the halo around the text. The default is None.

halo_size

Optional integer/float. The point size of a halo around the text symbol.

horizontal_alignment

optional string. One of the following string values representing the horizontal alignment of the text. Must be one of the following values: - left - right - center - justify

kerning

optional boolean. Boolean value indicating whether to adjust the spacing between characters in the text string.

line_color

optional string/list. Outline color is represented as a four-element array or string of a color map.

line_width

optional integer/float. Outline size.

marker_angle

optional int. A numeric value that defines the number of degrees (0 to 360) that a text symbol is rotated. The rotation is from East in a counter-clockwise direction where East is the 0 axis.

marker_xoffset

optional int/float.Numeric value indicating the offset on the x-axis in points.

marker_yoffset

optional int/float.Numeric value indicating the offset on the x-axis in points.

right_to_left

optional boolean. Set to true if using Hebrew or Arabic fonts.

rotated

optional boolean. Boolean value indicating whether every character in the text string is rotated.

text

Required string. Text Value to display next to geometry.

vertical_alignment

Optional string. One of the following string values representing the vertical alignment of the text. Must be one of the following values: - top - bottom - middle - baseline

Cartographic Symbol

This type of symbol only applies to line geometries.

Argument

Description

line_width

optional float. Numeric value indicating the width of the line in points

cap

Optional string. The cap style.

join

Optional string. The join style.

miter_limit

Optional string. Size threshold for showing mitered line joins.

The kwargs parameter accepts all parameters of the create_symbol method and the create_renderer method.

Returns

A MapView object with new drawings

project(spatial_reference, transformation_name=None)

The project method reprojects the who dataset into a new SpatialReference. This is an inplace operation meaning that it will update the defined geometry column from the set_geometry.

Note

The project method requires ArcPy or pyproj v4

Argument

Description

spatial_reference

Required SpatialReference. The new spatial reference. This can be a SpatialReference object or the coordinate system name.

transformation_name

Optional String. The geotransformation name.

Returns

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

relationship(other, op, relation=None)

The relationship method allows for dataframe to dataframe comparison using spatial relationships.

Note

The return is a Pandas DataFrame (pd.DataFrame) that meet the operations’ requirements.

Argument

Description

other

Required Spatially Enabled DataFrame. The geometry to perform the operation from.

op

Optional String. The spatial operation to perform. The allowed value are: contains,crosses,disjoint,equals, overlaps,touches, or within.

  • contains - Indicates if the base geometry contains the comparison geometry.

  • crosses - Indicates if the two geometries intersect in a geometry of a lesser shape type.

  • disjoint - Indicates if the base and comparison geometries share no points in common.

  • equals - Indicates if the base and comparison geometries are of the same shape type and define the same set of points in the plane. This is a 2D comparison only; M and Z values are ignored.

  • overlaps - Indicates if the intersection of the two geometries has the same shape type as one of the input geometries and is not equivalent to either of the input geometries.

  • touches - Indicates if the boundaries of the geometries intersect.

  • within - Indicates if the base geometry contains the comparison geometry.

  • intersect - Indicates if the base geometry has an intersection of the other geometry.

Note - contains and within will lead to same results when performing spatial operations.

relation

Optional String. The spatial relationship type. The allowed values are: BOUNDARY, CLEMENTINI, and PROPER.

  • BOUNDARY - Relationship has no restrictions for interiors or boundaries.

  • CLEMENTINI - Interiors of geometries must intersect. This is the default.

  • PROPER - Boundaries of geometries must not intersect.

This only applies to contains,

Returns

Spatially enabled DataFrame (pd.DataFrame)

property renderer

The renderer property defines the renderer for the Spatially-enabled DataFrame.

Argument

Description

value

Required dict. If none is given, then the value is reset

Returns

`InsensitiveDict`: A case-insensitive dict like object used to update and alter JSON A varients of a case-less dictionary that allows for dot and bracket notation.

sanitize_column_names(convert_to_string=True, remove_special_char=True, inplace=False, use_snake_case=True)

The sanitize_column_names cleans column names by converting them to string, removing special characters, renaming columns without column names to noname, renaming duplicates with integer suffixes and switching spaces or Pascal or camel cases to Python’s favored snake_case style.

Snake_casing gives you consistent column names, no matter what the flavor of your backend database is when you publish the DataFrame as a Feature Layer in your web GIS.

Argument

Description

convert_to_string

Optional Boolean. Default is True. Converts column names to string

remove_special_char

Optional Boolean. Default is True. Removes any characters in column names that are not numeric or underscores. This also ensures column names begin with alphabets by removing numeral prefixes.

inplace

Optional Boolean. Default is False. If True, edits the DataFrame in place and returns Nothing. If False, returns a new DataFrame object.

use_snake_case

Optional Boolean. Default is True. Makes column names lower case, and replaces spaces between words with underscores. If column names are in PascalCase or camelCase, it replaces them to snake_case.

Returns

pd.DataFrame object if inplace= False . Else None .

select(other)

The select operation performs a dataset wide selection by geometric intersection. A geometry or another Spatially enabled DataFrame can be given and select will return all rows that intersect that input geometry. The select operation uses a spatial index to complete the task, so if it is not built before the first run, the function will build a quadtree index on the fly.

Note

The select method requires ArcPy or Shapely

Returns

A Pandas DataFrame (pd.DataFrame, spatially enabled)

set_geometry(col, sr=None, inplace=True)

The set_geometry method assigns the geometry column by name or by list.

Argument

Description

col

Required string, Pandas Series, GeoArray, list or tuple. If a string, this is the name of the column containing the geometry. If a Pandas Series GeoArray, list or tuple, it is an iterable of Geometry objects.

sr

Optional integer or spatial reference of the geometries described in the first parameter. If the geometry objects already have the spatial reference defined, this is not necessary. If the spatial reference for the geometry objects is NOT define, it will default to WGS84 (wkid 4326).

inplace

Optional bool. Whether or not to modify the dataframe in place, or return a new dataframe. If True, nothing is returned and the dataframe is modified in place. If False, a new dataframe is returned with the geometry set. Defaults to True.

Returns

Spatially Enabled DataFrame or None

sindex(stype='quadtree', reset=False, **kwargs)

The sindex creates a spatial index for the given dataset.

Note

By default, the spatial index is a QuadTree spatial index.

r-tree indexes should be used for large datasets. This will allow users to create very large out of memory indexes. To use r-tree indexes, the r-tree library must be installed. To do so, install via conda using the following command: conda install -c conda-forge rtree

Returns

A spatial index for the given dataset.

property sr

The sr property gets and sets the SpatialReference of the dataframe

Argument

Description

value

Spatial Reference

to_feature_collection(name=None, drawing_info=None, extent=None, global_id_field=None, sanitize_columns=False)

The to_feature_collection converts a spatially enabled a Pandas DataFrame to a FeatureCollection .

optional argument

Description

name

optional string. Name of the FeatureCollection

drawing_info

Optional dictionary. This is the rendering information for a Feature Collection. Rendering information is a dictionary with the symbology, labelling and other properties defined. See the Renderer Objects page in the ArcGIS REST API for more information.

extent

Optional dictionary. If desired, a custom extent can be provided to set where the map starts up when showing the data. The default is the full extent of the dataset in the Spatial DataFrame.

global_id_field

Optional string. The Global ID field of the dataset.

sanitize_columns

Optional Boolean. If True, column names will be converted to string, invalid characters removed and other checks will be performed. The default is False.

Returns

A FeatureCollection object

to_featureclass(location, overwrite=True, has_z=None, has_m=None, sanitize_columns=True)

The to_featureclass exports a spatially enabled dataframe to a feature class.

Argument

Description

location

Required string. The output of the table.

overwrite

Optional Boolean. If True and if the feature class exists, it will be deleted and overwritten. This is default. If False, the feature class and the feature class exists, and exception will be raised.

has_z

Optional Boolean. If True, the dataset will be forced to have Z based geometries. If a geometry is missing a Z value when true, a RuntimeError will be raised. When False, the API will not use the Z value.

has_m

Optional Boolean. If True, the dataset will be forced to have M based geometries. If a geometry is missing a M value when true, a RuntimeError will be raised. When False, the API will not use the M value.

sanitize_columns

Optional Boolean. If True, column names will be converted to string, invalid characters removed and other checks will be performed. The default is True.

Returns

A String

to_featurelayer(title=None, gis=None, tags=None, folder=None, sanitize_columns=False, service_name=None)

The to_featurelayer method publishes a spatial dataframe to a new FeatureLayer object.

Argument

Description

title

Optional string. The name of the service. If not provided, a random string is generated.

gis

Optional GIS. The GIS connection object

tags

Optional list of strings. A comma seperated list of descriptive words for the service.

folder

Optional string. Name of the folder where the featurelayer item and imported data would be stored.

sanitize_columns

Optional Boolean. If True, column names will be converted to string, invalid characters removed and other checks will be performed. The default is False.

service_name

Optional String. The name for the service that will be added to the Item. Name cannot be used already and cannot contain special characters, spaces, or a numerical value as the first letter.

Returns

A FeatureLayer object.

to_featureset()

The to_featureset method converts a Spatially Enabled DataFrame object. to a FeatureSet object.

Returns

A FeatureSet object

to_table(location, overwrite=True, **kwargs)

The to_table method exports a geo enabled dataframe to a Table object.

Argument

Description

location

Required string. The output of the table.

overwrite

Optional Boolean. If True and if the table exists, it will be deleted and overwritten. This is default. If False, the table and the table exists, and exception will be raised.

sanitize_columns

Optional Boolean. If True, column names will be converted to string, invalid characters removed and other checks will be performed. The default is True.

Returns

String

property true_centroid

The true_centroid property retrieves the true centroid of the DataFrame

Returns

A Geometry object

>>> df.spatial.true_centroid
(1.23427, 34)
validate(strict=False)

The validate method determines if the GeoAccessor is Valid with Geometry objects in all values

Returns

A boolean indicating Success (True), or Failure (False)

voronoi()

The voronoi method generates a voronoi diagram on the whole dataset.

Note

If the Geometry object is not a :class:`~arcgis.geometry.Point then the centroid is used for the geometry. The result is a Polygon GeoArray Series that matches 1:1 to the original dataset.

Note

The voronoi method requires SciPy

Returns

A Pandas Series (pd.Series)

arcgis.features.GeoSeriesAccessor

class arcgis.features.GeoSeriesAccessor(obj)
property JSON

The JSON method creates a JSON string out of the Geometry object.

Returns

Series of strings

property WKB

The WKB method retrieves the Geometry object as a WKB

Returns

A Series of Bytes

property WKT

The WKT method retrieves the Geometry object’s WKT

Returns

Series of String

angle_distance_to(second_geometry, method='GEODESIC')

The angle_distance_to method retrieves a tuple of angle and distance to another point using a measurement method.

Argument

Description

second_geometry

Required Geometry. A Geometry object.

method

Optional String. PLANAR measurements reflect the projection of geographic data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

Returns

A Series where each element is a tuple of angle and distance to another point using a measurement type.

property area

The area method retrieves the Feature object’s area.

return

A float in a series

property as_arcpy

The as_arcpy method retrieves the features as an ArcPy geometry object.

Returns

An arcpy.geometry as a series

property as_shapely

The as_shapely method retrieves the features as Shapely`Geometry <https://shapely.readthedocs.io/en/stable/manual.html#geometric-objects>`_

Returns

shapely.Geometry objects in a series

boundary()

The boundary method constructs the boundary of the Geometry object.

Returns

A Pandas Series of Polyline objects

buffer(distance)

The buffer method constructs a Polygon at a specified distance from the Geometry object.

Argument

Description

distance

Required float. The buffer distance. The buffer distance is in the same units as the geometry that is being buffered. A negative distance can only be specified against a polygon geometry.

Returns

A Pandas Series of Polygon objects

property centroid

Returns the feature’s centroid

Returns

tuple (x,y) in series

clip(envelope)

The clip method constructs the intersection of the Geometry object and the specified extent.

Argument

Description

envelope

required tuple. The tuple must have (XMin, YMin, XMax, YMax) each value represents the lower left bound and upper right bound of the extent.

Returns

A Pandas Series of Geometry objects

contains(second_geometry, relation=None)

The contains method indicates if the base Geometry contains the comparison Geometry.

Argument

Description

second_geometry

Required Geometry. A second geometry

relation

Optional string. The spatial relationship type.

  • BOUNDARY - Relationship has no restrictions for interiors or boundaries.

  • CLEMENTINI - Interiors of geometries must intersect. Specifying CLEMENTINI is equivalent to specifying None. This is the default.

  • PROPER - Boundaries of geometries must not intersect.

Returns

A Pandas Series of booleans indicating success (True), or failure (False)

convex_hull()

The convex_hull method constructs the Geometry that is the minimal bounding Polygon such that all outer angles are convex.

Returns

A Pandas Series of Geometry objects

crosses(second_geometry)

The crosses method indicates if the two Geometry objects intersect in a geometry of a lesser shape type.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of booleans indicating success (True), or failure (False)

cut(cutter)

The cut method splits this Geometry into a part to the left of the cutting Polyline and a part to the right of it.

Argument

Description

cutter

Required Polyline. The cutting polyline geometry

Returns

A Pandas Series where each element is a list of two Geometry objects

densify(method, distance, deviation)

The densify method creates a new Geometry with added vertices

Argument

Description

method

Required String. The type of densification, DISTANCE, ANGLE, or GEODESIC

distance

Required float. The maximum distance between vertices. The actual distance between vertices will usually be less than the maximum distance as new vertices will be evenly distributed along the original segment. If using a type of DISTANCE or ANGLE, the distance is measured in the units of the geometry’s spatial reference. If using a type of GEODESIC, the distance is measured in meters.

deviation

Required float. Densify uses straight lines to approximate curves. You use deviation to control the accuracy of this approximation. The deviation is the maximum distance between the new segment and the original curve. The smaller its value, the more segments will be required to approximate the curve.

Returns

A Pandas Series of Geometry objects

difference(second_geometry)

The difference method constructs the Geometry that is composed only of the region unique to the base geometry but not part of the other geometry.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of Geometry objects

disjoint(second_geometry)

The disjoint method indicates if the base and comparison Geometry objects share no Point objects in common.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of booleans indicating success (True), or failure (False)

distance_to(second_geometry)

The distance_to method retrieves the minimum distance between two Geometry. If the geometries intersect, the minimum distance is 0.

Note

Both geometries must have the same projection.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of floats

equals(second_geometry)

The equals method indicates if the base and comparison Geometry objects are of the same shape type and define the same set of Point objects in the plane.

Note

This is a 2D comparison only; M and Z values are ignored.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of booleans indicating success (True), or failure (False)

property extent

The extent method retrieves the feature’s extent

Returns

A tuple (xmin,ymin,xmax,ymax) in series

property first_point

The first_point property retrieves the feature’s first Point object

Returns

A Point object

generalize(max_offset)

The generalize method creates a new simplified Geometry using a specified maximum offset tolerance.

Note

This only works on Polyline and Polygon objects.

Argument

Description

max_offset

Required float. The maximum offset tolerance.

Returns

A Pandas Series of Geometry objects

property geoextent

The geoextent method retrieves the Geometry object’s extents

Returns

A Series of Floats

property geometry_type

The geometry_type property retrieves the Geometry object’s type.

Returns

A Series of strings

get_area(method, units=None)

The get_area method retreives the area of the feature using a measurement type.

Returns

A Pandas Series of floats

get_length(method, units)

The get_length method retrieves the length of the feature using a measurement type.

Argument

Description

method

Required String. PLANAR measurements reflect the projection of geographic data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

units

Required String. Linear unit of measure keywords: CENTIMETERS | DECIMETERS | FEET | INCHES | KILOMETERS | METERS | MILES | MILLIMETERS | NAUTICALMILES | YARDS

Returns

A A Pandas Series of floats

get_part(index=None)

The get_part method retrieves an array of Point objects for a particular part of Geometry or an array containing a number of arrays, one for each part.

requires arcpy

Argument

Description

index

Required Integer. The index position of the geometry.

Returns

AnA Pandas Series of arcpy.Arrays

property has_m

The has_m method determines if the Geometry objects has an M value

Returns

A Series of Booleans

property has_z

The has_z method determines if the Geometry object has a Z value

Returns

A Series of Booleans

property hull_rectangle

The hull_rectangle retrieves a space-delimited string of the coordinate pairs of the convex hull

Returns

A Series of strings

intersect(second_geometry, dimension=1)

The intersect method constructs a Geometry that is the geometric intersection of the two input geometries. Different dimension values can be used to create different shape types.

Note

The intersection of two Geometry objects of the same shape type is a geometry containing only the regions of overlap between the original geometries.

Argument

Description

second_geometry

Required Geometry. A second geometry

dimension

Required Integer. The topological dimension (shape type) of the resulting geometry.

  • 1 -A zero-dimensional geometry (point or multipoint).

  • 2 -A one-dimensional geometry (polyline).

  • 4 -A two-dimensional geometry (polygon).

Returns

A Pandas Series of Geometry objects

property is_empty

The is_empty method determines if the Geometry object is empty.

Returns

A Series of Booleans

property is_multipart

The is_multipart method determines if features has multiple parts.

Returns

A Series of Booleans

property is_valid

The is_valid method determines if the features Geometry is valid

Returns

A Series of Booleans

property label_point

The label_point method determines the Point for the optimal label location.

Returns

A Series of Geometry object

property last_point

The last_point method retrieves the Geometry of the last point in a feature.

Returns

A Series of Geometry objects

property length

The length method retrieves the length of the features.

Returns

A Series of floats

property length3D

The length3D method retrieves the length of the features

Returns

A Series of floats

measure_on_line(second_geometry, as_percentage=False)

The measure_on_line method retrieves the measure from the start Point of this line to the in_point.

Argument

Description

second_geometry

Required Geometry. A second geometry

as_percentage

Optional Boolean. If False, the measure will be returned as a distance; if True, the measure will be returned as a percentage.

Returns

A Pandas Series of floats

overlaps(second_geometry)

The overlaps method indicates if the intersection of the two Geometry objects has the same shape type as one of the input geometries and is not equivalent to either of the input geometries.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of booleans indicating success (True), or failure (False)

property part_count

The part_count method retrieves the number of parts in a feature’s Geometry

Returns

A Series of Integers

property point_count

The point_count method retrieves the number of Point objects in a feature’s Geometry.

Returns

A Series of Integers

point_from_angle_and_distance(angle, distance, method='GEODESCIC')

The point_from_angle_and_distance retrieves a Point at a given angle and distance in degrees and meters using the specified measurement type.

Argument

Description

angle

Required Float. The angle in degrees to the returned point.

distance

Required Float. The distance in meters to the returned point.

method

Optional String. PLANAR measurements reflect the projection of geographic data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

Returns

A Pandas Series of Geometry objects

position_along_line(value, use_percentage=False)

The position_along_line method retrieves a Point on a line at a specified distance from the beginning of the line.

Argument

Description

value

Required Float. The distance along the line.

use_percentage

Optional Boolean. The distance may be specified as a fixed unit of measure or a ratio of the length of the line. If True, value is used as a percentage; if False, value is used as a distance. For percentages, the value should be expressed as a double from 0.0 (0%) to 1.0 (100%).

Returns

A Pandas Series of Geometry objects.

project_as(spatial_reference, transformation_name=None)

The project_as method projects a Geometry`and optionally applies a ``geotransformation`.

Argument

Description

spatial_reference

Required SpatialReference. The new spatial reference. This can be a SpatialReference object or the coordinate system name.

transformation_name

Required String. The geotransformation name.

Returns

A Pandas Series of Geometry objects

query_point_and_distance(second_geometry, use_percentage=False)

The query_point_and_distance finds the Point on the Polyline nearest to the in_point and the distance between those points.

Note

query_point_and_distance also returns information about the side of the line the in_point is on as well as the distance along the line where the nearest point occurs.

Argument

Description

second_geometry

Required Geometry. A second geometry

as_percentage

Optional boolean - if False, the measure will be returned as distance, True, measure will be a percentage

Returns

A Pandas Series of tuples

segment_along_line(start_measure, end_measure, use_percentage=False)

The segment_along_line method retrieves a Polyline between start and end measures. Similar to positionAlongLine but will return a polyline segment between two points on the polyline instead of a single Point.

Argument

Description

start_measure

Required Float. The starting distance from the beginning of the line.

end_measure

Required Float. The ending distance from the beginning of the line.

use_percentage

Optional Boolean. The start and end measures may be specified as fixed units or as a ratio. If True, start_measure and end_measure are used as a percentage; if False, start_measure and end_measure are used as a distance. For percentages, the measures should be expressed as a double from 0.0 (0 percent) to 1.0 (100 percent).

Returns

A Pandas Series of Geometry objects

snap_to_line(second_geometry)

The snap_to_line method creates a new Point based on in_point snapped to this Geometry object.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of Geometry objects

property spatial_reference

The spatial_reference method retrieves the SpatialReference of the Geometry

Returns

A Series of SpatialReference objects.

symmetric_difference(second_geometry)

The symmetric_difference method constructs the Geometry that is the union of two geometries minus the intersection of those geometries.

Note

The two input Geometry must be the same shape type.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of Geometry objects

touches(second_geometry)

The touches method indicates if the boundaries of the Geometry intersect.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of booleans indicating touching (True), or not touching (False)

property true_centroid

The true_centroid method retrieves the true centroid of the Geometry object.

Returns

A Series of Point objects

union(second_geometry)

The union method constructs the Geometry object that is the set-theoretic union of the input geometries.

Argument

Description

second_geometry

Required Geometry. A second geometry

Returns

A Pandas Series of Geometry objects

within(second_geometry, relation=None)

The within method indicates if the base Geometry is within the comparison Geometry.

Argument

Description

second_geometry

Required Geometry. A second geometry

relation

Optional String. The spatial relationship type.

  • BOUNDARY - Relationship has no restrictions for interiors or boundaries.

  • CLEMENTINI - Interiors of geometries must intersect. Specifying CLEMENTINI is equivalent to specifying None. This is the default.

  • PROPER - Boundaries of geometries must not intersect.

Returns

A Pandas Series of booleans indicating within (True), or not within (False)

arcgis.features.EditFeatureJob

class arcgis.features._async.EditFeatureJob(future, connection)

Represents a Single Editing Job. The EditFeatureJob class allows for the asynchronous operation of the edit_features() method. This class is not intended for users to initialize directly, but is retuned by edit_features() when future=True.

Argument

Description

future

Future. The future request.

connection

The GIS connection object.

cancelled()

Return True if the call was successfully cancelled.

Returns

boolean

done()

Return True if the call was successfully cancelled or finished running.

Returns

boolean

property messages

returns the GP messages

Returns

List

result()

Return the value returned by the call. If the call hasn’t yet completed then this method will wait.

Returns

object

running()

Return True if the call is currently being executed and cannot be cancelled.

Returns

boolean

property status

returns the Job status

Returns

bool - True means running, False means finished

property task

Returns the task name. :return: string

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.