topic Re: Qlik Sense Visualization API - How to set cell attributes in Integration, Extension & APIs

Qlik Sense Visualization API - How to set cell attributes

rbartley — Mon, 29 Jan 2018 17:44:49 GMT

Hi everyone,

Could anyone tell me how to use the setOptions method of the visualization API (setOptions method ‒ Qlik Sense Developers) to set the attributes of a dimension?

The following code can be used to change title, subtitle and footnote:

app.visualization.get(strQID).then(function(vis){
 
  console.log('vis',vis);

  vis.setOptions(
  {
  //orientation:"vertical"
  title:"New title",
  subtitle:"New subtitle",
  footnote:"New footnote"
  });

According to the help, I should be able to set all of these properties: http://help.qlik.com/en-US/sense-developer/September2017/Subsystems/APIs/Content/CapabilityAPIs/VisualizationAPI/pivottable-properties.htm

, but the example is rather simplistic and doesn't cover how to interact with the attributes.

Thanks in advance.

Re: Qlik Sense Visualization API - How to set cell attributes

ErikWetterberg — Mon, 29 Jan 2018 18:07:40 GMT

Hi Rickard,

You'll probably have to experiment with this, but the principle is that you should provide an object, something like this:

vis.setOptions({
  qHyperCubeDef:{
     qDimensions:[{
        qDef: {autoSort:false}
      }]
  }
});

Just make an object with the properties you want to change, omitting the ones you don't want to change. SetOptions wraps applyPatches, and convertes the object to a patch array, that is eventually sent to engine.

I must admit I haven't tried this for a long time though, so I haven't verified that this actually works. Hope you find it helpful anyhow.

Erik Wetterberg

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Tue, 30 Jan 2018 09:28:51 GMT

Hi Erik,

Thanks for your response. Unfortunately, the autosort raises an error (I only tried this with a pivot-table visualization, which includes the autoSort property, so it's not a case of the wrong type):

require.js:19 TypeError: Cannot read property 'qError' of undefined

at http://....../resources/js/qlik.js:106:22645

at Array.map (native)

at http://....../resources/js/qlik.js:106:22581

at g (http://....../resources/assets/external/requirejs/require.js:20:2335)

at http://....../resources/assets/external/requirejs/require.js:20:2507

at o.$eval (http://....../resources/assets/external/requirejs/require.js:20:10136)

at o.$digest (http://....../resources/assets/external/requirejs/require.js:20:8622)

at http://....../resources/assets/external/requirejs/require.js:20:10223

at f (http://....../resources/assets/external/requirejs/require.js:18:20514)

at http://....../resources/assets/external/requirejs/require.js:18:21973

Any ideas?

Here's the code:

app.visualization.get(strQID).then(function(vis){
  if(strQID=='ueBFGP')
  {
  vis.setOptions(
  {

  title:"New title",
  subtitle:"New subtitle",
  footnote:"New footnote",
  qHyperCubeDef:
  {
  qDimensions:[{
  qDef: {autoSort:false}
  }]
  }
  });
  }
});

Re: Qlik Sense Visualization API - How to set cell attributes

ErikWetterberg — Wed, 31 Jan 2018 10:21:48 GMT

Hi,

The problem could be that it tries to replace the entire qDimensions array, which gives an error, that is not handled well, but breaks.

Try this:

vis.setOptions({
qHyperCubeDef:{
  qDimensions:{
     0: {qDef: {autoSort:false}}
  }
}
});

If you want to modify the first dimension.

And I'm sorry, I haven't tried this, I'll leave that to you...

Erik Wetterberg

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Fri, 02 Feb 2018 12:24:30 GMT

Hi Erik,

Yes, this works, thanks. I am now trying to work out how to set use the cellBackgroundColor option.

if(strQID=='ueBFGP')
{
vis.setOptions(
{

title:"New title",
subtitle:"New subtitle",
footnote:"New footnote",


qHyperCubeDef:
{
qDimensions:
{
0: {
qDef: {autoSort:false} ,
qAttributeExpressions: 
[
{

  "qDef": "Product (Production)",
  "id": {"cellBackgroundColor":"=Red()"}

}
]
}
},
qMeasures:
{
0: {
qAttributeExpressions: 
[
{
  "id": {cellBackgroundColor:"Red()"}
}
]
}
}
}
});
}

When I look at the console (see below), it seems as though this has worked, but the cell colour has not been changed. Any ideas?

Re: Qlik Sense Visualization API - How to set cell attributes

ErikWetterberg — Fri, 02 Feb 2018 13:14:13 GMT

Hi,

The format looks strange, what was it like before the change? I would expect it to be something like:

id: "cellBackgroundColor",

qDef: "=Red()"

But, really, what did it look like to start with??

Erik Wetterberg

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Fri, 02 Feb 2018 14:58:12 GMT

When I comment out these changes, I see the following:

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Fri, 02 Feb 2018 15:03:51 GMT

And when I change the code to:

id: "cellBackgroundColor",

qDef: "=Red()"

I get the following (similar to my comment of 02-Feb-2018 12:24). This still has no impact on the cell background colour.

Re: Qlik Sense Visualization API - How to set cell attributes

ErikWetterberg — Fri, 02 Feb 2018 16:10:05 GMT

And what does it look like if you set background color to red in the client?

Erik Wetterberg

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Fri, 02 Feb 2018 16:24:35 GMT

Sorry Erik, do you mean in the Qlik Sense client, i.e. accessed through the QS hub? There's no option with the pivot table, only table.

Here's the table:

...and here's the pivot table:

But according to Qlik Help, cellBackgroundColor should be possible to set for pivot-table too.

https://help.qlik.com/en-US/sense-developer/November2017/Subsystems/APIs/Content/CapabilityAPIs/VisualizationAPI/pivottable-properties.htm

Still, I'll try it on a table and let you know what happens.

Re: Qlik Sense Visualization API - How to set cell attributes

ErikWetterberg — Fri, 02 Feb 2018 17:47:53 GMT

That looks like a bug in the documentation. I would be very surprised if setting it through the API works when you cannot do it in the client.

Erik Wetterberg

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Fri, 02 Feb 2018 17:48:32 GMT

Eureka! I got it to work with the table by replacing the qDef with the qExpression property, so it now looks like this:

if(strQID=='ueBFGP')
{
vis.setOptions(
{

title:"New title",
subtitle:"New subtitle",
footnote:"New footnote",


qHyperCubeDef:
{
qDimensions:
{
0: {
qDef: {autoSort:false} ,
"qAttributeExpressions": 
[
{
  "id": "cellBackgroundColor",
  "qExpression":"=Red()"
}
]
}
}
}
});
}

Re: Qlik Sense Visualization API - How to set cell attributes

rbartley — Fri, 02 Feb 2018 17:54:20 GMT

Perhaps it is a mistake in the documentation since when I tried the same approach that worked for the table, it didn't work for the pivot table. While in the table, setting "qExpression":"=Red()" showed "qExpression":"=Red()" in the console, it showed as qFallbackTitle:"=Red()" for the pivot table, which makes me think that it's not possible.

Thanks for all your help Erik