topic Re: Qliksense custom measure property for extension with expression value in Integration, Extension & APIs

Qliksense custom measure property for extension with expression value

sheldonqlik — Thu, 20 Aug 2015 18:28:04 GMT

I have created a custom property for a measure in my extension

CustomMeasureProp:{

type:"string",

label:"Custom Measure Property",

ref:"customMeasureProperty",

expression: "optional"

}

In the QlikSense Desktop I am able to add my extension and see the custom property when adding my measure.

I populate it with my EXPRESSION Max(value).

THE QUESTION.

How do I access that evaluated expression through the api?

I have used my code

$scope.backendApi.getProperties().then(function(reply){

angular.forEach(reply.qHyperCubeDef.qMeasures,function(measure){

console.log('MEASURE',measure);

if(typeof measure.customMeasureProperty!=='undefined'){

console.log('MEASURE LABEL', measure.customMeasureProperty);

}

});

Rather than returning the evaluated expression when looking at the object measure.customMeasureProperty, it returns the string Max(value).

So how do get the evaluated value?

Re: Qliksense custom measure property for extension with expression value

Alexander_Thor — Thu, 20 Aug 2015 19:36:13 GMT

Most likely you just need to add a = sign before Max(value) otherwise it's interpreted as a string.

You could also change the type to number if you want to ensure you get a number back and not a string.

There is no need to fetch the properties btw, the customMeasureProperty should be available on the layout object or on scope if you aren't referencing your custom property as a measure on the HyperCubeDef which is not inluded in the snippet.

Re: Qliksense custom measure property for extension with expression value

sheldonqlik — Thu, 20 Aug 2015 20:12:18 GMT

I am actually doing it as a custom property of a measure.

I added the '=' sign but realized that it automatically does that anyway.

I have used this code.

$scope.backendApi.getProperties().then(function(reply){

angular.forEach(reply.qHyperCubeDef.qMeasures,function(measure){

console.log('MEASURE',measure);

if(typeof measure.customMeasureProperty!=='undefined'){

console.log('MEASURE LABEL', measure.customMeasureProperty);

}

});

Unfortunately it comes back as a

qStringExpression: Object
1. qExpr: "=Max(value)";

In the object. So I am still stuck there. Don't know if I can get the evaluated expression.

Re: Qliksense custom measure property for extension with expression value

Alexander_Thor — Thu, 20 Aug 2015 20:22:47 GMT

Can you share the full definition? Also what happens when you changed the type to number instead of string?

A working example can be found here, line 95-102 WaterfallChart/waterfall.js at master · mindspank/WaterfallChart · GitHub

A string expression wont be evaluated if ifs surrounded by single quotes so the properties panel probably interprets your input as a string since you have the type set to that.

Re: Qliksense custom measure property for extension with expression value

Alexander_Thor — Thu, 20 Aug 2015 20:24:31 GMT

Also set the expression property to "always" and it will never evaluate your expression as a string regardless of type.

You can check the documentation for that over here, https://help.qlik.com/sense/2.0/en-us/developer/Subsystems/Extensions/Content/Howtos/custom-string-properties.htm

Re: Qliksense custom measure property for extension with expression value

Alexander_Thor — Thu, 20 Aug 2015 20:34:57 GMT

It could also be the case that since you are accessing the properties of the hypercube and the not the hypercube itself that the expression has not been evaluated yet.

The evaluated hypercube will be accessible from the layout, $scope.layout.qHyperCube

Re: Qliksense custom measure property for extension with expression value

sheldonqlik — Fri, 21 Aug 2015 13:44:40 GMT

You may be very right. I don't think what I am attempting to do may be possible. But here is my definition

define([], function () {

var settings = {

uses: "settings",

items: {

measures : {

uses : "measures",

min : 1,

max : 10,

items:{

//allows for custom labels using functions in the measure. Can use an expression to set it.

InformationLabelProp:{

type:"string",

label:"Custom Label",

ref:"props.tInformationLabel",

expression: "always",

defaultValue: ""

}

};

// Return values

return {

type: "items",

component: "accordion",

items: {

settings: settings

}

};

});

Then in my angular controller I am doing the get from the backendApi like i stated in the original

$scope.backendApi.getProperties().then(function(reply){

angular.forEach(reply.qHyperCubeDef.qMeasures,function(measure){

console.log('MEASURE',measure);

}

console.log('MATRIX',layout.qHyperCube.qDataPages[0].qMatrix[0]);

});

Thanks so much for the information yesterday. I just don't know where in the hypercube that data would be.

Re: Qliksense custom measure property for extension with expression value

Alexander_Thor — Fri, 21 Aug 2015 16:46:21 GMT

It is very possible, you are just not reading what I'm posting for you.
Stop accessing the properties through getProperties(). Period.

Why? Because you are accessing the definition of the hypercube, not the hypercube itself

Here are two working examples, 1 for Attribute Expressions and 1 for Measure properties

Re: Qliksense custom measure property for extension with expression value

sheldonqlik — Fri, 21 Aug 2015 19:39:44 GMT

thank you much! I was not listening apparently! thanks much.

Re: Qliksense custom measure property for extension with expression value

yblake — Thu, 11 Feb 2016 11:58:23 GMT

Hi Alexander,

I tried to use exactly your both properties definitions (Sense Desktop 2.1.1 build 22).

But when I enter a formula in measures properties I get a Json rpc error :

The property formula is not saved.

Layout hypercube data matrix object log in the console shows qAttrExps.qValue.0.qNum equal to "Nan" for calculated measure property.

Layout hypercube measure info shows newLabel with 'TE'.

When I edit again the object, both formulas has vanished.

Should I set up some special initial properties to get this working ?

Any other ideas ?

Regards

Re: Qliksense custom measure property for extension with expression value

pablolabbe — Thu, 31 Mar 2016 05:00:26 GMT

Hi Sheldon,

Did you solved this issue ?

Re: Qliksense custom measure property for extension with expression value

yblake — Mon, 04 Apr 2016 17:07:31 GMT

I found this trick to get it working...

InformationLabelProp: {

type : 'string',

component: 'expression',

label : 'Evaluates for each row',

ref : 'qAttributeExpressions.0.qExpression',

defaultValue: ''

You may check.

Regards

Re: Qliksense custom measure property for extension with expression value

Mon, 11 Jul 2016 13:29:30 GMT

Hello Alexander,

Do you know how to specify an expression which would return a meaningful color value in a custom extension?

I'm following steps you've done (case with expression evaluated per each row) and I'm getting qAttrExps, but their values are numbers, not strings, and for instance instead of RGB(0,0,0) I receive value '4278190080'.

My expression is defined like this - IF($(fieldName)<0,RGB(0,0,0)). For rows which are falsy for IF statement I end up with 'NaN'.

Thanks in advance

Re: Qliksense custom measure property for extension with expression value

Wed, 31 Aug 2016 15:35:47 GMT

Hi Alexander,

According to the documentation, same approach can be applied for Dimensions. Only difference is that for dimensions the property is named qAttributeExpression instead of qAttributeExpressions (no 's' at the end).

The thing is that as a result, I can't see qAttrExps created. Even in qDimensionInfos qAttrExpInfo is empty for every dimension. Can you please assist?

Cheers,
Adrian

Re: Qliksense custom measure property for extension with expression value

pamaxeed — Thu, 08 Sep 2016 21:49:14 GMT

Hi,

i also was wondering if for the Dimensions we have the same Attribute, qAttrExps.

Somebody could go further regarding this topic?

I would like to define custom attribute on dimension level, so it could be nice if somebody could assist.
The documentation says that there exists such property:

qAttributeExpression

List of attribute expressions.

Array of NxAttrExprDef

https://help.qlik.com/en-US/sense-developer/3.0/Subsystems/EngineAPI/Content/Structs/NxDimension.htm

thanks!

Re: Qliksense custom measure property for extension with expression value

guantujiang — Sun, 13 Nov 2016 02:51:31 GMT

then how can we do the same work in dimension? I try in the cub and it work, but the expression can not be evaluation

code:

dimensions: {

columnWidth: {

type : 'string',

component: 'expression',

label : 'Column Width',

ref : 'qDef.columnWidth',

defaultValue: ''

Re: Qliksense custom measure property for extension with expression value

simondachstr — Tue, 14 Feb 2017 16:05:57 GMT

Actually that's expected as rgb() is interpreted as a number by the engine. Simply replace with strings.

Re: Qliksense custom measure property for extension with expression value

jonvitale — Tue, 17 Oct 2017 17:05:30 GMT

This is old,

But I notice that you do not use an "=" sign in front of the evaluate for each row expression. I am noticing that in my work reproducing this, when I use an equal sign the expression is not evaluated. When I write an expression without the leading =, then I'm okay. I'm worried that this will be confusing for users.

I am setting expression to "optional" but have also tried "always"

Re: Qliksense custom measure property for extension with expression value

robcastle — Mon, 12 Feb 2018 19:48:34 GMT

Can someone help me understand this solution?

I'm trying to add a property (expression) to a dimension that I want to use to define a color based on the value of the cell.

I defined my property like this:

var style={

ref: "qAttributeExpressions.0.nwsStyle",

label: "Style",

type: "string",

//expression: "always",

component: "expression"

};

And I'm accessing this expression in my extension code like this.

style = dimensionInfo[key].qAttrExprInfo[0].nwsStyle;

What gets returned is the expression formula and not the evaluated expression..

Returned results:

If(LEVEL = 1, 'background-color:green;',

If(LEVEL = 2, 'background-color:lightgreen;',

If(LEVEL = 3, 'background-color:yellow;',

If(LEVEL = 4, 'background-color:lightred;',

If(LEVEL = 5, 'background-color:red;','background-color:gray;')))))

I'm expecting the style to be returned so I can apply it to the html.

Does anyone know how to make this work? I noticed several people trying to do this in the forums but I'm not finding a successful solution.

Re: Qliksense custom measure property for extension with expression value

jonvitale — Wed, 14 Feb 2018 14:25:44 GMT

Hi Rob, I think I got what you are looking for working. I modified an extension to give some color-by-expression features. Let's see what we can do:

First, in my dimension, where I want to color by expression, I use the ref "qAttributeExpressions.0.qExpression" and not a custom reference name, like your "qAttributeExpressions.0.nwsStyle". I'm not sure that this matters 100%, but I think it tells Qlik to evaluate this expression for each dimensional value and put the result with the rest of the data.

Next, in the body of my code (the paint function), I can find the values deep in my layout object:

Basically, in my case, I have a matrix with 16 rows, representing 16 combinations of the the two dimensions I'm using in my object. The array[3] is because I have 2 defined dimensions and 1 measure. If I dive into the first dimension I see the object qAttrExps and a sub-object qValues. Because I used qAttributeExpressions.0.qExpression (with a zero) I get my evaluated color expression in the first index of the qValues array. Depending on how you set this up it could either by a Num or a Text. In my case the expression returned a text, a nice RGB representation.

Give that a try and let me know if it works. I did this a couple months ago, so I'm a little rusty on what I've done. But hopefully this helps. Also, if you want to see my code where I did this stuff you can go here:

GitHub - jonvitale/SenseColorableSankey: Qlik Sense Colorable Sankey Extension