listbox properties
This API is reliable and breaking changes are unlikely.
listbox()
These are the properties used by Qlik Sense list boxes.
When the engine calculates the layout of a list object, it calculates all values. If some selections are applied, the selected values are displayed along with the excluded and optional values
Version history
| Version state | Details |
|---|---|
| Introduced | Qlik Sense November 2017 |
Properties
showTitles
Type: Boolean
Show title for the visualization.
Default: true.
showDetails
Type: Boolean
Sets if visualization details should be shown.
Default: false
title
Type: String | qStringExpression
Visualization title shown if "showTitles": true.
subtitle
Type: String | qStringExpression
Visualization subtitle shown if "showTitles": true.
footnote
Type: String | qStringExpression
Visualization footnote shown if "showTitles": true.
disableNavMenu
Type: Boolean
Disables the hover menu in the visualization.
Default: false
qListObjectDef
Type: Object
A subset of the properties available in the ListObjectDef is presented here. For complete documentation of all available properties, see Engine API: ListObjectDef.
Properties
-
qDef
Type: Object
Description: Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.
qDef properties Name Type Description autoSort Boolean Set to automatically sort the dimension.
Default: true
cId String ID used by the client. Must be unique within the current chart. othersLabel StringExpressionContainer String expression container. -
frequencyEnabled
Type: Boolean
Controls whether or not the frequency count is displayed in the listbox. Default: false
In this example we create a basic list box with a custom title.
app.visualization.create(
'listbox',
[
"Course"
],
{
"showTitles": true,
"title": "Courses"
}
).then(function(vis){
vis.show("QV01");
});