topic Re: Making runtime featureLayers register as datasources for select widget in ArcGIS Experience Builder Questions

Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Wed, 15 May 2024 20:15:18 GMT

I am loading my map layers at runtime through a custom widget. Everything is configured as desired in Developer Edition 1.12. Now, I am upgrading to 1.14 primarily for the access to the Select Widget and the Add to Table Data Action.

Adding a data layer with the OOTB Add Data widget will make the layer selectable in the Select Widget, but layers loaded from my custom widget are not available in the Select Widget.

How can I get the Select Widget to recognize the added data? Bonus points, if the Map Layers Widget will also show the Add To Table option.

@Wei_Ying Would creating a client side data source be picked up by the Select Widget? https://github.com/Esri/arcgis-experience-builder-sdk-resources/tree/master/widgets/client-side-output Can a single widget have multiple output datasources?

Looking through the code for the Add Data Widget I found these lines.

const dataSourcesChangeMessage = new DataSourcesChangeMessage(widgetId, DataSourcesChangeType.Create, dataSources) MessageManager.getInstance().publishMessage(dataSourcesChangeMessage)

Could publishing a message similar to this trigger the Select Widget to find the layers?

Re: Making runtime featureLayers register as datasources for select widget

Wei_Ying — Wed, 15 May 2024 21:21:48 GMT

@TonghuiMing any comment on this question?

Re: Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Fri, 28 Jun 2024 14:15:16 GMT

I've thought about and researched this question the best that I can over the past month and I keep coming back to the same issue. I need to take the REST endpoint of a FeatureLayer and have it be recognized by Experience Builder as a valid datasource. I know Experience Builder is capable of this, but I don't know how to do it.

I've looked at the sever/client side data source widget samples, but they presuppose an already existing datasource to create from. https://github.com/Esri/arcgis-experience-builder-sdk-resources/tree/master/widgets/server-side-output

My widget would also need to output an arbitrary number of datasources which presumably the Add Data Widget is capable of, but is not shown in any code samples.

Re: Making runtime featureLayers register as datasources for select widget

YueyangLi — Wed, 03 Jul 2024 03:15:23 GMT

@JeffreyThompson2 You can generate multiple output data sources in your widget. If you do not know the number and schema of the data sources your widget needs to generate in your settings, I recommend you look through the Add Data widget.

Please see the createDataSourcesByDataOptions method in the add-data/src/runtime/utils.ts.

1. Prepare the FeatureLayerDataSourceConstructorOptions. Pass the layer to let the created data source query via it. The layer can be client-side or server-side Maps SDK feature layer. Pass the dataSourceJson to let the data source manager know the definition of the data source, including id, type, label, url, itemId, portalUrl, layerId (e.g. '0', '1') and geometryType (e.g. 'esriGeometryPoint', 'esriGeometryPolyline').

2. Create data sources by DataSourceManager.getInstance().createDataSource(options).

3. Publish the message you mentioned above if you want the add-to-map, pan-to, and zoom-to message actions of the map widget (also need to declare your widget publish messages in the manifest, by adding "publishMessages": ["DATA_SOURCES_CHANGE"]). If you only need data actions, you do not need to do it.

Re: Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Fri, 05 Jul 2024 15:24:07 GMT

Thanks to your suggestions I have a block of code that completes without error and the DataSourceManager indicates that the layers have been accepted as valid datasources. However, the Select Widget still does not acknowledge them and the full list of data actions is not visible.

mapLayer = new FeatureLayer({ url: layerGroup.layers[i].url, id: layerGroup.layers[i].id }) setTimeout(() => { console.log(mapLayer.sourceJSON) const data: DataSourceJson = { id: 'custom_' + layerGroup.layers[i].id, itemId: layerGroup.layers[i].id, url: layerGroup.layers[i].url, type: 'FEATURE_LAYER', geometryType: mapLayer.sourceJSON["geometryType"], label: mapLayer.title } const dataJson = Immutable(data) const dataSourceOptions = { id: layerGroup.layers[i].id, layer: mapLayer, dataSourceJson: dataJson } console.log(dataSourceOptions) const dataSource = DataSourceManager.getInstance().createDataSource(dataSourceOptions) dataSource.then((source) => { //map layers widget const messageLayer = new DataSourcesChangeMessage('widget_30', DataSourcesChangeType.Create, [source]) MessageManager.getInstance().publishMessage(messageLayer) //select widget const message = new DataSourcesChangeMessage('widget_63', DataSourcesChangeType.Create, [source]) MessageManager.getInstance().publishMessage(message) }) console.log(DataSourceManager.getInstance()) }, 3000)

Console log of DataSourceManager.GetInstance()

The only actions I am getting are the same ones I saw adding the layers to the map using the JS SDK methods.

I have added the publishMessgaes statement to my manifest.json.

{ "name": "add-remove-layers", "type": "widget", "version": "1.11.0", "dependency": ["jimu-arcgis"], "exbVersion": "1.11.0", "author": "Jeffrey Thompson", "description": "Loads or removes sets of data by groups or individual layers", "copyright": "City of Arlington", "license": "", "properties": {}, "translatedLocales": [ "en" ], "defaultSize": { "width": 800, "height": 500 }, "publishMessages": ["DATA_SOURCES_CHANGE"] }

What am I missing? @YueyangLi @Wei_Ying @TonghuiMing

Re: Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Tue, 09 Jul 2024 18:29:54 GMT

The DataSourcesChange message did not work, but I got something functional with the JimuMapView.addRemoveDataOnMap() method.

setTimeout(() => { console.log(mapLayer.sourceJSON) const data: DataSourceJson = { id: 'custom_' + layerGroup.layers[i].id, layerId: `${mapLayer.sourceJSON["id"]}`, itemId: layerGroup.layers[i].id, url: layerGroup.layers[i].url, type: 'FEATURE_LAYER', geometryType: mapLayer.sourceJSON["geometryType"], label: mapLayer.title, portalUrl: 'url' } const dataJson = Immutable(data) const dataSourceOptions = { id: layerGroup.layers[i].id, layer: mapLayer, dataSourceJson: dataJson } console.log(dataSourceOptions) const dataSource = DataSourceManager.getInstance().createDataSource(dataSourceOptions) dataSource.then((source) => { console.log(source) const sourceId = source.id const addMapData: AddToMapData = { mapWidgetId: 'widget_9', messageWidgetId: 'widget_33', jimuMapViewId: jimuMapView.id, dataSourceId: sourceId, type: ActionType.MessageAction, title: 'Add Data', dataChangeType: DataChangeType.Create, dataChangeStatus: DataChangeStatus.Fulfilled } console.log(addMapData) mapDatas[sourceId] = addMapData setTimeout(() => { jimuMapView.addOrRemoveDataOnMap(mapDatas) }, 50) }) }, 3000)

Re: Making runtime featureLayers register as datasources for select widget

YueyangLi — Thu, 11 Jul 2024 08:49:47 GMT

@JeffreyThompson2, sorry for the late reply.

The DataSourcesChange is a message action, that must be configured in the widget settings (builder).

If you want an action to add the new layer data source to the map widget in runtime, you can use the DataActionList component like AddData widget. The select widget can use the new layer data source after doing that. The component will calculate the supported data actions based on the added widgets and show a dropdown list.

I'm glad you have found a workaround. But if you want to use the DataActionList and have other issues, you can reply there.

Re: Making runtime featureLayers register as datasources for select widget

MohammedHilal_K — Wed, 09 Oct 2024 08:54:53 GMT

hi @YueyangLi
I followed your suggestion and it is working fine. I could able to get the data actions like zoom to , pan to etc. But the thing is I need to reorder the layer, the polygon has to go bottom and point on top and line on bottom. When I reorder he layer using view.map.reorder(), am losing the data actions. any help on that?

Re: Making runtime featureLayers register as datasources for select widget

QunSun — Wed, 09 Oct 2024 09:30:17 GMT

Hi @MohammedHilal_K ,

Are there any errors in the browser console? Which data actions are missing? Is it only zoom to and pan to that are missing, or are they all missing? It would be great if you could upload a screenshot of the data actions.

Re: Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Wed, 09 Oct 2024 12:09:35 GMT

https://community.esri.com/t5/arcgis-experience-builder-questions/loss-of-runtime-created-datasource-functionality/m-p/1541505#M15032

This is a documented bug in Experience Builder 1.15. It is not a problem in 1.14.

Re: Making runtime featureLayers register as datasources for select widget

MohammedHilal_K — Wed, 09 Oct 2024 16:23:48 GMT

Hi @QunSun
Am attaching the screenshots. Only zoom to/hide label data action is available after reordering the layers.

Before re-order

after re-order.

Re: Making runtime featureLayers register as datasources for select widget

MohammedHilal_K — Wed, 09 Oct 2024 16:26:20 GMT

Hi @JeffreyThompson2 @QunSun
Am developing custom widget like 'AddData'. So is there any solution to fix this? like updating DataSource again or any other methods?

Re: Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Wed, 09 Oct 2024 18:33:42 GMT

@MohammedHilal_K Currently, the only workaround is to use Developer Edition 1.14 which does not have this bug.

Re: Making runtime featureLayers register as datasources for select widget

QunSun — Thu, 10 Oct 2024 01:27:59 GMT

@MohammedHilal_K

Thanks for providing more details. This is a bug and will be fixed in next release.

Re: Making runtime featureLayers register as datasources for select widget

MohammedHilal_K — Mon, 14 Oct 2024 09:02:35 GMT

@JeffreyThompson2 @QunSun

In my custom widget, I'm trying to add multiple layers to the map using the jimuMapView.addOrRemoveDataOnMap(mapData) method. I'm looping through an array and passing mapData to addOrRemoveDataOnMap(). However, the layers are not maintaining the order that I provide.

For example, if the order in my array is [layer1, layer2, layer3], the layers are added to the map in an inconsistent order, like [layer2, layer1, layer3]. Additionally, addOrRemoveDataOnMap does not return a promise, which means I can't use await to control the sequence.

Any suggestions on how to address this issue?

Note: I've also tried passing the complete array to addOrRemoveDataOnMap(mapDatas), but I'm still facing the same issue.

Re: Making runtime featureLayers register as datasources for select widget

JeffreyThompson2 — Mon, 14 Oct 2024 12:37:53 GMT

https://community.esri.com/t5/experience-builder-custom-widgets/add-remove-layers-2-0/ta-p/1540096

I dealt with this problem by building a re-ordering function inside a setTimeout() function.

Re: Making runtime featureLayers register as datasources for select widget

MohammedHilal_K — Fri, 18 Oct 2024 05:41:17 GMT

Hi@JeffreyThompson2 @QunSun @YueyangLi @Wei_Ying

When I add a map service in the above context, the popup does not appear. However, the popup works for feature layers and groups. Any help on this?
Note: If the same map service is configured in Map widget while initial load, that time pop up works.

Re: Making runtime featureLayers register as datasources for select widget

YueyangLi — Fri, 18 Oct 2024 07:22:09 GMT

@MohammedHilal_K Are you referring to the data action popup? Most data actions (such as export and add to table) are available only for data sources that support queries. Map service data sources do not support queries in ExB.

Re: Making runtime featureLayers register as datasources for select widget

MohammedHilal_K — Fri, 18 Oct 2024 08:37:56 GMT

@YueyangLi
I am referring to the attribute info popup. The DataActions (export & add to table) are working fine, but when we directly click on the map service, the attribute info popup does not display. I have observed this issue even with the out-of-the-box ‘AddData’ widget as well

Re: Making runtime featureLayers register as datasources for select widget

YueyangLi — Fri, 18 Oct 2024 09:37:45 GMT

@MohammedHilal_K I was able to reproduce the issue and have logged it. Thank you for raising this issue!