table properties

table()

These are the properties used by Qlik Sense straight tables.

Version history

Properties

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.

disableNavMenu

Type: Boolean

Disables the hover menu in the visualization.

Default: false

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

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

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

-1 equals to auto.

qDimensions

Type: Array

Extends NxDimension, see Engine API: NxDimension.

• qDef
  

  Type: Object

  Extends NxInlineDimensionDef, see Engine API: NxInlineDimensionDef.

  Additional properties:

  • 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.

  • textAlign

    Text alignment settings.

    textAlign Properties

    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

    Representation settings.

    representation properties

    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	Label expression: qExpression: Type: String. The string containing the expression used for the URL labels. id: Type: String. The urlLabel. qAttribute: Type: Boolean. Attribute enabled. Default: true.   URL expression: qExpression: Type: String. The string containing the expression used for the URL hyperlinks. id: Type: String. The url. qAttribute: Type: Boolean. Attribute enabled. Default: true.

  • modifiers
    

    Type: Array

    Description: Set to apply a modifier to a measure.

    Available modifiers

    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: Type: 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: Type: Boolean. Only displayed when there are two dimensions. Continues accumulation across both dimensions. fullAccumulation: Type: Boolean. Select whether the accumulation will happen on the Full range or Custom range. steps: Type: 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: Type: String. Shows the expression used by the modifier. showExcludedValues: Type: Boolean. Shows the excluded values (values not in the current selection) in the accumulation. disabled: Type: Boolean.
    movingAverage	Object	Only displayed when movingAverage has been set as a modifier. Properties: primaryDimension: Type: 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: Type: Boolean. Only displayed when there are two dimensions. Continues the moving average across both dimensions. fullRange: Type: Boolean. Select whether the moving average will happen on the Full range or Custom range. steps: Type: 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: Type: Boolean. Choose to have null values calculated by the moving average modifier. outputExpression: Type: String. Shows the expression used by the modifier. showExcludedValues: Type: Boolean. Shows the excluded values (values not in the current selection) in the moving average. disabled: Type: Boolean.
    difference	Object	Only displayed when difference has been set as a modifier. Properties: primaryDimension: Type: 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: Type: Boolean. Only displayed when there are two dimensions. Continues the difference across both dimensions. outputExpression: Type: String. Shows the expression used by the modifier. showExcludedValues: Type: Boolean. Shows the excluded values (values not in the current selection) in the difference. disabled: Type: 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.

• qAttributeExpressions
  

  Type: Array

  Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

  id

  Type: 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

Type: Array

Description: Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

• qDef
  

  Type: Object

  Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

  Additional properties:

  • representation

    Type: Object

    Representation settings.

    representation properties

    Name	Type	Description
    type	String	Determines how column values are represented. One of: text indicator miniChart
    indicator	Object	Indicator properties. showTextValues: Type: Boolean. Controls if text value is shown with indicator. applySegmentColors: Type: Boolean. Controls if text color should match indicator color. position: Type: String. Can be either Left or right. Controls if the indicator should be to the left or right of the text.
    miniChart	Object	miniChart properties. type: Type: String. Chart type. Can be one of: sparkline dots bars posNeg showDots: Type: Boolean. Only used for sparkline. colors: Type: Object. Color settings. main index (Integer): Index in palette of the main color used in the mini-chart. color (String): Color as HEX string. Optional, only used as default. min index (Integer): Index in palette used to color min data values. Not used for posNeg. color (String): Color as HEX string. Optional, only used as default. max index (Integer): Index in palette used to color max data values. Not used for posNeg. color (String): Color as HEX string. Optional, only used as default. first index (Integer): Index in palette used to color the first data value. Not used for posNeg. color (String): Color as HEX string. Optional, only used as default. last index (Integer): Index in palette used to color the last data value. Not used for posNeg. color (String): Color as HEX string. Optional, only used as default. positive index (Integer): Index in palette only used by posNeg to color all positive values. color (String): Color as HEX string. Optional, only used as default. negative index (Integer): Index in palette only used by posNeg to color all negative values. color (String): Color as HEX string. Optional, only used as default. yAxis: Type: Object. Y axis settings. scale (String): Can be one of: local: The y-axis is scaled to the min and max values per cell. global: The y-axis is scaled the same way across the entire column, that is, the y-axis has the same min and max value for all charts in that column. Not used for posNeg. position (String): Can be one of: auto: For Sparkline and dots, the min and max values are used from the data. For bars, the axis starts from zero. zeroBaseline: The y-axis starts/ends from zero, but depends on the min and max values of the data rendered. Only used for sparkline and dots. If used with bars, behavior is the same as auto. zeroCenter: The y-axis has zero in the center and scaled so that min and max are the same absolute number. Not used for posNeg.

  • qMiniChartDef

    Type: Object

    • qLibraryId

    Type: String

    Description: See engine API doc.

    • qDef

    Type: String

    Description: See engine API doc.

    • qNullSuppression

    Type: Boolean

    Description: See engine API doc.

    • Default: true

    • qOtherTotalSpec

      Type: Object

    • qSuppressOther

      Type: Boolean

      Description: See engine API doc.

      Default: true

  • conditionalColoring

    Type: Object

    Description: Coloring settings.

    • segments

      Type: Object

      Segment settings.

      segments properties

      Name	Type	Description
      limits	Array	Color gradient limitations. value: Type: ValueExpressionContainer Description: Value expression container. gradient: Type: Boolean Description: Set to use gradient between segments.
      paletteColors	Object	Replaces segment colors and provides ability to set custom colors. Overrides segment.colors when set. color: Type: String Color as hex string (mandatory if index: -1) index: Type: Integer Index in palette. Default: 6 icon: Type: String Icon to use in a segment. Optional.

  • textAlign

    Text alignment settings.

    textAlign Properties

    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

  Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

  id

  Type: 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

Type: Object

customErrorMessage

Type: Object

Set to define custom error messages.

• calcCondition
  

  Type: String

  Description: 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.

Additional properties:

key

Type: String

Determines which component the settings apply to.

Default: theme

content

Type: Object

Content font and interaction settings.

header

Type: Object

Header object font settings.

scrollbar

Type: Object

Scroll bar settings.

totals

Type: Object

scrolling

Type: Object

Settings related to scrolling behavior.

scrollbar

Type: Object

Scroll bar settings.

Additional properties:

size

Sets the width of the scroll bar.

Type: String

Can be one of:

• small
• medium
• large

Default: unset

The default is inherited from Theme. If Theme is not set, small becomes the default.

search

Type: Object

Search settings.

Additional properties:

sorting

Type: String

The settings for sorting the values of a dimension.

multiline

Type: Object

Header and text wrapping settings.

Example 1 using Visualization API

In this example, we create a basic table, containing one dimension and four measures. The measures have basic number formatting applied and the dimension is sorted by load order. No options are defined for the table.

app.visualization.create(
  'table',
  [
    {
      "qDef": {
        "qFieldDefs": [
          "=If(Par>3,TClubName)"
        ],
        "qFieldLabels": [
          "Tee club"
        ],
        "qSortCriterias": [
          {
            "qSortByLoadOrder": 1
          }
        ]
      },
      "qNullSuppression": true
    },
    {
      "qDef": {
        "qLabel": "#",
        "qDef": "Count(HoID)"
      }
    },
    {
      "qDef": {
        "qLabel": "FIR%",
        "qDef": "Avg(FwHit)",
        "qNumFormat": {
          "qType": "F",
          "qnDec": 2,
          "qUseThou": 0,
          "qFmt": "0.0%",
          "qDec": ".",
          "qThou": ","
        }
      }
    },
    {
      "qDef": {
        "qLabel": "Avg",
        "qDef": "Avg(DrDist)",
        "qNumFormat": {
          "qType": "F",
          "qnDec": 2,
          "qUseThou": 0,
          "qFmt": "#,##0.00 m",
          "qDec": ".",
          "qThou": ","
        },
        "numFormatFromTemplate": false
      }
    },
    {
      "qDef": {
        "qLabel": "Max",
        "qDef": "Max(DrDist)",
        "qNumFormat": {
          "qType": "F",
          "qnDec": 2,
          "qUseThou": 0,
          "qFmt": "#,##0 m",
          "qDec": ".",
          "qThou": ","
        },
        "numFormatFromTemplate": false
      }
    }
  ],
  {
  }
).then(function(vis){
  vis.show("QV01");
});

Example 2 using Visualization API

In this example, we create a table with mini-charts, containing two dimensions and one measure.

app.visualization.create(
    'table',
    [
        {
            "qDef": {
                "qFieldDefs": [
                    "Product"
                ],
                "qFieldLabels": [
                    "Product"
                ],
                "qSortCriterias": [
                    {
                        "qSortByLoadOrder": 1
                    }
                ]
            },
            "qNullSuppression": true
        },
        {
            "qDef": {
                "qLabel": "Sum Sales",
                "qDef": "Sum(Sales)",
                "representation": {
                    "type": "miniChart", 
                    "miniChart": {
                        "type": "sparkline",
                        "colors": {
                            "main": {
                                "index": 6
                            },
                            "max": {
                                "index": 0,
                                "color": "none"
                            },
                            "min": {
                                "index": 0,
                                "color": "none"
                            },
                            "first": {
                                "index": 0,
                                "color": "none"
                            },
                            "last": {
                                "index": 0,
                                "color": "none"
                            },
                            "positive": {
                                "index": 6
                            },
                            "negative": {
                                "index": 10
                            }
                        },
                        "showDots": true,
                        "yAxis": {
                            "scale": "local",
                            "position": "auto"
                        }
                    }
                },
            },
            "qMiniChartDef": {
                "qDef": "Date.autoCalendar.Month",
            }
        },
    ],
    {}
).then(function(vis){
    vis.show("QV01");
});