Skip to content

Sense Client Objects

v1.4.0

Sense Client Objects consists of a collection of properties for defining different types of objects compatible with Qlik Sense Client

appProperties

object

appProperties

Properties

chartAnimations
default=true
boolean

Enable chart animations for all sheet objects Default:true

disableCellNavMenu
default=false
boolean

Disables the hover menu for all sheet objects Default:false

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

rtl
default=false
boolean

Right to left layout for right-to-left languages Default:false

sheetLogoPosition
string

Position of the sheet logo. right|left|center

sheetLogoThumbnail

No description

sheetTitleBgColor
string

Color of the sheet background. Left side color when using gradient

sheetTitleColor
string

Color of the sheet title text

sheetTitleGradientColor
string

Right side background color when using gradient

theme
default='horizon'
string

The theme used across the app Default:horizon

appPropertiesList

object

appPropertiesList

Properties

qAppObjectListDef

Defines the list of objects in an app. An app object is a generic object created at app level.

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

bookmark

object

bookmark

Properties

creationDate
string

Creation date of the bookmark.

qDistinctValues
default=false
boolean

If true all selected values will be stored distinct, i.e. searchstrings will not be kept. Default:false

qIncludeVariables
default=false
boolean

If true all variables will be stored in the bookmark. Default:false

qInfo

No description

qMetaDef

The metadata object used by all app objects

selectionFields
string

Fields that have selections made to them.

sheetId
string

Sheet ID of the sheet that the bookmark applies to.

bookmarkList

object

Properties for defining list of Bookmarks.

Properties

qBookmarkListDef

Defines the list of bookmarks.

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

const bookmarkListProps = {
  "qInfo": {
    "qType": "BookmarkList",
    "qId": ""
  },
  "qBookmarkListDef": {
    "qData": {
      "title": "/qMetaDef/title",
      "description": "/qMetaDef/description",
      "sheetId": "/sheetId",
      "selectionFields": "/selectionFields",
      "creationDate": "/creationDate"
    },
    "qType": "bookmark",
    "qIncludePatches": true
  }
};
const bookmarkList = await doc.createSessionObject(bookmarkListProps).then(list => list.getLayout());

currentSelections

object

currentSelections

Properties

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qSelectionObjectDef

No description

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

qType
default='CurrentSelection'
string

CurrentSelections Object Default:CurrentSelection

const currentSelectionsProps = {
  "qInfo": {
    "qType": "CurrentSelections",
    "qId": "CurrentSelections"
  },
  "qSelectionObjectDef": {
    "qStateName": "$"
  }
};
const currentSelections = await doc.createSessionObject(currentSelectionsProps).then(list => list.getLayout());

dimension

object

dimension

Properties

qDim

No description

qInfo

No description

qMetaDef

The metadata object used by all app objects

dimensionList

object

Properties for defining list of Dimensions.

Properties

qDimensionListDef

Defines the lists of dimensions.

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

const dimensionListProps = {
  "qInfo": {
    "qType": "DimensionList",
    "qId": ""
  },
  "qDimensionListDef": {
    "qData": {
      "title": "/qMetaDef/title",
      "tags": "/qMetaDef/tags",
      "grouping": "/qDim/grouping",
      "info": "/qDimInfos",
      "labelExpression": "/qDim/labelExpression"
    },
    "qType": "dimension"
  }
};
const dimensionList = await doc.createSessionObject(dimensionListProps).then(list => list.getLayout());

fieldList

object

fieldList

Properties

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qFieldListDef

No description

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

qType
default='FieldList'
string

FieldList Object Default:FieldList

const fieldListProps = {
  "qInfo": {
    "qType": "FieldList",
    "qId": "FieldList"
  },
  "qFieldListDef": {
    "qShowDefinitionOnly": "false",
    "qShowDerivedFields": "true",
    "qShowHidden": "false",
    "qShowImplicit": "false",
    "qShowSemantic": "true",
    "qShowSrcTables": "true",
    "qShowSystem": "false"
  }
};
const fieldList = await doc.createSessionObject(fieldListProps).then(list => list.getLayout());

masterobject

object

Base visualizations class with common settings.

Properties

masterVersion
default=0.95
number

Version number. Will default to latest Qlik Sense version if not manually set. Default:0.95

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qLayoutExclude
object

No description

qMetaDef

The metadata object used by all app objects

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

showDetails
default=false
boolean

Show visualization details toggle Default:false

showTitles
default=true
boolean

Visualization subtitle Default:true

visualization
string

Visualization type. Must always be set.

masterobjectList

object

Properties for defining list of MasterObjects.

Properties

qAppObjectListDef

Defines the list of objects in an app. An app object is a generic object created at app level.

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

const masterobjectListProps = {
  "qInfo": {
    "qType": "MasterObjectList",
    "qId": ""
  },
  "qAppObjectListDef": {
    "qData": {
      "name": "/qMetaDef/title",
      "labelExpression": "/labelExpression",
      "visualization": "/visualization",
      "tags": "/qMetaDef/tags"
    },
    "qType": "masterobject"
  }
};
const masterobjectList = await doc.createSessionObject(masterobjectListProps).then(list => list.getLayout());

measure

object

measure

Properties

qInfo

No description

qMeasure

No description

qMetaDef

The metadata object used by all app objects

measureList

object

Properties for defining list of Measures.

Properties

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMeasureListDef

Defines the list of measures.

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

const measureListProps = {
  "qInfo": {
    "qType": "MeasureList",
    "qId": ""
  },
  "qMeasureListDef": {
    "qData": {
      "title": "/qMetaDef/title",
      "tags": "/qMetaDef/tags",
      "labelExpression": "/qMeasure/qLabelExpression"
    },
    "qType": "measure"
  }
};
const measureList = await doc.createSessionObject(measureListProps).then(list => list.getLayout());

sheet

object

sheet

Properties

cells

Sheet cells.

columns
default=24
integer

Number of grid columns the sheet consists of. Using anything else than the default setting may cause the Qlik Sense client to malfunction. Default:24

gridResolution
default='small'
string

Sets the number of grid cells: small|medium|large Default:small

height
integer

Height in percentage. Used in tandem with layoutOptions.sheetMode RESPONSIVE and extended sheets. Can be larger than 100

layoutOptions

No description

pxHeight
integer

Height in pixels. Used in tandem with layoutOptions.sheetMode

pxWidth
integer

Width in pixels. Used in tandem with layoutOptions.sheetMode CUSTOM

qChildListDef

No description

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef

The metadata object used by all app objects

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

rank
default=1
number

Sheet rank. The sheet with the lowest rank will be displayed first, so the rank is inverted. Default:1

rows
default=12
integer

Number of grid rows the sheet consists of. Using anything else than the default setting may cause the Qlik Sense client to malfunction. Default:12

thumbnail

No description

sheetList

object

sheetList

Properties

qAppObjectListDef

Defines the list of objects in an app. An app object is a generic object created at app level.

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

const sheetListProps = {
  "qInfo": {
    "qType": "SheetList",
    "qId": ""
  },
  "qAppObjectListDef": {
    "qData": {
      "title": "/qMetaDef/title",
      "labelExpression": "/labelExpression",
      "showCondition": "/showCondition",
      "description": "/qMetaDef/description",
      "descriptionExpression": "/qMetaDef/descriptionExpression",
      "thumbnail": "/qMetaDef/thumbnail",
      "cells": "/cells",
      "rank": "/rank",
      "columns": "/columns",
      "rows": "/rows"
    },
    "qType": "sheet"
  }
};
const sheetList = await doc.createSessionObject(sheetListProps).then(list => list.getLayout());

variable

object

variable

Properties

qComment
string

Comment related to the variable. This parameter is optional.

qDefinition
string

Definition of the variable.

qIncludeInBookmark
default=false
boolean

Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. The value of a variable can affect the state of the selections. Script variables cannot be persisted in the bookmark. The default value is false. Default:false

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qName
string

Name of the variable. The name must be unique. This parameter is mandatory.

qNumberPresentation

Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

Formatting mechanism The formatting mechanism depends on the type set in qType, as shown below: In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

Type is DATE, TIME, TIMESTAMP or INTERVAL The following applies: If a format pattern is defined in qFmt , the formatting is as defined in qFmt . If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ). The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ). If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ). If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used. If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used. If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ). If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY The following applies: If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ). If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII No formatting, qFmt is ignored.

tags
Array<string>

Tags added to the variable. Optional.

variableList

object

Properties for defining list of Variables.

Properties

qExtendsId
string

Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.

qInfo

No description

qMetaDef
object

Used to collect meta data.

Properties Semantic type with an empty structure.

qStateName
default='$'
string

Name of the alternate state. Default is current selections $ . Default:$

qVariableListDef

Defines the list of variables in an app.

const variableListProps = {
  "qInfo": {
    "qType": "VariableList",
    "qId": ""
  },
  "qVariableListDef": {
    "qData": {
      "tags": "/tags"
    },
    "qType": "variable",
    "qShowReserved": "true",
    "qShowConfig": "true",
    "qShowSession": true
  }
};
const variableList = await doc.createSessionObject(variableListProps).then(list => list.getLayout());
Was this page helpful?