@qlik/api reference
Embed
Extend
Manage
APIs
Toolkits
Embed
Extend
Manage
APIs
Toolkits
Preparing search index...
qix
Module qix
Interfaces
GenericObject
QixAPI
Type Aliases
AlfaNumString
AlternateStateData
AnyGenericObjectLayout
AnyGenericObjectProperties
AppEntry
ApplyGroupStatesResult
ApplyGroupStateWarning
ApplyGroupStateWarningType
AppObjectList
AppObjectListDef
AppScript
AppScriptMeta
AppSession
ArrayOfNxValuePoint
AssociationScore
Blob
BNFDef
BNFDefMetaType
BNFType
Bookmark
BookmarkApplyAndVerifyResult
BookmarkFieldItem
BookmarkFieldPage
BookmarkFieldPageEx
BookmarkFieldVerifyResultState
BookmarkFieldVerifyWarning
BookmarkList
BookmarkListData
BookmarkListDef
BookmarkListItem
BookmarkStateFieldPages
BookmarkVariableItem
CalendarStrings
CharEncodingType
CharRange
ChildList
ChildListDef
CloseProps
CodePage
CombinedWebSocketStateEvent
CondDef
Connection
ContentLibraryList
ContentLibraryListItem
CurrentSelections
CustomConnector
CyclicGroupPosition
Database
DatabaseInfo
DatabaseOwner
DataField
DataRecord
DataTable
DataTableEx
DelimiterInfo
DerivedFieldsInTableData
DimensionList
DimensionListData
DimensionListDef
DimensionListItem
DimensionReference
Doc
DocAction
DocListEntry
DoReloadExParams
DoReloadExResult
DriveInfo
DriveType
DynamicAppViewListData
DynamicAppViewListItem
EditorBreakpoint
EmbeddedSnapshot
EmbeddedSnapshotDef
ErrorData
ErrorDataCode
ExpandedFieldListItem
ExpansionData
ExtendedLayoutBookmarkData
ExtendedPivotStateData
ExtensionList
ExtensionListDef
FailureData
Field
FieldAttributes
FieldAttrType
FieldDefEx
FieldDescription
FieldInTableData
FieldInTableProfilingData
FieldList
FieldListDef
FieldListObject
FieldOrColumn
FieldScores
FieldType
FieldValue
FileDataFormat
FileType
FilterInfo
FilterType
FolderItem
FolderItemType
FrequencyDistributionData
FunctionGroup
GenericBookmark
GenericBookmarkEntry
GenericBookmarkLayout
GenericBookmarkProperties
GenericConnectMachine
GenericDimension
GenericDimensionInfo
GenericDimensionLayout
GenericDimensionProperties
GenericListObject
GenericMeasure
GenericMeasureLayout
GenericMeasureProperties
GenericObjectEntry
GenericObjectLayout
GenericObjectLayoutAdditionalProperties
GenericObjectLayoutNode
GenericObjectLayoutNodeLevel2
GenericObjectLayoutNodeLevel3
GenericObjectLayoutNodeLevel4
GenericObjectLayoutNodeLevel5
GenericObjectLayoutNodeRec
GenericObjectProperties
GenericObjectPropertiesAdditionalProperties
GenericObjectPropertiesNode
GenericObjectPropertiesNodeLevel2
GenericObjectPropertiesNodeLevel3
GenericObjectPropertiesNodeLevel4
GenericObjectPropertiesNodeLevel5
GenericObjectPropertiesNodeRec
GenericVariable
GenericVariableConstraints
GenericVariableLayout
GenericVariableProperties
GenericVariableType
Global
GraphMode
GroupBookmarkData
GroupState
GroupStateInfo
HyperCube
HyperCubeDef
InputFieldItem
InteractDef
InteractType
InterFieldSortData
KeyType
LayoutBookmarkData
LayoutExclude
LayoutFieldInfo
LineageInfo
ListBoxProperties
ListFunctions
ListItem
ListObject
ListObjectDef
LocaleInfo
LogOnType
MasterObjectListData
MasterObjectListItem
MeasureList
MeasureListData
MeasureListDef
MeasureListItem
MediaListDef
MediaListItem
MetaData
ModalFunctions
NativeDocFunctions
NativeFieldFunctions
NativeGenericBookmarkFunctions
NativeGenericDimensionFunctions
NativeGenericMeasureFunctions
NativeGenericObjectFunctions
NativeGenericVariableFunctions
NativeGlobalFunctions
NativeReactHooks
NativeVariableFunctions
NxAppLayout
NxAppProperties
NxAttrDimDef
NxAttrDimInfo
NxAttrExprDef
NxAttrExprInfo
NxAttributeDimValues
NxAttributeExpressionValues
NxAutoSortByStateDef
NxAxisData
NxAxisTicks
NxBookmark
NxCalcCond
NxCardinalities
NxCell
NxCellPosition
NxCellRows
NxContainerEntry
NxContinuousDataOptions
NxContinuousMode
NxContinuousRangeSelectInfo
NxCurrentSelectionItem
NxDataAreaPage
NxDataPage
NxDataReductionMode
NxDerivedField
NxDerivedFieldDescriptionList
NxDerivedFieldsData
NxDerivedGroup
NxDimCellType
NxDimension
NxDimensionInfo
NxDimensionType
NxDownloadInfo
NxDownloadOptions
NxEngineVersion
NxExportFileType
NxExportState
NxFeature
NxFieldDescription
NxFieldProperties
NxFieldResourceId
NxFieldSelectionInfo
NxFieldSelectionMode
NxFieldTableResourceId
NxFrequencyMode
NxGetBookmarkOptions
NxGetObjectOptions
NxGroupDef
NxGroupMember
NxGroupMemberClass
NxGroupObjectId
NxGroupTail
NxGrpType
NxHighlightRanges
NxHypercubeMode
NxInfo
NxInlineDimensionDef
NxInlineMeasureDef
NxLayoutErrors
NxLibraryDimension
NxLibraryDimensionDef
NxLibraryMeasure
NxLibraryMeasureDef
NxLinkedObjectInfo
NxListObjectExpression
NxListObjectExpressionDef
NxLocalizedErrorCode
NxLocalizedWarningCode
NxLTrendlineType
NxMatchingFieldInfo
NxMatchingFieldMode
NxMeasure
NxMeasureInfo
NxMeta
NxMetaDef
NxMiniChart
NxMiniChartCell
NxMiniChartData
NxMiniChartDef
NxMiniChartRows
NxMultiRangeSelectInfo
NxPage
NxPageTreeLevel
NxPageTreeNode
NxPatch
NxPatches
NxPatchOperationType
NxPivotDimensionCell
NxPivotPage
NxPivotValuePoint
NxRange
NxRangeSelectInfo
NxSelectionCell
NxSelectionCellType
NxSelectionInfo
NxSimpleDimValue
NxSimpleValue
NxSortIndicatorType
NxStackedPivotCell
NxStackPage
NxStateCounts
NxStreamListEntry
NxTempBookmarkOptions
NxTickCell
NxTreeDataOption
NxTreeDimensionDef
NxTreeDimensionInfo
NxTreeMultiRangeSelectInfo
NxTreeNode
NxTreeRangeSelectInfo
NxTreeValue
NxTrendline
NxTrendlineDef
NxTrendlineMode
NxValidationError
NxVariableListItem
NxVariableProperties
NxViewPort
ObjectHelperFunctions
ObjectInterface
ODAGAppLinkListData
ODAGAppLinkListItem
OdbcDsn
OleDbProvider
OpenAppSessionProps
OtherLimitMode
OtherMode
OtherSortMode
OtherTotalSpecProp
Point
PositionMark
ProgressData
ProgressMessage
QFunction
QMediaList
QRange
RangeSelectInfo
Rect
ReloadError
RpcObject
SampleResult
ScriptSyntaxError
ScrollPosition
SearchAssociationResult
SearchAttribute
SearchCharRange
SearchCombinationOptions
SearchContextType
SearchFieldDictionary
SearchFieldMatch
SearchFieldMatchesItem
SearchFieldMatchType
SearchFieldSelectionMode
SearchFieldValueItem
SearchGroup
SearchGroupItem
SearchGroupItemMatch
SearchGroupItemOptions
SearchGroupItemType
SearchGroupOptions
SearchGroupType
SearchMatchCombination
SearchMatchCombinations
SearchObjectOptions
SearchPage
SearchResult
SearchSuggestionResult
SearchSuggestItem
SearchTermResult
SearchValueOptions
SearchValuePage
SearchValueResult
SelectInfo
SelectionObject
SelectionObjectDef
SheetListData
SheetListDataCell
SheetListDataCellBounds
SheetListItem
Size
SortCriteria
SourceKeyRecord
SpecialObjectFunctions
StandardFunctions
StateEnumType
StateFieldValues
StaticContentList
StaticContentListItem
StaticContentUrl
StaticContentUrlDef
StoryListData
StoryListItem
StringExpr
StringExpression
SymbolFrequency
SymbolValue
TableProfilingData
TableRecord
TableRow
TableViewBroomPointSaveInfo
TableViewConnectionPointSaveInfo
TableViewCtlSaveInfo
TableViewDlgSaveInfo
TableViewSaveInfo
TableViewTableWinSaveInfo
TextMacro
TotalMode
TransformAppParameters
TransformAppResult
TreeData
TreeDataDef
UndoInfo
UndoInfoDef
UndoInfoObject
UsageEnum
UseAppHook
ValueExpr
ValueExpression
VariableList
VariableListData
VariableListDef
VariableListItem
WebSocketEvent
WorkloadType
Variables
QIX_SCHEMA_VERSION
Functions
openAppSession
withHostConfig
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Interfaces
Generic
Object
Qix
API
Type Aliases
Alfa
Num
String
Alternate
State
Data
Any
Generic
Object
Layout
Any
Generic
Object
Properties
App
Entry
Apply
Group
States
Result
Apply
Group
State
Warning
Apply
Group
State
Warning
Type
App
Object
List
App
Object
List
Def
App
Script
App
Script
Meta
App
Session
Array
Of
Nx
Value
Point
Association
Score
Blob
BNF
Def
BNF
Def
Meta
Type
BNF
Type
Bookmark
Bookmark
Apply
And
Verify
Result
Bookmark
Field
Item
Bookmark
Field
Page
Bookmark
Field
Page
Ex
Bookmark
Field
Verify
Result
State
Bookmark
Field
Verify
Warning
Bookmark
List
Bookmark
List
Data
Bookmark
List
Def
Bookmark
List
Item
Bookmark
State
Field
Pages
Bookmark
Variable
Item
Calendar
Strings
Char
Encoding
Type
Char
Range
Child
List
Child
List
Def
Close
Props
Code
Page
Combined
Web
Socket
State
Event
Cond
Def
Connection
Content
Library
List
Content
Library
List
Item
Current
Selections
Custom
Connector
Cyclic
Group
Position
Database
Database
Info
Database
Owner
Data
Field
Data
Record
Data
Table
Data
Table
Ex
Delimiter
Info
Derived
Fields
In
Table
Data
Dimension
List
Dimension
List
Data
Dimension
List
Def
Dimension
List
Item
Dimension
Reference
Doc
Doc
Action
Doc
List
Entry
Do
Reload
Ex
Params
Do
Reload
Ex
Result
Drive
Info
Drive
Type
Dynamic
App
View
List
Data
Dynamic
App
View
List
Item
Editor
Breakpoint
Embedded
Snapshot
Embedded
Snapshot
Def
Error
Data
Error
Data
Code
Expanded
Field
List
Item
Expansion
Data
Extended
Layout
Bookmark
Data
Extended
Pivot
State
Data
Extension
List
Extension
List
Def
Failure
Data
Field
Field
Attributes
Field
Attr
Type
Field
Def
Ex
Field
Description
Field
In
Table
Data
Field
In
Table
Profiling
Data
Field
List
Field
List
Def
Field
List
Object
Field
Or
Column
Field
Scores
Field
Type
Field
Value
File
Data
Format
File
Type
Filter
Info
Filter
Type
Folder
Item
Folder
Item
Type
Frequency
Distribution
Data
Function
Group
Generic
Bookmark
Generic
Bookmark
Entry
Generic
Bookmark
Layout
Generic
Bookmark
Properties
Generic
Connect
Machine
Generic
Dimension
Generic
Dimension
Info
Generic
Dimension
Layout
Generic
Dimension
Properties
Generic
List
Object
Generic
Measure
Generic
Measure
Layout
Generic
Measure
Properties
Generic
Object
Entry
Generic
Object
Layout
Generic
Object
Layout
Additional
Properties
Generic
Object
Layout
Node
Generic
Object
Layout
Node
Level2
Generic
Object
Layout
Node
Level3
Generic
Object
Layout
Node
Level4
Generic
Object
Layout
Node
Level5
Generic
Object
Layout
Node
Rec
Generic
Object
Properties
Generic
Object
Properties
Additional
Properties
Generic
Object
Properties
Node
Generic
Object
Properties
Node
Level2
Generic
Object
Properties
Node
Level3
Generic
Object
Properties
Node
Level4
Generic
Object
Properties
Node
Level5
Generic
Object
Properties
Node
Rec
Generic
Variable
Generic
Variable
Constraints
Generic
Variable
Layout
Generic
Variable
Properties
Generic
Variable
Type
Global
Graph
Mode
Group
Bookmark
Data
Group
State
Group
State
Info
Hyper
Cube
Hyper
Cube
Def
Input
Field
Item
Interact
Def
Interact
Type
Inter
Field
Sort
Data
Key
Type
Layout
Bookmark
Data
Layout
Exclude
Layout
Field
Info
Lineage
Info
List
Box
Properties
List
Functions
List
Item
List
Object
List
Object
Def
Locale
Info
Log
On
Type
Master
Object
List
Data
Master
Object
List
Item
Measure
List
Measure
List
Data
Measure
List
Def
Measure
List
Item
Media
List
Def
Media
List
Item
Meta
Data
Modal
Functions
Native
Doc
Functions
Native
Field
Functions
Native
Generic
Bookmark
Functions
Native
Generic
Dimension
Functions
Native
Generic
Measure
Functions
Native
Generic
Object
Functions
Native
Generic
Variable
Functions
Native
Global
Functions
Native
React
Hooks
Native
Variable
Functions
Nx
App
Layout
Nx
App
Properties
Nx
Attr
Dim
Def
Nx
Attr
Dim
Info
Nx
Attr
Expr
Def
Nx
Attr
Expr
Info
Nx
Attribute
Dim
Values
Nx
Attribute
Expression
Values
Nx
Auto
Sort
By
State
Def
Nx
Axis
Data
Nx
Axis
Ticks
Nx
Bookmark
Nx
Calc
Cond
Nx
Cardinalities
Nx
Cell
Nx
Cell
Position
Nx
Cell
Rows
Nx
Container
Entry
Nx
Continuous
Data
Options
Nx
Continuous
Mode
Nx
Continuous
Range
Select
Info
Nx
Current
Selection
Item
Nx
Data
Area
Page
Nx
Data
Page
Nx
Data
Reduction
Mode
Nx
Derived
Field
Nx
Derived
Field
Description
List
Nx
Derived
Fields
Data
Nx
Derived
Group
Nx
Dim
Cell
Type
Nx
Dimension
Nx
Dimension
Info
Nx
Dimension
Type
Nx
Download
Info
Nx
Download
Options
Nx
Engine
Version
Nx
Export
File
Type
Nx
Export
State
Nx
Feature
Nx
Field
Description
Nx
Field
Properties
Nx
Field
Resource
Id
Nx
Field
Selection
Info
Nx
Field
Selection
Mode
Nx
Field
Table
Resource
Id
Nx
Frequency
Mode
Nx
Get
Bookmark
Options
Nx
Get
Object
Options
Nx
Group
Def
Nx
Group
Member
Nx
Group
Member
Class
Nx
Group
Object
Id
Nx
Group
Tail
Nx
Grp
Type
Nx
Highlight
Ranges
Nx
Hypercube
Mode
Nx
Info
Nx
Inline
Dimension
Def
Nx
Inline
Measure
Def
Nx
Layout
Errors
Nx
Library
Dimension
Nx
Library
Dimension
Def
Nx
Library
Measure
Nx
Library
Measure
Def
Nx
Linked
Object
Info
Nx
List
Object
Expression
Nx
List
Object
Expression
Def
Nx
Localized
Error
Code
Nx
Localized
Warning
Code
Nx
L
Trendline
Type
Nx
Matching
Field
Info
Nx
Matching
Field
Mode
Nx
Measure
Nx
Measure
Info
Nx
Meta
Nx
Meta
Def
Nx
Mini
Chart
Nx
Mini
Chart
Cell
Nx
Mini
Chart
Data
Nx
Mini
Chart
Def
Nx
Mini
Chart
Rows
Nx
Multi
Range
Select
Info
Nx
Page
Nx
Page
Tree
Level
Nx
Page
Tree
Node
Nx
Patch
Nx
Patches
Nx
Patch
Operation
Type
Nx
Pivot
Dimension
Cell
Nx
Pivot
Page
Nx
Pivot
Value
Point
Nx
Range
Nx
Range
Select
Info
Nx
Selection
Cell
Nx
Selection
Cell
Type
Nx
Selection
Info
Nx
Simple
Dim
Value
Nx
Simple
Value
Nx
Sort
Indicator
Type
Nx
Stacked
Pivot
Cell
Nx
Stack
Page
Nx
State
Counts
Nx
Stream
List
Entry
Nx
Temp
Bookmark
Options
Nx
Tick
Cell
Nx
Tree
Data
Option
Nx
Tree
Dimension
Def
Nx
Tree
Dimension
Info
Nx
Tree
Multi
Range
Select
Info
Nx
Tree
Node
Nx
Tree
Range
Select
Info
Nx
Tree
Value
Nx
Trendline
Nx
Trendline
Def
Nx
Trendline
Mode
Nx
Validation
Error
Nx
Variable
List
Item
Nx
Variable
Properties
Nx
View
Port
Object
Helper
Functions
Object
Interface
ODAG
App
Link
List
Data
ODAG
App
Link
List
Item
Odbc
Dsn
Ole
Db
Provider
Open
App
Session
Props
Other
Limit
Mode
Other
Mode
Other
Sort
Mode
Other
Total
Spec
Prop
Point
Position
Mark
Progress
Data
Progress
Message
Q
Function
Q
Media
List
Q
Range
Range
Select
Info
Rect
Reload
Error
Rpc
Object
Sample
Result
Script
Syntax
Error
Scroll
Position
Search
Association
Result
Search
Attribute
Search
Char
Range
Search
Combination
Options
Search
Context
Type
Search
Field
Dictionary
Search
Field
Match
Search
Field
Matches
Item
Search
Field
Match
Type
Search
Field
Selection
Mode
Search
Field
Value
Item
Search
Group
Search
Group
Item
Search
Group
Item
Match
Search
Group
Item
Options
Search
Group
Item
Type
Search
Group
Options
Search
Group
Type
Search
Match
Combination
Search
Match
Combinations
Search
Object
Options
Search
Page
Search
Result
Search
Suggestion
Result
Search
Suggest
Item
Search
Term
Result
Search
Value
Options
Search
Value
Page
Search
Value
Result
Select
Info
Selection
Object
Selection
Object
Def
Sheet
List
Data
Sheet
List
Data
Cell
Sheet
List
Data
Cell
Bounds
Sheet
List
Item
Size
Sort
Criteria
Source
Key
Record
Special
Object
Functions
Standard
Functions
State
Enum
Type
State
Field
Values
Static
Content
List
Static
Content
List
Item
Static
Content
Url
Static
Content
Url
Def
Story
List
Data
Story
List
Item
String
Expr
String
Expression
Symbol
Frequency
Symbol
Value
Table
Profiling
Data
Table
Record
Table
Row
Table
View
Broom
Point
Save
Info
Table
View
Connection
Point
Save
Info
Table
View
Ctl
Save
Info
Table
View
Dlg
Save
Info
Table
View
Save
Info
Table
View
Table
Win
Save
Info
Text
Macro
Total
Mode
Transform
App
Parameters
Transform
App
Result
Tree
Data
Tree
Data
Def
Undo
Info
Undo
Info
Def
Undo
Info
Object
Usage
Enum
Use
App
Hook
Value
Expr
Value
Expression
Variable
List
Variable
List
Data
Variable
List
Def
Variable
List
Item
Web
Socket
Event
Workload
Type
Variables
QIX_
SCHEMA_
VERSION
Functions
open
App
Session
with
Host
Config
Embed
Extend
Manage
APIs
Toolkits
@qlik/api reference
Loading...