topic Re: Re: Re: Backend Api getSelections in Integration, Extension & APIs

Backend Api getSelections

rbecher — Mon, 29 Sep 2014 20:18:22 GMT

Hi,

is there any method to get the current selections of the app?

- Ralf

Re: Backend Api getSelections

Tue, 30 Sep 2014 14:54:19 GMT

Yes,

You can retrieve it with the getList method see https://help.qlik.com/sense/en-us/developer/index.html#../Subsystems/Workbench/Content/BuildingWebsites/API/Methods/Meth… for more information

Re: Backend Api getSelections

rbecher — Wed, 01 Oct 2014 11:36:40 GMT

Is there another way to get the result during the paint function? It seems to be the callback is made asynchronously, receives result after end of paint..

Re: Backend Api getSelections

Fri, 03 Oct 2014 11:11:04 GMT

Hi, I had the same question and i found a solution.

in the javascript file, you have to include "qlik" in define function, then you can call to app using this method:

var app = qlik.currApp();

code will be like this:

define(["jquery","qlik"], function($, qlik) {

return {

paint : function($element, layout) {

var app = qlik.currApp();

app.getList("CurrentSelections", function(data){

console.log(data);

});

}

Re: Backend Api getSelections

rbecher — Fri, 03 Oct 2014 11:23:46 GMT

That's exactly what I've coded but callback function is called after paint!

Re: Backend Api getSelections

Fri, 03 Oct 2014 11:32:13 GMT

Yes, it is asynchronously, so, if it needs to paint something when the selected fields are ready, the logic to render HTML should be inside of callback function.

app.getList("CurrentSelections", function(data){

rendeView(); // for example

});

Re: Backend Api getSelections

rbecher — Fri, 03 Oct 2014 11:56:14 GMT

Understand, but why the paint function isn't called after the selected fields are ready? Would make more sense..

Re: Backend Api getSelections

Fri, 03 Oct 2014 12:41:05 GMT

Essentially what you are doing is creating/accessing a separate object that gets its own change notifications. your extension will still fire a paint when the selection changes.

Re: Re: Backend Api getSelections

Sun, 16 Nov 2014 19:08:05 GMT

I used this to get the selected values during paint. You need to fetch all the entries in the field for it to work.

var selectedDates = qMatrix.filter(function(d) { return (d[0].qState == 'S') }).map(function(d) {
  return d[0].qNum
  });

Re: Re: Backend Api getSelections

rbecher — Mon, 17 Nov 2014 12:50:32 GMT

Thanks, Karl. But this helps only for getting the selections inside of the defined cube. I don't understand why the API is lacking such basic function to obtain information about the current selections of the application.

Re: Re: Re: Backend Api getSelections

ErikWetterberg — Mon, 17 Nov 2014 14:10:51 GMT

Hi Ralf,

getList is actually not meant for use in extensions, though there might be situations when it is useful (like if you create stuff dynamically). Like Johan said, it will create a second GenericObject, but you are really after adding more stuff to the one you already have.

You do this in initialProperties, which are used to initialize your objects properties on creation. If you add a qSelectionObjectDef to your initialProperties you will get info about current selections in your layout. Something like this:

initialProperties : {
     qSelectionObjectDef:{  
     },
     qHyperCubeDef:{
......
}

You can do this for all the list and combine it with qHyperCubeDef, qListObjectDef etc. The Toolbar extension example uses this to get lists of Fields and Bookmarks:

initialProperties : {
     version : 1.0,
     qBookmarkListDef : {
          qType : "bookmark",
          qData : {
               title : "/title",
               description : "/description"
          }
     },
     qFieldListDef: {}
}

Erik