Listbox

nebula listbox properties definition

Download specification

ListboxProperties object

Properties

  • autoConfirm boolean

    Automatically confirm selections when clicking outside a listbox, without showing the selections toolbar.

    default = false

  • checkboxes boolean

    Show values as checkboxes instead of as fields.

    default = false

  • frequencyMax 'fetch'  |  ValueExpression

    frequencyMax calculation needed for histogram when not using qListObjectDef.qFrequencyMode: 'P' use an expression in the form Max(AGGR(Count([field]), [field])) (when needed) or 'fetch' that triggers an extra engine call but needed for library dimension that could change field when using the object

  • histogram boolean

    Show histogram bar. also requires (qListObjectDef.qFrequencyMode 'V' and frequencyMax) or qListObjectDef.qFrequencyMode 'P'

    default = false

  • layoutOptions object

    Layout settings.

    Show layoutOptions properties
    • dataLayout 'singleColumn'  |  'grid'

      Layout mode.

      default = "singleColumn"

    • dense boolean

      Dense mode.

      default = false

    • layoutOrder 'row'  |  'column'

      Layout order. Only used when dataLayout is 'grid'

      default = "row"

    • maxVisibleColumns object

      Max visible columns. Only used when dataLayout is 'grid' and layoutOrder is 'row'

      Show maxVisibleColumns properties
      • auto boolean

        Automatically fit as many columns as possible. Only used when dataLayout is 'grid' and layoutOrder is 'row'

        default = true

      • maxColumns number

        Fixed number of max visible columns. Only used when dataLayout is 'grid' layoutOrder is 'row' and auto is false

        default = 3

    • maxVisibleRows object

      Max visible rows. Only used when dataLayout is 'grid' and layoutOrder is 'column'

      Show maxVisibleRows properties
      • auto boolean

        Automatically fits as many rows as possible. Only used when dataLayout is 'grid' and layoutOrder is 'column'

        default = true

      • maxRows number

        Fixed number of max visible rows. Only used when dataLayout is 'grid' layoutOrder is 'column' and auto is false

        default = 3

  • qListObjectDef ListObjectDef
    Required
    Show qListObjectDef properties
    • frequencyEnabled boolean

      Show frequency count. also requires qListObjectDef.qFrequencyMode to be set

      default = false

  • searchEnabled boolean

    Enables search.

    default = true

  • showTitle boolean

    Show title.

    default = true

  • title string

    Listbox title

    default = ""

  • wildCardSearch boolean

    Pre-fill search input field with wildcard characters.

    default = false

ListObjectDef interface

extends qix.ListObjectDef

Extends ListObjectDef, see Engine API: ListObjectDef.

Properties

  • frequencyEnabled boolean

    Show frequency count. also requires qListObjectDef.qFrequencyMode to be set

    default = false

ValueExpression object

see: https://qlik.dev/apis/json-rpc/qix/schemas#%23%2Fdefinitions%2Fschemas%2Fentries%2FValueExpression

Properties

  • qValueExpression object
    Required
    Show qValueExpression properties
    • qExpr string
      Required