Nebula Listbox properties

nebula listbox properties definition

Download JavaScript spec

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

  • representation Representation
    Required
    Show representation properties
    • borderColor string

      Cell border color. Only used when type is 'image' and borderWidth > 0.

      default = "#d9d9d9"

    • borderColorMode 'single'  |  'expression'  |  'selectionState'

      Cell border color mode. Only used when type is 'image' and borderWidth > 0.

      default = "single"

    • borderWidth number

      Cell border width in px. Only used when type is 'image'.

      default = 0

    • cellBgColor string  |  object  |  ValueExpression

      Cell background color (hex string or color object when cellBgColorMode='single') or expression (when cellBgColorMode='expression'). Only used when type is 'image'.

    • cellBgColorMode 'single'  |  'expression'  |  'selectionState'

      Cell background color mode. Only used when type is 'image'.

      default = "single"

    • cornerRadius number

      Corner radius of the image cell in pixels. Only used when type is 'image'.

      default = 4

    • gridGap number

      Spacing between image grid cells, as a percentage of the column width. Only used when type is 'image'.

      default = 1

    • imageLabel ValueExpression

      Per-value image label expression. Only used when type is 'image' and imageSetting is 'label'. Stored in qExpressions with qLabel='imageLabel'.

      Show imageLabel properties
      • qValueExpression object
        Required
        Show qValueExpression properties
        • qExpr string
          Required
    • imagePosition string

      Image position within the cell. Only used when type is 'image' and imageSize is not 'stretch'.

      default = "topCenter"

    • imageSetting 'url'  |  'label'

      When type is 'image', choose whether the per-value expression (qExpressions.qLabel='imageUrl'/'imageLabel') provides the image URL ('url') or the image label ('label').

      default = "label"

    • imageSize 'alwaysFit'  |  'fitWidth'  |  'fitHeight'  |  'stretch'  |  'alwaysFill'

      Image sizing mode. Only used when type is 'image'.

      default = "alwaysFit"

    • imageUrl ValueExpression

      Per-value image URL expression. Only used when type is 'image' and imageSetting is 'url'. Stored in qExpressions with qLabel='imageUrl'.

    • showSelected boolean

      When type is 'image', show only selected values once a selection is applied (while selecting, all values stay visible). Set to false to keep unselected values visible.

      default = true

    • subtitle ValueExpression

      Per-value subtitle expression. Only used when type is 'image' and textOverlay is not false.

    • textOverlay boolean

      Whether to render the title/subtitle overlay text. Only used when type is 'image'.

      default = true

    • titleBackground boolean

      Draw a background behind the title text for legibility. Only used when type is 'image'.

      default = true

    • titlePosition string

      Overlay text alignment as {vertical}-{horizontal} (e.g. 'top-left', 'center-center', 'bottom-right'). Only used when type is 'image'.

      default = "top-center"

    • tooltip ValueExpression

      Per-value tooltip expression. Only used when type is 'image'.

    • type 'text'  |  'image'

      How the dimension values are presented.

      default = "text"

  • 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

Representation interface

Representation settings for the dimension values, set on the listbox object root representation (a sibling of qListObjectDef, alongside layoutOptions).

Notes on image representation:

    • When type is 'image' the values are rendered as images. Image metadata is resolved from list-object expressions (qListObjectDef.qExpressions) using their qLabel keys.

Properties

  • borderColor string

    Cell border color. Only used when type is 'image' and borderWidth > 0.

    default = "#d9d9d9"

  • borderColorMode 'single'  |  'expression'  |  'selectionState'

    Cell border color mode. Only used when type is 'image' and borderWidth > 0.

    default = "single"

  • borderWidth number

    Cell border width in px. Only used when type is 'image'.

    default = 0

  • cellBgColor string  |  object  |  ValueExpression

    Cell background color (hex string or color object when cellBgColorMode='single') or expression (when cellBgColorMode='expression'). Only used when type is 'image'.

  • cellBgColorMode 'single'  |  'expression'  |  'selectionState'

    Cell background color mode. Only used when type is 'image'.

    default = "single"

  • cornerRadius number

    Corner radius of the image cell in pixels. Only used when type is 'image'.

    default = 4

  • gridGap number

    Spacing between image grid cells, as a percentage of the column width. Only used when type is 'image'.

    default = 1

  • imageLabel ValueExpression

    Per-value image label expression. Only used when type is 'image' and imageSetting is 'label'. Stored in qExpressions with qLabel='imageLabel'.

    Show imageLabel properties
    • qValueExpression object
      Required
      Show qValueExpression properties
      • qExpr string
        Required
  • imagePosition string

    Image position within the cell. Only used when type is 'image' and imageSize is not 'stretch'.

    default = "topCenter"

  • imageSetting 'url'  |  'label'

    When type is 'image', choose whether the per-value expression (qExpressions.qLabel='imageUrl'/'imageLabel') provides the image URL ('url') or the image label ('label').

    default = "label"

  • imageSize 'alwaysFit'  |  'fitWidth'  |  'fitHeight'  |  'stretch'  |  'alwaysFill'

    Image sizing mode. Only used when type is 'image'.

    default = "alwaysFit"

  • imageUrl ValueExpression

    Per-value image URL expression. Only used when type is 'image' and imageSetting is 'url'. Stored in qExpressions with qLabel='imageUrl'.

  • showSelected boolean

    When type is 'image', show only selected values once a selection is applied (while selecting, all values stay visible). Set to false to keep unselected values visible.

    default = true

  • subtitle ValueExpression

    Per-value subtitle expression. Only used when type is 'image' and textOverlay is not false.

  • textOverlay boolean

    Whether to render the title/subtitle overlay text. Only used when type is 'image'.

    default = true

  • titleBackground boolean

    Draw a background behind the title text for legibility. Only used when type is 'image'.

    default = true

  • titlePosition string

    Overlay text alignment as {vertical}-{horizontal} (e.g. 'top-left', 'center-center', 'bottom-right'). Only used when type is 'image'.

    default = "top-center"

  • tooltip ValueExpression

    Per-value tooltip expression. Only used when type is 'image'.

  • type 'text'  |  'image'

    How the dimension values are presented.

    default = "text"

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