Appendix

Appendix A: List of useful CSS definitions for button styling

The Button Editor makes heavy use of CSS definitions for styling buttons. The following lists give an overview of frequently used CSS properties.

A.1. Colors

The following color expressions can be used in MENUBAR:

Color names: black, white, red, etc.
Hex values, three or six digits: #f80, #ff8800
Hex values, four or eight digits (alpha channel): #f087, #ff008877
RGB and RGBA: rgb(255,127,0), rgba(255,127,0,.5) or rgb(255 127 0), rgba(255 127 0 / .5)
HSL and HSLA: hsl(360,100%,50%), hsla(360,100%,50%,.8) or hsl(360 100% 50%), hsla(360 100% 50% / .8)
ARGB: =argb(127,255,63,15) with the alpha channel being a value between 0 and 255.

Appendix B: White- and Blacklist for Actions

The config file will be reset after every update. Please make a backup of your config file and edit the new config file after every update.

With the config.js file located in the extension folder, actions of the button can either be black- or whitelisted. Blacklisted actions are not available while whitelisted actions are. The combination of both methods is necessary to create specific scenarios, where all actions are blacklisted for a user group but some users have whitelisted actions.

The listing rules can be defined for user directories and users. Just enter the user directory name(s) and the user name(s). Writing a "*" will target all users or user directories depending on where the "*" is used.

If there are no actions available after setting the config to make sure that the action "none" is set as a whitelisted action. Also, it’s important to note that the trigger is not visible and can not be reused when the trigger is already defined but is blocked because of the config. For example, an onClick trigger cannot be set two times. The only exception is custom triggers which can be defined multiple times.

Figure 61. Listing example.

Appendix C: List of actions for triggers

The following actions can be attached to events that trigger a button.

C.1. None

Action	Parameters
None	No parameters.

C.2. Custom

Action	Parameters
Custom	A custom JS function to be executed with the Custom event.

Action	Parameters
Next sheet/page	No parameters.
Previous sheet/page	No parameters.
Go to sheet	Sheet id of the sheet to go to; can be entered manually or automatically by using the drop-down list.
Go to story	Story id of the story to go to; can be entered manually or automatically by using the drop-down list.
Go to url	Specify the URL in the Url input box and the target in the Target list. The Mashup only option restricts the action to mashups.
Go to app	Specify the id of the app you’d like to navigate to in the App ID input box and the id of the specific sheet in the Sheet ID input. If you select Email as the target you can further specify an email address, email subject and email body. You can use {0} as a placeholder for the generated link. You can also add a custom text for the link. The link will then show the text as specified. If omitted, it will be inserted at the end of the body. You can also specify the link to be opened in the same, new, custom named window or just be copied to the clipboard. If you use the email option, the email will be generated as an eml file. That way the email can have custom HTML and allows the option for the individual link. In order to download the eml file, the system administrators have to enable the option to download the generated eml file in the browsers. Currently, all browsers handle the download of eml files differently. In general, all browsers need to allow downloads. Then either save the eml file or open it directly. It is possible to clear all selections or apply current selections in the target app by checking the corresponding checkboxes. For current selections to work, the currently selected fields/dimensions need to be present in the target app as well. Additionally, you can add optional parameters to apply specific selections or a bookmark. Limitations: In "Qlik Sense Desktop" the Email target doesn’t work. Eml files are necessary because direct emails can not handle the sense links correctly Generated eml files are shown as possible bad software by some browsers Links in outlook don’t open selections correctly when using the link directly, to open the links use the copy hyperlink option Fields/Dimensions containing "%" characters, they will not be applied. When importing apps from another system, their ID changes. So, for example, if you designed a target app locally and push it to a server, this action will no longer work since the target app ID has changed. It needs to be manually repaired. This is also the case when publishing.
Share app	Specify the target of a generated link to be shared as email or added to clipboard. If you select Email as the target you can further specify an email address, email subject and email body. You can use {0} as a placeholder for the generated link. You can also add a custom text for the link. The link will then show the text as specified. If omitted, it will be inserted at the end of the body. If you use the email option, the email will be generated as an eml file. That way the email can have custom HTML and allows the option for the individual link. In order to download the eml file, the system administrators have to enable the option to download the generated eml file in the browsers. Currently, all browsers handle the download of eml files differently. In general, all browsers need to allow downloads. Then either save the eml file or open it directly. Target clipboard adds the generated link to the clipboard and shows a message to the user. Limitations: In "Qlik Sense Desktop" the Email target doesn’t work. In mashup/story mode the URL can’t be properly generated. Eml files are necessary because direct emails can not handle the sense links correctly Generated eml files are shown as possible bad software by some browsers Links in outlook don’t open selections correctly when using the link directly, to open the links use the copy hyperlink option

C.4. Sense

Action	Parameters
Set variable	Specify the variable and value to be set in the Sense variable and Variable content input box. The Keep option keeps the value unchanged if it’s already set.
Select value(s)	Select the field and value(s) in the Field name and Value(s) input box. The Toggle option will toggle between selected states. The Soft lock option sets locked selections to be overridden. The Keep option sets existing selections for the selected field to remain unchanged. The Add option sets the values to be added to the existing selection.
Select match	Specify the field to be selected and value(s) in the Field name and Value(s) input box. The Soft lock option sets locked selections to be overridden. The Keep option sets existing selections for the selected field to remain unchanged.
Select alternative	Specify the field to be selected in the Field name input box. The Soft lock option sets locked selections to be overridden.
Select excluded	Specify the field to be selected in the Field name input box. The Soft lock option sets locked selections to be overridden.
Select possible	Specify the field to be selected in the Field name input box. The Soft lock option sets locked selections to be overridden.
Select all	Specify the field to be selected in the Field name input box. The Soft lock option sets locked selections to be overridden.
Selection backward	No parameters.
Selection forward	No parameters.
Clear field	Select the field to be cleared in the Field name input box.
Clear other	Select the field in the Field name input box. The Soft lock option sets locked selections to be overridden.
Clear all	Set the Locked also option to also clear locked selections.
Lock field	Select the field in the Field name input box.
Lock all	Set the Locked also option to also clear locked selections.
Unlock field	Select the field in the Field name input box.
Unlock all	No parameters.
Apply bookmark	Bookmark id which can be entered manually or automatically by using the drop-down list.
Reload data	Set the desired mode in the Mode list. Set the Partial option to do only a partial reload.

The Reload data action should be used with extreme care as reloading the app triggers a sheet reload which can result in the complete loss of unsaved comments on this sheet. Additionally, in the case of publicated apps, it is necessary to create a corresponding Security Rule on the Qlik Sense server. Security Rule configuration hints for this reload action can be found here: Enable the reload action for published apps.

C.5. Other

Action	Parameters
Toggle fullscreen	The expression which must result 0 (disable fullscreen), 1 (go to fullscreen) or can be empty (toggles current fullscreen mode). This action is only on click trigger available, due to browser security restrictions.

TRUECHART knowledge base