topic Re: Extending the Print Widget in Web AppBuilder Custom Widgets Questions

Extending the Print Widget

DamonMyers — Wed, 20 May 2015 21:04:39 GMT

A user has requested the ability to type notes into the print widget before the call is made to the Print service that generates the map documents for printing. I understand the majority of how to implement this, except for how to pass form data to the Print service.

Can anyone tell me where, in the Esri Print Widget, passing form data (such as Map Title, Format, Layout, and Author) to the Print service is handled?

Thanks,

Damon

Re: Extending the Print Widget

DamonMyers — Wed, 20 May 2015 21:39:26 GMT

Answered my own question pretty shortly after posting:

Passing data to the PrintTemplate object is handled on lines 262-273 of the Print.js file of the Print widget. I was having trouble as I was trying to update the description text of the print template, which does not seem to be supported. I instead need to use the customTextElements object of the layoutOptions attribute of PrintTemplate.

API reference: PrintTemplate | API Reference | ArcGIS API for JavaScript

Thanks,

Damon

Re: Extending the Print Widget

DrewSwayne — Thu, 21 May 2015 19:20:40 GMT

Damon,

How did you actually implement this? I tried adding a subtitle to the map title but I am unable to modify the text size, etc. I added it as a new line in the current Map Title when printed, but then it bleeds into the map frame. Are you able to use the customTextElements to place text anywhere you want within the printed map?

Re: Extending the Print Widget

RobertScheitlin__GISP — Thu, 21 May 2015 19:57:04 GMT

Drew,

Add a new text element to your print template in ArcMap using the menu Insert > Text, place and format it as desired.
switch to the Size and Position Tab and in the Element Name enter "SubTitle".
Save your print template.
In the WAB print widgets' Print.js file find line 267 "template.layoutOptions = {"
Add a new line under 267 and paste this

customTextElements: [{SubTitle: form.subtitle}], (assuming your Dam Id field on the from is called "subtitle").

Re: Extending the Print Widget

JayHalligan — Tue, 16 Jun 2015 18:50:35 GMT

Can anyone provide more detailed information on how to modify the form, to add the input, to pass the custom text element into the layout. I have modified the template "Element" and added the new line under Line 267, but I cant seem to get past this point. I just want the option to input a few new lines of text to pass to my custom text elements in the layout. Any help would be appreciated. Thanks.

Re: Extending the Print Widget

StanMcShinsky — Sun, 12 Dec 2021 08:57:49 GMT

Jay,

You need to add code to your form in the \widgets\Print\templates\Print.html file

It depends on where you want the user to enter the information. Visible from the top of accessible through the advanced button. For example I wanted mine to show up in the advanced section so I just added this between the Author and copyright table rows.

<tr>
    <td>
        Additional Text:
    </td>
    <td>
        <input type="text" data-dojo-attach-point="BOXTEXTNode" data-dojo-type="dijit/form/ValidationTextBox" data-dojo-props="name:'BOXTEXT',trim:true,required:false,style:'width:100%;'" data-dojo-attach-point="BOXTEXTTB"/>
    </td>
</tr>

In line 6 above replace the 3 instances of BOXTEXT with the value you made in the Print.js file as mentioned previously.

-Stan

Re: Extending the Print Widget

HelenWhiteley — Tue, 31 May 2016 15:56:56 GMT

Hi Robert,

I managed to use your above code to use customTextElements to add in a free text box, as Drew has above, into the print widget in WAB. However, following further customisations (which also were working), I am now no longer getting any free text boxes within the widget, despite (I'm sure) not changing anything.

Do you have any suggestions as to what might have changed / what I am doing wrong?

Thanks,

Helen