topic Re: Does the default JavaScript API (v4) popup support related records? in ArcGIS JavaScript Maps SDK Questions

Does the default JavaScript API (v4) popup support related records?

GFlonk — Sun, 15 Oct 2017 12:42:59 GMT

I'm not sure if i'm overlooking things or this is not yet supported, but i'm curious if the default JavaScript API (v4) popup supports related records.

I have the following situation:

Hosted feature service on ArcGIS Online. In it three sublayers (trees, roads and vegetation). Each of the sublayers has a related table in which i store quality-inspection records (quality level, date of inspection and attachment-option). The relation is 1-m.
Hosted feature service is added to a webmap which is also stored on AGO.
In my custom front-end i created a mapView which loads the entire webmap at once (rather than adding all layer individually)
Map draws perfectly and the popup works, but does not show the related records. Related records are however visible and editable in collector, explorer and via webappbuilder (see screenshot).

Example in default JSAPI popup:

Example in Webappbuilder:

What i'm looking for is the option to add the functionality regarding the related records in the second screenshot to the situation in the first screenshot.

My question is twofold:

Is this supported by default and if yes, how do i turn it on?
If this is not a default option, how would one go about and custom create this functionality?

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Mon, 16 Oct 2017 13:00:23 GMT

Q1. No this is not supported by default.

Q2. You will need to use QueryTask executeRelationshipQuery

https://developers.arcgis.com/javascript/latest/api-reference/esri-tasks-QueryTask.html#executeRelationshipQuery

Once you get the featureSet results from the Query you will loop through the results and generate html markup to append to the popup widgets content properly. This is not going to be a simple one of two lines of code type customization.

Re: Does the default JavaScript API (v4) popup support related records?

GFlonk — Mon, 16 Oct 2017 16:25:25 GMT

Thanks for the response!

Too bad this functionality isn't default (this seems to be the case in the vanilla options within for example webappbuilder).

- - Some context:

I have played around with speaking to the queryRelated REST endpoint directly via hitTest, getting all related records and appending them to a custom popup (with html markup). With this there were two issues:

- Buggy peformance when hitting multiple features

- Identity manager didnt seem to cover the authentication when getting the attachmentURL(of the related record) and displaying it

-- End of context

With the suggested idea of using QueryTask. In order to perform a QueryTask one would need an OBJECTID for the current selected feature (correct me if i'm wrong). Is there any other way to do this other than using hitTest?

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Mon, 16 Oct 2017 16:36:57 GMT

WAB is a Highly customized app built on top of JS API (so not vanilla at all). You can borrow code from WAB if you want the file you are looking for is the jimu/RelatedRecordsPopupProjector.js

You can use the popup widgets selectedFeature property and then get the OID from the returned value.

https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html#selectedFeature

Re: Does the default JavaScript API (v4) popup support related records?

GFlonk — Mon, 16 Oct 2017 19:04:57 GMT

Vanilla might have been the wrong term there. The complexity of the sourcefile you linked is way beyond my understanding

The selectedFeature property looks like the thing I need. I was able to implement it partly. I'm now getting an object returned as the selectedFeature after an on-click action.

Two things:

- To get the current selected feature I would need some kind of event listener. view.on("click", function(event) doesn't seem like the right one.

- Trying to access the OBJECTID via view.popup.selectedFeature.attributes.OBJCTID gives me an error (also via data.getAttributes("OBJECTID")). How would one access this object?

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Mon, 16 Oct 2017 19:13:40 GMT

Is ObjectID part of the attributes in you console above?

Re: Does the default JavaScript API (v4) popup support related records?

GFlonk — Mon, 16 Oct 2017 19:28:01 GMT

Yes, see screenshot (erased some values in paint due to privacyreasons).

view.popup.selectedFeature.attributes also gives an error

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Mon, 16 Oct 2017 19:38:02 GMT

Sounds like a timing issue. The selected feature is undefined at the time when you attempt to get the attributes property. So you need to use WatchUtils to watch the popups selectedFeature property for being defined before you attempt to access the attributes property:

https://developers.arcgis.com/javascript/latest/api-reference/esri-core-watchUtils.html#whenDefined

Re: Does the default JavaScript API (v4) popup support related records?

GFlonk — Mon, 16 Oct 2017 20:58:51 GMT

This still gives strange results. Sometimes, when clicking one feature, I get a burst of console logs (some of which are null, often one more than the previous burst). Also view.popup.attributes still doesnt work. Feels indeed like a timing thing, as all the logs happen before the popup draws.

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Fri, 10 Dec 2021 23:38:39 GMT

There is not need to have the watch occur inside a view click event. Just add this after you create your view:

watchUtils.when(view.popup, "selectedFeature", function(evt){
  console.info(view.popup.selectedFeature.attributes);
});‍‍‍

Re: Does the default JavaScript API (v4) popup support related records?

GFlonk — Fri, 10 Dec 2021 23:38:42 GMT

Robert,

That worked like a charm! Thank you. I expanded a little bit on it and am now getting the related records as a response after selectedFeature changes:

The code I used (might not be pretty, but it works):

watchUtils.when(view.popup, "selectedFeature", function(evt){
     console.log(view.popup.selectedFeature);
     
     var url = view.popup.selectedFeature.layer.url;
     var layerId = view.popup.selectedFeature.layer.layerId;
     var fullURL = url + "/" + layerId;
     var objectID = view.popup.selectedFeature.attributes.OBJECTID;

     var queryTask = new QueryTask({
          url: fullURL
     });
     
     relationQuery = new RelationshipQuery({
          objectIds: [objectID],
          outFields: ["*"],
          relationshipId: 0
     });
     
     queryTask.executeRelationshipQuery(relationQuery).then(function(results){
          console.log(results)
     });
});
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Now what I've got to do is append this to the content property of the popup.

I'll keep this thread updated.

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Thu, 19 Oct 2017 04:46:22 GMT

I like to use dojo dom-construct for building html elements and then domConstruct.place to add them. You can use dojo query to get the infoWindow dim node to append to.

Re: Does the default JavaScript API (v4) popup support related records?

AnninaHirschiWyss — Mon, 02 Mar 2020 10:45:40 GMT

Is there a road map / timeline when editing related records will be possible with the JS API v4?

Thx

Jim Barry‌ or anyone else from the dev-team?

Re: Does the default JavaScript API (v4) popup support related records?

RobertScheitlin__GISP — Mon, 02 Mar 2020 13:20:39 GMT

Annina,

Just FYI Jim is not on the development team.

Re: Does the default JavaScript API (v4) popup support related records?

AnninaHirschiWyss — Mon, 02 Mar 2020 13:42:57 GMT

Thanks, Robert, I just took his name because he figures as responsible for this space. Maybe he can transfer the question to someone in charge 🙂

Re: Does the default JavaScript API (v4) popup support related records?

JimBarry — Wed, 11 Mar 2020 20:09:19 GMT

Sorry for the delay on this. Checking with the dev team to see what they say.

Re: Does the default JavaScript API (v4) popup support related records?

JimBarry — Wed, 11 Mar 2020 21:51:58 GMT

It's on our plan for 2020. Might not be the next release, but something being worked on.