Namespace QlikTools.Model.Engine
Classes
AlfaNumString
AlternateStateData
AppEntry
AppObjectList
Lists the app objects. Is the layout for AppObjectListDef.
note
An app object is a generic object created at app level.
AppObjectListDef
Defines the list of objects in an app.
note
An app object is a generic object created at app level.
AppScript
ArrayOfNxValuePoint
AssociationScore
BNFDef
BookmarkFieldItem
BookmarkFieldPage
Defines the range of the bookmark fields that are returned.
BookmarkList
Lists the bookmarks. Is the layout for BookmarkListDef.
BookmarkListDef
Defines the list of bookmarks.
BookmarkVariableItem
CalendarStrings
CharRange
CheckExpressionResponse
CheckNumberOrExpressionResponse
ChildList
Lists the children of a generic object. Is the layout for ChildListDef.
note
ChildList is used by the _GetLayout Method_ to list the children of a generic 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.
CodePage
Connection
ContentLibraryList
ContentLibraryListItem
CreateAppResponse
CreateChildResponse
CustomConnector
Database
DatabaseInfo
DatabaseOwner
DataField
DataRecord
DataTable
DataTableEx
DelimiterInfo
DerivedFieldsInTableData
DimensionList
Lists the dimensions. Is the layout for DimensionListDef.
DimensionListDef
Defines the lists of dimensions.
DocListEntry
DoReloadExParams
Parameters for a reload.
DoReloadExResult
The result and path to script log for a reload.
DriveInfo
EditorBreakpoint
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”: {}
ErrorData
ExportDataResponse
ExtensionList
Obsolete, use qrs API’s to fetch extensions.
ExtensionListDef
Obsolete, use qrs API’s to fetch extensions.
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:
note
In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.
Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
FieldDefEx
FieldDescription
FieldInTableData
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
FilterInfo
FolderItem
Function
GenericBookmarkEntry
GenericBookmarkLayout
Is the layout for GenericBookmarkProperties.
GenericBookmarkProperties
GenericDimensionInfo
GenericDimensionLayout
Is the layout for GenericDimensionProperties.
GenericDimensionProperties
GenericMeasureLayout
Is the layout for GenericMeasureProperties.
GenericMeasureProperties
GenericObjectEntry
GenericObjectLayout
Is the layout for GenericObjectProperties.
GenericObjectProperties
GenericVariableLayout
Is the layout for GenericVariableProperties.
GenericVariableProperties
GetBaseBNFResponse
GetBaseBNFStringResponse
GetDatabaseTablePreviewResponse
GetFileTableFieldsResponse
GetFileTablePreviewResponse
GetHyperCubeContinuousDataResponse
GetInteractResponse
GetMediaListResponse
GetTablesAndKeysResponse
HyperCube
Renders the properties of a hypercube. Is the layout for HyperCubeDef.
For more information about the definition of a hypercube, see Generic object.
note
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).
HyperCubeDef
Defines the properties of a hypercube.
For more information about the definition of a hypercube, see Generic object.
InteractDef
LayoutExclude
Contains JSON to be excluded from validation.
LayoutFieldInfo
Meta data about the selection in a field.
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.
note
ListObject is used by the _GetLayout Method_ to display the properties of a list object.
ListObjectDef
Defines the properties of a list object.
For more information about the definition of a list object, see Generic object.
LocaleInfo
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.
note
This struct is deprecated.
MediaListDef
Defines the list of media files.
note
This struct is deprecated.
Properties
“qMediaListDef”: {}
qMediaListDef has an empty structure. No properties need to be set.
MediaListItem
note
In addition, this structure can return dynamic properties.
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
NxCellPosition
NxCellRows
NxContainerEntry
NxContinuousDataOptions
NxContinuousRangeSelectInfo
NxCurrentSelectionItem
NxDataAreaPage
NxDataPage
NxDerivedField
NxDerivedFieldDescriptionList
NxDerivedFieldsData
NxDerivedGroup
NxDimension
note
Either **qDef** or **qLibraryId** must be set, but not both.
note
If the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects.
note
A dimension that is set in the library can be used by many objects.
NxDimensionInfo
NxEngineVersion
NxFieldDescription
NxDerivedFieldsdata
[table] [tr] [th]Name[/th] [th]Description[/th] [th]Type[/th] [/tr] [tr] [td]qDerivedDefinitionName[/td] [td]Name of the derived definition.[/td] [td]String[/td] [/tr] [tr] [td]qFieldDefs[/td] [td]List of the derived fields.[/td] [td]Array of [i]NxDerivedField[/i][/td] [/tr] [tr] [td]qGroupDefs[/td] [td]List of the derived groups.[/td] [td]Array of [i]NxDerivedGroup[/i][/td] [/tr] [tr] [td]qTags[/td] [td]List of tags on the derived fields.[/td] [td]Array of [i]String[/i] [/td] [/tr] [/table]NxFieldProperties
NxFieldSelectionInfo
NxGetBookmarkOptions
NxGetObjectOptions
NxGroupTail
NxHighlightRanges
NxInfo
NxInlineDimensionDef
NxInlineMeasureDef
NxLayoutErrors
NxLibraryDimension
NxLibraryDimensionDef
NxLibraryMeasure
Information about the library measure. Is the layout for NxLibraryMeasureDef.
NxLibraryMeasureDef
NxLinkedObjectInfo
NxListObjectExpression
NxListObjectExpressionDef
NxMatchingFieldInfo
NxMeasure
note
Either **qDef** or **qLibraryId** must be set, but not both.
note
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
note
A measure that is set in the library can be used by many objects.
note
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.
NxMeasureInfo
Layout for NxInlineMeasureDef.
NxMeta
Layout for NxMetaDef.
NxMetaDef
Used to collect meta data.
Properties
Semantic type with an empty structure.
NxMultiRangeSelectInfo
NxPage
NxPageTreeLevel
NxPageTreeNode
Defines an area of the tree to be fetched.
NxPatch
NxPivotDimensionCell
NxPivotPage
NxPivotValuePoint
NxRange
NxRangeSelectInfo
NxSelectionCell
NxSelectionInfo
NxSimpleDimValue
NxSimpleValue
NxStackedPivotCell
NxStackPage
NxStateCounts
NxStreamListEntry
warning
This struct is deprecated (not recommended to use).
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.
NxValidationError
NxVariableListItem
NxVariableProperties
NxViewPort
ObjectInterface
OdbcDsn
OleDbProvider
OtherTotalSpecProp
Point
ProgressData
ProgressMessage
Range
RangeSelectInfo
Rect
SampleResult
ScriptSyntaxError
SearchAssociationResult
SearchAttribute
SearchCharRange
SearchCombinationOptions
SearchFieldDictionary
SearchFieldMatch
SearchGroup
SearchGroupItem
SearchGroupItemMatch
SearchGroupItemOptions
SearchGroupOptions
SearchMatchCombination
SearchMatchCombinations
SearchObjectOptions
SearchPage
SearchResult
SearchSuggestionResult
SearchSuggestItem
SearchTermResult
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”: {}
Size
SortCriteria
SourceKeyRecord
StaticContentList
StaticContentListItem
note
In addition, this structure can return dynamic properties.
StaticContentUrl
note
In addition, this structure can return dynamic properties.
StaticContentUrlDef
note
In addition, this structure can contain dynamic properties.
StringExpr
StringExpression
Properties
Abbreviated syntax:
“qStringExpression”:”=[expression]”
Extended object syntax:
“qStringExpression”:{“qExpr”:”=[expression]”}
Where:
- [ expression ] is a string
note
The “=” sign in the string expression is not mandatory. Even if the “=” sign is not given, the expression is evaluated.
note
A string expression is not evaluated, if the expression is surrounded by simple quotes.
The result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.
TableRecord
TableRow
TableViewBroomPointSaveInfo
TableViewConnectionPointSaveInfo
TableViewCtlSaveInfo
TableViewDlgSaveInfo
TableViewSaveInfo
TableViewTableWinSaveInfo
TextMacro
TreeData
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.
TreeDataDef
Defines the properties of a TreeData object.
For more information about the definition of a TreeData object, see Generic object.
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.
ValueExpr
ValueExpression
Properties
Abbreviated syntax:
“qValueExpression”:”=[expression]”
Extended object syntax:
“qValueExpression”:{“qExpr”:”=[expression]”}
Where:
- [ expression ] is a string.
note
The “=” sign in the value expression is not mandatory. Even if the “=” sign is not given, the expression is evaluated.
The expression is evaluated as a numeric.
VariableList
Lists the variables in an app. Is the layout for VariableListDef.
VariableListDef
Defines the list of variables in an app.
Interfaces
IDoc
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.
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.
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.
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.
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.
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.
IGlobal
IMixin
Mixin
IObjectInterface
Generated Interface
IProtocoll
Defines Options for the Protocoll
IRequestInterceptors
RequestInterceptors
IResponseInterceptors
ResponseInterceptors
IVariable
This class describes all the methods that apply at variable level.
note
Methods in this class are deprecated. Use methods in the _GenericVariableClass_ instead.
The _handle_ member in the JSON request for all methods listed in this section is the handle of the variable.
Enums
BNFDefMetaType
BNFType
CharEncodingType
DriveType
ErrorDataCode
FieldAttrType
FieldType
FileType
FilterType
FolderItemType
FunctionGroup
GenericConnectMachine
InteractType
KeyType
LogOnType
NxDataReductionMode
NxDimCellType
NxDimensionType
NxExportFileType
NxExportState
NxFieldSelectionMode
NxFrequencyMode
NxGrpType
NxHypercubeMode
NxLocalizedErrorCode
NxLocalizedWarningCode
NxMatchingFieldMode
NxPatchOperationType
NxSelectionCellType
NxSortIndicatorType
OtherLimitMode
OtherMode
OtherSortMode
SearchContextType
SearchFieldSelectionMode
SearchGroupItemType
SearchGroupType
StateEnumType
TotalMode