topic Re: Sharing a variable between Widgets in Web AppBuilder Custom Widgets Questions

Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 12:36:51 GMT

Hi everyone,

I'm sorry by advance for my question, I'm a beguiner with the Web App Builder for Developpers...

I have two different widget, one for visualisation and another for basics statistics. For each one, I use a query where the where clause is in a variable and I would like them to use the same where clause but I don't how to do for make them sharing this variable.

Thank you for your help !

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Sun, 12 Dec 2021 10:16:22 GMT

Florian,

You can use "jimu/WidgetManager" in your require for one of your widgets and then use:

var theWhereClause = WidgetManager.getInstance().getWidgetsByName('YourOtherWidgetsName').YOURPUBLICVAR;

Your other widget would need to have a public var like this:

return declare([_WidgetBase, _TemplatedMixin], {
    templateString: template,
    _currentSelectedBookmarkRowNode: null,
    _currentSelectedBookmarkLoadingDiv: null,
    _lastExtent: null,
    YOURPUBLICVAR: 'something',

Re: Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 13:44:01 GMT

So If I understand, I have two widgets :

In the first one where the whereClause is defined by selectors (because the whereClause is Dynamic...doesn't generate problems ?) I have to define the Widget Manager and the public var.

And in the second one where the whereClause will be re-used for another query, I just have to define the var whereClause in the :

return declare([ BaseWidget, _WidgetsInTemplateMixin],{

baseClass: 'jimu-widget-test',

name: 'Test_Dashboard',

var whereClause = blablabla...,

Or I didn't understood ?

(sorry by advance but I'm a beginner...)

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Wed, 08 Jul 2015 13:52:44 GMT

Florian,

You define the dynamic whereClause in widgetA and in widgetB you add the widgetManger and retrieve the dynamic whereClause from widgetA. Now what triggers widgetB to retrieve the dynamic whereClause in widgetA is another question.

What is your desired workflow?

dynamic whereClause in widgetA is changed > then in widgetB you manually click a button or something and it will retrieve the dynamic whereClause from widgetA and execute the query in widgetB
dynamic whereClause in widgetA is changed > automatically widgetB will retrieve the dynamic whereClause from widgetA and execute the query in widgetB

Re: Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 14:05:19 GMT

The better workflow should be the dynamic refresh of the whereclause ! How do you think is it possible to do this ?

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Wed, 08 Jul 2015 14:21:50 GMT

Florian,

OK then this would be the better route then:

WidgetA has the dynamic whereClause and when it changes you fire off a function that calls a function that exists in widgetB. You get access to the function in widgetB using WidgetManager.getInstance().getWidgetsByName('widgetB').executeQuery(newWhereClauseVar);

So widgetB would have to have a "executeQuery" function that take a parameter for the whereClause string. Let me know if this is enough to go on.

Re: Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 14:49:35 GMT

hmmm juste a question : Am I forced to use the var theWhereClause = WidgetManager.getInstance().getWidgetsByName('YourOtherWidgetsName').YOURPUBLICVAR; Becauce by my side, this syntax doesn't work (theWhereClause is undefined) but the YOURPUBLICVAR can be used simply and sent me back the good value ... I don't really understand this behavior...

For the workflow it seems to be great, I'll try to make run something like that !

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Wed, 08 Jul 2015 14:59:31 GMT

Florian,

No you can use whatever var name you want or not actually set a var. You can just do something like this (if you want):

query.where = WidgetManager.getInstance().getWidgetsByName('YourOtherWidgetsName').YOURPUBLICVAR;

Re: Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 15:08:38 GMT

ahah no, my problem is not the name of the variable but the WidgetManager.getInstance().getWidgetsByName('nameofwidget').publicvar; ... I dont understand why my Widget B can understand the Widget A's publicvar but not the Widget B's created var (with the .getinstance.getwidgetbyname...syntax) !

That's why I ask if it is usefull and/or forced to use the "...WidgetManager.getInstance().getWidgetsByName('widgetname')..." syntax ?

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Sun, 12 Dec 2021 10:16:25 GMT

Florian,

OK, you have me confused...

WidgetB can get to WidgetAs var because it is global (based on this code):

define(['dojo/_base/declare', 'jimu/BaseWidget'],
function(declare, BaseWidget) {
  return declare([BaseWidget], {

    baseClass: 'toggle-basemap-widget',
    name: 'ToggleBasemap',
    myWhereClause: '',
    // DO NOT use "var" myWhereClause as that make it local.

So yes you are forced to use the ...WidgetManager.getInstance().getWidgetsByName('widgetname')... syntax. This is the way that WidgetA knows what WidgetB is.

So using the above code sample the code would look like this:

query.where = WidgetManager.getInstance().getWidgetsByName('ToggleBasemap').myWhereClause;

Re: Sharing a variable between Widgets

FlorianCADOZ — Sun, 12 Dec 2021 10:16:28 GMT

Okay juste going from the basics :

In my Widget A (with whereClause Selector) I have :

define([
  'dojo/_base/declare',
  'dijit/_WidgetsInTemplateMixin',
  'jimu/BaseWidget',
...
function(
  declare,
  _WidgetsInTemplateMixin,
  BaseWidget,
...
return declare([
  BaseWidget,
  _WidgetsInTemplateMixin],{
     baseClass: 'blabla',
     name: 'blablabla',
     theWhereClause: '',
...
theSelectorFunction: function(){
     blablablablablabla
     ...
     theWhereClause = "DateSelected = '16/02/2015'";
...

And in the Widget B (where I want to use the whereClause value for another query) I have :

define([
  'dojo/_base/declare',
  'dijit/_WidgetsInTemplateMixin',
  'jimu/BaseWidget',
  'jimu/WidgetManager',
...
function(
  declare,
  _WidgetsInTemplateMixin,
  BaseWidget,
  WidgetManager,
...
return declare([
   BaseWidget,
  _WidgetsInTemplateMixin],{
     baseClass: 'blabla',
     name: 'ahahah',
...
onOpen: function(){
     var myWhereClause = WidgetManager.getInstance().getWidgetsByName('blablabla').theWhereClause;
     console.log(myWhereClause);
     console.log(theWhereClause);
...

And with that, myWhereClause return "undefined" and theWhereClause return "DateSelected = '16/02/2015'"

(the value selected with the widget A !) So now I don't understand what append...

Re: Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 16:16:16 GMT

sh*t my answer had a bug too ! Can you read easily what I writed or do you want me to re-edit this ?

(I don't know why but the end of my message is write in white)

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Wed, 08 Jul 2015 16:18:17 GMT

Florian,

Not sure why you are not getting the value. Try adding this line to widgetB:

console.info(WidgetManager.getInstance().getWidgetsByName('blablabla'));

and see if you are actually getting the widget object.

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Wed, 08 Jul 2015 16:23:24 GMT

Florian,

OK, I see the result of console.log(theWhereClause);

I have to say that I have never seen the ability to get a widgets var by doing it that way from another widget...

Re: Sharing a variable between Widgets

FlorianCADOZ — Wed, 08 Jul 2015 16:38:13 GMT

ahahah I don't know if it is a good thing or not...

So that's why I ask this question, because this way seems to be the simplest one but I don't know if it can generate some problems...

And the console.info(WidgetManager.getInstance().getWidgetsByName('blablabla')); gimme back a [] and nothing else...I don't know if it's good or not too ...

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Wed, 08 Jul 2015 16:47:28 GMT

Florian,

I am so sorry. I forgot that widget manager returns an array when searching for a widget by name. So the code should be:

query.where = WidgetManager.getInstance().getWidgetsByName('ToggleBasemap')[0].myWhereClause;

Yes I think that getting the myWhereClause the other way will be an issue.

Re: Sharing a variable between Widgets

FlorianCADOZ — Thu, 09 Jul 2015 07:59:20 GMT

No problem, don't worry !

The WidgetManager.getInstance().getWidgetsByName('ToggleBasemap')[0].myWhereClause; method don't gimme back anything ... It's juste blank in the console...

Re: Sharing a variable between Widgets

RobertScheitlin__GISP — Thu, 09 Jul 2015 13:16:45 GMT

Florian,

Lets have you try to get a variable from a esri widget that is normally loaded with WAB to test then.

console.info(WidgetManager.getInstance().getWidgetsByName('Geocoder')[0].hardcodeRegExp);

The result should be: "/geocode(.){0,3}\.arcgis.com\/arcgis\/rest\/services\/World\/GeocodeServer/g"

Re: Sharing a variable between Widgets

FlorianCADOZ — Thu, 09 Jul 2015 16:52:09 GMT

Oh sorry I made a mistake into the code of my first widget, so now, it's ok for the .get.get(blablablah) syntaxe !

I call myWhereClause variable with .get.get() in the onOpen function so the whereclause is refreshed more or less each time I open my Widget B...and after it's going on I think... Not working well at this time, but it will be ok !

thank you for your help !