Qlik Community

QlikView Extensions

Discussion Board for collaboration on QlikView Extensions.

Not applicable

What are the object property names that I can pass to SetProperty?

Hello,

I'm working with a QlikView Document extension and trying to change object properties from my JavaScript code.

From the API documentation available:

https://help.qlik.com/en-US/qlikview-developer/12.1/apis/js%20API/symbols/Qv.Document.Object.Layout....

and taking for example a line object, 'LA14', I am able to use:

Qv.GetCurrentDocument().GetObject('LA14').Layout.SetProperty('Caption.Text','test#ff0000',true);

to change the caption label to 'test#ff0000'.

The problem comes when I want to change anything else, such as the background colour (color) because the documentation doesn't list the property names that you need to pass to the function SetProperty. For example the only reason I knew to use 'Caption.Text' is because it was in the example. I have tried 'Background.Color', 'Presentation.Color' and many other variants but with no luck.

Where can I find a list of these property names?

Thanks,

1 Solution

Accepted Solutions
MVP & Luminary
MVP & Luminary

Re: What are the object property names that I can pass to SetProperty?

The available properties in a QV extension are documented here in the sub-sections.

https://help.qlik.com/en-US/qlikview-developer/12.1/Subsystems/Extensions/Content/extensions-propert...

There is some analogy, but these properties are not the same as those in the API Guide.

-Rob

http://masterssummit.com

http://qlikviewcookbook.com

8 Replies

Re: What are the object property names that I can pass to SetProperty?

If you selected "everything" during QV Desktop Installation, there should be an API document available on your C: drive.

Check C:\ProgramData\QlikTech\QlikView Documentaiton\Automation and open the single qvw located overthere.

Not applicable

Re: What are the object property names that I can pass to SetProperty?

I do not have that directory but I have seen reference to it on other posts I have read. It appeared to me to be from older versions of QlikView? If not, then please could you upload a copy so I can see if it is any help?

Does this tell you the required property name to change the background colour (color) of a line/arrow object for example?

Thanks

Re: What are the object property names that I can pass to SetProperty?

See here for a copy if you don't have the APIGuide installed: API GUIDE - Version 11

The core properties of QV and its UI objects haven't changed much between 11, 11.20 and 12. The technology has stabilised, and these days R&D development attention goes to Qlik Sense.

Most properties are documented with examples. Some properties are only available in arrays or matrices. Search the community for more information when you know what you want to manipulate.

MVP & Luminary
MVP & Luminary

Re: What are the object property names that I can pass to SetProperty?

The available properties in a QV extension are documented here in the sub-sections.

https://help.qlik.com/en-US/qlikview-developer/12.1/Subsystems/Extensions/Content/extensions-propert...

There is some analogy, but these properties are not the same as those in the API Guide.

-Rob

http://masterssummit.com

http://qlikviewcookbook.com

Re: What are the object property names that I can pass to SetProperty?

Thanks ROb, I should remember that.

Not applicable

Re: What are the object property names that I can pass to SetProperty?

That's great, thank you!

MVP & Luminary
MVP & Luminary

Re: What are the object property names that I can pass to SetProperty?

PEtEr,

I keep trying to get that "O" corrected, but no joy yet.

-ROb

Re: What are the object property names that I can pass to SetProperty?

Ok, I'll stop.

No worries, once you get that fixed, my name will probably reappear in all lower case. Together with Gysbert's it seems.