topic Re: off panel widget in ArcGIS Web AppBuilder Questions

off panel widget

MatejSkerjanc — Wed, 18 Apr 2018 10:59:10 GMT

Trying to create my first off panel widget, it would have no ui template just configuration, settings ui etc...

From what i read on this forum (yes the api documentation meantions nothing about this) you need to add your widget to the \client\stemap\predefined-apps\default\config.json

but in what format and to which element

According to the forum I

1. copied Scalebar widget (which is off panel widget), renamed it and changed name in manifest

2. went to config.json (mentioned above) and added a copy of scalebar widget items i found in this json

under

widgetOnScreen.widgets

{
"uri": "widgets/Something/Widget",
"position": {
"left": 17,
"bottom": 25
},
"version": "0.01"
},

2. mobileLayout.widgetOnScreen.widgets

"widgets/Something/Widget": {
"position": {
"left": 7,
"bottom": 40
},
"version": "1.4"
},

I am left without any idea how to add off panel widget now.

Also when you want to deploy this to IIS for portal admins to use on their Portals will they have to write into these configuration files as well?

Best regards

Re: off panel widget

RobertScheitlin__GISP — Wed, 18 Apr 2018 12:58:45 GMT

Matej,

So I don't see anything wrong with your steps and the config.json entries you added. So is the widget not appearing? What are the errors if any in your browsers console?

Also when you want to deploy this to IIS for portal admins to use on their Portals will they have to write into these configuration files as well?

Yes.

Re: off panel widget

MatejSkerjanc — Wed, 18 Apr 2018 18:36:22 GMT

Hello Mr. Rober arent you a sight for sore eyes (as usual, you seem to be answering all our posts:)

The thing is, i want this widget to be without icon and without panel (just settings but thats another story). And since i've added all those to config.json it shouldnt be available in the inpanel widgets...but its there and not in the off panel section like the scalebar.

Re: off panel widget

RobertScheitlin__GISP — Wed, 18 Apr 2018 18:58:12 GMT

Matej,

Hmm... I am not sure what you are missing then. I just tested this in WAB 2.7 using these steps and had no problem at all.

Copied the Scalebar widget folder in one of my apps in WAB (I did not do this in the stemApp folder)
Renamed the folder Scalebar2.
Opened the manifest.json and cahnged name property to Scalebar2.
Opened the Widget.js and changed the name: "Scalebar2".
Opened the Scalebar2\nls\strings.js and rename _widgetLabel to "Scalebar2".
Opened the apps main config.json an copied the scalebar widget portion and changed the uri and name properties to the use Scalebar2 and change the bottom property of the postion to make sure the two scalebars did not overlap.
For good measure I added a #2 to the icon.png in Photoshop.

And here is what I get:

Re: off panel widget

MatejSkerjanc — Wed, 18 Apr 2018 19:29:06 GMT

Hello again Robert

under step one why didnt you copy it to <WebAppBuilderDir>\client\stemapp\widgets?

Re: off panel widget

RobertScheitlin__GISP — Wed, 18 Apr 2018 19:40:19 GMT

You only need to do that if you plan to use it in more then one app.

Re: off panel widget

MatejSkerjanc — Wed, 18 Apr 2018 20:22:20 GMT

Im developing a widget that will be for customers portal and should work on any app. But as i said when i copy it to stemapp widgets it is only shown in the inpanel widgets (unlike the scalebar2 in your picture) and im looking for instructions on how and what to edit to get it to the correct spot.

p.s. i also read that i'll have to host the widget itself in order for portal users to be able to see it and use it. But i've not even come close to that yet as you see

Re: off panel widget

RobertScheitlin__GISP — Wed, 18 Apr 2018 20:26:02 GMT

Matej,

If you want to have it in the right spot for all new apps in WAB then you have to my step 6 but instead of in the main config.json you do it in the \client\stemap\predefined-apps\default\config.json

Re: off panel widget

MatejSkerjanc — Wed, 18 Apr 2018 20:46:05 GMT

i have rather hoped i had done that, exactly how i described in the first post.

This is the config json in <wab>\predefined-apps\default\config.json

Pastiebin.com 5ad7adfd96109

and the widget is called GDiGisPluginWidget and its exact copy paste (on two positions) of scalebar just the rename.

And the widget itself is located in <wab>\client\stemapp\widgets\GDiGisPluginWidget

and the manifest says no ui file, and in panel false

Re: off panel widget

RobertScheitlin__GISP — Wed, 18 Apr 2018 21:06:56 GMT

Matej,

Line 192 in your json is an extra {. you need to delete that one.

Re: off panel widget

MatejSkerjanc — Thu, 19 Apr 2018 05:17:12 GMT

Hello Robert I see, i deleted it but still same result, on the left its the original Scalebar and in the inpanel widgets i see the new "scalebar", and i have no idea why it is called scalebar still. Thought i changed the name

Re: off panel widget

RobertScheitlin__GISP — Thu, 19 Apr 2018 12:56:26 GMT

Matej,

The label still being Scalebar is simple you like did not do the step I outlined about changing the _widgetLabel in the strings.js. Have you tried to start new app? The issue with setting the widget in the predefined-apps\default\config.json is that it only takes affect when creating a new app, and does NOT affect existing apps.

Re: off panel widget

MatejSkerjanc — Thu, 19 Apr 2018 16:52:16 GMT

found the string just as i read this:)

Oh so i have to make another app in order for it to work ...I'll try that and report back as soon as i get VPN going..its bugging out. Thanks!

Re: off panel widget

MatejSkerjanc — Fri, 20 Apr 2018 05:25:39 GMT

Hello mr. Robert

I've added another app and the widget was still in the inpanel section.

This is the entire widget ExpireBox | GDiGisPluginWidget.7z its not done yet but it should start without a prob. Its located in the \client\stemapp\widgets. And this Pastiebin.com 5ad978fa2fe76

is the \client\stemapp\predefined-apps\default\config.json

Cannot find the reason why wont it appear in the off panel

p.s it did work if i complete the steps in the application itself

Re: off panel widget

MatejSkerjanc — Fri, 20 Apr 2018 05:36:20 GMT

Mr. Robert,

After I've done second new application it worked...dont ask me how that happened but in the 2nd new app its where it belongs. Thank you for your help, I'm really grateful