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.

Properties

Name Type Description
columnOrder Array

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 Array

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

-1 equals to auto.
qDimensions Array

Extends NxDimension, see Engine API: NxDimension.

Additional properties

Name Type Description
qDef Object

Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

Additional properties

Name Type Description
textAlign Object

Properties

Name Type Description
auto Boolean Default: true
align String

Can be one of:

  • left
  • right

Default: left
representation Object

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. Empty string displays the actual URL.
modifiers Array

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: 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: Continues accumulation across all available dimensions.
  • fullAccumulation: Boolean: Select whether the accumulation will happen on the Full range or Custom range.
  • outputExpression: String: Shows the expression used by the modifier.
  • showExcludedValues: Boolean: Include excluded values in the accumulation.
  • steps: Integer: Only displayed when Range is set to Custom. The number of steps in the dimension which form an accumulation range. Only zero and positive integers are accepted.
  • disabled: Boolean
autoSort Boolean

Defines if the dimension should be auto-sorted.

Default: true
cID String  
othersLabel

StringExpressionContainer

Label for the others group if dimension limits are used.
qAttributeDimensions Array

Extends NxAttrDimDef, see Engine API: NxAttrDimDef.

Additional properties

Name Type Description
id String

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 Array

Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

Name Type Description
qDef Object

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Additional properties

Name Type Description
textAlign Object

Properties

Name Type Description
auto Boolean Default: true
align String

Can be one of:

  • left
  • right

Default: left
autoSort Boolean

Defines if the measure should be auto-sorted.

Default: true
numFormatFromTemplate Boolean

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 Boolean Set to true to toggle off the default client formatting.
qAttributeExpressions Array

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Additional properties

Name Type Description
id String

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 Object  
customErrorMessage Object

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

Same as paletteColor used in color.

Default: unset
Header Object

Properties

Name Type Description
fontSize Integer

Font size of table header text

Default: unset
fontColor Object

Same as paletteColor used in color.

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 added in Qlik Sense November 2017.

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

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