

Definitions¶

QIX definitions for version 12.538.0.

`AlfaNumString`¶

Deprecated

This definition is deprecated and should not be used

No description.

Name	Type	Default	Description
`qString`	string	N/A	Calculated value.
`qIsNum`	boolean	N/A	Is set to true if the value is a numeric.

`AlternateStateData`¶

No description.

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

`AppEntry`¶

No description.

Name	Type	Default	Description
`qID`	string	N/A	Identifier of the app.
`qTitle`	string	N/A	Title of the app.
`qPath`	string	N/A	Path of the app.
`qLastReloadTime`	string	N/A	Last reload time of the app.
`qReadOnly`	boolean	N/A	Is set to true if the app is read-only.
`qMeta`	`NxMeta`	N/A	Meta data.
`qThumbnail`	`StaticContentUrl`	N/A	App thumbnail.
`qFileSize`	integer	N/A	No description.
`qHasSectionAccess`	boolean	N/A	If true the app has section access configured.

`AppObjectList`¶

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

Name	Type	Default	Description
`qItems`	array<`NxContainerEntry`>	N/A	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	Default	Description
`qType`	string	N/A	Type of the app list.
`qData`	`JsonObject`	N/A	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	Default	Description
`qScript`	string	N/A	Script text.
`qMeta`	`NxMeta`	N/A	Information about publishing and permissions. This parameter is optional.

`AssociationScore`¶

No description.

Name	Type	Default	Description
`qFieldPairName`	string	N/A	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	N/A	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`	N/A	Association information about the field FieldName1 defined in qFieldPairName .
`qField2Scores`	`FieldScores`	N/A	Association information about the field FieldName2 defined in qFieldPairName .

`BNFDef`¶

No description.

Name	Type	Default	Description
`qBnf`	array<integer>	N/A	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	N/A	Number of the current token definition.
`qPNbr`	integer	N/A	Number of the parent rule definition.
`qHelpId`	integer	N/A	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	N/A	Token name. One of: - A rule name - An identifier - A literal value
`qStr`	string	N/A	Literal string of the token. Examples: 'Round' and '('.
`qIsBnfRule`	boolean	N/A	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	N/A	If set to true, the definition specifies a script statement. This parameter is optional. The default value is false.
`qControlStatement`	boolean	N/A	If set to true, the definition specifies a control statement. This parameter is optional. The default value is false.
`qBnfLiteral`	boolean	N/A	If set to true, the definition specifies a literal token. This parameter is optional. The default value is false.
`qQvFunc`	boolean	N/A	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	N/A	If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false.
`qFG`	string	N/A	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 - PROB or FUNC_GROUP_PROBABILITY - ARRAY or FUNC_GROUP_ARRAY - LEG or FUNC_GROUP_LEGACY
`qFieldFlag`	boolean	N/A	If set to true, the definition is related to a field. This parameter is optional. The default value is false.
`qMT`	string	N/A	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	N/A	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.
`qFGList`	array<undefined>	N/A	List of groups the function belongs to.

`BookmarkFieldItem`¶

No description.

Name	Type	Default	Description
`qDef`	`FieldDefEx`	N/A	Name and type of the field.
`qLocked`	boolean	N/A	Indicates if the field is locked. Default is false.
`qSelectInfo`	`SelectInfo`	N/A	Information on the selections criteria.
`qValues`	array<`FieldValue`>	N/A	No description.
`qExcludedValues`	array<`FieldValue`>	N/A	List of excluded values. Either the list of selected values or the list of excluded values is displayed.
`qAndMode`	boolean	N/A	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	N/A	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	Default	Description
`qStartIndex`	integer	N/A	The start value of the range.
`qEndIndex`	integer	N/A	The end value of the range.

`BookmarkList`¶

Lists the bookmarks. Is the layout for BookmarkListDef.

Name	Type	Default	Description
`qItems`	array<`NxContainerEntry`>	N/A	Information about the list of bookmarks.

`BookmarkListDef`¶

Defines the list of bookmarks.

Name	Type	Default	Description
`qType`	string	N/A	Type of the list.
`qData`	`JsonObject`	N/A	Data

`BookmarkVariableItem`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the variable.
`qValue`	`FieldValue`	N/A	Value of the variable.

`CalendarStrings`¶

No description.

Name	Type	Default	Description
`qDayNames`	array<string>	N/A	List of short day names.
`qMonthNames`	array<string>	N/A	List of short month names.
`qLongDayNames`	array<string>	N/A	List of long day names.
`qLongMonthNames`	array<string>	N/A	List of long month names.

`CharRange`¶

No description.

Name	Type	Default	Description
`qCharPos`	integer	N/A	Position of the first search occurrence.
`qCharCount`	integer	N/A	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	Default	Description
`qItems`	array<`NxContainerEntry`>	N/A	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	Default	Description
`qData`	`JsonObject`	N/A	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	Default	Description
`qNumber`	integer	N/A	Number of the code page.
`qName`	string	N/A	Name of the code page.
`qDescription`	string	N/A	Description of the code page.

`Connection`¶

No description.

Name	Type	Default	Description
`qId`	string	N/A	Identifier of the connection. Is generated by the engine and is unique.
`qName`	string	N/A	Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection.
`qConnectionString`	string	N/A	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	N/A	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	N/A	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	N/A	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	N/A	Is generated by the engine. Creation date of the connection or last modification date of the connection.
`qMeta`	`NxMeta`	N/A	Information about the connection.
`qLogOn`	string	N/A	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	Default	Description
`qItems`	array<`ContentLibraryListItem`>	N/A	Information about the content library.

`ContentLibraryListItem`¶

No description.

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

`CustomConnector`¶

No description.

Name	Type	Default	Description
`qProvider`	string	N/A	Name of the custom connector file.
`qParent`	string	N/A	Name of the parent folder that contains the custom connector file.
`qDisplayName`	string	N/A	Name of the custom connector as displayed in the Qlik interface.
`qMachineMode`	string	N/A	Mode of the machine (64 or 32 bits). One of: - CONNECT_DEFAULT - CONNECT_64 - CONNECT_32
`qSupportFileStreaming`	boolean	N/A	No description.

`DataField`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the field.
`qIsKey`	boolean	N/A	Is set to true if the field is a primary key.
`qOriginalFieldName`	string	N/A	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	Default	Description
`qValues`	array<string>	N/A	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	Default	Description
`qName`	string	N/A	Name of the table.
`qType`	string	N/A	Type of the table. For example: Table or View.

`DataTableEx`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the table.
`qFields`	array<`DataField`>	N/A	List of the fields in the table.
`qFormatSpec`	string	N/A	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	Default	Description
`qName`	string	N/A	Name of the database.
`qIsDefault`	boolean	N/A	Is set to true if the database is set by default.

`DatabaseInfo`¶

No description.

Name	Type	Default	Description
`qDBMSName`	string	N/A	Name of the product accessed by the provider.
`qDBUsage`	boolean	N/A	If set to true, it means that the data source contains some databases.
`qOwnerUsage`	boolean	N/A	If set to true, it means that the data source contains some owners.
`qDBSeparator`	string	N/A	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	N/A	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	N/A	If set to true, it means that the database is displayed first, before the owners and tables.
`qQuotePreffix`	string	N/A	Prefix used with field, database or owner names that contain special characters or keywords.
`qQuoteSuffix`	string	N/A	Suffix used with field, database or owner names that contain special characters or keywords.
`qSpecialChars`	string	N/A	List of the special characters.
`qDefaultDatabase`	string	N/A	Name of the default database.
`qKeywords`	array<string>	N/A	List of the script keywords.

`DatabaseOwner`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the owner.

`DelimiterInfo`¶

No description.

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

`DerivedFieldsInTableData`¶

No description.

Name	Type	Default	Description
`qDefinitionName`	string	N/A	Name of the derived definition.
`qTags`	array<string>	N/A	List of tags.
`qActive`	boolean	N/A	Is set to true is the derived field is in use.

`DimensionList`¶

Lists the dimensions. Is the layout for DimensionListDef.

Name	Type	Default	Description
`qItems`	array<`NxContainerEntry`>	N/A	Information about the list of dimensions.

`DimensionListDef`¶

Defines the lists of dimensions.

Name	Type	Default	Description
`qType`	string	N/A	Type of the list.
`qData`	`JsonObject`	N/A	Data

`DoReloadExParams`¶

Parameters for a reload.

Name	Type	Default	Description
`qMode`	integer	N/A	0: for default mode. 1: for ABEND; the reload of the script ends if an error occurs. 2: for ignore; the reload of the script continues even if an error is detected in the script.
`qPartial`	boolean	N/A	Set to true for partial reload. The default value is false.
`qDebug`	boolean	N/A	Set to true to debug reload. The default value is false.
`qReloadId`	string	N/A	Optional reload ID. ID will be automatically generated if not set.

`DoReloadExResult`¶

The result and path to script log for a reload.

Name	Type	Default	Description
`qSuccess`	boolean	N/A	The reload is successful if True.
`qScriptLogFile`	string	N/A	Path to the script log file.

`DocListEntry`¶

No description.

Name	Type	Default	Description
`qDocName`	string	N/A	Name of the app.
`qConnectedUsers`	integer	N/A	Not used.
`qFileTime`	number	N/A	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	N/A	Size of remote app. This property is used only with Qlik Sense Desktop. It is set to 0 for Qlik Sense Enterprise.
`qDocId`	string	N/A	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`	N/A	Meta data related to the app.
`qLastReloadTime`	string	N/A	Last reload time of the app.
`qReadOnly`	boolean	N/A	If set to true, the app is read-only.
`qTitle`	string	N/A	Title of the app.
`qThumbnail`	`StaticContentUrl`	N/A	Thumbnail of the app.
`qHasSectionAccess`	boolean	N/A	If true the app has section access configured.

`DriveInfo`¶

No description.

Name	Type	Default	Description
`qDrive`	string	N/A	Value of the drive. Examples: C:\\, E:\\
`qType`	string	N/A	Type of the drive. Fixed means physical drive.
`qName`	string	N/A	Name of the drive.
`qTypeIdentifier`	string	N/A	Information about the drive type. One of: - REMOVABLE - FIXED - NETWORK - CD_ROM - RAM - UNKNOWN_TYPE
`qUnnamedDrive`	boolean	N/A	No description.

`EditorBreakpoint`¶

No description.

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

`ErrorData`¶

No description.

Name	Type	Default	Description
`qErrorString`	string	N/A	Detailed information about the error message.
`qLineEnd`	string	N/A	Line termination characters.
`qLine`	string	N/A	Script statement where the error occurs.
`qErrorDataCode`	string	N/A	Type of the error messages. One of: - EDC_ERROR - EDC_WARNING - EDC_CIRCULAR_REFERENCE
`qMessage`	`ProgressMessage`	N/A	No description.

`ExtensionList`¶

Obsolete, use qrs API's to fetch extensions.

Name	Type	Default	Description
`qItems`	array<string>	N/A	No description.

`FieldAttributes`¶

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

Name	Type	Default	Description
`qType`	string	UNKNOWN	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	10	Number of decimals. Default is 10.
`qUseThou`	integer	N/A	Defines whether or not a thousands separator must be used. Default is 0.
`qFmt`	string	N/A	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	N/A	Defines the decimal separator. Example: .
`qThou`	string	N/A	Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,

`FieldDefEx`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the field.
`qType`	string	N/A	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	Default	Description
`qInternalNumber`	integer	N/A	Internal number of the field.
`qName`	string	N/A	Name of the field.
`qSrcTables`	array<string>	N/A	List of table names.
`qIsSystem`	boolean	N/A	If set to true, it means that the field is a system field. The default value is false.
`qIsHidden`	boolean	N/A	If set to true, it means that the field is hidden. The default value is false.
`qIsSemantic`	boolean	N/A	If set to true, it means that the field is a semantic. The default value is false.
`qDistinctOnly`	boolean	N/A	If set to true, only distinct field values are shown. The default value is false.
`qCardinal`	integer	N/A	Number of distinct field values.
`qTotalCount`	integer	N/A	Total number of field values.
`qPossibleCount_OBSOLETE`	integer	N/A	No description.
`qHasInfo_OBSOLETE`	boolean	N/A	No description.
`qIsLocked`	boolean	N/A	If set to true, it means that the field is locked. The default value is false.
`qAlwaysOneSelected`	boolean	N/A	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	N/A	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	N/A	Is set to true if the value is a numeric. The default value is false.
`qComment`	string	N/A	Field comment.
`qTags`	array<string>	N/A	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.
`qIsDefinitionOnly`	boolean	N/A	If set to true, it means that the field is a field on the fly. The default value is false.
`qByteSize`	integer	N/A	Static RAM memory used in bytes.

`FieldInTableData`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the field.
`qOriginalFields`	array<string>	N/A	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	N/A	No description.
`qHasNull`	boolean	N/A	This property is set to true if the field contains some Null values.
`qHasWild`	boolean	N/A	No description.
`qHasDuplicates`	boolean	N/A	This property is set to true if the field contains some duplicate values.
`qIsSynthetic`	boolean	N/A	This property is set to true if the field contains a synthetic key.
`qInformationDensity`	number	N/A	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	N/A	Number of values that are non Null.
`qnRows`	integer	N/A	Number of rows in the field.
`qSubsetRatio`	number	N/A	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	N/A	Number of distinct values in the field.
`qnPresentDistinctValues`	integer	N/A	No description.
`qKeyType`	string	N/A	Tells if the field is a key field. One of: - NOT_KEY - ANY_KEY - PRIMARY_KEY - PERFECT_KEY
`qComment`	string	N/A	Comment related to the field.
`qTags`	array<string>	N/A	List of tags related to the field.
`qDerivedFields`	array<`DerivedFieldsInTableData`>	N/A	List of the derived fields.
`qIsFieldOnTheFly`	boolean	N/A	No description.
`qReadableName`	string	N/A	No description.

`FieldList`¶

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

Name	Type	Default	Description
`qItems`	array<`NxFieldDescription`>	N/A	Array of items.

`FieldListDef`¶

Defines the fields to show.

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

`FieldOrColumn`¶

No description.

Name	Type	Default	Description
`qFieldName`	string	N/A	Name of the field or column to be matched.
`qTableName`	string	N/A	Name of the table to be matched on. This parameter is optional. If TableName is set, FieldName represent the Table column with that name. If TableName is not set, FieldName represents the the field with that name.

`FieldScores`¶

No description.

Name	Type	Default	Description
`qFieldName`	string	N/A	Field name. One of the field names defined in qFieldPairName.
`qReadableName`	string	N/A	No description.
`qCardinalRatio`	number	N/A	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	N/A	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	N/A	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	Default	Description
`qText`	string	N/A	Text related to the field value. This parameter is optional.
`qIsNumeric`	boolean	N/A	Is set to true if the value is a numeric. This parameter is optional. Default is false.
`qNumber`	number	N/A	Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.

`FileDataFormat`¶

Name	Type	Default	Description
`qType`	string	N/A	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	N/A	One of: - Embedded labels (field names are present in the file) - No labels - Explicit labels (for DIFfiles)
`qQuote`	string	N/A	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	N/A	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`	N/A	Information about the delimiter. This property is used for delimited files.
`qCodePage`	integer	N/A	Character set used in the file.
`qHeaderSize`	integer	N/A	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	N/A	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	N/A	Number of spaces that one tab character represents in the table file. This property is used for fixed record data files.
`qIgnoreEOF`	boolean	N/A	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	N/A	Positions of the field breaks in the table. This property is used for fixed record data files.

`FilterInfo`¶

No description.

Name	Type	Default	Description
`qType`	string	N/A	One of: - NONE or FILTER_TYPE_NONE - RAW or FILTER_TYPE_RAW
`qWherePredicate`	string	N/A	No description.

`FolderItem`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the folder item.
`qType`	string	N/A	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	Default	Description
`qName`	string	N/A	Name of the script function.
`qGroup`	string	N/A	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 - PROB or FUNC_GROUP_PROBABILITY - ARRAY or FUNC_GROUP_ARRAY - LEG or FUNC_GROUP_LEGACY
`qSignature`	string	N/A	Signature of the script function. Gives general information about the function.

`GenericBookmarkEntry`¶

No description.

Name	Type	Default	Description
`qProperties`	`GenericBookmarkProperties`	N/A	Information about the properties of the bookmark.
`qBookmark`	`NxBookmark`	N/A	Information about the bookmark.

`GenericBookmarkLayout`¶

Is the layout for GenericBookmarkProperties.

Name	Type	Default	Description
`qInfo`	`NxInfo`	N/A	Information about the object.
`qMeta`	`NxMeta`	N/A	Information on publishing and permissions.
`qBookmark`	`NxBookmark`	N/A	Information about the bookmark.
`qFieldInfos`	array<`LayoutFieldInfo`>	N/A	Information about the field selections associated with the bookmark.

`GenericBookmarkProperties`¶

No description.

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

`GenericDimensionInfo`¶

No description.

Name	Type	Default	Description
`qApprMaxGlyphCount`	integer	N/A	Length of the longest value in the field.
`qCardinal`	integer	N/A	Number of distinct field values
`qTags`	array<string>	N/A	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII
`qIsSemantic`	boolean	N/A	If set to true, it means that the field is a semantic.
`qAndMode`	boolean	N/A	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	Default	Description
`qInfo`	`NxInfo`	N/A	Identifier and type of the dimension.
`qMeta`	`NxMeta`	N/A	Information about publishing and permissions.
`qDim`	`NxLibraryDimension`	N/A	Name and label of the dimension, information about grouping.
`qDimInfos`	array<`GenericDimensionInfo`>	N/A	Cardinal and tags related to the dimension. Length of the longest value in the field.

`GenericDimensionProperties`¶

No description.

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

`GenericMeasureLayout`¶

Is the layout for GenericMeasureProperties.

Name	Type	Default	Description
`qInfo`	`NxInfo`	N/A	Information about the object.
`qMeasure`	`NxLibraryMeasure`	N/A	Information about the measure.
`qMeta`	`NxMeta`	N/A	Information on publishing and permissions.

`GenericMeasureProperties`¶

No description.

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

`GenericObjectEntry`¶

No description.

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

`GenericObjectLayout`¶

Is the layout for GenericObjectProperties.

Name	Type	Default	Description
`qInfo`	`NxInfo`	N/A	Identifier and type of the generic object.
`qMeta`	`NxMeta`	N/A	Information about publishing and permissions. This parameter is optional.
`qExtendsId`	string	N/A	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	N/A	Is set to true if the generic object contains some properties that are not persistent (a soft patch was applied).
`qError`	`NxLayoutErrors`	N/A	Gives information on the error. This parameter is optional.
`qSelectionInfo`	`NxSelectionInfo`	N/A	Information about the selections.
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .

`GenericObjectProperties`¶

No description.

Name	Type	Default	Description
`qInfo`	`NxInfo`	N/A	Identifier and type of the object. This parameter is mandatory.
`qExtendsId`	string	N/A	Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string.
`qMetaDef`	`NxMetaDef`	N/A	Definition of the dynamic properties.
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .

`GenericVariableLayout`¶

Is the layout for GenericVariableProperties.

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

`GenericVariableProperties`¶

No description.

Name	Type	Default	Description
`qInfo`	`NxInfo`	N/A	Identifier and type of the object. This parameter is mandatory.
`qMetaDef`	`NxMetaDef`	N/A	Meta data.
`qName`	string	N/A	Name of the variable. The name must be unique. This parameter is mandatory.
`qComment`	string	N/A	Comment related to the variable. This parameter is optional.
`qNumberPresentation`	`FieldAttributes`	N/A	Defines the format of the value. This parameter is optional.
`qIncludeInBookmark`	boolean	N/A	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	N/A	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	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .
`qSize`	`Size`	N/A	Defines the size of the hypercube.
`qError`	`NxValidationError`	N/A	This parameter is optional and is displayed in case of error.
`qDimensionInfo`	array<`NxDimensionInfo`>	N/A	Information on the dimension.
`qMeasureInfo`	array<`NxMeasureInfo`>	N/A	Information on the measure.
`qEffectiveInterColumnSortOrder`	array<integer>	N/A	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`>	N/A	Aggregate for measures of all values in the field. The result value depends on the qAggrFunc defined in `HyperCubeDef`.
`qDataPages`	array<`NxDataPage`>	N/A	Set of data. Is empty if nothing has been defined in qInitialDataFetch in `HyperCubeDef`.
`qPivotDataPages`	array<`NxPivotPage`>	N/A	Set of data for pivot tables. Is empty if nothing has been defined in qInitialDataFetch in `HyperCubeDef`.
`qStackedDataPages`	array<`NxStackPage`>	N/A	Set of data for stacked tables. Is empty if nothing has been defined in qInitialDataFetch in `HyperCubeDef`.
`qMode`	string	N/A	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	N/A	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	N/A	Is used for pivot tables only. If set to true, the formatting of the results is slightly different. This property is optional.
`qLastExpandedPos`	`NxCellPosition`	N/A	Is used for pivot tables only. Position of the last expended cell. This property is optional.
`qHasOtherValues`	boolean	N/A	True if other row exists.
`qTitle`	string	N/A	Title of the hypercube, for example the title of a chart.
`qTreeNodesOnDim`	array<integer>	N/A	The total number of nodes on each dimension (only applicable when qMode = T ).
`qCalcCondMsg`	string	N/A	The message displayed if calculation condition is not fulfilled.
`qColumnOrder`	array<integer>	N/A	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	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .
`qDimensions`	array<`NxDimension`>	N/A	Array of dimensions.
`qMeasures`	array<`NxMeasure`>	N/A	Array of measures.
`qInterColumnSortOrder`	array<integer>	N/A	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	N/A	Removes zero values.
`qSuppressMissing`	boolean	N/A	Removes missing values.
`qInitialDataFetch`	array<`NxPage`>	N/A	Initial data set.
`qReductionMode`	string	N/A	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	DATA_MODE_STRAIGHT	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	-1	No description.
`qNoOfLeftDims`	integer	-1	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	N/A	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	5000	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	N/A	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	N/A	If set to true, the total (if any) is shown on the first row. The default value is false.
`qIndentMode`	boolean	N/A	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`	N/A	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	N/A	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`	N/A	Title of the hypercube, for example the title of a chart.
`qCalcCondition`	`NxCalcCond`	N/A	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<integer>	N/A	The order of the columns.

`InteractDef`¶

No description.

Name	Type	Default	Description
`qType`	string	N/A	Interaction type. One of: - IT_MSGBOX - IT_SCRIPTLINE - IT_BREAK - IT_INPUT - IT_END - IT_PASSWD - IT_USERNAME
`qTitle`	string	N/A	Title used in the message box dialog. This property is relevant if qType is IT_MSGBOX.
`qMsg`	string	N/A	Message used in the message box dialog. This property is relevant if qType is IT_MSGBOX.
`qButtons`	integer	N/A	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	N/A	Next script statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.
`qOldLineNr`	integer	N/A	First line number of the previously executed statement. This property is used if the type of interaction is IT_SCRIPTLINE.
`qNewLineNr`	integer	N/A	First line number of the next statement to be executed. This property is used if the type of interaction is IT_SCRIPTLINE.
`qPath`	string	N/A	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	N/A	This property is set to true if the returned statement is an hidden script statement.
`qResult`	integer	N/A	Not relevant for describing the requested user interaction.
`qInput`	string	N/A	Is not used in Qlik Sense.

`LayoutFieldInfo`¶

Meta data about the selection in a field.

Name	Type	Default	Description
`qFieldName`	string	N/A	The name of the field.
`qValuesCount`	integer	N/A	Number of selected values in the field.
`qExcludedValuesCount`	integer	N/A	Number of excluded values in the field.

`LineageInfo`¶

No description.

Name	Type	Default	Description
`qDiscriminator`	string	N/A	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	N/A	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	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .
`qSize`	`Size`	N/A	Defines the size of a list object.
`qError`	`NxValidationError`	N/A	This parameter is optional and is displayed in case of error.
`qDimensionInfo`	`NxDimensionInfo`	N/A	Information about the dimension.
`qExpressions`	array<`NxListObjectExpression`>	N/A	Lists the expressions in the list object.
`qDataPages`	array<`NxDataPage`>	N/A	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	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .
`qLibraryId`	string	N/A	Refers to a dimension stored in the library.
`qDef`	`NxInlineDimensionDef`	N/A	Refers to a dimension stored in the list object.
`qAutoSortByState`	`NxAutoSortByStateDef`	N/A	Defines the sorting by state.
`qFrequencyMode`	string	NX_FREQUENCY_NONE	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	N/A	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`>	N/A	Fetches an initial data set.
`qExpressions`	array<`NxListObjectExpressionDef`>	N/A	Lists the expressions in the list object. This parameter is optional.

`LocaleInfo`¶

No description.

Name	Type	Default	Description
`qDecimalSep`	string	N/A	Decimal separator.
`qThousandSep`	string	N/A	Thousand separator.
`qListSep`	string	N/A	List separator.
`qMoneyDecimalSep`	string	N/A	Money decimal separator.
`qMoneyThousandSep`	string	N/A	Money thousand separator.
`qCurrentYear`	integer	N/A	Current year.
`qMoneyFmt`	string	N/A	Money format. Example: #.##0,00 kr;-#.##0,00 kr
`qTimeFmt`	string	N/A	Time format. Example: hh:mm:ss
`qDateFmt`	string	N/A	Date format. Example: YYYY-MM-DD
`qTimestampFmt`	string	N/A	Time stamp format. Example: YYYY-MM-DD hh:mm:ss[.fff]
`qCalendarStrings`	`CalendarStrings`	N/A	Information about the calendar.
`qFirstWeekDay`	integer	N/A	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	N/A	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	N/A	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	N/A	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	N/A	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	N/A	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	Default	Description
`qItems`	array<`NxContainerEntry`>	N/A	Information about the list of measures.

`MeasureListDef`¶

Defines the list of measures.

Name	Type	Default	Description
`qType`	string	N/A	Type of the list.
`qData`	`JsonObject`	N/A	Data

`MediaList`¶

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

Name	Type	Default	Description
`qItems`	array<`MediaListItem`>	N/A	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	Default	Description
`qUrlDef`	string	N/A	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	N/A	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	Default	Description
`qTitle`	string	N/A	Title of the app.
`qFileName`	string	N/A	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	N/A	Date and time of the last reload of the app in ISO format.
`qModified`	boolean	N/A	Is set to true if the app has been updated since the last save.
`qHasScript`	boolean	N/A	Is set to true if a script is defined in the app.
`qStateNames`	array<string>	N/A	Array of alternate states.
`qMeta`	`NxMeta`	N/A	Information on publishing and permissions.
`qLocaleInfo`	`LocaleInfo`	N/A	Information about the locale.
`qHasData`	boolean	N/A	Is set to true if the app contains data following a script reload.
`qReadOnly`	boolean	N/A	If set to true, it means that the app is read-only.
`qIsOpenedWithoutData`	boolean	N/A	If set to true, it means that the app was opened without loading its data.
`qIsSessionApp`	boolean	N/A	If set to true, the app is a Session App, i.e. not persistent.
`qThumbnail`	`StaticContentUrl`	N/A	App thumbnail.

`NxAppProperties`¶

Name	Type	Default	Description
`qTitle`	string	N/A	App title.
`qLastReloadTime`	string	N/A	Last reload time of the app.
`qMigrationHash`	string	N/A	Internal property reserved for app migration. Patch version of the app. Do not update.
`qSavedInProductVersion`	string	N/A	Internal property reserved for app migration. The app is saved in this version of the product. Do not update.
`qThumbnail`	`StaticContentUrlDef`	N/A	App thumbnail.
`qHasSectionAccess`	boolean	N/A	If true the app has section access configured.

`NxAttrDimDef`¶

Layout for NxAttrDimDef.

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

`NxAttrDimInfo`¶

Layout for NxAttrDimDef.

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

`NxAttrExprDef`¶

No description.

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

`NxAttrExprInfo`¶

Layout for NxAttrExprDef.

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

`NxAttributeDimValues`¶

No description.

Name	Type	Default	Description
`qValues`	array<`NxSimpleDimValue`>	N/A	List of values.

`NxAttributeExpressionValues`¶

No description.

Name	Type	Default	Description
`qValues`	array<`NxSimpleValue`>	N/A	List of attribute expressions values.

`NxAutoSortByStateDef`¶

No description.

Name	Type	Default	Description
`qDisplayNumberOfRows`	integer	N/A	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	Default	Description
`qAxis`	array<`NxAxisTicks`>	N/A	List of axis data.

`NxAxisTicks`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the derived definition.
`qTags`	array<string>	N/A	List of tags.
`qTicks`	array<`NxTickCell`>	N/A	List of ticks.

`NxBookmark`¶

No description.

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

`NxCalcCond`¶

No description.

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

`NxCardinalities`¶

No description.

Name	Type	Default	Description
`qCardinal`	integer	N/A	Number of distinct field values.
`qHypercubeCardinal`	integer	N/A	Number of distinct hypercube values.
`qAllValuesCardinal`	integer	-1	Number of distinct values when paging for AllValues in a Tree Structure. Default is -1 if not part of a Tree structure.

`NxCell`¶

No description.

Name	Type	Default	Description
`qText`	string	N/A	Some text. This parameter is optional.
`qNum`	number	N/A	A value. This parameter is optional.
`qElemNumber`	integer	N/A	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 a Null cell. - -3: the cell belongs to the group Others . - -4: the cell is empty. Applies to pivot tables.
`qState`	string	N/A	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	N/A	Is set to true , if qText and qNum are empty. This parameter is optional. The default value is false .
`qIsTotalCell`	boolean	N/A	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	N/A	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	N/A	Frequency of the value. This parameter is optional.
`qHighlightRanges`	`NxHighlightRanges`	N/A	Search hits. The search hits are highlighted. This parameter is optional.
`qAttrExps`	`NxAttributeExpressionValues`	N/A	Attribute expression values.
`qAttrDims`	`NxAttributeDimValues`	N/A	Attribute dimensions values.
`qIsNull`	boolean	N/A	Is set to true if the value is Null.

`NxCellPosition`¶

No description.

Name	Type	Default	Description
`qx`	integer	N/A	Position of the cell on the x-axis.
`qy`	integer	N/A	Position of the cell on the y-axis.

`NxContainerEntry`¶

No description.

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

`NxContinuousDataOptions`¶

No description.

Name	Type	Default	Description
`qStart`	number	N/A	Start value.
`qEnd`	number	N/A	End value.
`qNbrPoints`	integer	N/A	Number of bins for binning.
`qMaxNbrTicks`	integer	N/A	Maximum number of ticks.
`qMaxNumberLines`	integer	-1	Maximum number of lines.

`NxContinuousRangeSelectInfo`¶

No description.

Name	Type	Default	Description
`qRange`	`Range`	N/A	`Range` information.
`qDimIx`	integer	N/A	Dimension index.

`NxCurrentSelectionItem`¶

No description.

Name	Type	Default	Description
`qTotal`	integer	N/A	Number of values in the field.
`qIsNum`	boolean	N/A	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	N/A	Name of the field that is selected.
`qLocked`	boolean	N/A	This parameter is displayed if its value is true. Is set to true if the field is locked. This parameter is optional.
`qOneAndOnlyOne`	boolean	N/A	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	N/A	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	N/A	Number of values that are selected.
`qSelected`	string	N/A	Values that are selected.
`qRangeInfo`	array<`RangeSelectInfo`>	N/A	Information about the range of selected values. Is empty if there is no range of selected values.
`qSortIndex`	integer	N/A	Sort index of the field. Indexing starts from 0.
`qStateCounts`	`NxStateCounts`	N/A	Number of values in a particular state.
`qSelectedFieldSelectionInfo`	array<`NxFieldSelectionInfo`>	N/A	Information about the fields that are selected.
`qNotSelectedFieldSelectionInfo`	array<`NxFieldSelectionInfo`>	N/A	Information about the fields that are not selected.
`qSelectionThreshold`	integer	N/A	Maximum values to show in the current selections. The default value is 6.
`qReadableName`	string	N/A	Label that, if defined, is displayed in current selections instead of the actual expression.
`qIsHidden`	boolean	N/A	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	Default	Description
`qLeft`	number	N/A	Position from the left. Corresponds to the lowest possible value of the first measure (the measure on the x-axis).
`qTop`	number	N/A	Position from the top. Corresponds to the highest possible value of the second measure (the measure on the y-axis).
`qWidth`	number	N/A	Width of the page. Corresponds to the highest possible value of the first measure (the measure on the x-axis).
`qHeight`	number	N/A	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	Default	Description
`qMatrix`	array<`NxCellRows`>	N/A	Array of data.
`qTails`	array<`NxGroupTail`>	N/A	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`	N/A	Size and offset of the data in the matrix.
`qIsReduced`	boolean	N/A	Is set to true, if the data have been reduced. The default value is false.

`NxDerivedField`¶

No description.

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

`NxDerivedFieldDescriptionList`¶

No description.

Name	Type	Default	Description
`qDerivedFieldLists`	array<`NxDerivedFieldsData`>	N/A	Information about the derived fields.

`NxDerivedFieldsData`¶

No description.

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

`NxDerivedGroup`¶

No description.

Name	Type	Default	Description
`qId`	string	N/A	Identifier of the group.
`qName`	string	N/A	Name of the derived group.
`qGrouping`	string	N/A	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<string>	N/A	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	Default	Description
`qLibraryId`	string	N/A	Refers to a dimension stored in the library.
`qDef`	`NxInlineDimensionDef`	N/A	Refers to a dimension stored in the hypercube.
`qNullSuppression`	boolean	N/A	If set to true, no null values are returned.
`qIncludeElemValue`	boolean	N/A	No description.
`qOtherTotalSpec`	`OtherTotalSpecProp`	N/A	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	N/A	No description.
`qShowAll`	boolean	N/A	If set to true, all dimension values are shown.
`qOtherLabel`	`StringExpr`	N/A	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`	N/A	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`	N/A	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`>	N/A	List of attribute expressions.
`qAttributeDimensions`	array<`NxAttrDimDef`>	N/A	List of attribute dimensions.
`qCalcCondition`	`NxCalcCond`	N/A	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	Default	Description
`qFallbackTitle`	string	N/A	Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.
`qApprMaxGlyphCount`	integer	N/A	Length of the longest value in the field.
`qCardinal`	integer	N/A	Number of distinct field values.
`qLocked`	boolean	N/A	Is set to true if the field is locked.
`qSortIndicator`	string	N/A	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<string>	N/A	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	N/A	Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.
`qStateCounts`	`NxStateCounts`	N/A	Number of values in a particular state.
`qTags`	array<string>	N/A	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII
`qError`	`NxValidationError`	N/A	This parameter is optional. Gives information on the error.
`qDimensionType`	string	N/A	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	N/A	If set to true, it inverts the sort criteria in the field.
`qGrouping`	string	N/A	Defines the grouping. One of: - N or GRP_NX_NONE - H or GRP_NX_HIEARCHY - C or GRP_NX_COLLECTION
`qIsSemantic`	boolean	N/A	If set to true, it means that the field is a semantic.
`qNumFormat`	`FieldAttributes`	N/A	Format of the field. This parameter is optional.
`qIsAutoFormat`	boolean	N/A	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<string>	N/A	Array of field names.
`qMin`	number	N/A	Minimum value.
`qMax`	number	N/A	Maximum value.
`qContinuousAxes`	boolean	N/A	Is continuous axis used.
`qIsCyclic`	boolean	N/A	Is a cyclic dimension used.
`qDerivedField`	boolean	N/A	Is derived field is used as a dimension.
`qAttrExprInfo`	array<`NxAttrExprInfo`>	N/A	Array of attribute expressions.
`qAttrDimInfo`	array<`NxAttrDimInfo`>	N/A	Array of attribute dimensions.
`qCalcCondMsg`	string	N/A	The message displayed if calculation condition is not fulfilled.
`qIsCalculated`	boolean	N/A	True if this is a calculated dimension.
`qIsOneAndOnlyOne`	boolean	N/A	If set to true, it means that the field always has one and only one selected value.
`qCardinalities`	`NxCardinalities`	N/A	Dimension Cardinalities
`qLibraryId`	string	N/A	Refers to a dimension stored in the library.

`NxDownloadInfo`¶

No description.

Name	Type	Default	Description
`qUrl`	string	N/A	URL to download the reduced app on.
`qFileSize`	integer	-1	The filesize of the reduced app.

`NxDownloadOptions`¶

No description.

Name	Type	Default	Description
`qBookmarkId`	string	N/A	Bookmark Id to apply before reducing the application.
`qExpires`	integer	3600	Time in seconds for how long the download link is valid.

`NxEngineVersion`¶

No description.

Name	Type	Default	Description
`qComponentVersion`	string	N/A	Version number of the Qlik engine component.

`NxFieldDescription`¶

Name	Type	Default	Description
`qIsSemantic`	boolean	N/A	If set to true, it means that the field is a semantic.
`qIsHidden`	boolean	N/A	If set to true, it means that the field is hidden.
`qIsSystem`	boolean	N/A	If set to true, it means that the field is a system field.
`qAndMode`	boolean	N/A	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	N/A	Name of the field
`qCardinal`	integer	N/A	Number of distinct field values
`qTags`	array<string>	N/A	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII
`qIsDefinitionOnly`	boolean	N/A	If set to true, it means that the field is a field on the fly.
`qDerivedFieldData`	`NxDerivedFieldDescriptionList`	N/A	Lists the derived fields if any.
`qIsDetail`	boolean	N/A	Is used for Direct Discovery. If set to true, it means that the type of the field is detail.
`qIsImplicit`	boolean	N/A	Is used for Direct Discovery. If set to true, it means that the type of the field is measure.
`qReadableName`	string	N/A	No description.

`NxFieldProperties`¶

No description.

Name	Type	Default	Description
`qOneAndOnlyOne`	boolean	N/A	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	Default	Description
`qName`	string	N/A	Name of the field.
`qFieldSelectionMode`	string	N/A	Selection mode.

`NxGetBookmarkOptions`¶

No description.

Name	Type	Default	Description
`qTypes`	array<string>	N/A	List of object types.
`qData`	`JsonObject`	N/A	Set of data.

`NxGetObjectOptions`¶

No description.

Name	Type	Default	Description
`qTypes`	array<string>	N/A	List of object types.
`qIncludeSessionObjects`	boolean	N/A	Set to true to include session objects. The default value is false.
`qData`	`JsonObject`	N/A	Set of data.

`NxGroupTail`¶

No description.

Name	Type	Default	Description
`qUp`	integer	N/A	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	N/A	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	Default	Description
`qRanges`	array<`CharRange`>	N/A	Ranges of highlighted values.

`NxInfo`¶

No description.

Name	Type	Default	Description
`qId`	string	N/A	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	N/A	Type of the object. This parameter is mandatory.

`NxInlineDimensionDef`¶

No description.

Name	Type	Default	Description
`qGrouping`	string	N/A	Used to define a cyclic group or drill-down 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<string>	N/A	Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional.
`qFieldLabels`	array<string>	N/A	Array of field labels. This parameter is optional.
`qSortCriterias`	array<`SortCriteria`>	N/A	Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional.
`qNumberPresentations`	array<`FieldAttributes`>	N/A	Defines the format of the value. This parameter is optional.
`qReverseSort`	boolean	N/A	If set to true, it inverts the sort criteria in the field.
`qActiveField`	integer	N/A	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	N/A	Label expression. This parameter is optional.

`NxInlineMeasureDef`¶

No description.

Name	Type	Default	Description
`qLabel`	string	N/A	Name of the measure. An empty string is returned as a default value. This parameter is optional.
`qDescription`	string	N/A	Description of the measure. An empty string is returned as a default value. This parameter is optional.
`qTags`	array<string>	N/A	Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional.
`qGrouping`	string	N/A	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	N/A	Definition of the expression in the measure. Example: Sum (OrderTotal) This parameter is mandatory.
`qNumFormat`	`FieldAttributes`	N/A	Format of the field. This parameter is optional.
`qRelative`	boolean	N/A	If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional.
`qBrutalSum`	boolean	N/A	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	N/A	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	N/A	* 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	N/A	If set to true, it inverts the sort criteria in the field.
`qActiveExpression`	integer	N/A	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<string>	N/A	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	N/A	Label expression. This parameter is optional.

`NxLayoutErrors`¶

No description.

Name	Type	Default	Description
`qErrorCode`	integer	N/A	Error code.

`NxLibraryDimension`¶

No description.

Name	Type	Default	Description
`qGrouping`	string	N/A	Information about the grouping. One of: - N or GRP_NX_NONE - H or GRP_NX_HIEARCHY - C or GRP_NX_COLLECTION
`qFieldDefs`	array<string>	N/A	Array of dimension names.
`qFieldLabels`	array<string>	N/A	Array of dimension labels.
`qLabelExpression`	string	N/A	No description.

`NxLibraryDimensionDef`¶

No description.

Name	Type	Default	Description
`qGrouping`	string	N/A	Information about the grouping. One of: - N or GRP_NX_NONE - H or GRP_NX_HIEARCHY - C or GRP_NX_COLLECTION
`qFieldDefs`	array<string>	N/A	Array of dimension names.
`qFieldLabels`	array<string>	N/A	Array of dimension labels.
`qLabelExpression`	string	N/A	No description.

`NxLibraryMeasure`¶

Information about the library measure. Is the layout for NxLibraryMeasureDef.

Name	Type	Default	Description
`qLabel`	string	N/A	No description.
`qDef`	string	N/A	No description.
`qGrouping`	string	N/A	One of: - N or GRP_NX_NONE - H or GRP_NX_HIEARCHY - C or GRP_NX_COLLECTION
`qExpressions`	array<string>	N/A	No description.
`qActiveExpression`	integer	N/A	No description.
`qLabelExpression`	string	N/A	No description.

`NxLibraryMeasureDef`¶

No description.

Name	Type	Default	Description
`qLabel`	string	N/A	Label of the measure.
`qDef`	string	N/A	Definition of the measure.
`qGrouping`	string	N/A	Used to define a cyclic group or drill-down 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<string>	N/A	Array of expressions.
`qActiveExpression`	integer	N/A	Index to the active expression in a measure.
`qLabelExpression`	string	N/A	Optional expression used for dynamic label.

`NxLinkedObjectInfo`¶

No description.

Name	Type	Default	Description
`qRootId`	string	N/A	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`	N/A	Information about the linked object.

`NxListObjectExpression`¶

No description.

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

`NxListObjectExpressionDef`¶

No description.

Name	Type	Default	Description
`qExpr`	string	N/A	Value of the expression.
`qLibraryId`	string	N/A	Refers to an expression stored in the library.

`NxMatchingFieldInfo`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the field.
`qTags`	array<string>	N/A	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	Default	Description
`qLibraryId`	string	N/A	Refers to a measure stored in the library.
`qDef`	`NxInlineMeasureDef`	N/A	Refers to a measure stored in the hypercube.
`qSortBy`	`SortCriteria`	N/A	Defines the sort criteria. The default value is sort by ascending alphabetic order. This property is optional.
`qAttributeExpressions`	array<`NxAttrExprDef`>	N/A	List of attribute expressions.
`qAttributeDimensions`	array<`NxAttrDimDef`>	N/A	List of attribute dimensions.
`qCalcCond`	`ValueExpr`	N/A	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`	N/A	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.
`qTrendLines`	array<`NxTrendlineDef`>	N/A	Specifies trendlines for this measure.

`NxMeasureInfo`¶

Layout for NxInlineMeasureDef.

Name	Type	Default	Description
`qFallbackTitle`	string	N/A	Corresponds to the label of the measure. If the label is not defined then the measure name is used.
`qApprMaxGlyphCount`	integer	N/A	Length of the longest value in the field.
`qCardinal`	integer	N/A	Number of distinct field values.
`qSortIndicator`	string	N/A	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`	N/A	Format of the field. This parameter is optional.
`qMin`	number	N/A	Lowest value in the range.
`qMax`	number	N/A	Highest value in the range.
`qError`	`NxValidationError`	N/A	This parameter is optional. Gives information on the error.
`qReverseSort`	boolean	N/A	If set to true, it inverts the sort criteria in the field.
`qIsAutoFormat`	boolean	N/A	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`>	N/A	List of attribute expressions.
`qAttrDimInfo`	array<`NxAttrDimInfo`>	N/A	List of attribute dimensions.
`qCalcCondMsg`	string	N/A	The message displayed if calculation condition is not fulfilled.
`qLibraryId`	string	N/A	Refers to a dimension stored in the library.
`qTrendLines`	array<`NxTrendline`>	N/A	Calculated trendlines

`NxMeta`¶

Layout for NxMetaDef.

Name	Type	Default	Description
`qName`	string	N/A	Name. This property is optional.

`NxMultiRangeSelectInfo`¶

No description.

Name	Type	Default	Description
`qRanges`	array<`NxRangeSelectInfo`>	N/A	No description.
`qColumnsToSelect`	array<integer>	N/A	No description.

`NxPage`¶

No description.

Name	Type	Default	Description
`qLeft`	integer	N/A	Position from the left. Corresponds to the first column.
`qTop`	integer	N/A	Position from the top. Corresponds to the first row.
`qWidth`	integer	N/A	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	N/A	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: Stable

No description.

Name	Type	Default	Description
`qLeft`	integer	N/A	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	-1	Number of dimensions to include in the tree.

`NxPageTreeNode`¶

Stability Index: Stable

Defines an area of the tree to be fetched.

Name	Type	Default	Description
`qArea`	`Rect`	N/A	The area of the tree to be fetched. If no area is defined on a dimension, all existing nodes are included.
`qAllValues`	boolean	N/A	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	Default	Description
`qOp`	string	N/A	Operation to perform. One of: - add or Add - remove or Remove - replace or Replace
`qPath`	string	N/A	Path to the property to add, remove or replace.
`qValue`	string	N/A	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	Default	Description
`qText`	string	N/A	Some text.
`qElemNo`	integer	N/A	Rank number of the value. If set to -1, it means that the value is not an element number.
`qValue`	number	N/A	Value of the cell. Is set to NaN , if the value is not a number.
`qCanExpand`	boolean	N/A	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	N/A	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	N/A	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	N/A	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	N/A	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`>	N/A	Information about sub nodes (or sub cells). The array is empty [ ] when there is no sub nodes.
`qAttrExps`	`NxAttributeExpressionValues`	N/A	Information about attribute expressions. The array is empty [ ] when there is no attribute expressions.
`qAttrDims`	`NxAttributeDimValues`	N/A	Information about attribute dimensions.

`NxPivotPage`¶

No description.

Name	Type	Default	Description
`qLeft`	array<`NxPivotDimensionCell`>	N/A	Information about the left dimension values of a pivot table.
`qTop`	array<`NxPivotDimensionCell`>	N/A	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`>	N/A	Array of data.
`qArea`	`Rect`	N/A	Size and offset of the data in the matrix.

`NxPivotValuePoint`¶

No description.

Name	Type	Default	Description
`qLabel`	string	N/A	Label of the cell. This parameter is optional.
`qText`	string	N/A	Some text related to the cell.
`qNum`	number	N/A	Value of the cell.
`qType`	string	N/A	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`	N/A	Attribute expressions values.
`qAttrDims`	`NxAttributeDimValues`	N/A	No description.

`NxRange`¶

No description.

Name	Type	Default	Description
`qFrom`	integer	N/A	Position in the expression of the first character of the field name.
`qCount`	integer	N/A	Number of characters in the field name.

`NxRangeSelectInfo`¶

No description.

Name	Type	Default	Description
`qRange`	`Range`	N/A	`Range` of values.
`qMeasureIx`	integer	N/A	Number of the measure to select. Numbering starts from 0.

`NxSelectionCell`¶

No description.

Name	Type	Default	Description
`qType`	string	N/A	Type of cells to select. One of: - D or NX_CELL_DATA - T or NX_CELL_TOP - L or NX_CELL_LEFT
`qCol`	integer	N/A	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	N/A	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	Default	Description
`qInSelections`	boolean	N/A	Is set to true if the visualization is in selection mode. For more information about the selection mode, see BeginSelections Method.
`qMadeSelections`	boolean	N/A	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	Default	Description
`qText`	string	N/A	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	N/A	Element number.

`NxSimpleValue`¶

No description.

Name	Type	Default	Description
`qText`	string	N/A	Text related to the attribute expression value.
`qNum`	number	N/A	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	Default	Description
`qData`	array<`NxStackedPivotCell`>	N/A	Array of data.
`qArea`	`Rect`	N/A	Size and offset of the data in the matrix.

`NxStackedPivotCell`¶

No description.

Name	Type	Default	Description
`qText`	string	N/A	Some text.
`qElemNo`	integer	N/A	Rank number of the value. If set to -1, it means that the value is not an element number.
`qValue`	number	N/A	Value of the cell. Is set to NaN , if the value is not a number.
`qCanExpand`	boolean	N/A	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	N/A	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	N/A	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	N/A	Total of the positive values in the current group of cells.
`qMinNeg`	number	N/A	Total of the negative values in the current group of cells.
`qUp`	integer	N/A	Number of elements that are part of the previous tail.
`qDown`	integer	N/A	Number of elements that are part of the next tail.
`qRow`	integer	N/A	Row index in the data matrix. The indexing starts from 0.
`qSubNodes`	array<`NxStackedPivotCell`>	N/A	Information about sub nodes (or sub cells). The array is empty [ ] when there are no sub nodes.
`qAttrExps`	`NxAttributeExpressionValues`	N/A	Attribute expressions values.
`qAttrDims`	`NxAttributeDimValues`	N/A	Attribute dimensions values.

`NxStateCounts`¶

No description.

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

`NxStreamListEntry`¶

Deprecated

This definition is deprecated and should not be used

This struct is deprecated (not recommended to use).

Name	Type	Default	Description
`qName`	string	N/A	Name of the stream.
`qId`	string	N/A	Identifier of the stream.

`NxTickCell`¶

No description.

Name	Type	Default	Description
`qText`	string	N/A	Tick's label.
`qStart`	number	N/A	Start value.
`qEnd`	number	N/A	End value.

`NxTreeDataOption`¶

Stability Index: Stable

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

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

`NxTreeDimensionDef`¶

Stability Index: Stable

No description.

Name	Type	Default	Description
`qLibraryId`	string	N/A	Refers to a dimension stored in the library.
`qDef`	`NxInlineDimensionDef`	N/A	Refers to a dimension.
`qValueExprs`	array<`NxMeasure`>	N/A	List of measures.
`qNullSuppression`	boolean	N/A	If set to true, no null values are returned.
`qOtherTotalSpec`	`OtherTotalSpecProp`	N/A	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	N/A	If set to true, all dimension values are shown.
`qOtherLabel`	`StringExpr`	N/A	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`	N/A	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`	N/A	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`>	N/A	List of attribute expressions.
`qAttributeDimensions`	array<`NxAttrDimDef`>	N/A	List of attribute dimensions.

`NxTreeDimensionInfo`¶

Stability Index: Stable

No description.

Name	Type	Default	Description
`qFallbackTitle`	string	N/A	Corresponds to the label of the dimension that is selected. If the label is not defined then the field name is used.
`qApprMaxGlyphCount`	integer	N/A	Length of the longest value in the field.
`qCardinal`	integer	N/A	Number of distinct field values.
`qLocked`	boolean	N/A	Is set to true if the field is locked.
`qSortIndicator`	string	N/A	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<string>	N/A	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	N/A	Index of the dimension that is currently in use. qGroupPos is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.
`qStateCounts`	`NxStateCounts`	N/A	Number of values in a particular state.
`qTags`	array<string>	N/A	Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII
`qError`	`NxValidationError`	N/A	This parameter is optional. Gives information on the error.
`qDimensionType`	string	N/A	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	N/A	If set to true, it inverts the sort criteria in the field.
`qGrouping`	string	N/A	Defines the grouping. One of: - N or GRP_NX_NONE - H or GRP_NX_HIEARCHY - C or GRP_NX_COLLECTION
`qIsSemantic`	boolean	N/A	If set to true, it means that the field is a semantic.
`qNumFormat`	`FieldAttributes`	N/A	Format of the field. This parameter is optional.
`qIsAutoFormat`	boolean	N/A	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<string>	N/A	Array of field names.
`qMin`	number	N/A	Minimum value.
`qMax`	number	N/A	Maximum value.
`qContinuousAxes`	boolean	N/A	Is continuous axis used.
`qIsCyclic`	boolean	N/A	Is a cyclic dimension used.
`qDerivedField`	boolean	N/A	Is derived field is used as a dimension.
`qMeasureInfo`	array<`NxMeasureInfo`>	N/A	A List of measures to be calculated on this TreeDimension.
`qAttrExprInfo`	array<`NxAttrExprInfo`>	N/A	List of attribute expressions.
`qAttrDimInfo`	array<`NxAttrDimInfo`>	N/A	List of attribute dimensions.
`qCalcCondMsg`	string	N/A	The message displayed if calculation condition is not fulfilled.
`qIsCalculated`	boolean	N/A	True if this is a calculated dimension.
`qIsOneAndOnlyOne`	boolean	N/A	If set to true, it means that the field always has one and only one selected value.
`qCardinalities`	`NxCardinalities`	N/A	Dimension Cardinalities
`qLibraryId`	string	N/A	Refers to a dimension stored in the library.

`NxTreeMultiRangeSelectInfo`¶

Stability Index: Stable

No description.

Name	Type	Default	Description
`qRanges`	array<`NxTreeRangeSelectInfo`>	N/A	An array of Ranges.

`NxTreeNode`¶

Stability Index: Stable

Represents a dimension in the tree.

Name	Type	Default	Description
`qText`	string	N/A	The text version of the value, if available.
`qValue`	number	N/A	Value of the cell. Is set to NaN , if the value is not a number.
`qElemNo`	integer	N/A	Element number.
`qGroupPos`	integer	N/A	The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.
`qGroupSize`	integer	N/A	Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.
`qRow`	integer	N/A	Row index in the data matrix. The indexing starts from 0.
`qType`	string	N/A	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`>	N/A	The measures for this node.
`qNodes`	array<`NxTreeNode`>	N/A	The children of this node in the fetched tree structure.
`qAttrExps`	`NxAttributeExpressionValues`	N/A	Attribute expression values.
`qAttrDims`	`NxAttributeDimValues`	N/A	Attribute dimension values.
`qMaxPos`	array<number>	N/A	Total of the positive values in the current group of cells.
`qMinNeg`	array<number>	N/A	Total of the negative values in the current group of cells.
`qCanExpand`	boolean	N/A	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	N/A	If set to true, it means that the cell can be collapsed. This parameter is not returned if it is set to false.
`qState`	string	N/A	Selection State of the value. The default state for a measure is L(Locked). 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
`qTreePath`	array<integer>	N/A	The GroupPos of all prior nodes connected to this one, one position for each level of the tree. If this node is attached directly to the root, this array is empty.

`NxTreeRangeSelectInfo`¶

Stability Index: Stable

No description.

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

`NxTreeValue`¶

Stability Index: Stable

Represents a measure.

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

`NxTrendline`¶

Stability Index: Experimental

Information about the calculated trendline.

Name	Type	Default	Description
`qType`	string	N/A	Type of trendline One of: - AVERAGE or Average - LINEAR or Linear - POLYNOMIAL2 or Polynomial2 - POLYNOMIAL3 or Polynomial3 - POLYNOMIAL4 or Polynomial4 - EXPONENTIAL or Exponential - POWER or Power - LOG or Logarithmic
`qError`	`NxValidationError`	N/A	This parameter is optional and is displayed in case of error.
`qCoeff`	array<number>	N/A	Coefficent c0..cN depending on the trendline type.
`qR2`	number	N/A	R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.
`qExpression`	string	N/A	Trendline expression
`qElemNo`	integer	N/A	Inner Dim elem no

`NxTrendlineDef`¶

Stability Index: Experimental

Trendline input definition

Name	Type	Default	Description
`qType`	string	N/A	The type of trendline to calculate One of: - AVERAGE or Average - LINEAR or Linear - POLYNOMIAL2 or Polynomial2 - POLYNOMIAL3 or Polynomial3 - POLYNOMIAL4 or Polynomial4 - EXPONENTIAL or Exponential - POWER or Power - LOG or Logarithmic
`qXColIx`	integer	-1	The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
`qCalcR2`	boolean	N/A	Set to true to calulatate the R2 score
`qContinuousXAxis`	string	CONTINUOUS_NEVER	Set if the numerical value of x axis dimension should be used One of: - Never or CONTINUOUS_NEVER - Possible or CONTINUOUS_IF_POSSIBLE - Time or CONTINUOUS_IF_TIME
`qMultiDimMode`	string	TRENDLINE_MULTILINE	If you have a hypercube with two dimensions and qXColIx refers to a dimension This determines if you get one trendline of each value in the other dimension or Or trendline based on the sum of the value in the other dimension The sum variant is only supported when qXColIx is 0 and qMode (on the hypercube) is K or T One of: - Multi or TRENDLINE_MULTILINE - Sum or TRENDLINE_SUM

`NxValidationError`¶

No description.

Name	Type	Default	Description
`qErrorCode`	integer	N/A	Error code. This parameter is always displayed in case of error.
`qContext`	string	N/A	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	N/A	Internal information from the server. This parameter is optional.

`NxVariableListItem`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the variable.
`qDescription`	string	N/A	Description of the variable.
`qDefinition`	string	N/A	Definition of the variable. It can be a value or an expression.
`qIsConfig`	boolean	N/A	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	N/A	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`	N/A	Information about publishing and permissions. This parameter is optional.
`qInfo`	`NxInfo`	N/A	Identifier and type of the object. This parameter is mandatory.
`qData`	`JsonObject`	N/A	Data.
`qIsScriptCreated`	boolean	N/A	If set to true, it means that the variable was defined via script.

`NxVariableProperties`¶

Deprecated

This definition is deprecated and should not be used

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the variable.
`qNumberPresentation`	`FieldAttributes`	N/A	Defines the format of the value of a variable.
`qIncludeInBookmark`	boolean	N/A	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	N/A	The value of a variable can be an enumeration. Set this property to true to reflect the predefined values in an enumeration.
`qPreDefinedList`	array<string>	N/A	List of enumerations. This property is used if qUsePredefListedValues is set to true.

`NxViewPort`¶

No description.

Name	Type	Default	Description
`qWidth`	integer	N/A	Width of the canvas in pixels.
`qHeight`	integer	N/A	Height of the canvas in pixels.
`qZoomLevel`	integer	N/A	Zoom level.

`ObjectInterface`¶

No description.

Name	Type	Default	Description
`qType`	string	N/A	The native type of the object.
`qHandle`	integer	N/A	The handle used to connect to object.
`qGenericType`	string	N/A	The type of the object.
`qGenericId`	string	N/A	Object ID.

`OdbcDsn`¶

No description.

Name	Type	Default	Description
`qName`	string	N/A	Name of the ODBC connection.
`qDescription`	string	N/A	Description of the ODBC connection.
`qBit32`	boolean	N/A	Is set to true if the version of ODBC is 32-bit. This parameter is optional. Default is false.
`qUserOnly`	boolean	N/A	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	Default	Description
`qName`	string	N/A	Name of the OLEDB provider.
`qDescription`	string	N/A	Description of the OLEDB provider.
`qBit32`	boolean	N/A	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	Default	Description
`qOtherMode`	string	OTHER_OFF	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`	N/A	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`	N/A	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	OTHER_GT_LIMIT	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	N/A	If set to true, the group Others is not displayed as a dimension value. The default value is false.
`qForceBadValueKeeping`	boolean	true	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	true	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	N/A	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	N/A	If set to true, it collapses the inner dimensions (if any) in the group Others . The default value is false.
`qOtherSortMode`	string	OTHER_SORT_DESCENDING	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	TOTAL_OFF	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`	N/A	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	Default	Description
`qx`	integer	N/A	x-coordinate in pixels. The origin is the top left of the screen.
`qy`	integer	N/A	y-coordinate in pixels. The origin is the top left of the screen.

`ProgressData`¶

No description.

Name	Type	Default	Description
`qStarted`	boolean	N/A	True if the request is started.
`qFinished`	boolean	N/A	True if the request is finished.
`qCompleted`	integer	N/A	This property is not used.
`qTotal`	integer	N/A	This property is not used.
`qKB`	integer	N/A	This property is not used.
`qMillisecs`	integer	N/A	Request duration in milliseconds.
`qUserInteractionWanted`	boolean	N/A	True when the engine pauses the script execution and waits for a user interaction.
`qPersistentProgress`	string	N/A	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	N/A	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`>	N/A	Information about the error messages that occur during the script execution.
`qPersistentProgressMessages`	array<`ProgressMessage`>	N/A	List of persistent progress messages.
`qTransientProgressMessage`	`ProgressMessage`	N/A	Transient progress message.

`ProgressMessage`¶

No description.

Name	Type	Default	Description
`qMessageCode`	integer	N/A	Code number to the corresponding localized message string.
`qMessageParameters`	array<string>	N/A	Parameters to be inserted in the localized message string.

`Range`¶

No description.

Name	Type	Default	Description
`qMin`	number	N/A	Lowest value in the range
`qMax`	number	N/A	Highest value in the range
`qMinInclEq`	boolean	N/A	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	N/A	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	Default	Description
`qRangeLo`	number	-1e+300	Lowest value in the range.
`qRangeHi`	number	-1e+300	Highest value in the range.
`qMeasure`	string	N/A	Label of the measure.

`Rect`¶

No description.

Name	Type	Default	Description
`qLeft`	integer	N/A	Position from the left. Corresponds to the first column.
`qTop`	integer	N/A	Position from the top. Corresponds to the first row.
`qWidth`	integer	N/A	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	N/A	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` ).

`SampleResult`¶

No description.

Name	Type	Default	Description
`qFieldOrColumn`	`FieldOrColumn`	N/A	Name of field or column.
`qValues`	array<`FieldValue`>	N/A	Matched values part of the sample.

`ScriptSyntaxError`¶

No description.

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

`SearchAssociationResult`¶

Deprecated

This definition is deprecated and should not be used

No description.

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

`SearchAttribute`¶

No description.

Name	Type	Default	Description
`qKey`	string	N/A	String corresponding to SearchObjectOptions.qAttributes. It will be qProperty for `SearchObjectOptions`.
`qValue`	string	N/A	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	Default	Description
`qCharPos`	integer	N/A	Starting position of the match in the search result, starting from 0.
`qCharCount`	integer	N/A	Length of the match in the search result.
`qTerm`	integer	N/A	Position of the term in the list of search terms, starting from 0.

`SearchCombinationOptions`¶

No description.

Name	Type	Default	Description
`qSearchFields`	array<string>	N/A	List of the search fields. If empty, the search is performed in all fields of the app.
`qContext`	string	CONTEXT_LOCKED_FIELDS_ONLY	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	CHAR_ENCODING_UTF8	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<string>	N/A	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`¶

Deprecated

This definition is deprecated and should not be used

No description.

Name	Type	Default	Description
`qField`	integer	N/A	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`>	N/A	List of the matching values. The maximum number of values in this list is set by qMaxNbrFieldMatches .

`SearchFieldMatch`¶

Deprecated

This definition is deprecated and should not be used

No description.

Name	Type	Default	Description
`qField`	integer	N/A	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<integer>	N/A	Positions of the matching values in the search results. The maximum number of values in this list is defined by qMaxNbrFieldMatches .
`qTerms`	array<integer>	N/A	Positions of the search terms, starting from 0.
`qNoOfMatches`	integer	N/A	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	Default	Description
`qId`	integer	N/A	Identifier of the search group.
`qGroupType`	string	N/A	Type of the search group. One of: - DatasetType or DATASET_GROUP - GenericObjectsType or GENERIC_OBJECTS_GROUP
`qSearchTermsMatched`	array<integer>	N/A	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	N/A	Total number of distinct items in the search group.
`qItems`	array<`SearchGroupItem`>	N/A	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	Default	Description
`qItemType`	string	N/A	Type of the group item. One of: - Field or FIELD - GenericObject or GENERIC_OBJECT
`qTotalNumberOfMatches`	integer	N/A	Total number of distinct matches in the search group item.
`qIdentifier`	string	N/A	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`>	N/A	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<integer>	N/A	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	Default	Description
`qText`	string	N/A	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.
`qFieldSelectionMode`	undefined	N/A	Selection mode of a field. Suppressed by default. One and always one field value is selected when set to OneAndOnlyOne.
`qRanges`	array<`SearchCharRange`>	N/A	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`>	N/A	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	Default	Description
`qGroupItemType`	string	N/A	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	N/A	Position starting from 0. The default value is 0.
`qCount`	integer	-1	Maximum number of matches per item (in qItemMatches[ ] ). The default value is -1: all values are returned.

`SearchGroupOptions`¶

No description.

Name	Type	Default	Description
`qGroupType`	string	N/A	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	N/A	Position starting from 0. The default value is 0.
`qCount`	integer	-1	Maximum number of items per group (in qItems[ ] ). The default value is -1; all values are returned.

`SearchMatchCombination`¶

Deprecated

This definition is deprecated and should not be used

No description.

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

`SearchObjectOptions`¶

No description.

Name	Type	Default	Description
`qAttributes`	array<string>	N/A	This array is either empty or contains qProperty .
`qCharEncoding`	string	CHAR_ENCODING_UTF8	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	Default	Description
`qOffset`	integer	N/A	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	N/A	Number of search groups to return (in qSearchGroupArray ).
`qMaxNbrFieldMatches`	integer	-1	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`>	N/A	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`>	N/A	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	Default	Description
`qSearchTerms`	array<string>	N/A	List of the search terms.
`qTotalNumberOfGroups`	integer	N/A	Total number of groups.
`qSearchGroupArray`	array<`SearchGroup`>	N/A	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	Default	Description
`qValue`	string	N/A	Value of the suggestion.
`qTerm`	integer	N/A	Index of the suggestion value. The indexing starts from 0 and from the left.

`SearchSuggestionResult`¶

No description.

Name	Type	Default	Description
`qSuggestions`	array<`SearchSuggestItem`>	N/A	List of suggestions.
`qFieldNames`	array<string>	N/A	List of field names that contain search hits.

`SearchTermResult`¶

Deprecated

This definition is deprecated and should not be used

No description.

Name	Type	Default	Description
`qText`	string	N/A	Text of the associated value.
`qElemNumber`	integer	N/A	Element number of the associated value.
`qRanges`	array<`SearchCharRange`>	N/A	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	Default	Description
`qTextSearch`	string	N/A	Text search string. Everything that matches the text is selected. This parameter is optional.
`qRangeLo`	number	-1e+300	Lower value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
`qRangeHi`	number	-1e+300	Highest value of the search range. This parameter is used when performing range selections or text searches in dimensions. Default is Null.
`qNumberFormat`	`FieldAttributes`	N/A	Gives information about the formatting of the range. This parameter is used when performing range selections or text searches in dimensions.
`qRangeInfo`	array<`RangeSelectInfo`>	N/A	This parameter is used when performing range selections or text searches in measures. Gives information about the range of selections.
`qSoftLock`	boolean	N/A	Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
`qContinuousRangeInfo`	array<`Range`>	N/A	List of information about ranges for selections.
`qSelectFieldSearch`	boolean	N/A	This parameter is true if the TextSearch is a result of a Select Field operation.

`SelectionObject`¶

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

Name	Type	Default	Description
`qBackCount`	integer	N/A	Number of steps back.
`qForwardCount`	integer	N/A	Number of steps forward.
`qSelections`	array<`NxCurrentSelectionItem`>	N/A	Lists the fields that are selected.
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .

`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	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .

`Size`¶

No description.

Name	Type	Default	Description
`qcx`	integer	N/A	Number of pixels on the x axis.
`qcy`	integer	N/A	Number of pixels on the y axis.

`SortCriteria`¶

No description.

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

`SourceKeyRecord`¶

No description.

Name	Type	Default	Description
`qKeyFields`	array<string>	N/A	Name of the key field.
`qTables`	array<string>	N/A	Table the key belongs to.

`StaticContentList`¶

No description.

Name	Type	Default	Description
`qItems`	array<`StaticContentListItem`>	N/A	Information about the list of content files.

`StaticContentListItem`¶

In addition, this structure can return dynamic properties.

Name	Type	Default	Description
`qUrlDef`	string	N/A	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	N/A	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	Default	Description
`qUrl`	string	N/A	Relative path of the thumbnail.

`StaticContentUrlDef`¶

In addition, this structure can contain dynamic properties.

Name	Type	Default	Description
`qUrl`	string	N/A	Relative path of the thumbnail.

`StringExpr`¶

No description.

Name	Type	Default	Description
`qv`	string	N/A	Expression evaluated to string.

`StringExpression`¶

Name	Type	Default	Description
`qExpr`	string	N/A	No description.

`TableRecord`¶

No description.

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

`TableRow`¶

No description.

Name	Type	Default	Description
`qValue`	array<`FieldValue`>	N/A	Array of field values.

`TableViewBroomPointSaveInfo`¶

No description.

Name	Type	Default	Description
`qPos`	`Point`	N/A	Information about the position of the broom point.
`qTable`	string	N/A	Name of the table.
`qFields`	array<string>	N/A	List of fields in the table.

`TableViewConnectionPointSaveInfo`¶

No description.

Name	Type	Default	Description
`qPos`	`Point`	N/A	Information about the position of the connection point.
`qFields`	array<string>	N/A	List of the fields in the table.

`TableViewCtlSaveInfo`¶

No description.

Name	Type	Default	Description
`qInternalView`	`TableViewSaveInfo`	N/A	Internal view mode.
`qSourceView`	`TableViewSaveInfo`	N/A	Source view mode.

`TableViewDlgSaveInfo`¶

No description.

Name	Type	Default	Description
`qPos`	`Rect`	N/A	Information about the position of the dialog window. Not used in Qlik Sense.
`qCtlInfo`	`TableViewCtlSaveInfo`	N/A	Set of data for internal and source view modes.
`qMode`	integer	N/A	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	Default	Description
`qTables`	array<`TableViewTableWinSaveInfo`>	N/A	List of the tables in the database model viewer.
`qBroomPoints`	array<`TableViewBroomPointSaveInfo`>	N/A	List of the broom points in the database model viewer. Not used in Qlik Sense.
`qConnectionPoints`	array<`TableViewConnectionPointSaveInfo`>	N/A	List of connection points in the database model viewer. Not used in Qlik Sense.
`qZoomFactor`	number	1	Zoom factor in the database model viewer. The default value is 1.0.

`TableViewTableWinSaveInfo`¶

No description.

Name	Type	Default	Description
`qPos`	`Rect`	N/A	Information about the position of the table.
`qCaption`	string	N/A	Table name.

`TextMacro`¶

No description.

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

`TreeData`¶

Stability Index: Stable

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	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .
`qNodesOnDim`	array<integer>	N/A	The total number of nodes on each dimension.
`qError`	`NxValidationError`	N/A	This parameter is optional and is displayed in case of error.
`qDimensionInfo`	array<`NxTreeDimensionInfo`>	N/A	Information on the dimension.
`qEffectiveInterColumnSortOrder`	array<integer>	N/A	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	N/A	True if other row exists.
`qTitle`	string	N/A	Title of the `TreeData` object, for example the title of a chart.
`qLastExpandedPos`	`NxCellPosition`	N/A	Position of the last expended cell. This property is optional.
`qCalcCondMsg`	string	N/A	The message displayed if calculation condition is not fulfilled.
`qTreeDataPages`	array<`NxTreeNode`>	N/A	Set of data. Is empty if nothing has been defined in qInitialDataFetch in `TreeDataDef`.

`TreeDataDef`¶

Stability Index: Stable

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

Name	Type	Default	Description
`qStateName`	string	N/A	Name of the alternate state. Default is current selections $ .
`qDimensions`	array<`NxTreeDimensionDef`>	N/A	Array of dimensions.
`qInterColumnSortOrder`	array<integer>	N/A	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	N/A	Removes zero values.
`qSuppressMissing`	boolean	N/A	Removes missing values.
`qOpenFullyExpanded`	boolean	N/A	If this property is set to true, the cells are opened expanded. The default value is false.
`qPopulateMissing`	boolean	N/A	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`	N/A	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`	N/A	Title of the `TreeData` object, for example the title of a chart.
`qInitialDataFetch`	array<`NxTreeDataOption`>	N/A	Initial data set. This property is optional.

`UndoInfo`¶

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

Name	Type	Default	Description
`qUndoCount`	integer	N/A	Number of possible undos.
`qRedoCount`	integer	N/A	Number of possible redos.

`ValueExpr`¶

No description.

Name	Type	Default	Description
`qv`	string	N/A	Expression evaluated to dual.

`ValueExpression`¶

Name	Type	Default	Description
`qExpr`	string	N/A	No description.

`VariableList`¶

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

Name	Type	Default	Description
`qItems`	array<`NxVariableListItem`>	N/A	List of the variables.

`VariableListDef`¶

Defines the list of variables in an app.

Name	Type	Default	Description
`qType`	string	N/A	Type of variables to include in the list.
`qShowReserved`	boolean	N/A	Shows the reserved variables if set to true.
`qShowConfig`	boolean	N/A	Shows the system variables if set to true.
`qData`	`JsonObject`	N/A	Data
`qShowSession`	boolean	N/A	Shows the session variables if set to true.

Definitions¶

AlfaNumString¶

AlternateStateData¶

AppEntry¶

AppObjectList¶

AppObjectListDef¶

AppScript¶

AssociationScore¶

BNFDef¶

BookmarkFieldItem¶

BookmarkFieldPage¶

BookmarkList¶

BookmarkListDef¶

BookmarkVariableItem¶

CalendarStrings¶

CharRange¶

ChildList¶

ChildListDef¶

CodePage¶

Connection¶

ContentLibraryList¶

ContentLibraryListItem¶

CustomConnector¶

DataField¶

DataRecord¶

DataTable¶

DataTableEx¶

Database¶

DatabaseInfo¶

DatabaseOwner¶

DelimiterInfo¶

DerivedFieldsInTableData¶

DimensionList¶

DimensionListDef¶

DoReloadExParams¶

DoReloadExResult¶

DocListEntry¶

DriveInfo¶

EditorBreakpoint¶

ErrorData¶

ExtensionList¶

FieldAttributes¶

FieldDefEx¶

FieldDescription¶

FieldInTableData¶

FieldList¶

FieldListDef¶

FieldOrColumn¶

FieldScores¶

FieldValue¶

FileDataFormat¶

FilterInfo¶

FolderItem¶

Function¶

GenericBookmarkEntry¶

GenericBookmarkLayout¶

GenericBookmarkProperties¶

GenericDimensionInfo¶

GenericDimensionLayout¶

GenericDimensionProperties¶

GenericMeasureLayout¶

GenericMeasureProperties¶

GenericObjectEntry¶

GenericObjectLayout¶

GenericObjectProperties¶

GenericVariableLayout¶

GenericVariableProperties¶

HyperCube¶

HyperCubeDef¶

InteractDef¶

LayoutFieldInfo¶

LineageInfo¶

ListObject¶

ListObjectDef¶

LocaleInfo¶

MeasureList¶

MeasureListDef¶

MediaList¶

MediaListItem¶

NxAppLayout¶

`AlfaNumString`¶

`AlternateStateData`¶

`AppEntry`¶

`AppObjectList`¶

`AppObjectListDef`¶

`AppScript`¶

`AssociationScore`¶

`BNFDef`¶

`BookmarkFieldItem`¶

`BookmarkFieldPage`¶

`BookmarkList`¶

`BookmarkListDef`¶

`BookmarkVariableItem`¶

`CalendarStrings`¶

`CharRange`¶

`ChildList`¶

`ChildListDef`¶

`CodePage`¶

`Connection`¶

`ContentLibraryList`¶

`ContentLibraryListItem`¶

`CustomConnector`¶

`DataField`¶

`DataRecord`¶

`DataTable`¶

`DataTableEx`¶

`Database`¶

`DatabaseInfo`¶

`DatabaseOwner`¶

`DelimiterInfo`¶

`DerivedFieldsInTableData`¶

`DimensionList`¶

`DimensionListDef`¶

`DoReloadExParams`¶

`DoReloadExResult`¶

`DocListEntry`¶

`DriveInfo`¶

`EditorBreakpoint`¶

`ErrorData`¶

`ExtensionList`¶

`FieldAttributes`¶

`FieldDefEx`¶

`FieldDescription`¶

`FieldInTableData`¶

`FieldList`¶

`FieldListDef`¶

`FieldOrColumn`¶

`FieldScores`¶

`FieldValue`¶

`FileDataFormat`¶

`FilterInfo`¶

`FolderItem`¶

`Function`¶

`GenericBookmarkEntry`¶

`GenericBookmarkLayout`¶

`GenericBookmarkProperties`¶

`GenericDimensionInfo`¶

`GenericDimensionLayout`¶

`GenericDimensionProperties`¶

`GenericMeasureLayout`¶

`GenericMeasureProperties`¶

`GenericObjectEntry`¶

`GenericObjectLayout`¶

`GenericObjectProperties`¶

`GenericVariableLayout`¶

`GenericVariableProperties`¶

`HyperCube`¶

`HyperCubeDef`¶

`InteractDef`¶

`LayoutFieldInfo`¶

`LineageInfo`¶

`ListObject`¶

`ListObjectDef`¶

`LocaleInfo`¶

`MeasureList`¶

`MeasureListDef`¶

`MediaList`¶

`MediaListItem`¶

`NxAppLayout`¶

`NxAppProperties`¶