Skip to content

Definitions

QIX definitions for version 12.171.0.

AlfaNumString

No description.

Name Type Description
qString string Calculated value.
qIsNum boolean Is set to true if the value is a numeric.

AlternateStateData

No description.

Name Type Description
qStateName string Name of the alternate state.
Default is current selections: $
qFieldItems array<BookmarkFieldItem> List of the selections.

AppEntry

No description.

Name Type Description
qID string Identifier of the app.
qTitle string Title of the app.
qPath string Path of the app.
qLastReloadTime string Last reload time of the app.
qReadOnly boolean Is set to true if the app is read-only.
qMeta NxMeta Meta data.
qThumbnail StaticContentUrl App thumbnail.
qFileSize integer No description.

AppObjectList

Lists the app objects. Is the layout for AppObjectListDef.
An app object is a generic object created at app level.

Name Type Description
qItems array<NxContainerEntry> Information about the list of dimensions.

AppObjectListDef

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

Name Type Description
qType string Type of the app list.
qData JsonObject Data that you want to include in the app list definition.
You need to enter the paths to the information you want to retrieve.

AppScript

No description.

Name Type Description
qScript string Script text.
qMeta NxMeta Information about publishing and permissions.
This parameter is optional.

AssociationScore

No description.

Name Type Description
qFieldPairName string Pair of fields.
< FieldName1> / < FieldName2>
Where:
< FieldName1 > is a field in the table 1 (defined in qTable1 )
< FieldName2 > is a field in the table 2 (defined in qTable2 )
If the field is a synthetic key, the name of the field is preceded by [Synthetic key]: .
qScoreSummary integer Flag used to interpret calculated scores.
One of the following values or sum of values that apply:
0: The cardinal ratio cannot be zero but the symbol score and the row score can be zero.
-1: The fields do not have the same type.
-2: The number of rows of the field FieldName1 is zero.
-4: The number of distinct values of the field FieldName1 is zero.
-8: The number of rows of the field FieldName2 is zero.
-16: The number of distinct values of the field FieldName2 is zero.

Example:
The number of rows of the field FieldName1 is zero, and the number of distinct values of the field FieldName2 is zero, then qScoreSummary is -18.
qField1Scores FieldScores Association information about the field FieldName1 defined in qFieldPairName .
qField2Scores FieldScores Association information about the field FieldName2 defined in qFieldPairName .

BNFDef

No description.

Name Type Description
qBnf array Array of token references that all together build up the definition of the current token.
Generally, if the array is not empty, the definition is a BNF rule (qIsBnfRule is set to true). However, some BNF  rules do have an empty array (qIsBnfRule is set to true, but qBnf is empty).
qNbr integer Number of the current token definition.
qPNbr integer Number of the parent rule definition.
qHelpId integer Reference identifier to a function described in the documentation. The identifier is stored in the definition of the token containing the function name.
Is not used in Qlik Sense.
qName string Token name.
One of:
A rule name
An identifier
* A literal value
qStr string Literal string of the token.
Examples: 'Round' and '('.
qIsBnfRule boolean If set to true, a list of related rule tokens is assigned to qBnf .
This parameter is optional. The default value is false.
qScriptStatement boolean If set to true, the definition specifies a script statement.
This parameter is optional. The default value is false.
qControlStatement boolean If set to true, the definition specifies a control statement.
This parameter is optional. The default value is false.
qBnfLiteral boolean If set to true, the definition specifies a literal token.
This parameter is optional. The default value is false.
qQvFunc boolean If set to true, the definition is related to a Qlik Sense function. It cannot be an aggregation function.
This parameter is optional. The default value is false.
qAggrFunc boolean If set to true, the definition is related to an aggregation function.
This parameter is optional. The default value is false.
qFG string Group of the function.

One of:
ALL or FUNC_GROUP_ALL
U or FUNC_GROUP_UNKNOWN
NONE or FUNC_GROUP_NONE
AGGR or FUNC_GROUP_AGGR
NUM or FUNC_GROUP_NUMERIC
RNG or FUNC_GROUP_RANGE
EXP or FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC
TRIG or FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC
FIN or FUNC_GROUP_FINANCIAL
MATH or FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE
COUNT or FUNC_GROUP_COUNTER
STR or FUNC_GROUP_STRING
MAPP or FUNC_GROUP_MAPPING
RCRD or FUNC_GROUP_INTER_RECORD
CND or FUNC_GROUP_CONDITIONAL
LOG or FUNC_GROUP_LOGICAL
NULL or FUNC_GROUP_NULL
SYS or FUNC_GROUP_SYSTEM
FILE or FUNC_GROUP_FILE
TBL or FUNC_GROUP_TABLE
DATE or FUNC_GROUP_DATE_AND_TIME
NUMI or FUNC_GROUP_NUMBER_INTERPRET
FRMT or FUNC_GROUP_FORMATTING
CLR or FUNC_GROUP_COLOR
RNK or FUNC_GROUP_RANKING
GEO or FUNC_GROUP_GEO
* EXT or FUNC_GROUP_EXTERNAL
qFieldFlag boolean If set to true, the definition is related to a field.
This parameter is optional. The default value is false.
qMT string Type of the data.

One of:
N or NOT_META
D or META_DOC_NAME
R or META_RET_TYPE
V or META_DEFAULT_VALUE
qDepr boolean Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use).
If set to true, the script statement or the function is not recommended for use in Qlik Sense.
This parameter is optional. The default value is false.

BookmarkFieldItem

No description.

Name Type Description
qDef FieldDefEx Name and type of the field.
qLocked boolean Indicates if the field is locked.
Default is false.
qSelectInfo SelectInfo Information on the selections criteria.
qValues array<FieldValue> No description.
qExcludedValues array<FieldValue> List of excluded values.
Either the list of selected values or the list of excluded values is displayed.
qAndMode boolean If set to true, selections within a list object are made in AND mode; If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in and-mode, all records that are associated with Customer 1 and Customer 2 are selected.
The default value is false; selections within a list object are made in OR mode. If you have a list object that lists all customers, by selecting Customer 1 and Customer 2 while in or-mode, all records that are associated with either Customer 1 or Customer 2 are selected.
This parameter is not returned if set to false.
qOneAndOnlyOne boolean If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected.
The default value is false. This parameter is not returned if set to false.

BookmarkFieldPage

Defines the range of the bookmark fields that are returned.

Name Type Description
qStartIndex integer The start value of the range.
qEndIndex integer The end value of the range.

BookmarkList

Lists the bookmarks. Is the layout for BookmarkListDef.

Name Type Description
qItems array<NxContainerEntry> Information about the list of bookmarks.

BookmarkListDef

Defines the list of bookmarks.

Name Type Description
qType string Type of the list.
qData JsonObject Data

BookmarkVariableItem

No description.

Name Type Description
qName string Name of the variable.
qValue FieldValue Value of the variable.

CalendarStrings

No description.

Name Type Description
qDayNames array List of short day names.
qMonthNames array List of short month names.
qLongDayNames array List of long day names.
qLongMonthNames array List of long month names.

CharRange

No description.

Name Type Description
qCharPos integer Position of the first search occurrence.
qCharCount integer Number of occurrences found.

ChildList

Lists the children of a generic object. Is the layout for ChildListDef.
ChildList is used by the GetLayout Method to list the children of a generic object.

Name Type Description
qItems array<NxContainerEntry> Information about the items in the app object.

ChildListDef

Defines the list of children of a generic object.
What is defined in ChildListDef has an impact on what the GetLayout method returns. See Example for more information.

Name Type Description
qData JsonObject Data that you want to include in the child list definition.
You need to enter the paths to the information you want to retrieve.

CodePage

No description.

Name Type Description
qNumber integer Number of the code page.
qName string Name of the code page.
qDescription string Description of the code page.

Connection

No description.

Name Type Description
qId string Identifier of the connection.
Is generated by the engine and is unique.
qName string Name of the connection.
This parameter is mandatory and must be set when creating or modifying a connection.
qConnectionString string One of:
ODBC CONNECT TO [<provider name>]
OLEDB CONNECT TO [<provider name>]
CUSTOM CONNECT TO [<provider name>]
"<local absolute or relative path, UNC path>"
* "<URL>"

Connection string.
This parameter is mandatory and must be set when creating or modifying a connection.
qType string One of:
ODBC
OLEDB
<Name of the custom connection file>
folder
* internet

Type of the connection.
This parameter is mandatory and must be set when creating or modifying a connection.
For ODBC, OLEDB and custom connections, the engine checks that the connection type matches the connection string.
The type is not case sensitive.
qUserName string Name of the user who creates the connection.
This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections.
A call to GetConnection Method does not return the user name.
qPassword string Password of the user who creates the connection.
This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections.
A call to GetConnection Method does not return the password.
qModifiedDate string Is generated by the engine.
Creation date of the connection or last modification date of the connection.
qMeta NxMeta Information about the connection.
qLogOn string Select which user credentials to use to connect to the source.
LOG_ON_SERVICE_USER: Disables
LOG_ON_CURRENT_USER: Enables

One of:
LOG_ON_SERVICE_USER
LOG_ON_CURRENT_USER

ContentLibraryList

No description.

Name Type Description
qItems array<ContentLibraryListItem> Information about the content library.

ContentLibraryListItem

No description.

Name Type Description
qName string Name of the library.
qAppSpecific boolean Is set to true if the library is specific to the app (not a global content library).
qMeta NxMeta Information about publishing and permissions.

CustomConnector

No description.

Name Type Description
qProvider string Name of the custom connector file.
qParent string Name of the parent folder that contains the custom connector file.
qDisplayName string Name of the custom connector as displayed in the Qlik interface.
qMachineMode string Mode of the machine (64 or 32 bits).

One of:
CONNECT_DEFAULT
CONNECT_64
* CONNECT_32
qSupportFileStreaming boolean No description.

DataField

No description.

Name Type Description
qName string Name of the field.
qIsKey boolean Is set to true if the field is a primary key.
qOriginalFieldName string Is shown for fixed records.
qOriginalFieldName and qName are identical if no field names are used in the file.
qOriginalFieldName differs from qName if embedded file names are used in the file.

DataRecord

No description.

Name Type Description
qValues array List of values inside the table.
The first values (in result/qPreview/0/qValues ) correspond to the field names in the table.
The following values (from result/qPreview/1/qValues ) are the values of the fields in the table.

DataTable

No description.

Name Type Description
qName string Name of the table.
qType string Type of the table.
For example: Table or View.

DataTableEx

No description.

Name Type Description
qName string Name of the table.
qFields array<DataField> List of the fields in the table.
qFormatSpec string List of format specification items, within brackets.
Examples of specification items:
file type
embedded labels, no labels
* table is <table name>

Database

No description.

Name Type Description
qName string Name of the database.
qIsDefault boolean Is set to true if the database is set by default.

DatabaseInfo

No description.

Name Type Description
qDBMSName string Name of the product accessed by the provider.
qDBUsage boolean If set to true, it means that the data source contains some databases.
qOwnerUsage boolean If set to true, it means that the data source contains some owners.
qDBSeparator string Character string used after the database name.
Example with separator " . ":
FROM LinkedTablesData.dbo.Months
Where:
LinkedTablesData is the database name
dbo is the owner name
* Months is the table name
qOwnerSeparator string Character string used after the owner name.
Example with separator " . ":
FROM LinkedTablesData.dbo.Months
Where:
LinkedTablesData is the database name
dbo is the owner name
* Months is the table name
qDBFirst boolean If set to true, it means that the database is displayed first, before the owners and tables.
qQuotePreffix string Prefix used with field, database or owner names that contain special characters or keywords.
qQuoteSuffix string Suffix used with field, database or owner names that contain special characters or keywords.
qSpecialChars string List of the special characters.
qDefaultDatabase string Name of the default database.
qKeywords array List of the script keywords.

DatabaseOwner

No description.

Name Type Description
qName string Name of the owner.

DelimiterInfo

No description.

Name Type Description
qName string Name of the delimiter.
Example:
"Tab_DELIMITER"
qScriptCode string Representation of the delimiter value that is used in the script.
Example:
"'\t'"
qNumber integer Delimiter character number used by the engine to determine how to separate the values.
qIsMultiple boolean Is set to true if multiple spaces are used to separate the values.

DerivedFieldsInTableData

No description.

Name Type Description
qDefinitionName string Name of the derived definition.
qTags array List of tags.
qActive boolean Is set to true is the derived field is in use.

DimensionList

Lists the dimensions. Is the layout for DimensionListDef.

Name Type Description
qItems array<NxContainerEntry> Information about the list of dimensions.

DimensionListDef

Defines the lists of dimensions.

Name Type Description
qType string Type of the list.
qData JsonObject Data

DoReloadExParams

No description.

Name Type Description
qMode integer No description.
qPartial boolean No description.
qDebug boolean No description.

DoReloadExResult

No description.

Name Type Description
qSuccess boolean No description.
qScriptLogFile string No description.

DocListEntry

No description.

Name Type Description
qDocName string Name of the app.
qConnectedUsers integer Not used.
qFileTime number Last modified time stamp of the app.
This property is used only with Qlik Sense Desktop.
It is set to 0 for Qlik Sense Enterprise.
qFileSize number Size of remote app.
This property is used only with Qlik Sense Desktop.
It is set to 0 for Qlik Sense Enterprise.
qDocId string Identifier of the app.
In Qlik Sense Desktop, the identifier is the path and name of the app.
In Qlik Sense Enterprise, the identifier is the app's GUID.
qMeta NxMeta Meta data related to the app.
qLastReloadTime string Last reload time of the app.
qReadOnly boolean If set to true, the app is read-only.
qTitle string Title of the app.
qThumbnail StaticContentUrl Thumbnail of the app.

DriveInfo

No description.

Name Type Description
qDrive string Value of the drive.
Examples:
C:\\, E:\\
qType string Type of the drive.
Fixed means physical drive.
qName string Name of the drive.
qTypeIdentifier string Information about the drive type.

One of:
REMOVABLE
FIXED
NETWORK
CD_ROM
RAM
UNKNOWN_TYPE
qUnnamedDrive boolean No description.

EditorBreakpoint

No description.

Name Type Description
qbufferName string Name of the breakpoint.
qlineIx integer Line number in the script where the breakpoint is set.
qEnabled boolean If set to true then the breakpoint is enabled (in use).

ErrorData

No description.

Name Type Description
qErrorString string Detailed information about the error message.
qLineEnd string Line termination characters.
qLine string Script statement where the error occurs.
qErrorDataCode string Type of the error messages.

One of:
EDC_ERROR
EDC_WARNING
* EDC_CIRCULAR_REFERENCE
qMessage ProgressMessage No description.

ExtensionList

No description.

Name Type Description
qItems array No description.

FieldAttributes

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

Name Type Description
qType string Type of the field.
Default is U.

One of:
U or UNKNOWN
A or ASCII
I or INTEGER
R or REAL
F or FIX
M or MONEY
D or DATE
T or TIME
TS or TIMESTAMP
IV or INTERVAL
qnDec integer Number of decimals.
Default is 10.
qUseThou integer Defines whether or not a thousands separator must be used.
Default is 0.
qFmt string Defines the format pattern that applies to qText .
Is used in connection to the type of the field (parameter qType ).
For more information, see Formatting mechanism.
Example: YYYY-MM-DD for a date.
qDec string Defines the decimal separator.
Example: .
qThou string Defines the thousand separator (if any).
Is used if qUseThou is set to 1.
Example: ,

FieldDefEx

No description.

Name Type Description
qName string Name of the field.
qType string Type of data entity.

One of:
NOT_PRESENT
PRESENT
IS_CYCLIC_GROUP
IS_DRILL_GROUP
IS_VAR
IS_EXPR
IS_IMPLICIT
IS_DETAIL

FieldDescription

No description.

Name Type Description
qInternalNumber integer Internal number of the field.
qName string Name of the field.
qSrcTables array List of table names.
qIsSystem boolean If set to true, it means that the field is a system field.
The default value is false.
qIsHidden boolean If set to true, it means that the field is hidden.
The default value is false.
qIsSemantic boolean If set to true, it means that the field is a semantic.
The default value is false.
qDistinctOnly boolean If set to true, only distinct field values are shown.
The default value is false.
qCardinal integer Number of distinct field values.
qTotalCount integer Total number of field values.
qPossibleCount_OBSOLETE integer No description.
qHasInfo_OBSOLETE boolean No description.
qIsLocked boolean If set to true, it means that the field is locked.
The default value is false.
qAlwaysOneSelected boolean If set to true, it means that the field has one and only one selection (not 0 and not more than 1).
If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
The default value is false.
qAndMode boolean If set to true a logical AND (instead of a logical OR) is used when making selections in a field.
The default value is false.
qIsNumeric boolean Is set to true if the value is a numeric.
The default value is false.
qComment string Field comment.
qTags array Gives information on a field. For example, it can return the type of the field.
Examples: key, text, ASCII.
qIsDefinitionOnly boolean If set to true, it means that the field is a field on the fly.
The default value is false.
qByteSize integer Static RAM memory used in bytes.

FieldInTableData

No description.

Name Type Description
qName string Name of the field.
qOriginalFields array Is shown for fixed records.
qOriginalFieldName and qName are identical if no field names are used in the file.
qOriginalFieldName differs from qName if embedded file names are used in the file.
qPresent boolean No description.
qHasNull boolean This property is set to true if the field contains some Null values.
qHasWild boolean No description.
qHasDuplicates boolean This property is set to true if the field contains some duplicate values.
qIsSynthetic boolean This property is set to true if the field contains a synthetic key.
qInformationDensity number Number of records that have values (for example, not NULL) in the field as compared to the total number of records in the table.
qnNonNulls integer Number of values that are non Null.
qnRows integer Number of rows in the field.
qSubsetRatio number Number of distinct values in the field (in the current table) as compared to the total number of distinct values of this field (in all tables).
qnTotalDistinctValues integer Number of distinct values in the field.
qnPresentDistinctValues integer No description.
qKeyType string Tells if the field is a key field.

One of:
NOT_KEY
ANY_KEY
PRIMARY_KEY
PERFECT_KEY
qComment string Comment related to the field.
qTags array List of tags related to the field.
qDerivedFields array<DerivedFieldsInTableData> List of the derived fields.
qIsFieldOnTheFly boolean No description.
qReadableName string No description.

FieldList

Lists the fields present in the data model viewer. Is the layout for FieldListDef.

Name Type Description
qItems array<NxFieldDescription> Array of items.

FieldListDef

Defines the fields to show.

Name Type Description
qShowSystem boolean Shows the system tables if set to true.
Default is false.
qShowHidden boolean Shows the hidden fields if set to true.
Default is false.
qShowSemantic boolean Show the semantic fields if set to true.
Default is false.
qShowSrcTables boolean Shows the tables and fields present in the data model viewer if set to true.
Default is false.
qShowDefinitionOnly boolean Shows the fields defined on the fly if set to true.
Default is false.
qShowDerivedFields boolean Shows the fields and derived fields if set to true.
Default is false.
qShowImplicit boolean Shows the Direct Discovery measure fields if set to true.
Default is false.

FieldScores

No description.

Name Type Description
qFieldName string Field name.
One of the field names defined in qFieldPairName.
qReadableName string No description.
qCardinalRatio number Cardinality of a column/field divided by the number of rows in the table.
If the cardinal ratio is 1, it means that the column is a candidate/primary key.
qSymbolScore number Number of distinct matches between the two fields defined in qFieldPairName divided by the number of distinct values in the field qFieldName .
If 0, it means that there are no common values between the two fields defined in qFieldPairName .
qRowScore number Number of matches between the two fields defined in qFieldPairName divided by the number of values in the field qFieldName .
If 0, it means that there are no common values between the two fields defined in qFieldPairName .

FieldValue

No description.

Name Type Description
qText string Text related to the field value.
This parameter is optional.
qIsNumeric boolean Is set to true if the value is a numeric.
This parameter is optional. Default is false.
qNumber number Numeric value of the field.
This parameter is displayed if qIsNumeric is set to true.
This parameter is optional.

FileDataFormat

Name Type Description
qType string Type of the file.

One of:
CSV or FILE_TYPE_CSV
FIX or FILE_TYPE_FIX
DIF or FILE_TYPE_DIF
EXCEL_BIFF or FILE_TYPE_EXCEL_BIFF
EXCEL_OOXML or FILE_TYPE_EXCEL_OOXML
HTML or FILE_TYPE_HTML
QVD or FILE_TYPE_QVD
XML or FILE_TYPE_XML
QVX or FILE_TYPE_QVX
JSON or FILE_TYPE_JSON
* KML or FILE_TYPE_KML
qLabel string One of:
Embedded labels (field names are present in the file)
No labels
* Explicit labels (for DIFfiles)
qQuote string One of:
None (no quotes)
MSQ (Modern Style Quoting)
* Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value)

This property is used for delimited files.
qComment string String that marks the beginning of the comment line.
Example: “#” or “//”
The engine ignores the commented lines during the data load.
This property is only used for delimited files.
qDelimiter DelimiterInfo Information about the delimiter.
This property is used for delimited files.
qCodePage integer Character set used in the file.
qHeaderSize integer Size of the header.
Example: If the header size is 2, the first two rows in the file are considered as header and not as data. The header can contain the field names.
qRecordSize integer Record length.
Each record (row of data) contains a number of columns with a fixed field size.
This property is used for fixed record data files.
qTabSize integer Number of spaces that one tab character represents in the table file.
This property is used for fixed record data files.
qIgnoreEOF boolean Is set to true, the end-of-file character is not taken into account during reload.
This property is used for delimited files and fixed record data files.
qFixedWidthDelimiters string Positions of the field breaks in the table.
This property is used for fixed record data files.

FilterInfo

No description.

Name Type Description
qType string
One of:
NONE or FILTER_TYPE_NONE
RAW or FILTER_TYPE_RAW
qWherePredicate string No description.

FolderItem

No description.

Name Type Description
qName string Name of the folder item.
qType string Type of the folder item.

One of:
FOLDER or FOLDER_ITEM_FOLDER
FILE or FOLDER_ITEM_FILE
* OTHER or FOLDER_ITEM_OTHER

Function

No description.

Name Type Description
qName string Name of the script function.
qGroup string Group of the script function.

One of:
ALL or FUNC_GROUP_ALL
U or FUNC_GROUP_UNKNOWN
NONE or FUNC_GROUP_NONE
AGGR or FUNC_GROUP_AGGR
NUM or FUNC_GROUP_NUMERIC
RNG or FUNC_GROUP_RANGE
EXP or FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC
TRIG or FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC
FIN or FUNC_GROUP_FINANCIAL
MATH or FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE
COUNT or FUNC_GROUP_COUNTER
STR or FUNC_GROUP_STRING
MAPP or FUNC_GROUP_MAPPING
RCRD or FUNC_GROUP_INTER_RECORD
CND or FUNC_GROUP_CONDITIONAL
LOG or FUNC_GROUP_LOGICAL
NULL or FUNC_GROUP_NULL
SYS or FUNC_GROUP_SYSTEM
FILE or FUNC_GROUP_FILE
TBL or FUNC_GROUP_TABLE
DATE or FUNC_GROUP_DATE_AND_TIME
NUMI or FUNC_GROUP_NUMBER_INTERPRET
FRMT or FUNC_GROUP_FORMATTING
CLR or FUNC_GROUP_COLOR
RNK or FUNC_GROUP_RANKING
GEO or FUNC_GROUP_GEO
* EXT or FUNC_GROUP_EXTERNAL
qSignature string Signature of the script function.
Gives general information about the function.

GenericBookmarkEntry

No description.

Name Type Description
qProperties GenericBookmarkProperties Information about the properties of the bookmark.
qBookmark NxBookmark Information about the bookmark.

GenericBookmarkLayout

Is the layout for GenericBookmarkProperties.

Name Type Description
qInfo NxInfo Information about the object.
qMeta NxMeta Information on publishing and permissions.
qBookmark NxBookmark Information about the bookmark.
qFieldInfos array<LayoutFieldInfo> No description.

GenericBookmarkProperties

No description.

Name Type Description
qInfo NxInfo Information about the bookmark.
This parameter is mandatory.
qMetaDef NxMetaDef Definition of the dynamic properties.

GenericDimensionInfo

No description.

Name Type Description
qApprMaxGlyphCount integer Length of the longest value in the field.
qCardinal integer Number of distinct field values
qTags array Gives information on a field. For example, it can return the type of the field.
Examples: key, text, ASCII
qIsSemantic boolean If set to true, it means that the field is a semantic.
qAndMode boolean If set to true a logical AND (instead of a logical OR) is used when making selections in a field.
The default value is false.

GenericDimensionLayout

Is the layout for GenericDimensionProperties.

Name Type Description
qInfo NxInfo Identifier and type of the dimension.
qMeta NxMeta Information about publishing and permissions.
qDim NxLibraryDimension Name and label of the dimension, information about grouping.
qDimInfos array<GenericDimensionInfo> Cardinal and tags related to the dimension.
Length of the longest value in the field.

GenericDimensionProperties

No description.

Name Type Description
qInfo NxInfo Identifier and type of the dimension.
This parameter is mandatory.
qDim NxLibraryDimensionDef Definition of the dimension.
This parameter is mandatory.
qMetaDef NxMetaDef Definition of the dynamic properties.

GenericMeasureLayout

Is the layout for GenericMeasureProperties.

Name Type Description
qInfo NxInfo Information about the object.
qMeasure NxLibraryMeasure Information about the measure.
qMeta NxMeta Information on publishing and permissions.

GenericMeasureProperties

No description.

Name Type Description
qInfo NxInfo Information about the measure.
This parameter is mandatory.
qMeasure NxLibraryMeasureDef Definition of the measure.
This parameter is mandatory.
qMetaDef NxMetaDef Definition of the dynamic properties.

GenericObjectEntry

No description.

Name Type Description
qProperty GenericObjectProperties Information about the generic object properties.
qChildren array<GenericObjectEntry> Information about the children of the generic object.
qEmbeddedSnapshotRef GenericBookmarkEntry Reference to a bookmark/snapshot that is embedded in the generic object.

GenericObjectLayout

Is the layout for GenericObjectProperties.

Name Type Description
qInfo NxInfo Identifier and type of the generic object.
qMeta NxMeta Information about publishing and permissions.
This parameter is optional.
qExtendsId string Should be set to create an object that is linked to another object. Enter the identifier of the object you want to link to.
If you do not want to link your object, set this parameter to an empty string.
qHasSoftPatches boolean Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).
qError NxLayoutErrors Gives information on the error.
This parameter is optional.
qSelectionInfo NxSelectionInfo Information about the selections.

GenericObjectProperties

No description.

Name Type Description
qInfo NxInfo Identifier and type of the object.
This parameter is mandatory.
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).
This parameter is mandatory.
If you do not want to link your object, set this parameter to an empty string.
qMetaDef NxMetaDef Definition of the dynamic properties.

GenericVariableLayout

Is the layout for GenericVariableProperties.

Name Type Description
qInfo NxInfo Identifier and type of the object.
This parameter is mandatory.
qMeta NxMeta Information about publishing and permissions.
This parameter is optional.
qText string Some text.
qNum number A value.
qIsScriptCreated boolean If set to true, it means that the variable was defined via script.

GenericVariableProperties

No description.

Name Type Description
qInfo NxInfo Identifier and type of the object.
This parameter is mandatory.
qMetaDef NxMetaDef Meta data.
qName string Name of the variable.
The name must be unique.
This parameter is mandatory.
qComment string Comment related to the variable.
This parameter is optional.
qNumberPresentation FieldAttributes Defines the format of the value.
This parameter is optional.
qIncludeInBookmark 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.
qDefinition string Definition of the variable.

HyperCube

Renders the properties of a hypercube. Is the layout for HyperCubeDef.
For more information about the definition of a hypercube, see Generic object.
What is returned in HyperCube depends on the type of the hypercube (straight, pivot or stacked table, or tree) and on the method called (GetLayout, GetHyperCubeData, GetHyperCubePivotData, GetHyperCubeStackData, GetHyperCubeTreeData).

Name Type Description
qStateName string Name of the alternate state.
Default is current selections $ .
qSize Size Defines the size of the hypercube.
qError NxValidationError This parameter is optional and is displayed in case of error.
qDimensionInfo array<NxDimensionInfo> Information on the dimension.
qMeasureInfo array<NxMeasureInfo> Information on the measure.
qEffectiveInterColumnSortOrder array Sort order of the columns in the hypercube.
Column numbers are separated by a comma.
Example: [1,0,2] means that the first column to be sorted was the column 1, followed by the column 0 and the column 2.
qGrandTotalRow array<NxCell> Aggregate for measures of all values in the field.
The result value depends on the qAggrFunc defined in HyperCubeDef.
qDataPages array<NxDataPage> Set of data.
Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.
qPivotDataPages array<NxPivotPage> Set of data for pivot tables.
Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.
qStackedDataPages array<NxStackPage> Set of data for stacked tables.
Is empty if nothing has been defined in qInitialDataFetch in HyperCubeDef.
qMode string Information about the mode of the visualization.

One of:
S or DATA_MODE_STRAIGHT
P or DATA_MODE_PIVOT
K or DATA_MODE_PIVOT_STACK
T or DATA_MODE_TREE
qNoOfLeftDims integer Number of left dimensions.
Default value is -1.
The index related to each left dimension depends on the position of the pseudo dimension (if any).
For example, a pivot table with:
Four dimensions in the following order: Country, City, Product and Category
One pseudo dimension in position 1
Three left dimensions.

implies that:
The index 0 corresponds to the left dimension Country.
The index 1 corresponds to the pseudo dimension.
The index 2 corresponds to the left dimension City.
Product and Category are top dimensions.

Another example:
Four dimensions in the following order: Country, City, Product and Category.
One pseudo dimension in position -1.
Three left dimensions.

implies that:
The index -1 corresponds to the pseudo dimension; the pseudo dimension is the most to the right.
The index 0 corresponds to the left dimension Country.
The index 1 corresponds to the left dimension City.
The index 2 corresponds to the left dimension Product.
* Category is a top dimension.
qIndentMode boolean Is used for pivot tables only.
If set to true, the formatting of the results is slightly different.
This property is optional.
qLastExpandedPos NxCellPosition Is used for pivot tables only.
Position of the last expended cell.
This property is optional.
qHasOtherValues boolean True if other row exists.
qTitle string Title of the hypercube, for example the title of a chart.
qTreeNodesOnDim array The total number of nodes on each dimension (only applicable when qMode = T ).
qCalcCondMsg string The message displayed if calculation condition is not fulfilled.
qColumnOrder array The order of the columns.

HyperCubeDef

Defines the properties of a hypercube.
For more information about the definition of a hypercube, see Generic object.

Name Type Description
qStateName string Name of the alternate state.
Default is current selections $ .
qDimensions array<NxDimension> Array of dimensions.
qMeasures array<NxMeasure> Array of measures.
qInterColumnSortOrder array Defines the sort order of the columns in the hypercube.
Column numbers are separated by a comma.
Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2.
The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array.
The index of the pseudo-dimension (if any) is -1.
Pseudo dimensions only apply for pivot tables with more than one measure.
A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it.
Stacked pivot tables can only contain one measure.
qSuppressZero boolean Removes zero values.
qSuppressMissing boolean Removes missing values.
qInitialDataFetch array<NxPage> Initial data set.
qReductionMode string
One of:
N or DATA_REDUCTION_NONE
D1 or DATA_REDUCTION_ONEDIM
S or DATA_REDUCTION_SCATTERED
C or DATA_REDUCTION_CLUSTERED
* ST or DATA_REDUCTION_STACKED
qMode string Defines the way the data are handled internally by the engine.
Default value is DATA_MODE_STRAIGHT .
A pivot table can contain several dimensions and measures whereas a stacked pivot table can contain several dimensions but only one measure.

One of:
S or DATA_MODE_STRAIGHT
P or DATA_MODE_PIVOT
K or DATA_MODE_PIVOT_STACK
T or DATA_MODE_TREE
qPseudoDimPos integer No description.
qNoOfLeftDims integer Number of left dimensions.
Default value is -1. In that case, all dimensions are left dimensions.
Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context.
The index related to each left dimension depends on the position of the pseudo dimension (if any).
For example, a pivot table with:
Four dimensions in the following order: Country, City, Product and Category.
One pseudo dimension in position 1 (the position is defined in qInterColumnSortOrder )
qInterColumnSortOrder is (0,-1,1,2,3).
Three left dimensions ( qNoOfLeftDims is set to 3).

implies that:
The index 0 corresponds to the left dimension Country.
The index 1 corresponds to the pseudo dimension.
The index 2 corresponds to the left dimension City.
Product and Category are top dimensions.

Another example:
Four dimensions in the following order: Country, City, Product and Category.
Three left dimensions ( qNoOfLeftDims is set to 3).
One pseudo dimension.
The property qInterColumnSortOrder is left empty.

Implies that:
The index 0 corresponds to the left dimension Country.
The index 1 corresponds to the left dimension City.
The index 2 corresponds to the left dimension Product.
Category is a top dimension.
The pseudo dimension is a top dimension.
qAlwaysFullyExpanded boolean If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells.
The default value is false.
qMaxStackedCells integer Maximum number of cells for an initial data fetch (set in qInitialDataFetch ) when in stacked mode ( qMode is K).
The default value is 5000.
qPopulateMissing boolean If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string.
The default value is false.
qShowTotalsAbove boolean If set to true, the total (if any) is shown on the first row.
The default value is false.
qIndentMode boolean This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row.
The default value is false.
qCalcCond ValueExpr Specifies a calculation condition, which must be fulfilled for the hypercube to be (re)calculated.
As long as the condition is not met, the engine does not perform a new calculation.
This property is optional. By default, there is no calculation condition.
qSortbyYValue integer To enable the sorting by ascending or descending order in the values of a measure.
This property applies to pivot tables and stacked pivot tables.
In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table.
qTitle StringExpr Title of the hypercube, for example the title of a chart.
qCalcCondition NxCalcCond Specifies a calculation condition object.
If CalcCondition.Cond is not fulfilled, the hypercube is not calculated and CalcCondition.Msg is evaluated.
By default, there is no calculation condition.
This property is optional.
qColumnOrder array The order of the columns.

InteractDef

No description.

Name Type Description
qType string Interaction type.

One of:
IT_MSGBOX
IT_SCRIPTLINE
IT_BREAK
IT_INPUT
IT_END
IT_PASSWD
* IT_USERNAME
qTitle string Title used in the message box dialog.
This property is relevant if qType is IT_MSGBOX.
qMsg string Message used in the message box dialog.
This property is relevant if qType is IT_MSGBOX.
qButtons integer Buttons displayed in the message box dialog.
This property is relevant if qType is IT_MSGBOX.
One of:
0 means that the qButtons property is not relevant.
17 means that the message box contains the OK and Cancel buttons or the stop -sign icon.
qLine string Next script statement to be executed.
This property is used if the type of interaction is IT_SCRIPTLINE.
qOldLineNr integer First line number of the previously executed statement.
This property is used if the type of interaction is IT_SCRIPTLINE.
qNewLineNr integer First line number of the next statement to be executed.
This property is used if the type of interaction is IT_SCRIPTLINE.
qPath string Path specified by the Include script variable.
This property is used if the type of interaction is IT_SCRIPTLINE.
Example of an Include variable:
$(Include=lib:\\MyDataFiles\abc.txt);
qHidden boolean This property is set to true if the returned statement is an hidden script statement.
qResult integer Not relevant for describing the requested user interaction.
qInput string Is not used in Qlik Sense.

LayoutFieldInfo

No description.

Name Type Description
qFieldName string No description.
qValuesCount integer No description.
qExcludedValuesCount integer No description.

LineageInfo

No description.

Name Type Description
qDiscriminator string A string indicating the origin of the data:
[filename]: the data comes from a local file.
INLINE: the data is entered inline in the load script.
RESIDENT: the data comes from a resident table. The table name is listed.
AUTOGENERATE: the data is generated from the load script (no external table of data source).
Provider: the data comes from a data connection. The connector source name is listed.
[webfile]: the data comes from a web-based file.
STORE: path to QVD or TXT file where data is stored.
EXTENSION: the data comes from a Server Side Extension (SSE).
qStatement string The LOAD and SELECT script statements from the data load script.

ListObject

Renders the properties of a list object. Is the layout for ListObjectDef.
For more information about the definition of a list object, see Generic object.
ListObject is used by the GetLayout Method to display the properties of a list object.

Name Type Description
qStateName string Name of the alternate state.
Default is current selections $ .
qSize Size Defines the size of a list object.
qError NxValidationError This parameter is optional and is displayed in case of error.
qDimensionInfo NxDimensionInfo Information about the dimension.
qExpressions array<NxListObjectExpression> Lists the expressions in the list object.
qDataPages array<NxDataPage> Set of data.
Is empty if nothing has been defined in qInitialDataFetch in ListObjectDef.

ListObjectDef

Defines the properties of a list object.
For more information about the definition of a list object, see Generic object.

Name Type Description
qStateName string Name of the alternate state.
Default is current selections $ .
qLibraryId string Refers to a dimension stored in the library.
qDef NxInlineDimensionDef Refers to a dimension stored in the list object.
qAutoSortByState NxAutoSortByStateDef Defines the sorting by state.
qFrequencyMode string Defines the frequency mode. The frequency mode is used to calculate the frequency of a value in a list object.
Default is NX_FREQUENCY_NONE .
This parameter is optional.

One of:
N or NX_FREQUENCY_NONE
V or NX_FREQUENCY_VALUE
P or NX_FREQUENCY_PERCENT
R or NX_FREQUENCY_RELATIVE
qShowAlternatives boolean If set to true, alternative values are allowed in qData .
If set to false, no alternative values are displayed in qData . Values are excluded instead.
The default value is false.
Note that on the contrary, the qStateCounts parameter counts the excluded values as alternative values.
This parameter is optional.
qInitialDataFetch array<NxPage> Fetches an initial data set.
qExpressions array<NxListObjectExpressionDef> Lists the expressions in the list object.
This parameter is optional.

LocaleInfo

No description.

Name Type Description
qDecimalSep string Decimal separator.
qThousandSep string Thousand separator.
qListSep string List separator.
qMoneyDecimalSep string Money decimal separator.
qMoneyThousandSep string Money thousand separator.
qCurrentYear integer Current year.
qMoneyFmt string Money format.
Example: #.##0,00 kr;-#.##0,00 kr
qTimeFmt string Time format.
Example: hh:mm:ss
qDateFmt string Date format.
Example: YYYY-MM-DD
qTimestampFmt string Time stamp format.
Example: YYYY-MM-DD hh:mm:ss[.fff]
qCalendarStrings CalendarStrings Information about the calendar.
qFirstWeekDay integer First day of the week, starting from 0.
According to ISO 8601, Monday is the first day of the week.
0 = Monday
1 = Tuesday
...
6 = Sunday

If this property has not been set in a script, the returned value comes from the Windows operating system.
qBrokenWeeks boolean Is set to true if broken weeks are allowed in a year.
According to ISO 8601, no broken weeks should be allowed.
This property is not shown if set to false.
If qBrokenWeeks is set to true, qReferenceDay is irrelevant.
If this property has not been set in a script, the returned value comes from the Windows operating system.
qReferenceDay integer Day in the year that is always in week 1.
According to ISO 8601, January 4th should always be part of the first week of the year ( qReferenceDay =4).
Recommended values are in the range 1 and 7.
If this property has not been set in a script, the returned value comes from the Windows operating system.
This property is not relevant if there are broken weeks in the year.
qFirstMonthOfYear integer First month of the year, starting from 1.
According to ISO 8601, January is the first month of the year.
1 = January
2 = February
* 12 = January

If this property has not been set in a script, the returned value comes from the Windows operating system.
qCollation string Locale name (following language tagging convention RFC 4646):
< language>-<REGION>
Where:
language is a lowercase ISO  639 language code
REGION specifies an uppercase ISO 3166 country code.

If this property has not been set in a script, the returned value comes from the Windows operating system.
qNumericalAbbreviation string Number format.
Example: 3:k;6:M;9:G;12:T;15:P;18:E;21:Z;24:Y;-3:m;-6:μ;-9:n;-12:p;-15:f;-18:a;-21:z;-24:y

MeasureList

Lists the measures. Is the layout for MeasureListDef.

Name Type Description
qItems array<NxContainerEntry> Information about the list of measures.

MeasureListDef

Defines the list of measures.

Name Type Description
qType string Type of the list.
qData JsonObject Data

MediaList

Lists the media files. Is the layout for MediaListDef.
This struct is deprecated.

Name Type Description
qItems array<MediaListItem> Information about the list of media files.
In Qlik Sense Desktop, the media files are retrieved from:
%userprofile%\Documents\Qlik\Sense\Content\Default
In Qlik Sense Enterprise, the media files are retrieved from:
<installation_directory>\Qlik\Sense\Repository\Content\Default
The default installation directory is ProgramData .

MediaListItem

In addition, this structure can return dynamic properties.

Name Type Description
qUrlDef string Relative path to the media file. The URL is static.
Media files located:
in the /content/default/ folder are outside the qvf file.
in the /media/ folder are embedded in the qvf file.
qUrl string Relative path to the media file.
Media files located:
in the /content/default/ folder are outside the qvf file.
in the /media/ folder are embedded in the qvf file.

NxAppLayout

Name Type Description
qTitle string Title of the app.
qFileName string In Qlik Sense Enterprise, this property corresponds to the app identifier (GUID).
In Qlik Sense Desktop, this property corresponds to the full path of the app.
qLastReloadTime string Date and time of the last reload of the app in ISO format.
qModified boolean Is set to true if the app has been updated since the last save.
qHasScript boolean Is set to true if a script is defined in the app.
qStateNames array Array of alternate states.
qMeta NxMeta Information on publishing and permissions.
qLocaleInfo LocaleInfo Information about the locale.
qHasData boolean Is set to true if the app contains data following a script reload.
qReadOnly boolean If set to true, it means that the app is read-only.
qIsOpenedWithoutData boolean If set to true, it means that the app was opened without loading its data.
qThumbnail StaticContentUrl App thumbnail.

NxAppProperties

Name Type Description
qTitle string App title.
qLastReloadTime string Last reload time of the app.
qMigrationHash string Internal property reserved for app migration.
Patch version of the app.
Do not update.
qSavedInProductVersion string Internal property reserved for app migration.
The app is saved in this version of the product.
Do not update.
qThumbnail StaticContentUrlDef App thumbnail.

NxAttrDimDef

Layout for NxAttrDimDef.

Name Type Description
qDef string Expression or field name.
qLibraryId string LibraryId for dimension.
qSortBy SortCriteria Sorting.
qAttribute boolean If set to true, this attribute will not affect the number of rows in the cube.

NxAttrDimInfo

Layout for NxAttrDimDef.

Name Type Description
qCardinal integer Cardinality of the attribute expression.
qSize Size Number of rows.
qFallbackTitle string The title for the attribute dimension.
qLocked boolean The Locked value of the dimension.
qError NxValidationError Validation error.
qIsCalculated boolean True if this is a calculated dimension.

NxAttrExprDef

No description.

Name Type Description
qExpression string Definition of the attribute expression.
Example: "Max(OrderID)"
qLibraryId string Definition of the attribute expression stored in the library.
Example: "MyGenericMeasure"
qAttribute boolean If set to true, this measure will not affect the number of rows in the cube.

NxAttrExprInfo

Layout for NxAttrExprDef.

Name Type Description
qMin number Minimum value.
qMax number Maximum value.
qFallbackTitle string No description.
qMinText string String version of the minimum Value.
qMaxText string String version of the maximum Value.

NxAttributeDimValues

No description.

Name Type Description
qValues array<NxSimpleDimValue> List of values.

NxAttributeExpressionValues

No description.

Name Type Description
qValues array<NxSimpleValue> List of attribute expressions values.

NxAutoSortByStateDef

No description.

Name Type Description
qDisplayNumberOfRows integer This parameter applies to list objects.
If the number of selected values in the list object is greater than the value set in qDisplayNumberOfRows , the selected lines are promoted at the top of the list object.
If qDisplayNumberOfRows is set to a negative value or to 0, the sort by state is disabled.

NxAxisData

No description.

Name Type Description
qAxis array<NxAxisTicks> List of axis data.

NxAxisTicks

No description.

Name Type Description
qName string Name of the derived definition.
qTags array List of tags.
qTicks array<NxTickCell> List of ticks.

NxBookmark

No description.

Name Type Description
qStateData array<AlternateStateData> List of selections for each state.
qUtcModifyTime number Time when the bookmark was created.
qVariableItems array<BookmarkVariableItem> List of the variables in the app at the time the bookmark was created.

NxCalcCond

No description.

Name Type Description
qCond ValueExpr Condition for calculating an hypercube, dimension or measure.
qMsg StringExpr Evaluated if Cond is not fullfilled.

NxCardinalities

No description.

Name Type Description
qCardinal integer Number of distinct field values.
qHypercubeCardinal integer Number of distinct hypercube values.

NxCell

No description.

Name Type Description
qText string Some text.
This parameter is optional.
qNum number A value.
This parameter is optional.
qElemNumber integer Rank number of the value, starting from 0.
If the element number is a negative number, it means that the returned value is not an element number.
You can get the following negative values:
-1: the cell is a Total cell. It shows a total.
-2: the cell is collapsed. Applies to pivot tables.
-3: the cell belongs to the group Others .
-4: the cell is empty. Applies to pivot tables.
qState string State of the value.
The default state for a measure is L.

One of:
L or LOCKED
S or SELECTED
O or OPTION
D or DESELECTED
A or ALTERNATIVE
X or EXCLUDED
XS or EXCL_SELECTED
XL or EXCL_LOCKED
* NSTATES
qIsEmpty boolean Is set to true , if qText and qNum are empty.
This parameter is optional. The default value is false .
qIsTotalCell boolean Is set to true if a total is displayed in the cell.
This parameter is optional. The default value is false .
Not applicable to list objects.
qIsOtherCell boolean Is set to true if the cell belongs to the group Others .
Dimension values can be set as Others depending on what has been defined in OtherTotalSpecProp .
This parameter is optional. The default value is false .
Not applicable to list objects.
qFrequency string Frequency of the value.
This parameter is optional.
qHighlightRanges NxHighlightRanges Search hits.
The search hits are highlighted.
This parameter is optional.
qAttrExps NxAttributeExpressionValues Attribute expression values.
qAttrDims NxAttributeDimValues Attribute dimensions values.
qIsNull boolean Is set to true if the value is Null.

NxCellPosition

No description.

Name Type Description
qx integer Position of the cell on the x-axis.
qy integer Position of the cell on the y-axis.

NxContainerEntry

No description.

Name Type Description
qInfo NxInfo Information about the object.
qMeta NxMeta Information on publishing and permissions.
qData JsonObject Set of data.

NxContinuousDataOptions

No description.

Name Type Description
qStart number Start value.
qEnd number End value.
qNbrPoints integer Number of bins for binning.
qMaxNbrTicks integer Maximum number of ticks.
qMaxNumberLines integer Maximum number of lines.

NxContinuousRangeSelectInfo

No description.

Name Type Description
qRange Range Range information.
qDimIx integer Dimension index.

NxCurrentSelectionItem

No description.

Name Type Description
qTotal integer Number of values in the field.
qIsNum boolean This parameter is displayed if its value is true.
Is set to true if the field is a numeric.
This parameter is optional.
qField string Name of the field that is selected.
qLocked boolean This parameter is displayed if its value is true.
Is set to true if the field is locked.
This parameter is optional.
qOneAndOnlyOne boolean This parameter is displayed if its value is true.
Property that is set to a field. Is set to true if the field cannot be unselected.
This parameter is optional.
qTextSearch string Text that was used for the search. This parameter is filled when searching for a value and selecting it.
This parameter is optional.
qSelectedCount integer Number of values that are selected.
qSelected string Values that are selected.
qRangeInfo array<RangeSelectInfo> Information about the range of selected values.
Is empty if there is no range of selected values.
qSortIndex integer Sort index of the field. Indexing starts from 0.
qStateCounts NxStateCounts Number of values in a particular state.
qSelectedFieldSelectionInfo array<NxFieldSelectionInfo> Information about the fields that are selected.
qNotSelectedFieldSelectionInfo array<NxFieldSelectionInfo> Information about the fields that are not selected.
qSelectionThreshold integer Maximum values to show in the current selections.
The default value is 6.
qReadableName string Label that, if defined, is displayed in current selections instead of the actual expression.
qIsHidden boolean Optional parameter. Indicates if the selection is to be hidden in the Selections bar.
Is set to true if the current selection is hidden.

NxDataAreaPage

No description.

Name Type Description
qLeft number Position from the left.
Corresponds to the lowest possible value of the first measure (the measure on the x-axis).
qTop number Position from the top.
Corresponds to the highest possible value of the second measure (the measure on the y-axis).
qWidth number Width of the page.
Corresponds to the highest possible value of the first measure (the measure on the x-axis).
qHeight number Height of the page.
The difference between qTop and qHeight gives the lowest possible value of the second measure (the measure on the y-axis).

NxDataPage

No description.

Name Type Description
qMatrix array<NxCellRows> Array of data.
qTails array<NxGroupTail> Array of tails.
Is used for hypercube objects with multiple dimensions. It might happen that due to the window size some elements in a group cannot be displayed in the same page as the other elements of the group. Elements of a group of dimensions can be part of the previous or the next tail.
If there is no tail, the array is empty [ ] .
qArea Rect Size and offset of the data in the matrix.
qIsReduced boolean Is set to true, if the data have been reduced.
The default value is false.

NxDerivedField

No description.

Name Type Description
qId string Identifier of the derived field.
The identifier is unique.
qName string Combination of field name, definition and method.
Example:
OrderDate.MyDefinition.Year
qMethod string Method name associated to the derived field.
qExpr string Expression of the derived field.
Example:
If qName is OrderDate.MyDefinition.Year , the expression is as follows:
=${Mydefinition(OrderDate).Year}
qTags array List of tags.

NxDerivedFieldDescriptionList

No description.

Name Type Description
qDerivedFieldLists array<NxDerivedFieldsData> Information about the derived fields.

NxDerivedFieldsData

No description.

Name Type Description
qDerivedDefinitionName string Name of the derived definition.
qFieldDefs array<NxDerivedField> List of the derived fields.
qGroupDefs array<NxDerivedGroup> List of the derived groups.
qTags array List of tags on the derived fields.

NxDerivedGroup

No description.

Name Type Description
qId string Identifier of the group.
qName string Name of the derived group.
qGrouping string Grouping type.
The grouping should be either H or C (Grouping is mandatory for derived definitions).
The parameter is mandatory.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qFieldDefs array List of the derived fields in the group.

NxDimension

Either qDef or qLibraryId must be set, but not both. If the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects. A dimension that is set in the library can be used by many objects.

Name Type Description
qLibraryId string Refers to a dimension stored in the library.
qDef NxInlineDimensionDef Refers to a dimension stored in the hypercube.
qNullSuppression boolean If set to true, no null values are returned.
qIncludeElemValue boolean No description.
qOtherTotalSpec OtherTotalSpecProp Sets the dimension limits. Each dimension of a hypercube is configured separately.
Defines if some values (grouped as Others ) should be grouped together in the visualization.
For example in a pie chart all values lower than 200 could be grouped together.
qShowTotal boolean No description.
qShowAll boolean If set to true, all dimension values are shown.
qOtherLabel StringExpr This property is used when some dimension limits are set.
Label of the Others group. The default label is Others .
Example:
"qOtherLabel":"= <label>"
or
"qOtherLabel":{"qExpr":"= <label>"}
Where:
* < label > is the label of the Others group.
qTotalLabel StringExpr If this property is set, the total of the calculated values is returned.
The default label is Total .
Example:
"qTotalLabel":"= <label>"
or
"qTotalLabel":{"qExpr":"= <label>"}
Where:
* < label > is the label of the Total group.
qCalcCond ValueExpr Specifies a calculation condition, which must be fulfilled for the dimension to be calculated.
If the calculation condition is not met, the dimension is excluded from the calculation.
By default, there is no calculation condition.
This property is optional.
qAttributeExpressions array<NxAttrExprDef> List of attribute expressions.
qAttributeDimensions array<NxAttrDimDef> List of attribute dimensions.
qCalcCondition NxCalcCond Specifies a calculation condition object.
If CalcCondition.Cond is not fulfilled, the dimension is excluded from the calculation and CalcCondition.Msg is evaluated.
By default, there is no calculation condition.
This property is optional.

NxDimensionInfo

No description.

Name Type Description
qFallbackTitle string Corresponds to the label of the dimension that is selected.
If the label is not defined then the field name is used.
qApprMaxGlyphCount integer Length of the longest value in the field.
qCardinal integer Number of distinct field values.
qLocked boolean Is set to true if the field is locked.
qSortIndicator string Sort indicator.
The default value is no sorting.
This parameter is optional.

One of:
N or NX_SORT_INDICATE_NONE
A or NX_SORT_INDICATE_ASC
* D or NX_SORT_INDICATE_DESC
qGroupFallbackTitles array Array of dimension labels.
Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).
qGroupPos integer Index of the dimension that is currently in use.
qGroupPos is set to 0 if there are no hierarchical groups (drilldown groups) or cycle groups.
qStateCounts NxStateCounts Number of values in a particular state.
qTags array Gives information on a field. For example, it can return the type of the field.
Examples: key, text, ASCII
qError NxValidationError This parameter is optional.
Gives information on the error.
qDimensionType string Binary format of the field.

One of:
D or NX_DIMENSION_TYPE_DISCRETE
N or NX_DIMENSION_TYPE_NUMERIC
* T or NX_DIMENSION_TYPE_TIME
qReverseSort boolean If set to true, it inverts the sort criteria in the field.
qGrouping string Defines the grouping.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qIsSemantic boolean If set to true, it means that the field is a semantic.
qNumFormat FieldAttributes Format of the field.
This parameter is optional.
qIsAutoFormat boolean This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.
qGroupFieldDefs array Array of field names.
qMin number Minimum value.
qMax number Maximum value.
qContinuousAxes boolean Is continuous axis used.
qIsCyclic boolean Is a cyclic dimension used.
qDerivedField boolean Is derived field is used as a dimension.
qAttrExprInfo array<NxAttrExprInfo> Array of attribute expressions.
qAttrDimInfo array<NxAttrDimInfo> Array of attribute dimensions.
qCalcCondMsg string The message displayed if calculation condition is not fulfilled.
qIsCalculated boolean True if this is a calculated dimension.
qIsOneAndOnlyOne boolean If set to true, it means that the field always has one and only one selected value.
qCardinalities NxCardinalities Dimension Cardinalities

NxEngineVersion

No description.

Name Type Description
qComponentVersion string Version number of the Qlik engine component.

NxFieldDescription

Name Type Description
qIsSemantic boolean If set to true, it means that the field is a semantic.
qIsHidden boolean If set to true, it means that the field is hidden.
qIsSystem boolean If set to true, it means that the field is a system field.
qAndMode boolean If set to true a logical AND (instead of a logical OR) is used when making selections in a field.
The default value is false.
qName string Name of the field
qCardinal integer Number of distinct field values
qTags array Gives information on a field. For example, it can return the type of the field.
Examples: key, text, ASCII
qIsDefinitionOnly boolean If set to true, it means that the field is a field on the fly.
qDerivedFieldData NxDerivedFieldDescriptionList Lists the derived fields if any.
qIsDetail boolean Is used for Direct Discovery.
If set to true, it means that the type of the field is detail.
qIsImplicit boolean Is used for Direct Discovery.
If set to true, it means that the type of the field is measure.
qReadableName string No description.

NxFieldProperties

No description.

Name Type Description
qOneAndOnlyOne boolean This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1).
If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
The property OneAndOnlyOne can be set to true if one and only value has been selected in the field prior to setting the property.

NxFieldSelectionInfo

No description.

Name Type Description
qName string Name of the field.
qFieldSelectionMode string Selection mode.

NxGetBookmarkOptions

No description.

Name Type Description
qTypes array List of object types.
qData JsonObject Set of data.

NxGetObjectOptions

No description.

Name Type Description
qTypes array List of object types.
qIncludeSessionObjects boolean Set to true to include session objects.
The default value is false.
qData JsonObject Set of data.

NxGroupTail

No description.

Name Type Description
qUp integer Number of elements that are part of the previous tail.
This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
Is not shown if the value is 0.
This parameter is optional.
qDown integer Number of elements that are part of the next tail.
This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight
Is not shown if the value is 0.
This parameter is optional.

NxHighlightRanges

No description.

Name Type Description
qRanges array<CharRange> Ranges of highlighted values.

NxInfo

No description.

Name Type Description
qId string Identifier of the object.
If the chosen identifier is already in use, the engine automatically sets another one.
If an identifier is not set, the engine automatically sets one.
This parameter is optional.
qType string Type of the object.
This parameter is mandatory.

NxInlineDimensionDef

No description.

Name Type Description
qGrouping string Used to define a cyclic group or drilldown group.
Default value is no grouping.
This parameter is optional.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qFieldDefs array Array of field names.
When creating a grouped dimension, more than one field name is defined.
This parameter is optional.
qFieldLabels array Array of field labels.
This parameter is optional.
qSortCriterias array<SortCriteria> Defines the sorting criteria in the field.
Default is to sort by alphabetical order, ascending.
This parameter is optional.
qNumberPresentations array<FieldAttributes> Defines the format of the value.
This parameter is optional.
qReverseSort boolean If set to true, it inverts the sort criteria in the field.
qActiveField integer Index of the active field in a cyclic dimension.
This parameter is optional. The default value is 0.
This parameter is used in case of cyclic dimensions ( qGrouping is C).
qLabelExpression string Label expression.
This parameter is optional.

NxInlineMeasureDef

No description.

Name Type Description
qLabel string Name of the measure.
An empty string is returned as a default value.
This parameter is optional.
qDescription string Description of the measure.
An empty string is returned as a default value.
This parameter is optional.
qTags array Name connected to the measure that is used for search purposes.
A measure can have several tags.
This parameter is optional.
qGrouping string Default value is no grouping.
This parameter is optional.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qDef string Definition of the expression in the measure.
Example: Sum (OrderTotal)
This parameter is mandatory.
qNumFormat FieldAttributes Format of the field.
This parameter is optional.
qRelative boolean If set to true, percentage values are returned instead of absolute numbers.
Default value is false.
This parameter is optional.
qBrutalSum boolean If set to true, the sum of rows total should be used rather than real expression total.
This parameter is optional and applies to straight tables.
Default value is false.
If using the Qlik Sense interface, it means that the total mode is set to Expression Total .
qAggrFunc string Aggregate function.
For more information on the aggregate function syntax, see the section Working with Qlik Sense on the online help portal.
The default value is 0 (Sum of rows)
This parameter is optional.
qAccumulate integer * 0 means no accumulation
* 1 means full accumulation (each y-value accumulates all previous y-values of the expression)
* ≥ 2 means accumulate as many steps as the qAccumulate value
Default value is 0.
This parameter is optional.
qReverseSort boolean If set to true, it inverts the sort criteria in the field.
qActiveExpression integer Index of the active expression in a cyclic measure. The indexing starts from 0.
The default value is 0.
This parameter is optional.
qExpressions array Array of expressions. This parameter is used in case of cyclic measures ( qGrouping is C). List of the expressions in the cyclic group.
qLabelExpression string Label expression.
This parameter is optional.

NxLayoutErrors

No description.

Name Type Description
qErrorCode integer Error code.

NxLibraryDimension

No description.

Name Type Description
qGrouping string Information about the grouping.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qFieldDefs array Array of dimension names.
qFieldLabels array Array of dimension labels.
qLabelExpression string No description.

NxLibraryDimensionDef

No description.

Name Type Description
qGrouping string Information about the grouping.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qFieldDefs array Array of dimension names.
qFieldLabels array Array of dimension labels.
qLabelExpression string No description.

NxLibraryMeasure

No description.

Name Type Description
qLabel string No description.
qDef string No description.
qGrouping string
One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qExpressions array No description.
qActiveExpression integer No description.
qLabelExpression string No description.

NxLibraryMeasureDef

No description.

Name Type Description
qLabel string Label of the measure.
qDef string Definition of the measure.
qGrouping string Used to define a cyclic group or drilldown group.
Default value is no grouping.
This parameter is optional.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qExpressions array Array of expressions.
qActiveExpression integer Index to the active expression in a measure.
qLabelExpression string No description.

NxLinkedObjectInfo

No description.

Name Type Description
qRootId string Identifier of the root object.
If the linked object is a child, the root identifier is the identifier of the parent.
If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object.
qInfo NxInfo Information about the linked object.

NxListObjectExpression

No description.

Name Type Description
qExpr string Value of the expression.
qError NxLayoutErrors Gives information on the error.
This parameter is optional.

NxListObjectExpressionDef

No description.

Name Type Description
qExpr string Value of the expression.
qLibraryId string Refers to an expression stored in the library.

NxMatchingFieldInfo

No description.

Name Type Description
qName string Name of the field.
qTags array List of tags.

NxMeasure

Either qDef or qLibraryId must be set, but not both. If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects. A measure that is set in the library can be used by many objects.
expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure.
Attribute expressions do not affect the layout of an object. The sorting order is unchanged.

Name Type Description
qLibraryId string Refers to a measure stored in the library.
qDef NxInlineMeasureDef Refers to a measure stored in the hypercube.
qSortBy SortCriteria Defines the sort criteria.
The default value is sort by ascending alphabetic order.
This property is optional.
qAttributeExpressions array<NxAttrExprDef> List of attribute expressions.
qAttributeDimensions array<NxAttrDimDef> List of attribute dimensions.
qCalcCond ValueExpr Specifies a calculation condition, which must be fulfilled for the measure to be calculated.
If the calculation condition is not met, the measure is excluded from the calculation.
By default, there is no calculation condition.
This property is optional.
qCalcCondition NxCalcCond Specifies a calculation condition object.
If CalcCondition.Cond is not fulfilled, the measure is excluded from the calculation and CalcCondition.Msg is evaluated.
By default, there is no calculation condition.
This property is optional.

NxMeasureInfo

Layout for NxInlineMeasureDef.

Name Type Description
qFallbackTitle string Corresponds to the label of the measure.
If the label is not defined then the measure name is used.
qApprMaxGlyphCount integer Length of the longest value in the field.
qCardinal integer Number of distinct field values.
qSortIndicator string Sort indicator.
The default value is no sorting.
This parameter is optional.

One of:
N or NX_SORT_INDICATE_NONE
A or NX_SORT_INDICATE_ASC
* D or NX_SORT_INDICATE_DESC
qNumFormat FieldAttributes Format of the field.
This parameter is optional.
qMin number Lowest value in the range.
qMax number Highest value in the range.
qError NxValidationError This parameter is optional.
Gives information on the error.
qReverseSort boolean If set to true, it inverts the sort criteria in the field.
qIsAutoFormat boolean This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's expression.
qAttrExprInfo array<NxAttrExprInfo> List of attribute expressions.
qAttrDimInfo array<NxAttrDimInfo> List of attribute dimensions.
qCalcCondMsg string The message displayed if calculation condition is not fulfilled.

NxMeta

Layout for NxMetaDef.

Name Type Description
qName string Name.
This property is optional.

NxMultiRangeSelectInfo

No description.

Name Type Description
qRanges array<NxRangeSelectInfo> No description.
qColumnsToSelect array No description.

NxPage

No description.

Name Type Description
qLeft integer Position from the left.
Corresponds to the first column.
qTop integer Position from the top.
Corresponds to the first row.
qWidth integer Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
qHeight integer Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

NxPageTreeLevel

Stability Index: Experimental

No description.

Name Type Description
qLeft integer The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.
qDepth integer Number of dimensions to include in the tree.

NxPageTreeNode

Stability Index: Experimental

Defines an area of the tree to be fetched.

Name Type Description
qArea Rect The area of the tree to be fetched. If no area is defined on a dimension, all existing nodes are included.
qAllValues boolean When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.

NxPatch

No description.

Name Type Description
qOp string Operation to perform.

One of:
add or Add
remove or Remove
* replace or Replace
qPath string Path to the property to add, remove or replace.
qValue string This parameter is not used in a remove operation.
Corresponds to the value of the property to add or to the new value of the property to update.
Examples:
"false", "2", "\"New title\""

NxPivotDimensionCell

No description.

Name Type Description
qText string Some text.
qElemNo integer Rank number of the value.
If set to -1, it means that the value is not an element number.
qValue number Value of the cell.
Is set to NaN , if the value is not a number.
qCanExpand boolean If set to true, it means that the cell can be expanded.
This parameter is not returned if it is set to false.
qCanCollapse boolean If set to true, it means that the cell can be collapsed.
This parameter is not returned if it is set to false.
qType string Type of the cell.

One of:
V or NX_DIM_CELL_VALUE
E or NX_DIM_CELL_EMPTY
N or NX_DIM_CELL_NORMAL
T or NX_DIM_CELL_TOTAL
O or NX_DIM_CELL_OTHER
A or NX_DIM_CELL_AGGR
P or NX_DIM_CELL_PSEUDO
R or NX_DIM_CELL_ROOT
U or NX_DIM_CELL_NULL
G or NX_DIM_CELL_GENERATED
qUp integer Number of elements that are part of the previous tail.
This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
qDown integer Number of elements that are part of the next tail.
This number depends on the paging, more particularly it depends on the values defined in qTop and qHeight .
qSubNodes array<NxPivotDimensionCell> Information about sub nodes (or sub cells).
The array is empty [ ] when there is no sub nodes.
qAttrExps NxAttributeExpressionValues Information about attribute expressions.
The array is empty [ ] when there is no attribute expressions.
qAttrDims NxAttributeDimValues Information about attribute dimensions.

NxPivotPage

No description.

Name Type Description
qLeft array<NxPivotDimensionCell> Information about the left dimension values of a pivot table.
qTop array<NxPivotDimensionCell> Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.
qData array<ArrayOfNxValuePoint> Array of data.
qArea Rect Size and offset of the data in the matrix.

NxPivotValuePoint

No description.

Name Type Description
qLabel string Label of the cell.
This parameter is optional.
qText string Some text related to the cell.
qNum number Value of the cell.
qType string Type of the cell.

One of:
V or NX_DIM_CELL_VALUE
E or NX_DIM_CELL_EMPTY
N or NX_DIM_CELL_NORMAL
T or NX_DIM_CELL_TOTAL
O or NX_DIM_CELL_OTHER
A or NX_DIM_CELL_AGGR
P or NX_DIM_CELL_PSEUDO
R or NX_DIM_CELL_ROOT
U or NX_DIM_CELL_NULL
G or NX_DIM_CELL_GENERATED
qAttrExps NxAttributeExpressionValues Attribute expressions values.
qAttrDims NxAttributeDimValues No description.

NxRange

No description.

Name Type Description
qFrom integer Position in the expression of the first character of the field name.
qCount integer Number of characters in the field name.

NxRangeSelectInfo

No description.

Name Type Description
qRange Range Range of values.
qMeasureIx integer Number of the measure to select.
Numbering starts from 0.

NxSelectionCell

No description.

Name Type Description
qType string Type of cells to select.

One of:
D or NX_CELL_DATA
T or NX_CELL_TOP
* L or NX_CELL_LEFT
qCol integer Column index to select.
Indexing starts from 0.
If the cell's type is:
D, the index is based on the data matrix.
T, the index is based on the data matrix.
* L, the index is based on the left dimensions indexes.
qRow integer Row index to select.
Indexing starts from 0.
If the cell's type is:
D, the index is based on the data matrix.
T, the index is based on the top dimensions indexes.
* L, the index is based on the data matrix.

NxSelectionInfo

No description.

Name Type Description
qInSelections boolean Is set to true if the visualization is in selection mode.
For more information about the selection mode, see BeginSelections Method.
qMadeSelections boolean Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode.
For more information about the selection mode, see BeginSelections Method.

NxSimpleDimValue

No description.

Name Type Description
qText string Text related to the attribute expression value.
This property is optional. No text is returned if the attribute expression value is a numeric.
qElemNo integer Element number.

NxSimpleValue

No description.

Name Type Description
qText string Text related to the attribute expression value.
qNum number Numeric value of the attribute expression.
Set to NaN (Not a Number) if the attribute expression value is not numeric.

NxStackPage

No description.

Name Type Description
qData array<NxStackedPivotCell> Array of data.
qArea Rect Size and offset of the data in the matrix.

NxStackedPivotCell

No description.

Name Type Description
qText string Some text.
qElemNo integer Rank number of the value.
If set to -1, it means that the value is not an element number.
qValue number Value of the cell.
Is set to NaN , if the value is not a number.
qCanExpand boolean If set to true, it means that the cell can be expanded.
This parameter is not returned if it is set to false.
qCanCollapse boolean If set to true, it means that the cell can be collapsed.
This parameter is not returned if it is set to false.
qType string Type of the cell.

One of:
V or NX_DIM_CELL_VALUE
E or NX_DIM_CELL_EMPTY
N or NX_DIM_CELL_NORMAL
T or NX_DIM_CELL_TOTAL
O or NX_DIM_CELL_OTHER
A or NX_DIM_CELL_AGGR
P or NX_DIM_CELL_PSEUDO
R or NX_DIM_CELL_ROOT
U or NX_DIM_CELL_NULL
G or NX_DIM_CELL_GENERATED
qMaxPos number Total of the positive values in the current group of cells.
qMinNeg number Total of the negative values in the current group of cells.
qUp integer Number of elements that are part of the previous tail.
qDown integer Number of elements that are part of the next tail.
qRow integer Row index in the data matrix.
The indexing starts from 0.
qSubNodes array<NxStackedPivotCell> Information about sub nodes (or sub cells).
The array is empty [ ] when there are no sub nodes.
qAttrExps NxAttributeExpressionValues Attribute expressions values.
qAttrDims NxAttributeDimValues Attribute dimensions values.

NxStateCounts

No description.

Name Type Description
qLocked integer Number of values in locked state.
qSelected integer Number of values in selected state.
qOption integer Number of values in optional state.
qDeselected integer Number of values in deselected state.
qAlternative integer Number of values in alternative state.
qExcluded integer Number of values in excluded state.
qSelectedExcluded integer Number of values in selected excluded state.
qLockedExcluded integer Number of values in locked excluded state.

NxStreamListEntry

This struct is deprecated (not recommended to use).

Name Type Description
qName string Name of the stream.
qId string Identifier of the stream.

NxTickCell

No description.

Name Type Description
qText string Tick's label.
qStart number Start value.
qEnd number End value.

NxTreeDataOption

Stability Index: Experimental

Specifies all the paging filters needed to define the tree to be fetched.

Name Type Description
qMaxNbrOfNodes integer Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.
qTreeNodes array<NxPageTreeNode> Defines areas of the tree to be fetched. Areas must be defined left to right.
qTreeLevels NxPageTreeLevel Filters out complete dimensions from the fetched tree.

NxTreeDimensionDef

Stability Index: Experimental

No description.

Name Type Description
qLibraryId string Refers to a dimension stored in the library.
qDef NxInlineDimensionDef Refers to a dimension.
qValueExprs array<NxMeasure> List of measures.
qNullSuppression boolean If set to true, no null values are returned.
qOtherTotalSpec OtherTotalSpecProp Sets the dimension limits. Each dimension of a hypercube is configured separately.
Defines if some values (grouped as Others ) should be grouped together in the visualization.
For example in a pie chart all values lower than 200 could be grouped together.
qShowAll boolean If set to true, all dimension values are shown.
qOtherLabel StringExpr This property is used when some dimension limits are set.
Label of the Others group. The default label is Others .
Example:
"qOtherLabel":"= <label>"
or
"qOtherLabel":{"qExpr":"= <label>"}
Where:
* < label > is the label of the Others group.
qTotalLabel StringExpr If this property is set, the total of the calculated values is returned.
The default label is Total .
Example:
"qTotalLabel":"= <label>"
or
"qTotalLabel":{"qExpr":"= <label>"}
Where:
* < label > is the label of the Total group.
qCalcCondition NxCalcCond Specifies a calculation condition object.
If CalcCondition.Cond is not fulfilled, the dimension is excluded from the calculation and CalcCondition.Msg is evaluated.
By default, there is no calculation condition.
This property is optional.
qAttributeExpressions array<NxAttrExprDef> List of attribute expressions.
qAttributeDimensions array<NxAttrDimDef> List of attribute dimensions.

NxTreeDimensionInfo

Stability Index: Experimental

No description.

Name Type Description
qFallbackTitle string Corresponds to the label of the dimension that is selected.
If the label is not defined then the field name is used.
qApprMaxGlyphCount integer Length of the longest value in the field.
qCardinal integer Number of distinct field values.
qLocked boolean Is set to true if the field is locked.
qSortIndicator string Sort indicator.
The default value is no sorting.
This parameter is optional.

One of:
N or NX_SORT_INDICATE_NONE
A or NX_SORT_INDICATE_ASC
* D or NX_SORT_INDICATE_DESC
qGroupFallbackTitles array Array of dimension labels.
Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).
qGroupPos integer Index of the dimension that is currently in use.
qGroupPos is set to 0 if there are no hierarchical groups (drilldown groups) or cycle groups.
qStateCounts NxStateCounts Number of values in a particular state.
qTags array Gives information on a field. For example, it can return the type of the field.
Examples: key, text, ASCII
qError NxValidationError This parameter is optional.
Gives information on the error.
qDimensionType string Binary format of the field.

One of:
D or NX_DIMENSION_TYPE_DISCRETE
N or NX_DIMENSION_TYPE_NUMERIC
* T or NX_DIMENSION_TYPE_TIME
qReverseSort boolean If set to true, it inverts the sort criteria in the field.
qGrouping string Defines the grouping.

One of:
N or GRP_NX_NONE
H or GRP_NX_HIEARCHY
* C or GRP_NX_COLLECTION
qIsSemantic boolean If set to true, it means that the field is a semantic.
qNumFormat FieldAttributes Format of the field.
This parameter is optional.
qIsAutoFormat boolean This parameter is set to true if qNumFormat is set to U (unknown). The engine guesses the type of the field based on the field's definition.
qGroupFieldDefs array Array of field names.
qMin number Minimum value.
qMax number Maximum value.
qContinuousAxes boolean Is continuous axis used.
qIsCyclic boolean Is a cyclic dimension used.
qDerivedField boolean Is derived field is used as a dimension.
qMeasureInfo array<NxMeasureInfo> A List of measures to be calculated on this TreeDimension.
qAttrExprInfo array<NxAttrExprInfo> List of attribute expressions.
qAttrDimInfo array<NxAttrDimInfo> List of attribute dimensions.
qCalcCondMsg string The message displayed if calculation condition is not fulfilled.
qIsCalculated boolean True if this is a calculated dimension.
qIsOneAndOnlyOne boolean If set to true, it means that the field always has one and only one selected value.
qCardinalities NxCardinalities Dimension Cardinalities

NxTreeMultiRangeSelectInfo

Stability Index: Experimental

No description.

Name Type Description
qRanges array<NxTreeRangeSelectInfo> An array of Ranges.

NxTreeNode

Stability Index: Experimental

Represents a dimension in the tree.

Name Type Description
qText string The text version of the value, if available.
qElemNo integer Element number.
qNodeNr integer A generated number applicable to this page only. Used so that children can easily identify who their parents are.
qParentNode integer The qNodeNr of this node's parent for the current page.
qRow integer Row index in the data matrix.
The indexing starts from 0.
qType string Type of the cell.

One of:
V or NX_DIM_CELL_VALUE
E or NX_DIM_CELL_EMPTY
N or NX_DIM_CELL_NORMAL
T or NX_DIM_CELL_TOTAL
O or NX_DIM_CELL_OTHER
A or NX_DIM_CELL_AGGR
P or NX_DIM_CELL_PSEUDO
R or NX_DIM_CELL_ROOT
U or NX_DIM_CELL_NULL
G or NX_DIM_CELL_GENERATED
qValues array<NxTreeValue> The measures for this node.
qNodes array<NxTreeNode> The children of this node in the tree structure.
qAttrExps NxAttributeExpressionValues Attribute expression values.
qAttrDims NxAttributeDimValues Attribute dimension values.

NxTreeRangeSelectInfo

Stability Index: Experimental

No description.

Name Type Description
qRange Range Range of values.
qMeasureIx integer Number of the measure to select.
Numbering starts from 0.
qDimensionIx integer Number of the dimension to select
measure from. Numbering starts from 0.

NxTreeValue

Stability Index: Experimental

Represents a measure.

Name Type Description
qText string The text version of the value, if available.
qValue number Value of the cell.
Is set to NaN , if the value is not a number.
qAttrExps NxAttributeExpressionValues Attribute expression values.
qAttrDims NxAttributeDimValues Attribute dimension values.

NxValidationError

No description.

Name Type Description
qErrorCode integer Error code.
This parameter is always displayed in case of error.
qContext string Context related to the error, from the user app domain.
It can be the identifier of an object, a field name, a table name.
This parameter is optional.
qExtendedMessage string Internal information from the server.
This parameter is optional.

NxVariableListItem

No description.

Name Type Description
qName string Name of the variable.
qDescription string Description of the variable.
qDefinition string Definition of the variable. It can be a value or an expression.
qIsConfig boolean If set to true, it means that the variable is a system variable.
A system variable provides information about the system and is set by the engine. The content cannot be changed by the user.
This parameter is optional.
The default value is false.
qIsReserved boolean If set to true, it means that the variable is reserved.
The default value is false.
This parameter is optional.
Examples:
ScriptError is a reserved variable, set by the engine.
DayNames is a reserved variable, set by the user.
qMeta NxMeta Information about publishing and permissions.
This parameter is optional.
qInfo NxInfo Identifier and type of the object.
This parameter is mandatory.
qData JsonObject Data.
qIsScriptCreated boolean If set to true, it means that the variable was defined via script.

NxVariableProperties

No description.

Name Type Description
qName string Name of the variable.
qNumberPresentation FieldAttributes Defines the format of the value of a variable.
qIncludeInBookmark boolean Set this property to true to update the variable when applying a bookmark.
The value of a variable can affect the state of the selections.
The default value is false.
qUsePredefListedValues boolean The value of a variable can be an enumeration.
Set this property to true to reflect the predefined values in an enumeration.
qPreDefinedList array List of enumerations.
This property is used if qUsePredefListedValues is set to true.

NxViewPort

No description.

Name Type Description
qWidth integer Width of the canvas in pixels.
qHeight integer Height of the canvas in pixels.
qZoomLevel integer Zoom level.

ObjectInterface

No description.

Name Type Description
qType string No description.
qHandle integer No description.
qGenericType string No description.
qGenericId string No description.

OdbcDsn

No description.

Name Type Description
qName string Name of the ODBC connection.
qDescription string Description of the ODBC connection.
qBit32 boolean Is set to true if the version of ODBC is 32-bit.
This parameter is optional. Default is false.
qUserOnly boolean Is set to true if the connection is User DSN. The connection works only for a specific user.
Default is false.
This parameter is optional.

OleDbProvider

No description.

Name Type Description
qName string Name of the OLEDB provider.
qDescription string Description of the OLEDB provider.
qBit32 boolean Is set to true if the version of the OLEDB provider is 32-bit.
Default is false.
This parameter is optional.

OtherTotalSpecProp

No description.

Name Type Description
qOtherMode string Determines how many dimension values are displayed.
The default value is OTHER_OFF .

One of:
OTHER_OFF
OTHER_COUNTED
OTHER_ABS_LIMITED
OTHER_ABS_ACC_TARGET
OTHER_REL_LIMITED
OTHER_REL_ACC_TARGET
qOtherCounted ValueExpr Number of values to display. The number of values can be entered as a calculated formula.
This parameter is used when qOtherMode is set to OTHER_COUNTED .
qOtherLimit ValueExpr Value used to limit the dimension values. The limit can be entered as a calculated formula.
This parameter is used when qOtherMode is set to:
OTHER_ABS_LIMITED
OTHER_REL_LIMITED
* OTHER_ABS_ACC_TARGET
OTHER_REL_ACC_TARGET
qOtherLimitMode string Sets the limit for the Others mode.
This parameter is used when qOtherMode is set to:
OTHER_ABS_LIMITED
OTHER_REL_LIMITED
OTHER_ABS_ACC_TARGET
OTHER_REL_ACC_TARGET

One of:
OTHER_GE_LIMIT
OTHER_LE_LIMIT
OTHER_GT_LIMIT
* OTHER_LT_LIMIT
qSuppressOther boolean If set to true, the group Others is not displayed as a dimension value.
The default value is false.
qForceBadValueKeeping boolean This parameter is used when qOtherMode is set to:
OTHER_ABS_LIMITED
OTHER_REL_LIMITED
* OTHER_ABS_ACC_TARGET
OTHER_REL_ACC_TARGET

and when the dimension values include not numeric values.
Set this parameter to true to include text values in the returned values.
The default value is true.
qApplyEvenWhenPossiblyWrongResult boolean Set this parameter to true to allow the calculation of Others even if the engine detects some potential mistakes.
For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe.
The default value is true.
qGlobalOtherGrouping boolean This parameter applies to inner dimensions.
If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored.
The default value is false.
qOtherCollapseInnerDimensions boolean If set to true, it collapses the inner dimensions (if any) in the group Others .
The default value is false.
qOtherSortMode string Defines the sort order of the dimension values.
The default value is OTHER_SORT_DESCENDING .

One of:
OTHER_SORT_DEFAULT
OTHER_SORT_DESCENDING
* OTHER_SORT_ASCENDING
qTotalMode string If set to TOTAL_EXPR , the total of the dimension values is returned.
The default value is TOTAL_OFF .

One of:
TOTAL_OFF
TOTAL_EXPR
qReferencedExpression StringExpr This parameter applies when there are several measures.
Name of the measure to use for the calculation of Others for a specific dimension.

Point

No description.

Name Type Description
qx integer x-coordinate in pixels.
The origin is the top left of the screen.
qy integer y-coordinate in pixels.
The origin is the top left of the screen.

ProgressData

No description.

Name Type Description
qStarted boolean True if the request is started.
qFinished boolean True if the request is finished.
qCompleted integer This property is not used.
qTotal integer This property is not used.
qKB integer This property is not used.
qMillisecs integer Request duration in milliseconds.
qUserInteractionWanted boolean True when the engine pauses the script execution and waits for a user interaction.
qPersistentProgress string A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source or tell that the app was saved. All persistent progress messages between two GetProgress calls are summarized in this string. Contrarily to qPersistentProgressMessages, the content of the localized message string is displayed (not its message code).
qTransientProgress string A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two GetProgress calls are summarized in this string. Contrarily to qTransientProgressMessage, the content of the localized message string is displayed (not its message code).
qErrorData array<ErrorData> Information about the error messages that occur during the script execution.
qPersistentProgressMessages array<ProgressMessage> List of persistent progress messages.
qTransientProgressMessage ProgressMessage Transient progress message.

ProgressMessage

No description.

Name Type Description
qMessageCode integer Code number to the corresponding localized message string.
qMessageParameters array Parameters to be inserted in the localized message string.

Range

No description.

Name Type Description
qMin number Lowest value in the range
qMax number Highest value in the range
qMinInclEq boolean If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)]
Example:
The range is [1,10]. If qMinInclEq is set to true it means that 1 is included in the range of selections.
qMaxInclEq boolean If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)]
Example:
The range is [1,10]. If qMinInclEq is set to true it means that 10 is included in the range of selections.

RangeSelectInfo

No description.

Name Type Description
qRangeLo number Lowest value in the range.
qRangeHi number Highest value in the range.
qMeasure string Label of the measure.

Rect

No description.

Name Type Description
qLeft integer Position from the left.
Corresponds to the first column.
qTop integer Position from the top.
Corresponds to the first row.
qWidth integer Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).
qHeight integer Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter qAlwaysFullyExpanded in HyperCubeDef ).

ScriptSyntaxError

No description.

Name Type Description
qErrLen integer Length of the word where the error is located.
qTabIx integer Number of the faulty section.
qLineInTab integer Line number in the section where the error is located.
qColInLine integer Position of the erroneous text from the beginning of the line.
qTextPos integer Position of the erroneous text from the beginning of the script.
qSecondaryFailure boolean The default value is false.

SearchAssociationResult

No description.

Name Type Description
qFieldNames array List of the fields that contains search associations.
qSearchTerms array List of the search terms.
qFieldDictionaries array<SearchFieldDictionary> Information about the fields containing search hits.
qSearchTermsMatched array<SearchMatchCombinations> List of search results.
The maximum number of search results in this list is set by qPage/qCount .
qTotalSearchResults integer Total number of search results.
This number is not limited by qPage/qCount .

SearchAttribute

No description.

Name Type Description
qKey string String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for SearchObjectOptions.
qValue string String corresponding to qKey for the current SearchGroupItemMatch. For example, if the match is Make by Price found in the title of a generic object, qValue will be qMetaDef/title.

SearchCharRange

No description.

Name Type Description
qCharPos integer Starting position of the match in the search result, starting from 0.
qCharCount integer Length of the match in the search result.
qTerm integer Position of the term in the list of search terms, starting from 0.

SearchCombinationOptions

No description.

Name Type Description
qSearchFields array List of the search fields.
If empty, the search is performed in all fields of the app.
qContext string Search context.
The default value is LockedFieldsOnly .

One of:
Cleared or CONTEXT_CLEARED
LockedFieldsOnly or CONTEXT_LOCKED_FIELDS_ONLY
* CurrentSelections or CONTEXT_CURRENT_SELECTIONS
qCharEncoding string Encoding used to compute qRanges of type SearchCharRange.
Only affects the computation of the ranges. It does not impact the encoding of the text.

One of:
Utf8 or CHAR_ENCODING_UTF8
Utf16 or CHAR_ENCODING_UTF16
qAttributes array Optional.
For SearchSuggest method, this array is empty.
For SearchObjects method, this array is empty or contain qProperty .
* For SearchResults method, this array is empty, or contains qNum and/or qElemNum . It allows the user to request details in the outputted SearchGroupItemMatch . For more information, see SearchGroupItemMatch.

SearchFieldDictionary

No description.

Name Type Description
qField integer Position of the field in the list of fields, starting from 0.
The list of fields is defined in qResults/qFieldNames and contains the search associations.
qResult array<SearchTermResult> List of the matching values.
The maximum number of values in this list is set by qMaxNbrFieldMatches .

SearchFieldMatch

No description.

Name Type Description
qField integer Position of the field in the list of fields, starting from 0.
The list of fields is defined in qResults/qFieldNames and contains the search associations.
qValues array Positions of the matching values in the search results.
The maximum number of values in this list is defined by qMaxNbrFieldMatches .
qTerms array Positions of the search terms, starting from 0.
qNoOfMatches integer Number of search hits in the field.
The number of values in qValues and the value of qNoOfMatches are equal if qMaxNbrFieldMatches is -1.

SearchGroup

No description.

Name Type Description
qId integer Identifier of the search group.
qGroupType string Type of the search group.

One of:
DatasetType or DATASET_GROUP
GenericObjectsType or GENERIC_OBJECTS_GROUP
qSearchTermsMatched array Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .
qTotalNumberOfItems integer Total number of distinct items in the search group.
qItems array<SearchGroupItem> List of items in the search group.
The group items are numbered from the value of SearchGroupOptions.qOffset to the value of SearchGroupOptions.qOffset + SearchGroupOptions.qCount

SearchGroupItem

No description.

Name Type Description
qItemType string Type of the group item.

One of:
Field or FIELD
GenericObject or GENERIC_OBJECT
qTotalNumberOfMatches integer Total number of distinct matches in the search group item.
qIdentifier string Identifier of the item.
It corresponds to:
The name of the field, if the type of the search group is data set.
The id of the generic object if the type of the search group is generic object.
qItemMatches array<SearchGroupItemMatch> List of matches in the search group item.
The group item matches are numbered from the value of SearchGroupItemOptions.qOffset to the value of SearchGroupItemOptions.qOffset + SearchGroupItemOptions.qCount .
qSearchTermsMatched array Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in SearchResult.qSearchTerms .

SearchGroupItemMatch

No description.

Name Type Description
qText string Search match value.
Value of the search group item.
If the match is found in a field, it corresponds to the value of the field.
If the match is found in a generic object property, it corresponds to the property value.
qRanges array<SearchCharRange> List of ranges.
For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.
qAttributes array<SearchAttribute> Provides detail of the match as requested by the user in SearchObjectsOptions.qAttributes or SearchCombinationOptions.qAttributes
If the user requests SearchObjects or SearchResults with an empty qAttributes option, the outputted qAttributes is returned empty.
For SearchObjects requested with qProperty , the SearchGroupItemMatch.qAttributes return value contains [“qProperty”, "qMetaDef/title”] if the match has been found in the title of the item. For dimension values, the returned qProperty will be “*” .
For SearchResults requested with qNum , the SearchGroupItemMatch.qAttributes return value contains ["qNum", N] where N is the numeric value of the element or NaN if the value is not numeric.
For SearchResults requested with qElemNum , the SearchGroupItemMatch.qAttributes return value contains ["qElemNum", N] where N is the value index of the element.

SearchGroupItemOptions

No description.

Name Type Description
qGroupItemType string Type of the group item. Can be:
GenericObject: the type of the search group item is a generic object. Group items have this type when you are calling SearchObjects .
Field: the type of the search group item is a field. Group items have this type when you are calling SearchResults .

One of:
Field or FIELD
GenericObject or GENERIC_OBJECT
qOffset integer Position starting from 0.
The default value is 0.
qCount integer Maximum number of matches per item (in qItemMatches[ ] ).
The default value is -1: all values are returned.

SearchGroupOptions

No description.

Name Type Description
qGroupType string Type of the group. Can be:
GenericObjectType: the type of the search group item is a generic object. Groups have this type when you are calling SearchObjects .
DatasetType: type of the search group item is a dataset association. Groups have this type when you are calling SearchResults .

One of:
DatasetType or DATASET_GROUP
GenericObjectsType or GENERIC_OBJECTS_GROUP
qOffset integer Position starting from 0.
The default value is 0.
qCount integer Maximum number of items per group (in qItems[ ] ).
The default value is -1; all values are returned.

SearchMatchCombination

No description.

Name Type Description
qId integer Index of the search result, starting from 0.
qFieldMatches array<SearchFieldMatch> Information about the search matches.

SearchObjectOptions

No description.

Name Type Description
qAttributes array This array is either empty or contains qProperty .
qCharEncoding string Encoding used to compute qRanges of type SearchCharRange.
Only affects the computation of the ranges. It does not impact the encoding of the text.

One of:
Utf8 or CHAR_ENCODING_UTF8
Utf16 or CHAR_ENCODING_UTF16

SearchPage

No description.

Name Type Description
qOffset integer Position from the top, starting from 0.
If the offset is set to 0, the first search result to be returned is at position 0.
qCount integer Number of search groups to return (in qSearchGroupArray ).
qMaxNbrFieldMatches integer Maximum number of matching values to return per search result.
The default value is -1; all values are returned.
This property is to be used with the SearchAssociations method.
qGroupOptions array<SearchGroupOptions> Options of the search groups.
If this property is not set, all values are returned.
This property is to be used with the SearchResults method or the SearchObjects method.
qGroupItemOptions array<SearchGroupItemOptions> Options of the search group items.
If this property is not set, all values are returned.
This property is to be used with the SearchResults method or the SearchObjects method.

SearchResult

No description.

Name Type Description
qSearchTerms array List of the search terms.
qTotalNumberOfGroups integer Total number of groups.
qSearchGroupArray array<SearchGroup> List of search groups.
The groups are numbered from the value of SearchPage.qOffset to the value of SearchPage.qOffset + SearchPage.qCount .

SearchSuggestItem

No description.

Name Type Description
qValue string Value of the suggestion.
qTerm integer Index of the suggestion value.
The indexing starts from 0 and from the left.

SearchSuggestionResult

No description.

Name Type Description
qSuggestions array<SearchSuggestItem> List of suggestions.
qFieldNames array List of field names that contain search hits.

SearchTermResult

No description.

Name Type Description
qText string Text of the associated value.
qElemNumber integer Element number of the associated value.
qRanges array<SearchCharRange> List of ranges.
For example, if the user searches the term read and the associative value is Reading , then the corresponding range would be Read in Reading .

SelectInfo

No description.

Name Type Description
qTextSearch string Text search string.
Everything that matches the text is selected.
This parameter is optional.
qRangeLo number Lower value of the search range.
This parameter is used when performing range selections or text searches in dimensions.
Default is Null.
qRangeHi number Highest value of the search range.
This parameter is used when performing range selections or text searches in dimensions.
Default is Null.
qNumberFormat FieldAttributes Gives information about the formatting of the range.
This parameter is used when performing range selections or text searches in dimensions.
qRangeInfo array<RangeSelectInfo> This parameter is used when performing range selections or text searches in measures.
Gives information about the range of selections.
bool SoftLock = false;
qSoftLock boolean No description.
qContinuousRangeInfo array<Range> List of information about ranges for selections.

SelectionObject

Indicates which selections are currently applied. It gives the current selections. Is the layout for SelectionObjectDef.

Name Type Description
qBackCount integer Number of steps back.
qForwardCount integer Number of steps forward.
qSelections array<NxCurrentSelectionItem> Lists the fields that are selected.

SelectionObjectDef

To display the current selections.
Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

Name Type Description
qStateName string No description.

Size

No description.

Name Type Description
qcx integer Number of pixels on the x axis.
qcy integer Number of pixels on the y axis.

SortCriteria

No description.

Name Type Description
qSortByState integer Sorts the field values according to their logical state (selected, optional, alternative or excluded).
qSortByFrequency integer Sorts the field values by frequency (number of occurrences in the field).
qSortByNumeric integer Sorts the field values by numeric value.
qSortByAscii integer Sorts the field by alphabetical order.
qSortByLoadOrder integer Sorts the field values by the initial load order.
qSortByExpression integer Sorts the field by expression.
qExpression ValueExpr Sort by expression.
qSortByGreyness integer No description.

SourceKeyRecord

No description.

Name Type Description
qKeyFields array Name of the key field.
qTables array Table the key belongs to.

StaticContentList

No description.

Name Type Description
qItems array<StaticContentListItem> Information about the list of content files.

StaticContentListItem

In addition, this structure can return dynamic properties.

Name Type Description
qUrlDef string Relative path to the content file. The URL is static.
In Qlik Sense Enterprise, content files located:
In the /content/ <content library name>/ folder are part of a global content library.
In the /appcontent/ folder are part of the app specific library.
The content files are never embedded in the qvf file.
In Qlik Sense Desktop, content files located:
In the /content/default/ folder are outside the qvf file.
In the /media/ folder are embedded in the qvf file.
qUrl string Relative path to the content file. The URL is static.
In Qlik Sense Enterprise, content files located:
In the /content/ <content library name>/ folder are part of a global content library.
In the /appcontent/ folder are part of the app specific library.
The content files are never embedded in the qvf file.
In Qlik Sense Desktop, content files located:
In the /content/default/ folder are outside the qvf file.
In the /media/ folder are embedded in the qvf file.

StaticContentUrl

In addition, this structure can return dynamic properties.

Name Type Description
qUrl string Relative path of the thumbnail.

StaticContentUrlDef

In addition, this structure can contain dynamic properties.

Name Type Description
qUrl string Relative path of the thumbnail.

StringExpr

No description.

Name Type Description
qv string No description.

StringExpression

Name Type Description
qExpr string No description.

TableRecord

No description.

Name Type Description
qName string Name of the table.
qLoose boolean This property is set to true if the table is loose.
qNoOfRows integer Number of rows in the table.
qFields array<FieldInTableData> Information about the fields in the table.
qPos Point Information about the position of the table.
qComment string Comment related to the table.
qIsDirectDiscovery boolean If set to true, Direct Discovery is used.
Direct Discovery fields are not loaded into memory and remain in the external database.
qIsSynthetic boolean This property is set to true if the table contains a synthetic key.

TableRow

No description.

Name Type Description
qValue array<FieldValue> Array of field values.

TableViewBroomPointSaveInfo

No description.

Name Type Description
qPos Point Information about the position of the broom point.
qTable string Name of the table.
qFields array List of fields in the table.

TableViewConnectionPointSaveInfo

No description.

Name Type Description
qPos Point Information about the position of the connection point.
qFields array List of the fields in the table.

TableViewCtlSaveInfo

No description.

Name Type Description
qInternalView TableViewSaveInfo Internal view mode.
qSourceView TableViewSaveInfo Source view mode.

TableViewDlgSaveInfo

No description.

Name Type Description
qPos Rect Information about the position of the dialog window.
Not used in Qlik Sense.
qCtlInfo TableViewCtlSaveInfo Set of data for internal and source view modes.
qMode integer View mode to display when opening Qlik Sense data model viewer.
One of:
0 for internal view mode.
1 for source view mode.

TableViewSaveInfo

No description.

Name Type Description
qTables array<TableViewTableWinSaveInfo> List of the tables in the database model viewer.
qBroomPoints array<TableViewBroomPointSaveInfo> List of the broom points in the database model viewer.
Not used in Qlik Sense.
qConnectionPoints array<TableViewConnectionPointSaveInfo> List of connection points in the database model viewer.
Not used in Qlik Sense.
qZoomFactor number Zoom factor in the database model viewer.
The default value is 1.0.

TableViewTableWinSaveInfo

No description.

Name Type Description
qPos Rect Information about the position of the table.
qCaption string Table name.

TextMacro

No description.

Name Type Description
qTag string Name of the variable.
qRefSeqNo integer Order in which the variable was referenced during the script execution.
The same number sequence is used for both qRefSeqNo and qSetSeqNo .
qSetSeqNo integer Order in which the variable was updated during the script execution.
The same number sequence is used for both qRefSeqNo and qSetSeqNo .
qDisplayString string Variable value.
qIsSystem boolean Is set to true if the variable is a system variable.
qIsReserved boolean Is set to true if the variable is a reserved variable.

TreeData

Stability Index: Experimental

Renders the properties of a TreeData object. Is the layout for TreeDataDef.
For more information about the definition of TreeData, see Generic object.
To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.

Name Type Description
qStateName string Name of the alternate state.
Default is current selections $ .
qNodesOnDim array The total number of nodes on each dimension.
qError NxValidationError This parameter is optional and is displayed in case of error.
qDimensionInfo array<NxTreeDimensionInfo> Information on the dimension.
qEffectiveInterColumnSortOrder array Defines the order of the dimenion levels/columns in the TreeData object.
Column numbers are separated by a comma.
Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.
qHasOtherValues boolean True if other row exists.
qTitle string Title of the TreeData object, for example the title of a chart.
qLastExpandedPos NxCellPosition Position of the last expended cell.
This property is optional.
qCalcCondMsg string The message displayed if calculation condition is not fulfilled.

TreeDataDef

Stability Index: Experimental

Defines the properties of a TreeData object.
For more information about the definition of a TreeData object, see Generic object.

Name Type Description
qStateName string Name of the alternate state.
Default is current selections $ .
qDimensions array<NxTreeDimensionDef> Array of dimensions.
qInterColumnSortOrder array Defines the order of the dimension levels/columns in the TreeData object.
Column numbers are separated by a comma.
Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.
The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.
qSuppressZero boolean Removes zero values.
qSuppressMissing boolean Removes missing values.
qOpenFullyExpanded boolean If this property is set to true, the cells are opened expanded. The default value is false.
qPopulateMissing boolean If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string.
The default value is false.
qCalcCondition NxCalcCond Specifies a calculation condition object.
If CalcCondition.Cond is not fulfilled, the TreeData is excluded from the calculation and CalcCondition.Msg is evaluated.
By default, there is no calculation condition.
This property is optional.
qTitle StringExpr Title of the TreeData object, for example the title of a chart.

UndoInfo

Displays information about the number of possible undos and redos. Is the layout for UndoInfoDef.

Name Type Description
qUndoCount integer Number of possible undos.
qRedoCount integer Number of possible redos.

ValueExpr

No description.

Name Type Description
qv string No description.

ValueExpression

Name Type Description
qExpr string No description.

VariableList

Lists the variables in an app. Is the layout for VariableListDef.

Name Type Description
qItems array<NxVariableListItem> List of the variables.

VariableListDef

Defines the list of variables in an app.

Name Type Description
qType string Type of the list.
qShowReserved boolean Shows the reserved variables if set to true.
qShowConfig boolean Shows the system variables if set to true.
qData JsonObject Data