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; } } }

Configure Popup Attributes Programmatically with ArcGIS API for Python

NathanielEvatt

I am hoping to run a script that can hide certain fields from an ArcGIS Online web map. In ArcGIS Online, I would accomplish this by opening a webmap, clicking the three dots of the layer I was interested in, selecting "configure pop-up" then selecting "Configure Attribute". Finally from there I can edit the display options in the GUI shown below.

Is this something that is currently configurable from the ArcGIS API for Python?

Encuentra más publicaciones etiquetadas con

Accepted answers

Anonymous User

This is possible but there's no "popup" API for it. You can get the webmap json, then edit the popup properties in the json, then update the webmap.

See the webmap spec here: popupInfo | ArcGIS for Developers .

Code would be something like this (this hides every field in the popup):

import arcgis
import json

gis = arcgis.gis.GIS("https://arcgis.com", "username", "password")

item = gis.content.get("<item-id>")
item_data = item.get_data()
field_infos = item_data['operationalLayers'][0]['popupInfo']['fieldInfos']
for field in field_infos:
    field["visible"] = False

item_properties = {"text": json.dumps(item_data)}
item.update(item_properties=item_properties)

All comments

RamonWilliams

I'm still a newbie to all this stuff, is there a reason this command doesn't always work?

if I edit the visualization for my pop ups I can get to the data using the command. If I don't I can't pull back any data.

# Get the Item itself
    flc_itm = gis.content.get(fl_itmid)

Sean-Sweeney

I still haven't gotten around to trying @AlderMaps' solution. It's been sitting there on my to-do list mocking me, for almost a year now I see.

KappiPatterson

Hi Sean, I was wondering if you managed to get this to work? I'm also working with Feature Layers (not WebMaps) and am having the same None return on new FeatureLayers.

AlderMaps

@SeanSweeney Took all day but I think I have a method working to accomplish what we are looking to do--add the "default" popupInfo JSON to the webmap without having to configure anything in the UI ahead of time. TL;DR: have to get the popupInfo from the associated FeatureLayerCollection/Service Item Object.

It's unwieldy and clunky but it's the best I could do in the time allotted...adding here for posterity.

# Create Item object from item ID
itm = gis.content.get(itm_id)

# STEP 1: Make the dictionary of popupInfo and stuff in dict.

id_dict = [] # List to hold item IDs from which popupInfo is harvested
pop_dict = {} # Dict to hold popupInfo

wm = WebMap(itm)

for lyr in wm.layers:
    
    # Get the feature layer URL as key for dictionary
    fl_url = FeatureLayer(lyr).url["url"]
    
    # Get the itemID of the feature layer
    fl_itmid = FeatureLayer(lyr).url["itemId"]
    
    # Skip item ID if already done
    if fl_itmid in id_dict:
        continue
    
    # Add item ID to list to keep track of what services we've already checked
    id_dict.append(fl_itmid)
    
    # Get the Item itself
    flc_itm = gis.content.get(fl_itmid)
    
    # Get the item data (this is where the JSON we need lives...i.e.
    # ...this is what ArcGIS Assistant shows you when you click "View item JSON")
    flc_data = flc_itm.get_data()
    
    # Grab the value (list of layer info) at the key "layers"
    lyrs_info = flc_data["layers"]
    
    # Iterate through info for all layer info in the service
    for l in lyrs_info:
        
        # For each layer: make the key URL
        head = fl_url.rsplit("/",1)[0]
        tail = str(l["id"])
        key_url = f"{head}/{tail}"
        
        # FINALLY, WE GET OUR HANDS ON THE GODDAMNED POPUPINFO!!
        pop_info = l["popupInfo"]
    
        # Assign popupInfo to dict with feature layer URL as key
        pop_dict[key_url] = pop_info

# STEP 2: Assign the popupInfo to the correct layers in the webmap
itm_data = itm.get_data()

# Loop through operational layers
for ops_lyr in itm_data["operationalLayers"]:
    
    # Grab url (full URL including layer ID)
    ol_url = ops_lyr["url"]
    
    # Check whether popupInfo already exists for layer:
    if not "popupInfo" in ops_lyr:
        
        # Compare ops layer URL to url keys in dict from above
        if ol_url in pop_dict:
            
            # If there's a match, toss in the popupInfo!
            ops_lyr.update({"popupInfo": pop_dict[ol_url]})
            
            print(ol_url)
            print("popupInfo successfully added!\n")

# Update item_properties
itm_props = {"text": itm_data}
itm.update(item_properties = itm_props)

AlderMaps

I need to do exactly the same thing @SeanSweeney. I just need to tweak the JSON for my popups, but until the JSON exists in the map...well, it doesn't exist. I just want to stuff the default popupInfo > fieldInfos JSON in my map JSON and then be able to access and edit it. Note: for me, get_data() returns JSON but popupInfo and fieldInfos are not included. (I can verify they aren't in the map with ArcGIS Assistant, but are created when the popups are modified in the UI.)

achapkowski

Just a heads up for saved webmaps, you are going to be able to do this easier in ArcGIS API for Python v2.0.1.

Sean-Sweeney

Thanks Aaron. I'm using this on Feature Layers, and it works great as long as the Visualization for the layer has been edited already through the UI. For brand new just-published Feature Layers item.get_data() returns None. Is there a way through the Python API to "touch" the Visualization and create the backing JSON before running item.get_data()? I have over 150 layers to deal with so I don't want to have to update them all manually first.

JulieK

Thanks Earl, I was able to update the properties. 'layer_name' variable in line 5 threw me off. Searched for web map name and that worked!!

JulieK

Thanks for the blog, this might help me do what I want.

Using Python API, I am creating a webmap and adding a view to it. The view has three layers, and I want to configure the sequence of fields in each layer using json files.

I have created 3 json files based on all layer files in the webmap. can I update properties from json file as mentioned in your blog?

In your blog , in the first section 'update layer symbology in a webmap', in Line 5, are you searching for a layer in a webmap? it seems to list out feature services with the same name as the layer name in the web map. Please help!!.

LukasWürsch

Thanks a lot for your code, this is very helpful. I could make this work for normal Hosted Feature Layers. My problem is that I couldn't make it work for a Hosted Feature Layer View, because

item_data = item.get_data()

returns None, so I am not able to access 'fieldInfos'

Is this a general issue with Hosted Feature Layer Views or is there another way how I can configure the popup of these layers?

If necessary, I can provide an example layer to reproduce the issue. I would highly appreciate an answer.

Regards,

Lukas Würsch

EarlMedina

Hi Renaud,

This boils down to how the item is defined. For a good idea, see the second note in this post: https://community.esri.com/groups/arcgis-python-api/blog/2019/04/09/updating-layer-symbology-with-the-arcgis-api-for-python. My advice would be to create a Web Map as you want it to appear and then look at the definition.

-Earl

MaximeCampeau

Regarding this question, does anybody know if it is possible via Python to change the order in which the pop-ups appear in the menu? You can do it via the Web Interface, but I haven't found a way to do so with Python. Anyone has ever tried?

Anonymous User

When the I have an operational layer that is a map service layer, the "layers" property for that consistently misses many layers. I have one service that has 24 layers, and only 3 are returned. I thought maybe only the visible layers were being returned, or just the group layers, but neither is the case. Just 3 random layers are returned, all the rest totally ignored.

MapImageLayer will list all layers, but that is just the contents of the portal item associated with the map service, rather than the configured layer within the web map, which is what I wan't to get at.

Is there something I'm missing (probably)?

Thank you,

Randy

Anonymous User

This is great. Thank you. Where is this documented? This is the first I've seen of this particular functionality.

Thanks,

Randy

Anonymous User

Maybe I should start a different conversation, but our problem is that popups go away when overwriting a service from ArcGIS Pro, and we would like to automate the process of turning them back on (grr....).

This shows how to control which fields are displayed when the popups are turned on. Is it possible to enable popups programmatically?

Thank you,

Randy McGregor

NathanielEvatt

Cool, thanks very much guys

Anonymous User

You can accomplish this by editing the visibility property of each field. You can do something like this

web_map_obj <SPAN class="operator token">=</SPAN> WebMap<SPAN class="punctuation token">(</SPAN>wm_item<SPAN class="punctuation token">)</SPAN>
layer_1 <SPAN class="operator token">=</SPAN> web_map_obj<SPAN class="punctuation token">.</SPAN>layers<SPAN class="punctuation token">[</SPAN><SPAN class="number token">0</SPAN><SPAN class="punctuation token">]</SPAN>

<SPAN class="comment token">#turn off visibility of field 1 of layer 1</SPAN>
layer_1<SPAN class="punctuation token">.</SPAN>popupInfo<SPAN class="punctuation token">.</SPAN>fieldInfos<SPAN class="punctuation token">[</SPAN><SPAN class="number token">0</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">.</SPAN>visible <SPAN class="operator token">=</SPAN> <SPAN class="token boolean">False</SPAN>

<SPAN class="comment token"># update the web map</SPAN>
web_map_obj<SPAN class="punctuation token">.</SPAN>update<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>

Anonymous User

This is possible but there's no "popup" API for it. You can get the webmap json, then edit the popup properties in the json, then update the webmap.

See the webmap spec here: popupInfo | ArcGIS for Developers .

Code would be something like this (this hides every field in the popup):

import arcgis
import json

gis = arcgis.gis.GIS("https://arcgis.com", "username", "password")

item = gis.content.get("<item-id>")
item_data = item.get_data()
field_infos = item_data['operationalLayers'][0]['popupInfo']['fieldInfos']
for field in field_infos:
    field["visible"] = False

item_properties = {"text": json.dumps(item_data)}
item.update(item_properties=item_properties)

NeilAyres

I don't see anything in here to toggle visibility.

arcgis.mapping module — arcgis 1.4.0 documentation

Únete a la Conversación

Los miembros registrados pueden publicar, seguir actualizaciones y más. ¿Nuevo aquí? Regístrate gratis.

Enlaces Rápidos

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