topic Re: JSAPI 3.29 - customTextElements supported? in ArcGIS JavaScript Maps SDK Questions

JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Sat, 11 Dec 2021 17:26:54 GMT

First off, are customTextElements even supported in API 3.29? I have a Print dijit set up (code below) but I can't seem to get the customTextElements to show up on my layout. The customTextElements come directly from the Get Layout Templates Info Execute task. I would really like to be able to pass an array that is defined in PHP but the print keeps timing out. I swapped the arrays to just the letter "t" to see if that would work and again, it's timing out. I see that customTextElements are listed under the layoutOptions but you can't pass DynamicText? I am looking to display attribute information for the feature that is being printed by a URL parameter (ID) on the layout template.

  // print dijit
      var printer = new Print({
          map: theMap,
          url: "<server>",
          templates: [{
            label: "Map",
            format: "PDF",
            layout: "TREATMENTS",
            layoutOptions: {
              customTextElements: [
                  {"Target": "t"},
                  {"Date": "t"},
                  {"EPA": "t"},
                  {"Chemical": "t"},
                  {"Weather": "t"},
                  {"Title": "t"},
                  {"Year": "t"}
                ]
            },
            exportOptions: {
              width: 772,
              height: 772,
              dpi: 200
            }
          }]
      }, dom.byId("printButton"));
      printer.startup();
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Sat, 11 Dec 2021 17:26:57 GMT

Claire,

Sure they absolutely work for me in 3.29.

var templates = [{
        label: "jpg with info",
        format: "jpg",
        showAttribution: true,
        layout: "Letter ANSI A Landscape",
        exportOptions: {
          "dpi": 96
        },
        layoutOptions: {
          copyrightText: "",
          customTextElements: [{
            StreetAdd: "Street Address: 123 lone st"
          },{
            ParcelNum: "Parcel Num: 121345698"
          },{
            PPIN: "PPIN: 1234"
          },{
            OwnerName: "Owners Name: Me"
          }]
        }
      }];

      // print dijit
      app.printer = new Print({
        "map": app.map,
        "templates": templates,
        url: "my custom print service url"
      }, dojo.byId("printButton"));
      app.printer.startup();‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Mon, 12 Aug 2019 12:35:59 GMT

Robert Scheitlin, GISP - do you have to 'hard code' the text for the customTextElements or can you pass variables or certain attributes from the feature being printed?

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Mon, 12 Aug 2019 12:39:24 GMT

I am using variables in my code.

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Mon, 12 Aug 2019 12:45:17 GMT

Robert Scheitlin, GISP I'm still a bit of a novice with this so forgive me. How are you passing the variables to the text boxes on your layout?

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Mon, 12 Aug 2019 13:06:14 GMT

Using the code I provided above instead of :

StreetAdd: "Street Address: 123 lone st"

I just substitute the "Blah Blah" with some variable.

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Mon, 12 Aug 2019 13:17:38 GMT

Robert Scheitlin, GISP‌ Ah okay - I was under the assumption that this text was hard coded so that is why I was a bit confused. I've seen examples using the customTextElements but I don't believe I have seen any with variables being called.

Can you use something like $array[0] if you have everything defined or does it have to be formatted a certain way?

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Mon, 12 Aug 2019 13:40:06 GMT

Claire,

Are you saying that you do not know what the customTextElements are to begin with? You have me a little confused here. It seems you might be over complicating this.

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Mon, 12 Aug 2019 13:51:21 GMT

Robert Scheitlin, GISP‌ Sorry to confuse you, that is certainly not my intention. More than likely that is exactly what I am doing - I have been at this for 3, almost 4 weeks so I have been reading a lot of material and probably confusing myself.

So what I have is a custom print service that I published. Below is a screen shot with a few elements removed. It has a some text boxes (where it says empty) that I would like to have only certain attribute information appear on the printout. I do not have data driven pages enabled because there are no layers in this template (just wanted to create something nice for the printout). I currently have the attribute information working as a PHP array where it captures the information I need from the ID in the URL and prints it into an html div but I have not been able to figure out how to get that same information and place it on this layout.

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Sat, 11 Dec 2021 17:27:00 GMT

Claire,

So when I go to my custom print service and execute "get layout Template Info" Task I get results like this:

{
 "results": [
  {
   "paramName": "Output_JSON",
   "dataType": "GPString",
   "value": [
  {
    "layoutOptions":  {
      "hasAuthorText":  false,
      "hasCopyrightText":  false,
      "hasTitleText":  false,
      "hasLegend":  false,
      "customTextElements":  [{
          "StreetAdd":  " "
       }, {
          "ParcelNum":  " "
       }, {
          "PPIN":  " "
       }, {
          "OwnerName":  " "
       }]
     },
    "pageSize":  [
      11.0,
      8.5
     ],
    "layoutTemplate":  "Letter ANSI A Landscape",
    "activeDataFrameSize":  [
      10.0,
      6.25
     ]
    },
...‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

So then I use the code I originally posted to populate those customTextEelements.

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Sat, 11 Dec 2021 17:27:03 GMT

Robert Scheitlin, GISP‌

Similar to what I see as well but I am still a bit confused as to how those elements "pick up" the attribute information. Also it seems like whenever I add the customTextElements to my code, the print service times out.

The year seems to work just fine with <dyn type="date" format="yyyy"> in the properties but as soon as I add something like this to the other text boxes, they don't show up in the Execute Task information. Though I could be typing in something incorrect.

{
 "results": [{
  "paramName": "Output_JSON",
  "dataType": "GPString",
  "value": [{
   "layoutOptions": {
    "hasAuthorText": false,
    "hasCopyrightText": false,
    "hasTitleText": false,
    "hasLegend": true,
    "customTextElements": [
     {"Weather": ""},
     {"EPA": ""},
     {"Chemical": ""},
     {"tmDate": ""},
     {"Target": ""},
     {"Site": ""},
     {"Year": ""}
    ]
   },
   "pageSize": [
    11.0,
    8.5
   ],
   "layoutTemplate": "TREATMENTS",
   "activeDataFrameSize": [
    8.7866,
    7.3068
   ]
  }]
 }],
 "messages": []
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Sat, 11 Dec 2021 17:27:05 GMT

Claire,

So here is your layout info mixed in with my code:

var templates = [{
        label: "Map",
        format: "PDF",
        showAttribution: true,
        layout: "TREATMENTS",
        exportOptions: {
          "dpi": 96
        },
        layoutOptions: {
          copyrightText: "",
          customTextElements: [{
            Weather: "blah"
          },{
            EPA: "blah"
          },{
            Chemical: "blah"
          },{
            tmDate: "blah"
          },{
            Target: "blah"
          },{
            Site: "blah"
          },{
            Year: "blah"
          }]
        }
      }];

      // print dijit
      VAR printer = new Print({
        map: theMap,
        templates: templates,
        url: "your custom print service url"
      }, dojo.byId("printButton"));
      printer.startup();‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Mon, 12 Aug 2019 15:42:17 GMT

Robert Scheitlin, GISP‌ It still keeps timing out whenever I incorporate the customTextElements. As soon as I comment that section out - the print works.

Also - the "blah" is embedded into the code so it would print out blah in every box, correct? How would you print out certain attributes associated with the object being printed?

Re: JSAPI 3.29 - customTextElements supported?

RobertScheitlin__GISP — Mon, 12 Aug 2019 16:41:59 GMT

Claire,

Hmm.. So that should work just fine and print "blah" in each of the fields. I am not sure why your print service is timing out. You can check your ArcGIS Server Logs to see if there is a clue there. Getting certain attributes associated with the object being printed varies. If it is a certain feature of a certain layer that is selected/highlighted then you have to go to that layer in code and get the selected feature and then that features attributes and assign those attribute variables to the code block I provided.

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Mon, 12 Aug 2019 17:49:24 GMT

Thank you Robert - I will look into the logs to see if I can figure out what is going on. I certainly appreciate your time helping me with this matter.

Re: JSAPI 3.29 - customTextElements supported?

Anonymous User — Tue, 13 Aug 2019 02:00:35 GMT

Hi Claire,

It seems you have multiple issues encountering for this at the moment.

I believe

1. you want to achieve multiple printing from the array variable input.

2. Currently you are encountering time out issue

3. You can't pass your variable data into print param

So lets do it one step by another

Let solve item 2 first by going to developer mode in the browser about the print task request,

1. Check how long does it take and what is the return

If it is really timeout and if you are using arcgis server for windows with IIS web adapter. You might want to increase the request timeout by changing web.config. (executionTimeout to be increased)

Below is the sample -

<system.web>

</system.web>

</configuration>

Next step : Please solve item 3, pass the variable and test, check the parameters and print template

Last one : you might need to use deferred and promise dojo object to run print task paralleled.

Re: JSAPI 3.29 - customTextElements supported?

Claire_Peterson — Thu, 22 Aug 2019 19:51:20 GMT

Hi Than Aung‌, thank you for your reply! We had started to go a different direction to see if using the REST API could accomplish something similar to what we have been looking for but we have not made much progress - so we are headed back down the API for JavaScript route. I will have to dig a little deeper into the time out information, we decided to implement a simple print button that opens the generic Windows print screen to save to PDF for the time being so some sections of the code need to be uncommented to test.

I seem to still be a bit lost on passing the variables - in my php code they are $array[#] with the # representing the different columns. I could potentially capture them from the actual feature layer using something similar to graphic.attributes.<attribute name>

For the template I had published there doesn't seem to be much information on what exactly needs to be in the text box or are they kept empty? I usually only see the window that shows the spot to type in the element name.

Thank you for the information about the deferred and promise dojo object - I will have to take another look at this.

Re: JSAPI 3.29 - customTextElements supported?

Anonymous User — Fri, 23 Aug 2019 01:39:10 GMT

Hi Claire,

For parameter passing issue, how about try and use the postman and manually pass the value and test first.

Best Regards,