topic Re: Programmatically filter attribute table in ArcGIS Web AppBuilder Questions

Programmatically filter attribute table

Ravichandran_M_Kaushika — Fri, 17 Jun 2016 21:39:17 GMT

dear Readers,

thank you for taking the time to read the contents of the post.

How to programmatically filter records of the attribute grid?

there is a filter menu that open a popup window which allows the users to select the column by which the condition should be applied. it also provides the ability to add 1 or 2 more columns with the option to make it ANY or AND.\

Is there a way to perform this operation programmatically?

thanks and regards

ravi.

Re: Programmatically filter attribute table

AdrianWelsh — Fri, 17 Jun 2016 21:46:17 GMT

Hi Ravi,

If you are using Web AppBuilder, you can add the Query Widget to your web app. Using this query widget can be an interactive filter than can create an operational layer which can be viewed in the attribute table.

Info on out-of-the-box query widget:

Query widget—Web AppBuilder for ArcGIS | ArcGIS

Info on developer edition query widget:

Query—Web AppBuilder for ArcGIS (Developer Edition) | ArcGIS for Developers

I hope this helps.

Re: Programmatically filter attribute table

Ravichandran_M_Kaushika — Fri, 17 Jun 2016 22:44:12 GMT

Adrian,

good afternoon. thanks for replying quickly. Sorry I did not give too many details and tried to keep the question simple. To explain my situation, I have provide a detailed explanation as to why we want this.

Our feature n map server layer is of national extent. we implemented a widget using the sample blank widget template from ESRI with state/county/ and point feature layer names for a guided navigation for 2 purposes:

1. to search a point feature by state/county as people using this might not know the actual geographic location,

2. lock down users based on the state they are allowed to view.

When a user who is allowed to work on California, the state dropdown has only 1 entry and when the users select that 1 entry, all other point features are hidden when the application also zooms to California extent. The application would load all the counties of CA. NV state features are set to hidden from the feature layer display on the map element. the attribute grid changes to reflect the dams in the new extent but contains NV and AZ state records.

What we want to accomplish is that when we are programmatically removing point features belonging to NV and AZ from the visible extent after the application zooms to CA, at the same time, we want to programmatically do something as though the user click on filter by attributes of the attribute table to set the NV and AZ point feautres to hidden.

We are already using eSearch wizard (by Mr. Robert S., GISP of AL) for our searching and report creation purposes.

thanks once again for your help. have a good weekend.

regards

ravi.

Re: Programmatically filter attribute table

Ravichandran_M_Kaushika — Fri, 17 Jun 2016 22:49:22 GMT

Adrian,

One of our ESRI support staff requested us to use Select by option instead of the on-demand option while loading another layer. this is after the web map to facilitate the 'smoother' hiding of features in different state/county.

After we implemented the Select By option for the layer, the web app builder code does not know about the newly added Select by option layer and the jimu based WAB functions work fine with the on-demand layers that are coming from Web map residing in the portal.

right now with the on-demand feature layers coming from web map are working in a fine way with all other WAB functions and the only hitch is the attribute grid filtering. so if we fix the attribute grid then we have addressed our end users' needs.

regards

ravi.

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Sat, 18 Jun 2016 07:01:46 GMT

Ravi,

I have done this for the vanilla JS API so I should be able to come up with something for the AT Widget too. I'll keep you posted.

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Sat, 11 Dec 2021 17:09:56 GMT

Ravi,

So here is the code to add to some function to apply a filter to the Attribute Table Widget. This assumes that you are going to have the AT widget loaded and open already:

You will need to add the WidgetManager require: 'jimu/WidgetManager'

        this.wManager = WidgetManager.getInstance();
        if (this.wManager) {
          var widgetCfg = this._getWidgetConfig('AttributeTable');
          if(widgetCfg){
            var attWidget = this.wManager.getWidgetByLabel(widgetCfg.label);
            if(attWidget){
              this.wManager.openWidget(attWidget);
              var partsObj = {
                "expr": "Crime_Type='Auto Theft'",
                "parts": []
              };
              console.info(attWidget);
              var activeTable = attWidget._tableFunctionController.getActiveTable();
              activeTable.setFilterObj(partsObj);
              activeTable.refresh();
            }
          }
        }

and here is the support function called above:

     _getWidgetConfig: function(widgetName){
        var widgetCnfg = null;
        array.some(this.wManager.appConfig.widgetPool.widgets, function(aWidget) {
          if(aWidget.name == widgetName) {
            widgetCnfg = aWidget;
            return true;
          }
          return false;
        });
        if(!widgetCnfg){
          /*Check OnScreen widgets if not found in widgetPool*/
          array.some(this.wManager.appConfig.widgetOnScreen.widgets, function(aWidget) {
            if(aWidget.name == widgetName) {
              widgetCnfg = aWidget;
              return true;
            }
            return false;
          });
        }
        return widgetCnfg;
      }

Re: Programmatically filter attribute table

Ravichandran_M_Kaushika — Mon, 20 Jun 2016 15:52:37 GMT

Robert,

good morning. thank you for the reply. we will use the code and confirm it works.

thanks once again for your support to the entire js, WAB community.

regards

ravi.

Re: Programmatically filter attribute table

friskyweasel — Mon, 18 Jul 2016 14:07:34 GMT

Hello Robert! Your above code was absolutely perfect and exactly what we needed - thanks so much - just had one last quick question if you don't mind.

We implemented your code inside of our custom widget, but once the user is finished working with it and closes it, we would like to return the Attribute Table back to its original working application logic. In other words, clear out any custom filtering we have implemented via our "partsObj" expression, and have the Attribute table behave exactly as it did out of the box (display all items that fall within the currently displayed extent of the map).

Is there a simple technique for accomplishing this whenever our widget is closed? Thanks so much for your help!

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Sat, 11 Dec 2021 17:09:59 GMT

Frisky Weasel,

I Have not tested this but it should be as simple as setting the expr to 1=1:

              var partsObj = { 
                "expr": "1=1", 
                "parts": [] 
              };  
              var activeTable = attWidget._tableFunctionController.getActiveTable(); 
              activeTable.setFilterObj(partsObj); 
              activeTable.refresh();

Re: Programmatically filter attribute table

friskyweasel — Mon, 18 Jul 2016 14:45:54 GMT

Thanks a lot for the quick reply Robert - yes in retrospect I guess that should have been pretty obvious ; ). We will definitely try it - thanks a bunch for all of your help!

Re: Programmatically filter attribute table

RebeccaStrauch__GISP — Mon, 18 Jul 2016 15:56:15 GMT

fyi Robert, you text says "1=1", your sample code says "1-1". Might want to fix which ever is incorrect (assuming is should be 1=1)

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Mon, 18 Jul 2016 16:10:28 GMT

Thanks Rebecca.

Re: Programmatically filter attribute table

Ravichandran_M_Kaushika — Fri, 22 Jul 2016 17:56:37 GMT

Sorry Robert,

my colleague Mark (Frisky Weasel) was working on this issue and I forgot to check back.

have a good weekend.

regards

ravi.

Re: Programmatically filter attribute table

friskyweasel — Fri, 22 Jul 2016 18:07:18 GMT

worked beautifully Robert - thanks a lot!

Re: Programmatically filter attribute table

LefterisKoumis — Fri, 01 Mar 2019 17:49:19 GMT

Hello Robert. It seems that this solution cannot implemented with the latest WAB since tableFunctionController is no longer available. Do you have any alternative way?

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Sat, 11 Dec 2021 17:10:02 GMT

In 2.11 this is what you need:

var partsObj = {   
  "expr": "1=1",   
  "parts": []   
};    
var activeTable = attWidget._activeTable;   
activeTable.setFilterObj(partsObj);   
activeTable.refresh(); ‍‍‍‍‍‍‍

Re: Programmatically filter attribute table

LefterisKoumis — Sat, 11 Dec 2021 17:10:04 GMT

THank you Robert. However, I was referring to the query and not the solution for initializing the AT.

But based on your response this:

if(attWidget){  
              this.wManager.openWidget(attWidget);  
              var partsObj = {  
                "expr": "Crime_Type='Auto Theft'",  
                "parts": []  
              };  
              console.info(attWidget);  
              var activeTable = attWidget._tableFunctionController.getActiveTable();  
              activeTable.setFilterObj(partsObj);  
              activeTable.refresh();  ‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

needs to be modified to this, line 7?

if(attWidget){  
              this.wManager.openWidget(attWidget);  
              var partsObj = {  
                "expr": "Crime_Type='Auto Theft'",  
                "parts": []  
              };  
var activeTable = attWidget._activeTable.active();??
activeTable.setFilterObj(partsObj);   
activeTable.refresh(); ‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Fri, 01 Mar 2019 18:32:08 GMT

Nope. it is exactly like I posted previously. Just change the expr to whatever you desire.

Re: Programmatically filter attribute table

LefterisKoumis — Fri, 01 Mar 2019 19:31:07 GMT

ok. Got it.

At the risk to be an idiotic question here is:

I am modifying the _FeatureTable.js which is under the AT/table folder.

The code presented here is to call the

attWidget._activeTable;

where attWidget is AT widget.

In the _FeatureTable.js how to get access to the _activeTable function which in the widget.js?

Do I need to re-create the _activeTable in the current file?

Re: Programmatically filter attribute table

RobertScheitlin__GISP — Fri, 01 Mar 2019 19:39:42 GMT

Lefteris,

The attWidget is a reference to the AttributeTable widget (That could be coming from any widget). I was not providing code specific to the _FeatureTable.js, actually I am not sure why you would can to do it there.