topic PopupTemplate JavaScript promise for the contents is never being executed. in ArcGIS JavaScript Maps SDK Questions

PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 11:15:31 GMT

Summary:

My PopupTemplate JavaScript promise for the contents is never being executed.

My Requirements:

I am attempting to code a feature that will allow the user to click on a graphic in a Feature Layer and see a popup. We have integrated the map into our ASP.Net MVC web application using the JavaScript 4.5 API.

I have coded the popup in JavaScript as a Popup Template. When the user clicks on a graphic (that will represent a map pin-point), I need the code to do an (asynchronous) AJAX HTTP GET to an endpoint in order to retrieve a JSON object. The object will contain some data that will be displayed in the popup.

I have assigned the 'content' property of my PopupTemplate to my JavaScript function that returns a promise.

My Problem:

It appears that the promise is never being executed, as breakpoints in my code within the promise are never hit.

I have tried several ways to code the promise with no success. I am using esriRequest to actually do the AJAX GET, and returning the promise from this as the function assignment. Please see my attached code.

I think the JavaScript API is just executing my function and ignoring the promise that I am returning.

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AshrafDar — Wed, 06 Dec 2017 12:13:57 GMT

Hi Andrew,

Are you adding esriRequest as AMD? because cannot see the esriRequest module is loaded anywhere in your code.

Also is the code before esriRequest executing?

Regards,

Mohammad Ashraf

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 13:35:57 GMT

Further up in the code (not uploaded to you) I am loading the esriRequest as follows:

require([
"esri/Map",
...
"esri/request",
"dojo/Deferred"
], function (Map, ... esriRequest, Deferred) {

The esriRequest and Deferred objects are in-scope to the functions I have uploaded to you.

The code before the esriRequest is executing ok (each time that the user clicks a map point / graphic).

Re: PopupTemplate JavaScript promise for the contents is never being executed.

RobertScheitlin__GISP — Sun, 12 Dec 2021 05:19:53 GMT

Andrew,

You can try using otherwise to see if the esriRequest is failing:

  esriRequest(url, options).then(function(response) {
    // do something useful
  }).otherwise(function(error){
    console.log("informative error message: ", error.message);
  });‍‍‍‍‍‍‍‍‍‍

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AshrafDar — Wed, 06 Dec 2017 13:53:56 GMT

Hi Andrew,

Could you add failure callback and log the message returned.

Regards,

Mohammad Ashraf

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 14:06:13 GMT

Thanks for your responses.

I have tried the exact block of code above with 'otherwise' and neither the 'then' nor the 'otherwise' are ever called. No request is actually made (according to the Chrome Network tab). It seems that the code that calls my function (buried in the API) never calls the promise I am returning (as far as I can see).

Re: PopupTemplate JavaScript promise for the contents is never being executed.

RobertScheitlin__GISP — Sun, 12 Dec 2021 05:19:56 GMT

Andrew,

Based on this sample: https://developers.arcgis.com/javascript/latest/sample-code/sandbox/index.html?sample=popuptemplate-promise

The esriRequest is a Promise return type so you need to do something like this:

function setPopupContent(target) {
  var locationId = target.graphic.attributes.ObjectID;
  var url = urlGetLocationExtendedPointsData + '/' + locationId;
  var options = {
    query: {
      f: 'json'
    },
    responseType: 'json'
  };

  return esriRequest(url, options).then(function(response) {
    // THIS CODE IS NEVER EXECUTED!
    var source = $("#map-popup-content-template").html();
    var template = Handlebars.compile(source);
    var context = { RiskQualityChartTitle: "Chart title" }
    var html = template(context);
  });
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 14:33:06 GMT

I have just tried setting the block to be as below:

function setPopupContent(target) {
var locationId = target.graphic.attributes.ObjectID;
var url = urlGetLocationExtendedPointsData + '/' + locationId;
var options = {
query: {
f: 'json'
},
responseType: 'json'
};

return esriRequest(url, options).then(function (response) {
// THIS CODE IS NEVER EXECUTED!
var source = $("#map-popup-content-template").html();
var template = Handlebars.compile(source);
var context = { RiskQualityChartTitle: "Chart title" }
var html = template(context);
return html;
});
}

The block starting 'THIS CODE IS NEVER EXECUTED' is still never executed, with no message appearing in the console.

Re: PopupTemplate JavaScript promise for the contents is never being executed.

RobertScheitlin__GISP — Sun, 12 Dec 2021 05:19:59 GMT

Andrew,

I would try making your code more like the sample as far as defining the popupTemplate when you create the layer:

        // USA counties layer
        var countiesLayer = new FeatureLayer({
          url: "https://services.arcgis.com/P3ePLMYs2RVChkJx/ArcGIS/rest/services/USA_Counties/FeatureServer/0",
          outFields: ["*"],
          minScale: 0,
          maxScale: 0,
          renderer: null,
          // create a new popupTemplate for the layer
          popupTemplate: { // autocasts as new PopupTemplate()
            title: "County of {NAME}",
            content: queryBlockGroups
          }
        });‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 15:46:14 GMT

I have just tried this - and there is no difference. Thanks anyway. Any other suggestions?

Re: PopupTemplate JavaScript promise for the contents is never being executed.

RobertScheitlin__GISP — Wed, 06 Dec 2017 15:49:06 GMT

Andrew,

Have you tried to change the setPopupContent function to just return some simple string (just for testing)?

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 15:52:29 GMT

Yes, it works fine when it is just a simple function that returns some HTML. I am having this problem because I want to do an async request. In this scenario, there does not seem to be a way to get the API to actually execute the promise that I am returning.

Re: PopupTemplate JavaScript promise for the contents is never being executed.

RobertScheitlin__GISP — Wed, 06 Dec 2017 16:01:04 GMT

Andrew,

That is strange because the sample I linked to is using a promise.

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 16:07:12 GMT

Is there any difference between the promise returned from

return queryBlocksTask.execute(query).then(function(result)

and

return esriRequest(url, options).then(function (response)

Re: PopupTemplate JavaScript promise for the contents is never being executed.

RobertScheitlin__GISP — Wed, 06 Dec 2017 16:12:06 GMT

Yes, that is very likely it all depends on that the service is returning and how it it returning it. Have you tested just doing the esriRequest somewhere else in your code like just adding it to the main code block so you can debug if the request is ever working?

Re: PopupTemplate JavaScript promise for the contents is never being executed.

AndrewPage1 — Wed, 06 Dec 2017 16:53:10 GMT

I have got it working by reverting back to using JQuery:

function setPopupContent(target) {
var locationId = target.graphic.attributes.ObjectID;
var url = urlGetLocationExtendedPointsData + '/' + locationId;

   return $.get(url).then(function(data) {
      var source = $("#map-popup-content-template").html();
      var template = Handlebars.compile(source);
      var context = { RiskQualityChartTitle: data.SiteName }
      var html = template(context);

return html;
});
}

For some reason the esriRequest was not working. Thanks for your help anyway.

Re: PopupTemplate JavaScript promise for the contents is never being executed.

BrandonFlessner — Mon, 19 Mar 2018 19:53:27 GMT

This behavior (or lack thereof) also exists at 4.6 bug 4.x esrirequest popuptemplate