nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

ArcGIS API for Python: set an Area of Interest on a Hosted Feature Layer View?

Egge-Jan_Pollé

Hi,

Is it possible to set an Area of Interest on a Hosted Feature Layer View using the ArcGIS API for Python?

I know how to create a view on a Hosted Feature Layer and to set a View Definition by defining which features to show. (This procedure is also clearly explained in this blog: https://community.esri.com/groups/arcgis-python-api/blog/2019/02/11/using-the-arcgis-api-for-python-to-create-a-view-from-a-hosted-feature-layer-and-to-define-a-view-fefinition)

But you can also set a View Definition on a Hosted Feature Layer View by defining an Area of Interest. (This was new in ArcGIS Online in December 2017: What’s new with hosted feature layer views (December 2017))

So, my question is: is it possible to somehow set this Area of Interest using the ArcGIS API for Python?
So far, my research (Google, etc.) did not result in a positive answer, so any hint would be appreciated.

Thanks in advance,

Egge-Jan

Trouver plus de publications taguées avec

Accepted answers

EarlMedina

Hi Egge-Jan,

Thank you for sharing that blog spot here and I hope it was useful to you!

Essentially, when you set an area of interest the updateDefinition operation is executed on the view layer (https://whatever.domain.com/arcgis/rest/admin/services/worldEQView/FeatureServer/0/updateDefinition)

That request looks something like this, with the viewLayerDefintion property being updated:

{"viewLayerDefinition":{"filter":{"operator":"esriSpatialRelIntersects","value":{"geometryType":"esriGeometryEnvelope","geometry":{"xmin":4485937.7074932605,"ymin":1543545.165101517,"xmax":9417043.276225261,"ymax":6239836.182941515,"spatialReference":{"wkid":102100,"latestWkid":3857}}}}}}

Here you see that the Area of Interest is really just an envelope which intersects the view. So, the trickiest part is probably knowing the geometry to supply.

To accomplish this with the Python API, you use FeatureLayerManager's update_definition: <A class="link-titled" href="https://esri.github.io/arcgis-python-api/apidoc/html/arcgis.features.managers.html?highlight=update_definition#arcgis.features.managers.FeatureLayerManager.update_definition" title="https://esri.github.io/arcgis-python-api/apidoc/html/arcgis.features.managers.html?highlight=update_definition#arcgis.features.managers.FeatureLayerManager.update_definition" rel="nofollow noopener noreferrer" target="_blank">arcgis.features.managers module — arcgis 1.6.0 documentation</A>

</CODE>Something like this will accomplish the desired result:<PRE class="lia-code-sample line-numbers language-none"><CODE>from arcgis import GIS gis = GIS("https://machine.domain.com/portal", "user", "pass") url = 'https://machine.domain.com/arcgis/rest/services/viewLayer/FeatureServer/0' fs = arcgis.features.FeatureLayer(url, gis) update_dict = {"viewLayerDefinition":{"filter": {"operator":"esriSpatialRelIntersects","value": {"geometryType":"esriGeometryEnvelope","geometry": {"xmin":4485937.7074932605,"ymin":1543545.165101517, "xmax":9417043.276225261,"ymax":6239836.182941515, "spatialReference":{"wkid":102100,"latestWkid":3857}}}}}} fs.manager.update_definition(update_dict)‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Kind regards,

Earl

All comments

EarlMedina

Hi Egge-Jan,

Thank you for sharing that blog spot here and I hope it was useful to you!

That request looks something like this, with the viewLayerDefintion property being updated:

Here you see that the Area of Interest is really just an envelope which intersects the view. So, the trickiest part is probably knowing the geometry to supply.

Kind regards,

Earl

Egge-Jan_Pollé

Hi Earl,

Thanks for your prompt reply. Very useful 🙂 Now I know I was on the right track, but it was your sample code that really helped me out.

I did extent your example a little bit to apply the Area of Interest to each and every layer in the Hosted Feature Layer View. And yes, it works - see the red rectangle in the screendump below.

Now I can go and test with more complex geometries for the Area of Interest, and with another spatial operator.

(There is already one test result I can share: the Spatial Reference system of my dataset is 28992 (not 102100/3857). And yes it is posssible to define the Area of Interest in another Spatial Reference system. But if you do so, this area will not be visualized on the Visualization tab. So, if this visualization is important to you, you should stick to 102100/3857.)

Thanks again,

Egge-Jan

<SPAN class="comment token">## ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</SPAN>
<SPAN class="comment token">## ArcGIS Online Tools</SPAN>
<SPAN class="comment token">## Script: agol_create_view_area_of_interest.py</SPAN>
<SPAN class="comment token">## Goal: to create a Hosted Feature Layer View (i.e. a View on a Hosted Feature Layer) with an Area of Interest</SPAN>
<SPAN class="comment token">## Author: Egge-Jan Polle - Tensing GIS Consultancy</SPAN>
<SPAN class="comment token">## Date: March 14, 2019</SPAN>
<SPAN class="comment token">## ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</SPAN>

<SPAN class="comment token"># This script should be run within a specific ArcGIS/Python environment using the batch file below</SPAN>
<SPAN class="comment token"># (This batch file comes with the installation of ArcGIS Pro)</SPAN>
<SPAN class="comment token"># "C:\Program Files\ArcGIS\Pro\bin\Python\scripts\propy.bat" agol_create_view_area_of_interest.py</SPAN>

<SPAN class="keyword token">from</SPAN> arcgis<SPAN class="punctuation token">.</SPAN>gis <SPAN class="keyword token">import</SPAN> GIS
<SPAN class="keyword token">from</SPAN> arcgis<SPAN class="punctuation token">.</SPAN>features <SPAN class="keyword token">import</SPAN> FeatureLayerCollection
<SPAN class="keyword token">from</SPAN> provide_credentials <SPAN class="keyword token">import</SPAN> provide_credentials

<SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">'==================='</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">'The script that is running: '</SPAN> <SPAN class="operator token">+</SPAN> __file__<SPAN class="punctuation token">)</SPAN>
<SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">'First you have to log in to ArcGIS Online'</SPAN><SPAN class="punctuation token">)</SPAN>

<SPAN class="comment token"># Log in</SPAN>
username<SPAN class="punctuation token">,</SPAN> password <SPAN class="operator token">=</SPAN> provide_credentials<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
my_agol <SPAN class="operator token">=</SPAN> GIS<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"https://www.arcgis.com"</SPAN><SPAN class="punctuation token">,</SPAN> username<SPAN class="punctuation token">,</SPAN> password<SPAN class="punctuation token">)</SPAN>

<SPAN class="keyword token">print</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Start: "</SPAN><SPAN class="operator token">+</SPAN>datetime<SPAN class="punctuation token">.</SPAN>datetime<SPAN class="punctuation token">.</SPAN>today<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>strftime<SPAN class="punctuation token">(</SPAN><SPAN class="string token">'%c'</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>

service <SPAN class="operator token">=</SPAN> my_agol<SPAN class="punctuation token">.</SPAN>content<SPAN class="punctuation token">.</SPAN>get<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"<serviceItemId_of_your_Hosted_Feature_Layer>"</SPAN><SPAN class="punctuation token">)</SPAN>

flc <SPAN class="operator token">=</SPAN> FeatureLayerCollection<SPAN class="punctuation token">.</SPAN>fromitem<SPAN class="punctuation token">(</SPAN>service<SPAN class="punctuation token">)</SPAN>

xmin <SPAN class="operator token">=</SPAN> <SPAN class="number token">599538.1</SPAN>
ymin <SPAN class="operator token">=</SPAN> <SPAN class="number token">6828068</SPAN>
xmax <SPAN class="operator token">=</SPAN> <SPAN class="number token">599863.4</SPAN>
ymax <SPAN class="operator token">=</SPAN> <SPAN class="number token">6828394</SPAN>

update_dict <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">{</SPAN><SPAN class="string token">"viewLayerDefinition"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="punctuation token">{</SPAN><SPAN class="string token">"filter"</SPAN><SPAN class="punctuation token">:</SPAN>   
<SPAN class="punctuation token">{</SPAN><SPAN class="string token">"operator"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="string token">"esriSpatialRelIntersects"</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"value"</SPAN><SPAN class="punctuation token">:</SPAN>
<SPAN class="punctuation token">{</SPAN><SPAN class="string token">"geometryType"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="string token">"esriGeometryEnvelope"</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"geometry"</SPAN><SPAN class="punctuation token">:</SPAN>
<SPAN class="punctuation token">{</SPAN><SPAN class="string token">"xmin"</SPAN><SPAN class="punctuation token">:</SPAN>xmin<SPAN class="punctuation token">,</SPAN><SPAN class="string token">"ymin"</SPAN><SPAN class="punctuation token">:</SPAN>ymin<SPAN class="punctuation token">,</SPAN>
<SPAN class="string token">"xmax"</SPAN><SPAN class="punctuation token">:</SPAN>xmax<SPAN class="punctuation token">,</SPAN><SPAN class="string token">"ymax"</SPAN><SPAN class="punctuation token">:</SPAN>ymax<SPAN class="punctuation token">,</SPAN>
<SPAN class="string token">"spatialReference"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="punctuation token">{</SPAN><SPAN class="string token">"wkid"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="number token">102100</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"latestWkid"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="number token">3857</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN>

view_name <SPAN class="operator token">=</SPAN> service<SPAN class="punctuation token">.</SPAN>name <SPAN class="operator token">+</SPAN> <SPAN class="string token">"_view"</SPAN>
<SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN>view_name<SPAN class="punctuation token">)</SPAN>
view <SPAN class="operator token">=</SPAN> flc<SPAN class="punctuation token">.</SPAN>manager<SPAN class="punctuation token">.</SPAN>create_view<SPAN class="punctuation token">(</SPAN>name<SPAN class="operator token">=</SPAN>view_name<SPAN class="punctuation token">,</SPAN> spatial_reference<SPAN class="operator token">=</SPAN>None<SPAN class="punctuation token">,</SPAN> extent<SPAN class="operator token">=</SPAN>None<SPAN class="punctuation token">,</SPAN>
allow_schema_changes<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN> updateable<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN> capabilities<SPAN class="operator token">=</SPAN><SPAN class="string token">'Query, Update'</SPAN><SPAN class="punctuation token">,</SPAN> view_layers<SPAN class="operator token">=</SPAN>None<SPAN class="punctuation token">)</SPAN>
<SPAN class="keyword token">for</SPAN> lyr <SPAN class="keyword token">in</SPAN> view<SPAN class="punctuation token">.</SPAN>layers<SPAN class="punctuation token">:</SPAN>
    lyr<SPAN class="punctuation token">.</SPAN>manager<SPAN class="punctuation token">.</SPAN>update_definition<SPAN class="punctuation token">(</SPAN>update_dict<SPAN class="punctuation token">)</SPAN>

<SPAN class="keyword token">print</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="string token">"End: "</SPAN><SPAN class="operator token">+</SPAN>datetime<SPAN class="punctuation token">.</SPAN>datetime<SPAN class="punctuation token">.</SPAN>today<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>strftime<SPAN class="punctuation token">(</SPAN><SPAN class="string token">'%c'</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

EarlMedina

Hi Egge-Jan,

It was my pleasure to help out and thank you for sharing the end product. Please go ahead and mark this one answered for anyone who might be interested in the workflow.

Kind regards,

Earl

Egge-Jan_Pollé

Extending the example above with some other parameters in the update_dict‍:

The geometry is now a proper polygon now (instead of a rectangular envelope)
To make sure we only see objects that lie entirely within the Area of Interest I use the operater esriSpatialRelContains

update_dict <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">{</SPAN><SPAN class="string token">"viewLayerDefinition"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="punctuation token">{</SPAN><SPAN class="string token">"filter"</SPAN><SPAN class="punctuation token">:</SPAN>   
<SPAN class="punctuation token">{</SPAN><SPAN class="string token">"operator"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="string token">"esriSpatialRelContains"</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"value"</SPAN><SPAN class="punctuation token">:</SPAN>
<SPAN class="punctuation token">{</SPAN><SPAN class="string token">"geometryType"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="string token">"esriGeometryPolygon"</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"geometry"</SPAN><SPAN class="punctuation token">:</SPAN>
<SPAN class="punctuation token">{</SPAN><SPAN class="string token">"rings"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="punctuation token">[</SPAN> <SPAN class="punctuation token">[</SPAN> <SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599538.094340413692407</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828149.832508580759168</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599619.427406286238693</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828068.295202748849988</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599782.09063097089529</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828068.294832927174866</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599863.424065723433159</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828149.831768924370408</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599863.42953326983843</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828394.4517279881984</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599538.091433217399754</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828312.911664362065494</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="punctuation token">[</SPAN> <SPAN class="number token">599538.094340413692407</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">6828149.832508580759168</SPAN> <SPAN class="punctuation token">]</SPAN> <SPAN class="punctuation token">]</SPAN> <SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>
<SPAN class="string token">"spatialReference"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="punctuation token">{</SPAN><SPAN class="string token">"wkid"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="number token">102100</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">"latestWkid"</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="number token">3857</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">}</SPAN>
<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Rejoindre la conversation

Les membres connectés peuvent publier, suivre les mises à jour, et plus encore. Nouveau ici ? Inscrivez-vous gratuitement.

Liens rapides

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.