Skip to main content

Table properties

These are the properties used by Qlik Sense straight tables.

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.

qHyperCubeDef

Type: Object

The hypercube definition used by most visualizations.

A subset of the properties available in the qHyperCubeDef is presented here. For complete documentation of all available properties, see Engine API: HyperCubeDef.

columnOrder

Type: Array

Description: Index array that determines the column order, where 0 is the first column, 1 is the second, and so on. If omitted, a default value will be used.

columnWidths

Type: Array

Description: Array that determines the column widths. If omitted, a default value will be used.

-1 equals to auto.

qDimensions

Type: Array

Description: Extends NxDimension, see Engine API: NxDimension.

  • qDef

    Type: Object

    Description: Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

    Additional properties:

    • textAlign

      Type: Boolean

      Description: Set to automatically sort the measure.

      Default: true

      Name Type Description
      auto Boolean

      Can be one of:

      • true
      • false

      Default: true
      align String

      Can be one of:

      • left
      • right
      • center

      Default: left

    • representation

      Type: Object

      Description: Can be one of:

      Name Type Description
      type String

      Determines how column values are represented. One of:

      • text
      • url

      Default: text
      urlLabel String

      Label to use when represented as url. Used as a static string, like “Click here”. An empty string displays the actual URL.
      urlLabel Object

      Label to use when represented as url. Used with an expression for the Label part of the link.

      • qStringExpression: Object
        • qExpr: String. The expression used to generate the Label part of the link. Needs to be set in representation.qAttributeExpressions array, as well as in the Object with id=’urlLabel’.
      linkUrl Object

      URL to use when represented as url. Used with an expression for the URL part of the link. Use dimension or attribute.

      • qStringExpression: Object
        • qExpr: String. The expression used to generate the url part of the link. Needs to be set in representation.qAttributeExpressions array, as well as in the Object with id=’urlLabel’.
      urlPosition String

      The position of the url part of the link. One of:

      • dimension
      • attribute

      If the property is not set, it is treated as having the value of dimension.
      qAttributeExpressions Array

      The expression settings to use for URL labels or URL hyperlinks.

      Label expression

      Name Type Description
      qExpression String The string containing the expression used for the URL labels.
      id String The urlLabel
      qAttribute Boolean Default: true

      URL expression

      Name Type Description
      qExpression String The string containing the expression used for the URL hyperlinks.
      id String The url
      qAttribute Boolean Default: true

    • modifiers

      Type: Array

      Description: Set to apply a modifier to a measure.

      Name Type Description
      accumulation Object

      Only displayed when accumulation has been set as a modifier. It allows you to accumulate values of your measure over one or two dimensions.

      Properties:

      • accumulationDimension: Integer: Only displayed when there are two dimensions. Selects the dimension on which the accumulation will take place. If the accumulation is made across multiple dimensions, this will be the first dimension.
      • crossAllDimensions: Boolean: Only displayed when there are two dimensions. Continues accumulation across both dimensions.
      • fullAccumulation: Boolean: Select whether the accumulation will happen on the Full range or Custom range.

      • steps: Integer: Only displayed when Range is set to Custom. The number of steps in the dimensions which form an accumulation range. Only zero and positive integers are accepted.
        Note: Sorting order of dimension values (or step order) is important and affects results.

      • outputExpression: String: Shows the expression used by the modifier.
      • showExcludedValues: Boolean: Shows the excluded values (values not in the current selection) in the accumulation.
      • disabled: Boolean
      movingAverage Object

      Only displayed when movingAverage has been set as a modifier.

      Properties:

      • primaryDimension: Integer: Only displayed when there are two dimensions. Selects the dimension on which the moving average will take place. If the moving average is made across multiple dimensions, this will be the first dimension.
      • crossAllDimensions: Boolean: Only displayed when there are two dimensions. Continues the moving average across both dimensions.
      • fullRange: Boolean: Select whether the moving average will happen on the Full range or Custom range.
      • steps: Integer: Only displayed when Range is set to Custom. The number of steps in the dimension which form a moving average. Only zero and positive integers are accepted. Note: Sorting order of dimension values (or step order) is important and affects results.

      • nullSuppression: Boolean: Choose to have null values calculated by the moving average modifier.

      • outputExpression: String: Shows the expression used by the modifier.
      • showExcludedValues: Boolean: Shows the excluded values (values not in the current selection) in the moving average.
      • disabled: Boolean
      difference Object

      Only displayed when difference has been set as a modifier.

      Properties:

      • primaryDimension: Integer: Only displayed when there are two dimensions. Selects the dimension on which the difference will take place. If the difference is made across multiple dimensions, this will be the first dimension.
      • crossAllDimensions: Boolean: Only displayed when there are two dimensions. Continues the difference across both dimensions.
      • outputExpression: String: Shows the expression used by the modifier.
      • showExcludedValues: Boolean: Shows the excluded values (values not in the current selection) in the difference.
      • disabled: Boolean
      relativeNumber Object

      Only displayed when relativeNumber has been set as a modifier. Allows you to see relative percentages to see the impact of specific selections, relative to the selection, relative to the total, or relative to other fields. You can change the basis upon which the relative number is calculated.

      Properties:

      • dimensionalScope: Type: Integer. Sets whether the relative numbers are calculated based on a dimension. You can choose to have the modifier respect all available dimensions, respect a specific dimension if there are two, or to disregard the dimensions. The dimension values can be one of:
        • respectOneDimension: Value: 0. Available when more than one dimensions are available. Calculates the subtotal for that dimension.
        • respectAllDimensions: Value: 1. Available when more than one dimensions are available. Uses all dimensions when calculating the modifier. The calculated number is relative to every dimensional value, for both dimensions.
        • disregardDimension: Value: 2. Available when more than one dimensions are available. Uses the total when calculating the modifier. The calculated number is relative to the total.
        • disregardAllDimensions: Value: 3. Available when more than one dimensions are available. Uses the total when calculating the modifier. The calculated number is relative to the total.
      • selectionScope: Type: Integer. Sets whether the relative numbers are calculated based on the current selection or a specific field value. You can also disregard the current selection. The selection values can be one of:
        • currentSelection: Value: 0. Uses current selection to calculate modifier.
        • selectFieldValue: Value: 1. Uses a field to calculate the modifier.
        • disregardSelection: Value: 2. Disregards any selections when calculating the modifier.

    • autoSort

      Type: Boolean

      Description: Defines if the dimension should be auto-sorted. Default: true.

    • cId

      Type: String

      Description: ID used by the client. Must be unique within the current chart.

    • othersLabel

      Type: StringExpressionContainer

      Description: Label for the others group if dimension limits are used.


  • qAttributeDimensions

    Type: Array

    Description: Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

    • id

      Type: String

      Description: One of:

      • cellBackgroundColor: for attribute expression, expression for background color of table cell.
      • cellForegroundColor: for attribute expression, expression for text color of table cell.

qMeasures

Type: Array

Description: Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

  • qDef

    Type: Object

    Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

    Additional properties

    Additional properties:

    • representation

      Type: Object

      Description: Can be one of:

      Name Type Description
      type String

      "text" or "indicator"
      indicator Object
      Name Type Description
      showTextValues Boolean Controls if text value is shown with indicator.
      applySegmentColors Boolean Controls if text color should match indicator color.
      position String Left or right. Controls if the indicator should be to the left or right of the text.

    • conditionalColoring

      Type: Object

      Description: Coloring settings.

      • segments

        • Type: Object

        Description: Segment settings.

        Name Type Description
        limits Array

        Properties

        Name Type Description
        value Number

        Value of the divider between two segments. A segment is above and below this value.
        gradient Boolean

        Controls if the color from the segment below the limit should be blended with the color from the segment above the limit.

        Creates a new color gradient.
        paletteColors Array

        Colors of the segments. Array should contain (segment limits) + 1 colors.

        There should be one more paletteColors value then there are limit values.

        Properties

        Name Type Description
        color String

        Hexidecimal value used to color a segment.

        Value is optional.

        For theme colors, index property can be set instead.
        index Integer

        Refers to the index in the theme color palette.

        Can be set to -1 if using the color property.
        icon String

        Icon to use in a segment.

        Optional

    • textAlign

      Type: Boolean

      Description: Set to automatically sort the measure.

      Default: true

      Name Type Description
      auto Boolean

      Can be one of:

      • true
      • false

      Default: true
      align String

      Can be one of:

      • left
      • right
      • center

      Default: left

    • autoSort

      Type: Boolean

      Description: Defines if the dimension should be auto-sorted.

      Default: true

    • numFormatFromTemplate

      Type: Boolean

      Description: When enabled, the number format to use can be selected from multiple predefined formats based on the desired type: number or date.

      Default: true

    • isCustomFormatted

      Type: Boolean

      Description: Set to true to toggle off the default client formatting.


  • qAttributeExpressions

    Type: Array

    Description: Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

    • id

      Type: String

      Description: One of:

      • cellBackgroundColor: for attribute expression, expression for background color of table cell.
      • cellForegroundColor: for attribute expression, expression for text color of table cell.

qLayoutExclude

Type: Object

customErrorMessage

Type: Object

Description:Set to define custom error messages.

Name Type Description
calcCond String

Deprecated. Use qCalcCondition.qMsg instead.

Set to customize the calculation condition unfilled message.

components

Type: Array

Component settings. All theme component properties are unset (null) when creating a chart. The values for each attribute are fetched from the current theme. Setting any property here will override the theme used.

Properties

Name Type Description
key String

Determines which component the settings apply to.

Possible values:

'theme'
content Object

Properties

Name Type Description
fontSize Integer

Font size of table content text.

Default: unset
fontColor Object

Set to specify color:

{index: 2, color: '#ff0055'}

Default: unset
header Object

Properties

Name Type Description
fontSize Integer

Font size of table header text.

Default: unset
fontColor Object

Set to specify color:

{index: 2, color: '#ff0055'}

Default: unset

totals

Type: Object

Totals row settings.

Properties

Name Type Description
show Boolean

Set to automatically display totals row.

Default: true
position String

Set the position of the totals row. Can be one of:

  • noTotals
  • top
  • bottom

Default: noTotals
label String

Set the label of the totals row.

Default: Totals

scrolling

Type: Object

Settings related to scrolling behavior.

Properties

Name Type Description
keepFirstColumnInView Boolean

Specifies if the first column should be locked when the content is scrolled horizontally. Locking the first column allows to easily associate content in other columns with the objects represented in the rows.

Default: false
keepFirstColumnInViewTouch Boolean

Specifies if the keepFirstColumnInView property applies to touch screen devices.

Default: false
horizontal Boolean

Specifies if the content is scrolled horizontally (true), or hides the columns that cannot be rendered in the given space in a column picker (false).

Default: true

search

Type: Object

Search settings for the list box.

Properties

Name Type Description
sorting String

The settings for sorting the values of a dimension in a list box.

Can be one of:

  • auto

    Specifies if the search values of a dimension are auto sorted alphabetically or numerically in ascending order.

    Default: true

  • inherit

    Specifies if the sort settings are inherited from the dimension selected by the user.

multiline

Type: Object

Header and text wrapping settings.

Properties added in Qlik Sense November 2017.

Properties

Name Type Description
wrapTextInHeaders Boolean

Set to true to enable text wrapping into multiple lines in the table headers. When disabled, the table headers appear more compact.

Default: true
wrapTextInCells Boolean

Set to true to enable text wrapping into multiple lines in the tables data cells. When disabled, the table cell content appear more compact and more rows can be shown on the screen.

Default: true