topic Re: Backend Api getProperties / setProperties in Integration, Extension & APIs

Backend Api getProperties / setProperties

rbecher — Mon, 29 Sep 2014 20:10:07 GMT

Hi,

I'm looking for examples how to use this.backendApi.getProperties() / setProperties() methods. Anything on this?

- Ralf

Re: Backend Api getProperties / setProperties

Tue, 30 Sep 2014 14:48:09 GMT

You can find all the relevant documentation on the Qlik Sense help site http://help.qlik.com or for this specific question look here https://help.qlik.com/sense/en-us/developer/index.html#../Subsystems/Workbench/Content/BuildingExtensions/BackendAPI.htm…

Re: Backend Api getProperties / setProperties

rbecher — Tue, 30 Sep 2014 15:48:16 GMT

But there is no example for getProperties / setProperties..

Re: Backend Api getProperties / setProperties

Tue, 30 Sep 2014 20:02:52 GMT

Use

myprops = this.backendApi.getProperties();
this.backendApi.setProperties(myprops);

Re: Backend Api getProperties / setProperties

rbecher — Wed, 01 Oct 2014 11:13:13 GMT

Thanks, this was clear so far. But how access/set a property in myprops?

Re: Backend Api getProperties / setProperties

Stefan_Walther — Wed, 01 Oct 2014 19:07:59 GMT

Hi Ralf,

here is one of the examples: https://help.qlik.com/sense/en-us/developer/index.html#../Subsystems/Qlik_Engine_API/Content/HowTos/SetProperties.htm

Regards

Stefan

Re: Backend Api getProperties / setProperties

rbecher — Wed, 01 Oct 2014 19:20:27 GMT

Hi Stefan,

but this is not for this.backendApi.getProperties() ?

Best regards,

Ralf

Re: Backend Api getProperties / setProperties

Fri, 03 Oct 2014 13:09:03 GMT

Actually its very similar, the structure you retrieve is the qProp structure in the json response for getProperties, and the first item in the params array for setProperties

The only difference is that the javascript methods in backendAPI strips away the rest.

But I agree with you the Examples are missing and should be added. I'll file a request for it.

Re: Re: Backend Api getProperties / setProperties

ErikWetterberg — Wed, 29 Oct 2014 16:03:03 GMT

I'm afraid this doesn't work. The getPropertries is asynchronous, and does not return properties, but a promise.

It's a bit more complicated, but you can do something like this:

var me = this;
this.backendApi.getProperties().then(function(reply){
        reply.title = 'New title';
        me.backendApi.setProperties(reply);
});

Re: Re: Re: Backend Api getProperties / setProperties

ErikWetterberg — Thu, 30 Oct 2014 15:30:22 GMT

Another option would be to use the applyPatches method. This allows you to change properties without fetching them first (getProperties is not needed)

self.backendApi.applyPatches([{

"qPath" : "/title",

"qOp" : "replace",

"qValue" : "\"New title\""

}], true);

The last parameter is th softpatch flag: if you set it to true, the change will be regarded as temporary and not persisted.

Note the format of the qValue parameter: this is actually a JSON value inside a string (since you can patch strings, numbers or JSON objects). In this case we want to set a string value, and so we need double citation marks. If we wanted to set a number (not valid in the title) it should be something like "qValue": "-1".

Re: Backend Api getProperties / setProperties

rbecher — Sat, 07 Feb 2015 18:00:59 GMT

Hi Erik,

how do I set a property of an extension property panel (eg. settings/items/myprop) from inside the paint function? Any example?

Best,

Ralf

Re: Backend Api getProperties / setProperties

ErikWetterberg — Tue, 10 Feb 2015 11:47:30 GMT

Hi,

In your properties panel definition you have a value called 'ref' that points to the position in the properties structure where your property is stored. Use this either in your setProperties call or in applyPatch. Note that the ref notion is with dots, but applypatch wants it with slashes.

Erik

Re: Backend Api getProperties / setProperties

rbecher — Tue, 10 Feb 2015 12:03:41 GMT

Thanks! So, is the path the just "/myRef" ? I cannot find any example.

Re: Backend Api getProperties / setProperties

ErikWetterberg — Tue, 10 Feb 2015 13:02:23 GMT

Hi,

That depends on what you have written in 'ref' in the property panel definition.

In the definition:

myProperty : {

ref : "myProperty",

label : "My Property",

......

Would give you a path of "/myProperty" if you use applyPatch.

Erik

Re: Backend Api getProperties / setProperties

rbecher — Tue, 10 Feb 2015 13:42:16 GMT

Thanks, this works for the actual value, how about "/myProperty/defaultValue" ? Seems not to work..

Re: Backend Api getProperties / setProperties

ErikWetterberg — Tue, 10 Feb 2015 13:58:17 GMT

No, it only works for the values actually in the property object, and the default value is in the property panel.

Erik

Re: Backend Api getProperties / setProperties

rbecher — Tue, 10 Feb 2015 14:00:38 GMT

Ok, thanks.