Using popupElement for Arcade Content

Brian_McLeer — Fri, 16 Aug 2024 19:59:44 GMT

I am trying to batch-update multiple layers to all have the same Arcade content applied. I have found documentation on using a combination of Attribute Expressions / Text elements, but for the particular Arcade I am using, it only functions correctly if Arcade content is applied.

I have looked through the developer documentation and it does not appear to call out Arcade as a popupElement supported function.

Here is my current code, but ultimately I would like to remove the Attribute Expression and Text element and use Arcade as this works for hyperlinking out to URLs.

from arcgis.gis import GIS from arcgis.mapping import WebMap # Step 1: Connect to the Portal gis = GIS("https://portal.website.com/portal/", "username", "password") # Step 2: Access the Web Map webmap_item = gis.content.get("itemid") webmap = WebMap(webmap_item) # Function to clean popupInfo, remove attribute expressions, text boxes, and fields list def clean_popup(layer): # Update the layer title to remove ":" and references to "fields" if "title" in layer: original_title = layer["title"] new_title = original_title.replace(':', '').replace('fields', '', 1).strip() layer["title"] = new_title if original_title != new_title: print(f"Updated layer title from '{original_title}' to '{new_title}'") # Clean the popupInfo to remove attribute expressions, fields list, and text boxes if "popupInfo" in layer: popup_info = layer["popupInfo"] # Clear popupElements to remove Fields list, text elements, and any other custom elements popup_info["popupElements"] = [] # Remove fieldInfos and attribute expressions (expressionInfos) completely popup_info.pop("fieldInfos", None) popup_info.pop("expressionInfos", None) # Removes any existing attribute expressions # Remove other potential field-related properties field_related_keys = ['displayField', 'description', 'showAttachments', 'mediaInfos'] for key in field_related_keys: popup_info.pop(key, None) print(f"Cleaned popupInfo for layer: {layer.get('title', 'Unnamed Layer')}") # Function to add an Arcade attribute expression and reference it in a text element def add_arcade_expression_as_text(layer): if "popupInfo" in layer: popup_info = layer["popupInfo"] # Define the Arcade attribute expression arcade_expression = { "name": "customContent", "title": "Custom Content", "expression": """ var fieldsToExclude = ["OBJECTID", "OBJECTID_1", "SHAPE", "LAYERNAME", "GLOBALID", "SHAPE.STAREA()", "SHAPE.STLENGTH()", "CREATED_USER", "CREATED_DATE", "LAST_EDITED_USER", "LAST_EDITED_DATE", "LASTMODBY", "LASTMODDATE", "LASTSYNDATE"]; var content = ""; var seenUrls = {}; function formatURL(label, value) { return label + ": <a target='_blank' href='" + value + "'>Click here for more info.</a>"; } Expects($feature, "*"); var schemaDict = Schema($feature); var fieldsArray = schemaDict["fields"]; function getFieldAlias(fieldName) { for (var j = 0; j < Count(fieldsArray); j++) { var fieldDict = fieldsArray[j]; if (fieldDict['name'] == fieldName) { return fieldDict['alias']; } } return fieldName; } function formatDate(dateValue) { var date = Date(dateValue); return Text(date, "MM/DD/YYYY"); } function getDomainDescription(fieldDict, value) { if (HasKey(fieldDict, "domain")) { var domain = fieldDict["domain"]; if (domain != null && HasKey(domain, "codedValues")) { for (var k = 0; k < Count(domain["codedValues"]); k++) { var codedValue = domain["codedValues"][k]; if (codedValue["code"] == value) { return codedValue["name"]; } } } } return value; } for (var i = 0; i < Count(fieldsArray); i++) { var fieldDict = fieldsArray[i]; var fieldName = fieldDict["name"]; var alias = fieldDict["alias"]; var value = $feature[fieldName]; if (IndexOf(fieldsToExclude, Upper(fieldName)) == -1 && !IsEmpty(value) && Upper(Text(value)) != "NULL") { if (Upper(Left(Text(value), 7)) == "HTTP://" || Upper(Left(Text(value), 8)) == "HTTPS://") { if (!HasKey(seenUrls, value)) { content += formatURL(alias, value) + "\\n"; seenUrls[value] = true; } } else if (fieldDict.type == "esriFieldTypeDate") { content += alias + ": " + formatDate(value) + "\\n"; } else if (HasKey(fieldDict, "domain") && fieldDict["domain"] != null) { var domainDescription = getDomainDescription(fieldDict, value); content += alias + ": " + Text(domainDescription) + "\\n"; } else { content += alias + ": " + Text(value) + "\\n"; } } } return content; """ } # Add the Arcade expression to the expressionInfos if "expressionInfos" not in popup_info: popup_info["expressionInfos"] = [] popup_info["expressionInfos"].append(arcade_expression) # Reference the Arcade expression in a text element text_element = { "type": "text", "text": "{expression/customContent}" } # Add the text element to the popupElements popup_info["popupElements"].append(text_element) print(f"Added Arcade expression as a text element to layer: {layer.get('title', 'Unnamed Layer')}") # Recursive function to process all layers, including nested layers def process_layers(layers): for layer in layers: clean_popup(layer) add_arcade_expression_as_text(layer) # Process sublayers if the layer is a group if "layers" in layer: print(f"Processing sublayers of group layer: {layer.get('title', 'Unnamed Layer')}") process_layers(layer["layers"]) # Step 3: Process all layers, including those within group layers process_layers(webmap.layers) # Step 4: Save the updated Web Map webmap.update() print("All attribute expressions, fields lists, and text boxes removed, titles updated, and Arcade content added as a text element.")

When I apply the below in an Arcade content section, the hyperlinks work. Whereas if I do it in an Attribute Expression and Text content, everything but the hyperlink works.

Re: Using popupElement for Arcade Content

Clubdebambos — Fri, 24 Jan 2025 11:09:29 GMT

Hi @Brian_McLeer

Seems like you were very close. The expressions element is the Arcade element that you see in the documentation.

My go to is to do it manually in a WebMap and then grab the JSON from the definition for that layer. In your instance you only want an expression element in your popupElements that reflects your Arcade.

## API version 2.4.0 (will work for previos versions too) from arcgis.gis import GIS import json ## Access ArcGIS Online agol = GIS("home") ## get the WebMap Item object wm_item = agol.content.get("WM_ITEM_ID") ## get teh WebMap definition wm_item_data = wm_item.get_data() ## get teh definition for the layer of interest ## example below: the first layer [0] lyr = wm_item_data["operationalLayers"][0] ## print the definition for that layer to screen. ## you are interested in the "popupInfo" print(json.dumps(lyr, indent=4))

Example:

"popupInfo": { "popupElements": [ { "type": "expression", "expressionInfo": { "title": "My Arcade Expression", "expression": "var display = Concatenate($feature.Name, \" \", $feature.Score);\n\nreturn { \n\ttype : 'text', \n\ttext : display\n}", "returnType": "dictionary" } } ], "fieldInfos": [ { "fieldName": "OBJECTID", "isEditable": false, "label": "OBJECTID", "visible": false }, { "fieldName": "Name", "isEditable": true, "label": "Name", "visible": true }, { "fieldName": "ORIG_FID", "format": { "digitSeparator": true, "places": 0 }, "isEditable": true, "label": "ORIG_FID", "visible": true }, { "fieldName": "Score", "isEditable": true, "label": "Score", "visible": true } ], "title": "TEST_LAYER: {Name}" }

I'm really only interested in the popupElements as I only want an Arcade expression controlling the Popup.

from arcgis.gis import GIS ## Access ArcGIS Online agol = GIS("home") ## the popupElements to use in Popups ## One element below, the Arcade Expression popupElements = [ { "type": "expression", "expressionInfo": { "title": "My Arcade Expression", "expression": "var display = Concatenate($feature.Name, \" \", $feature.Score);\n\nreturn { \n\ttype : 'text', \n\ttext : display\n}", "returnType": "dictionary" } } ] ## get the WebMap Item object wm_item = agol.content.get("WM_ITEM_ID") ## get the WebMap definition wm_item_data = wm_item.get_data() ## apply the popupElements to the specific layer. wm_item_data["operationalLayers"][0]["popupInfo"]["popupElements"] = popupElements ## update the WebMap item objecy update_definition = {"text" : wm_item_data} wm_item.update(update_definition)

I hope that helps,

Glen

Re: Using popupElement for Arcade Content

Brian_McLeer — Tue, 04 Feb 2025 15:21:37 GMT

@Clubdebambos thank you for the feedback, I will review this over the next few weeks and let you know if I have any luck. After I made this post, I made a support case and Esri noted that it is not a functionality yet in the Python API for Arcade elements but may be in the future.

topic Re: Using popupElement for Arcade Content in ArcGIS API for Python Questions

Using popupElement for Arcade Content

Re: Using popupElement for Arcade Content

Re: Using popupElement for Arcade Content