Skip to main content Skip to complementary content

listbox properties

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.


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 history
Version state Details
Introduced Qlik Sense November 2017



Type: Boolean

Show title for the visualization.

Default: true.


Type: Boolean

Sets if visualization details should be shown.

Default: false


Type: String | qStringExpression

Visualization title shown if "showTitles": true.


Type: String | qStringExpression

Visualization subtitle shown if "showTitles": true.


Type: String | qStringExpression

Visualization footnote shown if "showTitles": true.


Type: Boolean

Disables the hover menu in the visualization.

Default: false


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.


  • 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

Example using Visualization API

Tip noteFor more examples of how to create list boxes on the fly, see Mashups: Creating list boxes.

In this example we create a basic list box with a custom title.

    "showTitles": true,
    "title": "Courses"

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!