Skip to main content Skip to complementary content

Qlik.Engine Namespace

Classes

AbstractStructure

A wrapper that can provide a typed interface for a JToken.

AlfaNumString
AlternateStateData
App

App / Doc class

AppEntry
AppIdentifier

Token to identify a unique Qlik Sense app

ApplyGroupStatesResult

Result of applying GroupState to multiple cyclic groups.

ApplyGroupStateWarning
AppObjectList

Lists the app objects. Is the layout for AppObjectListDef.

AppObjectListDef

Defines the list of objects in an app.

AppScript
AppScriptMeta
AppScriptObject
ArrayOfNxValuePoint
AssociationScore
AsyncHandle

User created handle to asynchronous method request

Blob

A class representing binary data.

BNFDef
Bookmark
BookmarkApplyAndVerifyResult
BookmarkFieldItem
BookmarkFieldPage

Defines the range of the bookmark fields that are returned.

BookmarkFieldVerifyWarning
BookmarkList

Lists the bookmarks. Is the layout for BookmarkListDef.

BookmarkListDef

Defines the list of bookmarks.

BookmarkVariableItem
BoolArray
BulkOp

Specification and arguments for an individual operation (request) in a bulk request set.

BulkRequests
BulkResult

Response for an individual request in a bulk request set.

BulkResults
CalendarStrings
CharRange
CheckExpressionResult
CheckNumberOrExpressionResult
ChildList

Lists the children of a generic object. Is the layout for ChildListDef.

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.

CodePage
CondDef
Connection
ConnectionInfo
ContentLibraryList
ContentLibraryListItem
CreateAppExResult
CreateAppResult
CreateBookmarkExResult
CreateChildResult
CreateChildResult<T>
CreateGenericBookmarkResult
CreateGenericDimensionResult
CreateGenericMeasureResult
CreateGenericObjectResult
CreateSessionAppFromAppResult
CreateSessionAppResult
CreateTemporaryBookmarkResult
CreateVariableExResult
CustomConnector
CyclicGroupPosition
Database
DatabaseInfo
DatabaseOwner
DataField
DataPager

A class providing a paging interface for a pageable structure.

DataRecord
DataTable
DataTableEx
DelimiterInfo
DerivedFieldsInTableData
DimensionList

Lists the dimensions. Is the layout for DimensionListDef.

DimensionListDef

Defines the lists of dimensions.

DoReloadExParams
DoReloadExResult
DriveInfo
DynamicStructure

Wrapper for the AbstractStructure class.

EditorBreakpoint
Else
EmbeddedSnapshot

Renders the embedded snapshot in an object.

The following is returned:

* Any dynamic properties defined in the bookmark

* Any properties defined in qEmbeddedSnapshot

Properties

"qEmbeddedSnapshot": {}

EmbeddedSnapshotDef

Defines the embedded snapshot in a generic object.

Properties

"EmbeddedSnapshotDef": {}

EncyptedSecretEntry
EngineApiVersion

Class for identifying the Qlik Sense Engine version that this build of the .Net SDK is based on.

ErrorData
ExpansionData
ExportDataResult
ExtendedLayoutBookmarkData
ExtendedPivotStateData
ExtensionList

Obsolete, use qrs API's to fetch extensions.

ExtensionListDef

Obsolete, use qrs API's to fetch extensions.

Field

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

FieldAttributes

Sets the formatting of a field.

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

Formatting mechanism

The formatting mechanism depends on the type set in qType, as shown below:

Type is DATE, TIME, TIMESTAMP or INTERVAL

The following applies:

* If a format pattern is defined in qFmt , the formatting is as defined in qFmt .

* If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).

* The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.

* If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

* If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY

The following applies:

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

* If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII

No formatting, qFmt is ignored.

FieldDefEx
FieldDescription
FieldInTableData
FieldInTableProfilingData
FieldList

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

FieldListDef

Defines the fields to show.

FieldOrColumn
FieldScores
FieldValue
FileDataFormat

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

FilterInfo
FolderItem
FrequencyDistributionData
Function
GenericAppObjectEntry
GenericAppObjectMetaData
GenericBookmark

This class describes all the methods that apply at bookmark level.

The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.

GenericBookmarkEntry
GenericBookmarkLayout

Is the layout for GenericBookmarkProperties.

GenericBookmarkProperties
GenericDerivedDefinitionEntry
GenericDerivedDefinitionProperties
GenericDerivedFieldEntry
GenericDerivedFieldEntryList
GenericDerivedFieldsProperties
GenericDimension

This class describes all the methods that apply at dimension level.

The handle member in the JSON request for all methods listed in this section is the handle of the dimension.

GenericDimensionInfo
GenericDimensionLayout

Is the layout for GenericDimensionProperties.

GenericDimensionProperties
GenericMeasure

This class describes all the methods that apply at measure level.

The handle member in the JSON request for all methods listed in this section is the handle of the measure.

GenericMeasureLayout

Is the layout for GenericMeasureProperties.

GenericMeasureProperties
GenericObject

This class describes all the methods that apply at generic object level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic object.

GenericObjectEntry
GenericObjectIdentifier
GenericObjectLayout

Is the layout for GenericObjectProperties.

GenericObjectProperties
GenericObjectTypeOverrideAttribute
GenericUserState
GenericVariable

This class describes all the methods that apply at generic variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic variable.

GenericVariableEntry
GenericVariableEntryList
GenericVariableLayout

Is the layout for GenericVariableProperties.

GenericVariableProperties
GetBaseBNFResult
GetBaseBNFStringResult
GetDatabaseTablePreviewResult
GetDerivedFieldResult
GetExpressionBNFResult
GetFileTableFieldsResult
GetFileTablePreviewResult
GetHyperCubeContinuousDataResult
GetInteractResult
GetMediaListResult
GetTablesAndKeysResult
GroupBookmarkData
GroupState
GroupStateInfo
Hub

Represents the hub of a Qlik engine location and is based on the Global class of the engine API.

HyperCube

Renders the properties of a hypercube. Is the layout for HyperCubeDef.

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

HyperCubeDef

Defines the properties of a hypercube.

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

HyperCubePager

A class providing a paging interface for a hypercube.

If
InputFieldItem
InteractDef
InterFieldSortData
InvalidPropertyAccessException

Exception indicating that a property in an object instance of a class derived from the AbstractStructure class has been accessed twice with incompatible types. Two types are considered compatible in this context if they are identical, if the type of the second type cast is a base class of the type of the first type class or if they are both subclasses of AbstractStructure.

JsonArray
JsonObject

Contains dynamic JSON data specified by the client.

JsonProperty
JSONWebTokenHeader
LayoutBookmarkData
LayoutExclude

Contains JSON to be excluded from validation.

LayoutFieldInfo

Meta data about the selection in a field.

LineageGraph
LineageGraphEdge
LineageGraphMetaData

* Key value pairs with metadata. Could be extra information on the nodes or edges.

LineageGraphNode
LineageGraphNodes

* Properties contain the node ID as names and the value is an object of type LineageGraphNode.

LineageGraphOptionsInternal
LineageInfo
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.

ListObjectDef

Defines the properties of a list object.

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

ListObjectPager

A class providing a paging interface for a list object.

LocaleInfo
Location

Handles the location of the Qlik Sense instance

LocationExtensions

Some locations need to be accessed in a specific way, the default is using NTML Authentication to connect against a server installation and will not require any specific setup.

MasterObjectException

An exception indicating an error condition relating to master objects.

MeasureList

Lists the measures. Is the layout for MeasureListDef.

MeasureListDef

Defines the list of measures.

MediaList

Lists the media files. Is the layout for MediaListDef.

MediaListDef

Defines the list of media files.

Properties

"qMediaListDef": {}

qMediaListDef has an empty structure. No properties need to be set.

MediaListItem
MetaData
MethodInvocationException

The Exception thrown when a method has gone wrong on the server during execution.

MethodInvocationException.Error

Qlik Sense error

MongoDataProps
MongoFieldProperties
MongoFields
NxAppLayout

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

NxAppProperties

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

NxAttrDimDef

Layout for NxAttrDimDef.

NxAttrDimInfo

Layout for NxAttrDimDef.

NxAttrExprDef
NxAttrExprInfo

Layout for NxAttrExprDef.

NxAttributeDimValues
NxAttributeExpressionValues
NxAutoSortByStateDef
NxAxisData
NxAxisTicks
NxBookmark
NxCalcCond
NxCardinalities
NxCell
NxCellMark
NxCellPosition
NxCellRows
NxConfigurationInfo
NxConnectivityManagerGetResponse
NxContainerEntry
NxContinuousDataOptions
NxContinuousRangeSelectInfo
NxCurrentSelectionItem
NxCustomProperty
NxDataAreaPage
NxDataPage
NxDerivedDefinition
NxDerivedDefinitionData
NxDerivedDefinitionInfo
NxDerivedDefinitionParameter
NxDerivedDefinitionParameterDesc
NxDerivedField
NxDerivedFieldDescriptionList
NxDerivedFieldsData
NxDerivedGroup
NxDimension
NxDimensionInfo
NxDownloadInfo
NxDownloadOptions
NxEngineSSESetting
NxEngineVersion
NxExpansionPath
NxExpressionCubeDef
NxExpressionCubeExpr
NxFeatureConfiguration
NxFieldDerivedDefinition
NxFieldDescription

NxDerivedFieldsdata

Please refer to Engine API reference for table definition.

NxFieldDescriptor
NxFieldProperties
NxFieldResourceId
NxFieldSelectionInfo
NxFieldTableResourceId
NxGeoBoundingBox
NxGeoCoordinate
NxGetBookmarkOptions
NxGetObjectOptions
NxGroupDerivedDefinition
NxGroupTail
NxHighlightRanges
NxInfo
NxInlineDimensionDef
NxInlineMeasureDef
NxLayoutErrors
NxLibraryDimension
NxLibraryDimensionDef
NxLibraryMeasure

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

NxLibraryMeasureDef
NxLinkedObjectInfo
NxListObjectExpression
NxListObjectExpressionDef
NxLocatedExpression
NxMatchingFieldInfo
NxMeasure
NxMeasureInfo

Layout for NxInlineMeasureDef.

NxMeta

Layout for NxMetaDef.

NxMetaDef

Used to collect meta data.

Properties

Semantic type with an empty structure.

NxMiniChart
NxMiniChartCell
NxMiniChartData
NxMiniChartDef
NxMiniChartRows
NxMultiRangeSelectInfo
NxNotification
NxPage
NxPageTreeLevel
NxPageTreeNode

Defines an area of the tree to be fetched.

NxPatch
NxPatches
NxPivotDimensionCell
NxPivotPage
NxPivotValuePoint
NxQrsAddedDataSegment
NxQrsAddedObject
NxQrsApp
NxQrsAppContainer
NxQrsAppContentLibraryListItem
NxQrsAppDataSegmentOperation
NxQrsAppFileMeta
NxQrsAppObject
NxQrsAppObjectPrivileges
NxQrsAppResponse
NxQrsBulkRequest
NxQrsChunk
NxQrsConnection
NxQrsConnectionOperation
NxQrsContentLibraryListItem
NxQrsCreateResponse
NxQrsDatasegment
NxQrsEncryption
NxQrsEngineApp
NxQrsEngineService
NxQrsEngineSettings
NxQrsExternalChangeInfo
NxQrsMagicImportItem
NxQrsMediaListItem
NxQrsObjectOperation
NxQrsRestEndpointHandle
NxQrsRule
NxQrsStaticContentItem
NxQrsStaticContentListItem
NxQrsStaticContentOperation
NxQrsSyncTransaction
NxQrsUser
NxQrsUserFull
NxQvfBundledItem
NxRange
NxRangeSelectInfo
NxRules
NxSelectionCell
NxSelectionInfo
NxServiceConfiguration
NxSimpleDimValue
NxSimpleValue
NxStackedPivotCell
NxStackPage
NxStateCounts
NxStreamListEntry
NxSystemProperties
NxTempBookmarkOptions
NxTickCell
NxTreeDataOption

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

NxTreeDimensionDef
NxTreeDimensionInfo
NxTreeMultiRangeSelectInfo
NxTreeNode

Represents a dimension in the tree.

NxTreeRangeSelectInfo
NxTreeValue

Represents a measure.

NxTrendline

Information about the calculated trendline.

NxTrendlineDef

Trendline input definition

NxValidationError
NxVariableListItem
NxVariableProperties
NxViewPort
ObjectInterface
OdbcDsn
OleDbProvider
OneAndOnlyOneSelection
OtherTotalSpecProp
Pager

Used for paging when getting data from the engine.

PersistedObjectMeta
Point
PositionMark
ProgressData
ProgressMessage
PropertyContainer

Instances of this class represent objects known to the Qlik Sense Engine that follow the properties/layout pattern.

QcsLocation

Class for handling connections to Qlik Cloud Services.

QixClassBase

Instances of this class represent objects known to the Qlik Sense Engine.

QixNameAttribute

Contains the actual server name for a component

Range
RangeSelectInfo
Rect
ReplaceBookmarkResult
SampleResult
ScriptSyntaxError
ScrollPosition
SearchableObject
SearchAssociationResult
SearchAttribute
SearchAttributeArray
SearchCharRange
SearchCombinationOptions
SearchFieldDictionary
SearchFieldMatch
SearchFieldMatchesItem
SearchFieldValueItem
SearchGroup
SearchGroupItem
SearchGroupItemMatch
SearchGroupItemOptions
SearchGroupOptions
SearchMatchCombination
SearchMatchCombinations
SearchObjectInternalOptions
SearchObjectOptions
SearchPage
SearchResult
SearchSuggestionResult
SearchSuggestItem
SearchTermResult
SearchValueOptions
SearchValuePage
SearchValueResult
SelectInfo
SelectionObject

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

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.

Properties

"qSelectionObjectDef": {}

Session

Contains Information to attach to a specific Qlik engine session When connecting to a Qlik Sense app you can work with sessions. Sessions specify who should see changes in an app, and are based on combining userId and session key.

SessionToken

Class for encapsulating the token string used to identify a Qlik Cloud Services session.

Size
SortCriteria
SourceKeyRecord
StaticContentList
StaticContentListItem
StaticContentUrl
StaticContentUrlDef
StoreTempSelectionStateResult
StringExpr

Expression class that evaluates to a string

StringExpression

Properties

Abbreviated syntax:

"qStringExpression":"=<expression>"

Extended object syntax:

"qStringExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string

The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.

StringExpressionContainer

Wrapper class for a StringExpression object.

StructureDiff

A class representing the diff between two abstract structures for a particular property path.

SuspendedLayoutException

Exception indicating that a layout has been accessed while suspended.

SymbolFrequency
SymbolValue
TableProfilingData
TableRecord
TableRow
TableViewBroomPointSaveInfo
TableViewConnectionPointSaveInfo
TableViewCtlSaveInfo
TableViewDlgSaveInfo
TableViewSaveInfo
TableViewTableWinSaveInfo
TextMacro
Then
TransformAppParameters
TransformAppResult
TreeData

Renders the properties of a TreeData object. Is the layout for TreeDataDef.

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

TreeDataDef

Defines the properties of a TreeData object.

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

UndoExclude
UndoInfo

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

UndoInfoDef

Defines if an object should contain information on the number of possible undo and redo.

Properties

"qUndoInfoDef": {}

The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

UriBindingException

Exception thrown when the system was unable to bind an uri to local qlik sense instance automatically

ValueClassAttribute

Describes that a class is static data only. When its parent object updates, this object will no longer be valid.

ValueExpr

Expression class that evaluates to a value

ValueExpression

Properties

Abbreviated syntax:

"qValueExpression":"=<expression>"

Extended object syntax:

"qValueExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string.

The expression is evaluated as a numeric.

ValueExpressionContainer

Wrapper class for a ValueExpression object.

Variable

This class describes all the methods that apply at variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the variable.

VariableList

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

VariableListDef

Defines the list of variables in an app.

Interfaces

IAbstractStructure

A wrapper that can provide a typed interface for a JToken.

IAlfaNumString
IAlternateStateData
IApp

App / Doc class

IAppEntry
IAppIdentifier

Token to identify a unique Qlik Sense app

IApplyGroupStatesResult

Result of applying GroupState to multiple cyclic groups.

IApplyGroupStateWarning
IAppObjectList

Lists the app objects. Is the layout for AppObjectListDef.

IAppObjectListDef

Defines the list of objects in an app.

IAppScript
IAppScriptMeta
IAppScriptObject
IArrayOfNxValuePoint
IAssociationScore
IBlob

A class representing binary data.

IBNFDef
IBookmark
IBookmarkApplyAndVerifyResult
IBookmarkFieldItem
IBookmarkFieldPage

Defines the range of the bookmark fields that are returned.

IBookmarkFieldVerifyWarning
IBookmarkList

Lists the bookmarks. Is the layout for BookmarkListDef.

IBookmarkListDef

Defines the list of bookmarks.

IBookmarkVariableItem
IBoolArray
IBulkOp

Specification and arguments for an individual operation (request) in a bulk request set.

IBulkRequests
IBulkResult

Response for an individual request in a bulk request set.

IBulkResults
ICalendarStrings
IChangeNotifier

Interface used by classes that supports change notification.

ICharRange
ICheckExpressionResult
ICheckNumberOrExpressionResult
IChildList

Lists the children of a generic object. Is the layout for ChildListDef.

IChildListDef

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.

ICodePage
ICondDef
IConnection
IConnectionInfo
IContentLibraryList
IContentLibraryListItem
ICreateAppExResult
ICreateAppResult
ICreateBookmarkExResult
ICreateChildResult
ICreateChildResult<T>
ICreateGenericBookmarkResult
ICreateGenericDimensionResult
ICreateGenericMeasureResult
ICreateGenericObjectResult
ICreateSessionAppFromAppResult
ICreateSessionAppResult
ICreateTemporaryBookmarkResult
ICreateVariableExResult
ICustomConnector
ICyclicGroupPosition
IDatabase
IDatabaseInfo
IDatabaseOwner
IDataField
IDataRecord
IDataTable
IDataTableEx
IDelimiterInfo
IDerivedFieldsInTableData
IDimensionList

Lists the dimensions. Is the layout for DimensionListDef.

IDimensionListDef

Defines the lists of dimensions.

IDoReloadExParams
IDoReloadExResult
IDriveInfo
IDynamicStructure
IEditorBreakpoint
IElse
IEmbeddedSnapshot

Renders the embedded snapshot in an object.

The following is returned:

* Any dynamic properties defined in the bookmark

* Any properties defined in qEmbeddedSnapshot

Properties

"qEmbeddedSnapshot": {}

IEmbeddedSnapshotDef

Defines the embedded snapshot in a generic object.

Properties

"EmbeddedSnapshotDef": {}

IEncyptedSecretEntry
IErrorData
IExpansionData
IExportDataResult
IExtendedLayoutBookmarkData
IExtendedPivotStateData
IExtensionList

Obsolete, use qrs API's to fetch extensions.

IExtensionListDef

Obsolete, use qrs API's to fetch extensions.

IField

This class describes all the methods that apply at field level.

The handle member in the JSON request for all methods listed in this section is the handle of the field.

IFieldAttributes

Sets the formatting of a field.

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

Formatting mechanism

The formatting mechanism depends on the type set in qType, as shown below:

Type is DATE, TIME, TIMESTAMP or INTERVAL

The following applies:

* If a format pattern is defined in qFmt , the formatting is as defined in qFmt .

* If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).

* The properties qDec , qThou , qnDec , qUseThou are not used.

Type is INTEGER

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

Type is REAL

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.

* If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

* If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is FIX

The following applies:

* If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).

* If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

Type is MONEY

The following applies:

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

* If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

Type is ASCII

No formatting, qFmt is ignored.

IFieldDefEx
IFieldDescription
IFieldInTableData
IFieldInTableProfilingData
IFieldList

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

IFieldListDef

Defines the fields to show.

IFieldOrColumn
IFieldScores
IFieldValue
IFileDataFormat

FileType

Recognized file formats are:

* CSV for Delimited

* FIX for Fixed Record

* DIF for Data Interchange Format

* EXCEL_BIFF for Microsoft Excel (XLS)

* EXCEL_OOXML for Microsoft Excel (XLSX)

* HTML for HTML

* QVD for QVD file

* XML for XML

* QVX for QVX file

* JSON for JSON format

* KML for KML file

* PARQUET for PARQUET file

IFilterInfo
IFolderItem
IFrequencyDistributionData
IFunction
IGenericAppObjectEntry
IGenericAppObjectMetaData
IGenericBookmark

This class describes all the methods that apply at bookmark level.

The handle member in the JSON request for all methods listed in this section is the handle of the bookmark.

IGenericBookmarkEntry
IGenericBookmarkLayout

Is the layout for GenericBookmarkProperties.

IGenericBookmarkProperties
IGenericDerivedDefinitionEntry
IGenericDerivedDefinitionProperties
IGenericDerivedFieldEntry
IGenericDerivedFieldEntryList
IGenericDerivedFieldsProperties
IGenericDimension

This class describes all the methods that apply at dimension level.

The handle member in the JSON request for all methods listed in this section is the handle of the dimension.

IGenericDimensionInfo
IGenericDimensionLayout

Is the layout for GenericDimensionProperties.

IGenericDimensionProperties
IGenericMeasure

This class describes all the methods that apply at measure level.

The handle member in the JSON request for all methods listed in this section is the handle of the measure.

IGenericMeasureLayout

Is the layout for GenericMeasureProperties.

IGenericMeasureProperties
IGenericObject

This class describes all the methods that apply at generic object level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic object.

IGenericObjectEntry
IGenericObjectIdentifier
IGenericObjectLayout

Is the layout for GenericObjectProperties.

IGenericObjectProperties
IGenericUserState
IGenericVariable

This class describes all the methods that apply at generic variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the generic variable.

IGenericVariableEntry
IGenericVariableEntryList
IGenericVariableLayout

Is the layout for GenericVariableProperties.

IGenericVariableProperties
IGetBaseBNFResult
IGetBaseBNFStringResult
IGetDatabaseTablePreviewResult
IGetDerivedFieldResult
IGetExpressionBNFResult
IGetFileTableFieldsResult
IGetFileTablePreviewResult
IGetHyperCubeContinuousDataResult
IGetInteractResult
IGetMediaListResult
IGetTablesAndKeysResult
IGroupBookmarkData
IGroupState
IGroupStateInfo
IHub
IHyperCube

Renders the properties of a hypercube. Is the layout for HyperCubeDef.

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

IHyperCubeDef

Defines the properties of a hypercube.

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

IIf
IInputFieldItem
IInteractDef
IInterFieldSortData
IJsonArray
IJsonObject

Contains dynamic JSON data specified by the client.

IJsonProperty
IJSONWebTokenHeader
ILayoutBookmarkData
ILayoutExclude

Contains JSON to be excluded from validation.

ILayoutFieldInfo

Meta data about the selection in a field.

ILineageGraph
ILineageGraphEdge
ILineageGraphMetaData

* Key value pairs with metadata. Could be extra information on the nodes or edges.

ILineageGraphNode
ILineageGraphNodes

* Properties contain the node ID as names and the value is an object of type LineageGraphNode.

ILineageGraphOptionsInternal
ILineageInfo
IListObject

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.

IListObjectDef

Defines the properties of a list object.

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

ILocaleInfo
ILocation

Interface for Qlik Sense instance location handling

IMeasureList

Lists the measures. Is the layout for MeasureListDef.

IMeasureListDef

Defines the list of measures.

IMediaList

Lists the media files. Is the layout for MediaListDef.

IMediaListDef

Defines the list of media files.

Properties

"qMediaListDef": {}

qMediaListDef has an empty structure. No properties need to be set.

IMediaListItem
IMetaData
IMongoDataProps
IMongoFieldProperties
IMongoFields
INxAppLayout

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

INxAppProperties

Qlik Sense Desktop

In Qlik Sense Desktop, this structure can contain dynamic properties.

Qlik Sense Enterprise

In Qlik Sense Enterprise, only a few dynamic properties at the app level are persisted.

The persisted dynamic properties are the following:

* modifiedDate

* published

* publishTime

* privileges

* description

* dynamicColor

INxAttrDimDef

Layout for NxAttrDimDef.

INxAttrDimInfo

Layout for NxAttrDimDef.

INxAttrExprDef
INxAttrExprInfo

Layout for NxAttrExprDef.

INxAttributeDimValues
INxAttributeExpressionValues
INxAutoSortByStateDef
INxAxisData
INxAxisTicks
INxBookmark
INxCalcCond
INxCardinalities
INxCell
INxCellMark
INxCellPosition
INxCellRows
INxConfigurationInfo
INxConnectivityManagerGetResponse
INxContainerEntry
INxContinuousDataOptions
INxContinuousRangeSelectInfo
INxCurrentSelectionItem
INxCustomProperty
INxDataAreaPage
INxDataPage
INxDerivedDefinition
INxDerivedDefinitionData
INxDerivedDefinitionInfo
INxDerivedDefinitionParameter
INxDerivedDefinitionParameterDesc
INxDerivedField
INxDerivedFieldDescriptionList
INxDerivedFieldsData
INxDerivedGroup
INxDimension
INxDimensionInfo
INxDownloadInfo
INxDownloadOptions
INxEngineSSESetting
INxEngineVersion
INxExpansionPath
INxExpressionCubeDef
INxExpressionCubeExpr
INxFeatureConfiguration
INxFieldDerivedDefinition
INxFieldDescription

NxDerivedFieldsdata

Please refer to Engine API reference for table definition.

INxFieldDescriptor
INxFieldProperties
INxFieldResourceId
INxFieldSelectionInfo
INxFieldTableResourceId
INxGeoBoundingBox
INxGeoCoordinate
INxGetBookmarkOptions
INxGetObjectOptions
INxGroupDerivedDefinition
INxGroupTail
INxHighlightRanges
INxInfo
INxInlineDimensionDef
INxInlineMeasureDef
INxLayoutErrors
INxLibraryDimension
INxLibraryDimensionDef
INxLibraryMeasure

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

INxLibraryMeasureDef
INxLinkedObjectInfo
INxListObjectExpression
INxListObjectExpressionDef
INxLocatedExpression
INxMatchingFieldInfo
INxMeasure
INxMeasureInfo

Layout for NxInlineMeasureDef.

INxMeta

Layout for NxMetaDef.

INxMetaDef

Used to collect meta data.

Properties

Semantic type with an empty structure.

INxMiniChart
INxMiniChartCell
INxMiniChartData
INxMiniChartDef
INxMiniChartRows
INxMultiRangeSelectInfo
INxNotification
INxPage
INxPageTreeLevel
INxPageTreeNode

Defines an area of the tree to be fetched.

INxPatch
INxPatches
INxPivotDimensionCell
INxPivotPage
INxPivotValuePoint
INxQrsAddedDataSegment
INxQrsAddedObject
INxQrsApp
INxQrsAppContainer
INxQrsAppContentLibraryListItem
INxQrsAppDataSegmentOperation
INxQrsAppFileMeta
INxQrsAppObject
INxQrsAppObjectPrivileges
INxQrsAppResponse
INxQrsBulkRequest
INxQrsChunk
INxQrsConnection
INxQrsConnectionOperation
INxQrsContentLibraryListItem
INxQrsCreateResponse
INxQrsDatasegment
INxQrsEncryption
INxQrsEngineApp
INxQrsEngineService
INxQrsEngineSettings
INxQrsExternalChangeInfo
INxQrsMagicImportItem
INxQrsMediaListItem
INxQrsObjectOperation
INxQrsRestEndpointHandle
INxQrsRule
INxQrsStaticContentItem
INxQrsStaticContentListItem
INxQrsStaticContentOperation
INxQrsSyncTransaction
INxQrsUser
INxQrsUserFull
INxQvfBundledItem
INxRange
INxRangeSelectInfo
INxRules
INxSelectionCell
INxSelectionInfo
INxServiceConfiguration
INxSimpleDimValue
INxSimpleValue
INxStackedPivotCell
INxStackPage
INxStateCounts
INxStreamListEntry
INxSystemProperties
INxTempBookmarkOptions
INxTickCell
INxTreeDataOption

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

INxTreeDimensionDef
INxTreeDimensionInfo
INxTreeMultiRangeSelectInfo
INxTreeNode

Represents a dimension in the tree.

INxTreeRangeSelectInfo
INxTreeValue

Represents a measure.

INxTrendline

Information about the calculated trendline.

INxTrendlineDef

Trendline input definition

INxValidationError
INxVariableListItem
INxVariableProperties
INxViewPort
IObjectInterface
IOdbcDsn
IOleDbProvider
IOneAndOnlyOneSelection
IOtherTotalSpecProp
IPersistedObjectMeta
IPoint
IPositionMark
IProgressData
IProgressMessage
IPropertyContainer
IQcsLocation

Interface for handling connections to Qlik Cloud Services.

IQixClassBase
IRange
IRangeSelectInfo
IRect
IReplaceBookmarkResult
ISampleResult
IScriptSyntaxError
IScrollPosition
ISearchableObject
ISearchAssociationResult
ISearchAttribute
ISearchAttributeArray
ISearchCharRange
ISearchCombinationOptions
ISearchFieldDictionary
ISearchFieldMatch
ISearchFieldMatchesItem
ISearchFieldValueItem
ISearchGroup
ISearchGroupItem
ISearchGroupItemMatch
ISearchGroupItemOptions
ISearchGroupOptions
ISearchMatchCombination
ISearchMatchCombinations
ISearchObjectInternalOptions
ISearchObjectOptions
ISearchPage
ISearchResult
ISearchSuggestionResult
ISearchSuggestItem
ISearchTermResult
ISearchValueOptions
ISearchValuePage
ISearchValueResult
ISelectInfo
ISelectionObject

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

ISelectionObjectDef

To display the current selections.

Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.

Properties

"qSelectionObjectDef": {}

ISession

Contains Information to attach to a specific qlik engine session When connecting to a Qlik Sense app you can work with sessions. Sessions specify who should see changes in an app, and are based on combining userId and session key.

ISize
ISortCriteria
ISourceKeyRecord
IStaticContentList
IStaticContentListItem
IStaticContentUrl
IStaticContentUrlDef
IStoreTempSelectionStateResult
IStringExpr
IStringExpression

Properties

Abbreviated syntax:

"qStringExpression":"=<expression>"

Extended object syntax:

"qStringExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string

The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.

IStringExpressionContainer
IStructureDiff

A class representing the diff between two abstract structures for a particular property path.

ISymbolFrequency
ISymbolValue
ITableProfilingData
ITableRecord
ITableRow
ITableViewBroomPointSaveInfo
ITableViewConnectionPointSaveInfo
ITableViewCtlSaveInfo
ITableViewDlgSaveInfo
ITableViewSaveInfo
ITableViewTableWinSaveInfo
ITextMacro
IThen
ITransformAppParameters
ITransformAppResult
ITransient

Interface for tagging an object as transient. Typically used to ensure that session objects are automatically destroyed during dispose.

ITreeData

Renders the properties of a TreeData object. Is the layout for TreeDataDef.

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

ITreeDataDef

Defines the properties of a TreeData object.

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

IUndoExclude
IUndoInfo

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

IUndoInfoDef

Defines if an object should contain information on the number of possible undo and redo.

Properties

"qUndoInfoDef": {}

The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.

IValueExpr
IValueExpression

Properties

Abbreviated syntax:

"qValueExpression":"=<expression>"

Extended object syntax:

"qValueExpression":{"qExpr":"=<expression>"}

Where:

* < expression > is a string.

The expression is evaluated as a numeric.

IValueExpressionContainer
IVariable

This class describes all the methods that apply at variable level.

The handle member in the JSON request for all methods listed in this section is the handle of the variable.

IVariableList

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

IVariableListDef

Defines the list of variables in an app.

Enums

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!