/** This is spectacularly generated code by spectacular based on QIX */ import Auth from '../auth/auth.js'; import { RpcSession, EventListener, EventTypes } from '../qlik.js'; export type NxAppPropertiesSheetLogoThumbnail = { /** In addition, this structure can contain dynamic properties. */ qStaticContentUrlDef?: NxAppPropertiesSheetLogoThumbnailQStaticContentUrlDef; [key: string]: any; }; export type NxAppPropertiesSheetLogoThumbnailQStaticContentUrlDef = { /** Relative path of the thumbnail. */ qUrl?: string; [key: string]: any; }; export type AppPropertiesList = { /** Defines the list of objects in an app. An app object is a generic object created at app level. */ qAppObjectListDef?: AppPropertiesListQAppObjectListDef; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** Used to collect meta data. Properties Semantic type with an empty structure. */ qMetaDef?: object; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; [key: string]: any; }; export type AppPropertiesListQAppObjectListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: AppPropertiesListQAppObjectListDefQData; /** Object type. Default:appprops @defaultValue "appprops" */ qType?: string; [key: string]: any; }; export type AppPropertiesListQAppObjectListDefQData = { /** Path to chartAnimations in AppGenericProperties Default:/chartAnimations @defaultValue "/chartAnimations" */ chartAnimations?: string; /** Path to disableCellNavMenu in AppGenericProperties Default:/disableCellNavMenu @defaultValue "/disableCellNavMenu" */ disableCellNavMenu?: string; /** Path to rtl in AppGenericProperties Default:/rtl @defaultValue "/rtl" */ rtl?: string; /** Path to sheetLogoPosition in AppGenericProperties Default:/sheetLogoPosition @defaultValue "/sheetLogoPosition" */ sheetLogoPosition?: string; /** Path to sheetLogoThumbnail in AppGenericProperties Default:/sheetLogoThumbnail @defaultValue "/sheetLogoThumbnail" */ sheetLogoThumbnail?: string; /** Path to sheetTitleBgColor in AppGenericProperties Default:/sheetTitleBgColor @defaultValue "/sheetTitleBgColor" */ sheetTitleBgColor?: string; /** Path to sheetTitleColor in AppGenericProperties Default:/sheetTitleColor @defaultValue "/sheetTitleColor" */ sheetTitleColor?: string; /** Path to sheetTitleGradientColor in AppGenericProperties Default:/sheetTitleGradientColor @defaultValue "/sheetTitleGradientColor" */ sheetTitleGradientColor?: string; /** Path to theme in AppGenericProperties Default:/theme @defaultValue "/theme" */ theme?: string; [key: string]: any; }; export type GenericBookmarkPropertiesQMetaDef = { /** Short description for the app object */ description?: string; /** Tags for the app object */ tags?: Array; /** Title for the app object */ title?: string; [key: string]: any; }; export type BookmarkListQBookmarkListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: BookmarkListQBookmarkListDefQData; /** Include the bookmark patches. Patches can be very large and may make the list result unmanageable. */ qIncludePatches?: boolean; /** Object type. Default:bookmark @defaultValue "bookmark" */ qType?: string; [key: string]: any; }; export type BookmarkListQBookmarkListDefQData = { /** Path to creationDate in BookmarkProperties Default:/creationDate @defaultValue "/creationDate" */ creationDate?: string; /** Path to description in BookmarkProperties Default:/qMetaDef/description @defaultValue "/qMetaDef/description" */ description?: string; /** Path to selectionFields in BookmarkProperties Default:/selectionFields @defaultValue "/selectionFields" */ selectionFields?: string; /** Path to sheetId in BookmarkProperties Default:/sheetId @defaultValue "/sheetId" */ sheetId?: string; /** Path to title in BookmarkProperties Default:/qMetaDef/title @defaultValue "/qMetaDef/title" */ title?: string; [key: string]: any; }; export type GenericCurrentSelectionsProperties = { /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** Used to collect meta data. Properties Semantic type with an empty structure. */ qMetaDef?: object; qSelectionObjectDef?: GenericCurrentSelectionsPropertiesQSelectionObjectDef; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; /** CurrentSelections Object Default:CurrentSelection @defaultValue "CurrentSelection" */ qType?: string; [key: string]: any; }; export type GenericCurrentSelectionsPropertiesQSelectionObjectDef = { /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; [key: string]: any; }; export type GenericDimensionPropertiesQDim = { /** Settings coloring by master dimension. */ coloring?: GenericDimensionPropertiesQDimColoring; /** Properties Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where: < **expression** > is a string The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated. 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. */ descriptionExpression?: GenericDimensionPropertiesQDimDescriptionExpression; /** Array of dimension names. */ qFieldDefs?: Array; /** Array of dimension labels. */ qFieldLabels?: Array; /** One of: N, H, C. */ qGrouping?: string; /** Name of the dimension as an expression. Only when qGrouping is N. */ qLabelExpression?: string; /** Name of the dimension. Used unless label expression is set. */ title?: string; [key: string]: any; }; export type GenericDimensionPropertiesQDimColoring = { /** Color information structure. Holds actual color and index in palette. */ baseColor?: GenericDimensionPropertiesQDimColoringBaseColor; [key: string]: any; }; export type GenericDimensionPropertiesQDimColoringBaseColor = { /** Color as hex string */ color?: string; /** Index in palette Default:6 @defaultValue 6 */ index?: number; [key: string]: any; }; export type GenericDimensionPropertiesQDimDescriptionExpression = { qExpr?: string; [key: string]: any; }; export type GenericDimensionPropertiesQMetaDef = { /** Short description for the app object */ description?: string; /** Tags for the app object */ tags?: Array; /** Title for the app object */ title?: string; [key: string]: any; }; export type DimensionListQDimensionListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: DimensionListQDimensionListDefQData; /** Object type Default:dimension @defaultValue "dimension" */ qType?: string; [key: string]: any; }; export type DimensionListQDimensionListDefQData = { /** Path to grouping in DimensionProperties Default:/qDim/grouping @defaultValue "/qDim/grouping" */ grouping?: string; /** Path to qDimInfos in DimensionProperties Default:/qDimInfos @defaultValue "/qDimInfos" */ info?: string; /** Path to labelExpression in DimensionProperties Default:/qDim/labelExpression @defaultValue "/qDim/labelExpression" */ labelExpression?: string; /** Path to tags in DimensionProperties Default:/qMetaDef/tags @defaultValue "/qMetaDef/tags" */ tags?: string; /** Path to title in DimensionProperties Default:/qMetaDef/title @defaultValue "/qMetaDef/title" */ title?: string; [key: string]: any; }; export type FieldListQFieldListDef = { /** Shows the fields defined on the fly if set to true. Default is false. Default:false */ qShowDefinitionOnly?: boolean; /** Shows the fields and derived fields if set to true. Default is true. Default:true @defaultValue true */ qShowDerivedFields?: boolean; /** Shows the hidden fields if set to true. Default is false. Default:false */ qShowHidden?: boolean; /** Shows the Direct Discovery measure fields if set to true. Default is false. Default:false */ qShowImplicit?: boolean; /** Show the semantic fields if set to true. Default is true. Default:true @defaultValue true */ qShowSemantic?: boolean; /** Shows the tables and fields present in the data model viewer if set to true. Default is true. Default:true @defaultValue true */ qShowSrcTables?: boolean; /** Shows the system tables if set to true. Default is false. Default:false */ qShowSystem?: boolean; [key: string]: any; }; export type GenericMasterobjectProperties = { /** Version number. Will default to latest Qlik Sense version if not manually set. Default:0.95 @defaultValue 0.95 */ masterVersion?: number; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; qLayoutExclude?: object; /** The metadata object used by all app objects */ qMetaDef?: GenericMasterobjectPropertiesQMetaDef; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; /** Show visualization details toggle Default:false */ showDetails?: boolean; /** Visualization subtitle Default:true @defaultValue true */ showTitles?: boolean; /** Visualization type. Must always be set. */ visualization?: string; [key: string]: any; }; export type GenericMasterobjectPropertiesQMetaDef = { /** Short description for the app object */ description?: string; /** Tags for the app object */ tags?: Array; /** Title for the app object */ title?: string; [key: string]: any; }; export type MasterobjectList = { /** Defines the list of objects in an app. An app object is a generic object created at app level. */ qAppObjectListDef?: MasterobjectListQAppObjectListDef; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** Used to collect meta data. Properties Semantic type with an empty structure. */ qMetaDef?: object; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; [key: string]: any; }; export type MasterobjectListQAppObjectListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: MasterobjectListQAppObjectListDefQData; /** Object type Default:masterobject @defaultValue "masterobject" */ qType?: string; [key: string]: any; }; export type MasterobjectListQAppObjectListDefQData = { /** Path to labelExpression in MasterObjectProperties Default:/labelExpression @defaultValue "/labelExpression" */ labelExpression?: string; /** Path to title in MasterObjectProperties Default:/qMetaDef/title @defaultValue "/qMetaDef/title" */ name?: string; /** Path to tags in MasterObjectProperties Default:/qMetaDef/tags @defaultValue "/qMetaDef/tags" */ tags?: string; /** Path to visualization in MasterObjectProperties Default:/visualization @defaultValue "/visualization" */ visualization?: string; [key: string]: any; }; export type GenericMeasurePropertiesQMeasure = { /** Settings coloring by master measure. */ coloring?: GenericMeasurePropertiesQMeasureColoring; /** Properties Abbreviated syntax: "qStringExpression":"=<expression>" Extended object syntax: "qStringExpression":{"qExpr":"=<expression>"} Where: < **expression** > is a string The "=" sign in the string expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated. 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. */ descriptionExpression?: GenericMeasurePropertiesQMeasureDescriptionExpression; /** Denotes whether the measure has custom formatting applied Default:false */ isCustomFormatted?: boolean; /** Denotes whether the number formatting comes from a template Default:false */ numFormatFromTemplate?: boolean; /** Index to the active expression in a measure. */ qActiveExpression?: number; /** Definition of the measure. */ qDef?: string; /** Array of expressions. */ qExpressions?: Array; /** One of: N, H, C. */ qGrouping?: string; /** Name of the Measure */ qLabel?: string; /** Optional expression used for dynamic label. */ qLabelExpression?: string; /** 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: 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. */ qNumFormat?: GenericMeasurePropertiesQMeasureQNumFormat; [key: string]: any; }; export type GenericMeasurePropertiesQMeasureColoring = { /** Color information structure. Holds actual color and index in palette. */ baseColor?: GenericMeasurePropertiesQMeasureColoringBaseColor; /** Color map used in by dimension color modes. */ gradient?: GenericMeasurePropertiesQMeasureColoringGradient; [key: string]: any; }; export type GenericMeasurePropertiesQMeasureColoringBaseColor = { /** Color as hex string */ color?: string; /** Index in palette Default:6 @defaultValue 6 */ index?: number; [key: string]: any; }; export type GenericMeasurePropertiesQMeasureColoringGradient = { /** Specifies how to blend in color intersections. Should be of length one less than the number of colors. */ breakTypes?: Array; /** Colors to map against measure values */ colors?: Array; /** percent|absolute Default:percent @defaultValue "percent" */ limitType?: string; /** Specifies where to place the color breakpoints. Should be of length one less than the number of colors. */ limits?: Array; [key: string]: any; }; export type GenericMeasurePropertiesQMeasureColoringGradientColorsItem = { /** Color as hex string */ color?: string; /** Index in palette Default:6 @defaultValue 6 */ index?: number; [key: string]: any; }; export type GenericMeasurePropertiesQMeasureDescriptionExpression = { qExpr?: string; [key: string]: any; }; export type GenericMeasurePropertiesQMeasureQNumFormat = { /** Defines the decimal separator. Example: **.** */ qDec?: string; /** Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. */ qFmt?: string; /** Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** */ qThou?: string; /** One of: U, A, I, R, F, M, D, T, TS, IV. */ qType?: string; /** Defines whether or not a thousands separator must be used. Default is 0. Default:0 */ qUseThou?: number; /** Number of decimals. Default is 10. Default:10 @defaultValue 10 */ qnDec?: number; [key: string]: any; }; export type GenericMeasurePropertiesQMetaDef = { /** Short description for the app object */ description?: string; /** Tags for the app object */ tags?: Array; /** Title for the app object */ title?: string; [key: string]: any; }; export type MeasureListQMeasureListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: MeasureListQMeasureListDefQData; /** Object type Default:measure @defaultValue "measure" */ qType?: string; [key: string]: any; }; export type MeasureListQMeasureListDefQData = { /** Path to labelExpression in MeasureProperties Default:/qMeasure/qLabelExpression @defaultValue "/qMeasure/qLabelExpression" */ labelExpression?: string; /** Path to tags in MeasureProperties Default:/qMetaDef/tags @defaultValue "/qMetaDef/tags" */ tags?: string; /** Path to title in MeasureProperties Default:/qMetaDef/title @defaultValue "/qMetaDef/title" */ title?: string; [key: string]: any; }; export type GenericSheetProperties = { /** Sheet cells. */ cells?: Array; /** Number of grid columns the sheet consists of. Using anything else than the default setting may cause the Qlik Sense client to malfunction. Default:24 @defaultValue 24 */ columns?: number; /** Sets the number of grid cells: small|medium|large Default:small @defaultValue "small" */ gridResolution?: string; /** Height in percentage. Used in tandem with layoutOptions.sheetMode RESPONSIVE and extended sheets. Can be larger than 100 */ height?: number; layoutOptions?: GenericSheetPropertiesLayoutOptions; /** Height in pixels. Used in tandem with layoutOptions.sheetMode */ pxHeight?: number; /** Width in pixels. Used in tandem with layoutOptions.sheetMode CUSTOM */ pxWidth?: number; qChildListDef?: GenericSheetPropertiesQChildListDef; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** The metadata object used by all app objects */ qMetaDef?: GenericSheetPropertiesQMetaDef; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; /** Sheet rank. The sheet with the lowest rank will be displayed first, so the rank is inverted. Default:1 @defaultValue 1 */ rank?: number; /** Number of grid rows the sheet consists of. Using anything else than the default setting may cause the Qlik Sense client to malfunction. Default:12 @defaultValue 12 */ rows?: number; thumbnail?: GenericSheetPropertiesThumbnail; [key: string]: any; }; export type GenericSheetPropertiesCellsItem = { /** Cell position and size in % of view */ bounds?: GenericSheetPropertiesCellsItemBounds; /** Column position. */ col?: number; /** Number of columns an object should span. */ colspan?: number; /** Id of object. */ name?: string; /** Row position. */ row?: number; /** Number of rows an object should span. */ rowspan?: number; /** Type of object. */ type?: string; [key: string]: any; }; export type GenericSheetPropertiesCellsItemBounds = { /** height in %, valid numbers are 0; /** Title for the app object */ title?: string; [key: string]: any; }; export type GenericSheetPropertiesThumbnail = { /** In addition, this structure can contain dynamic properties. */ qStaticContentUrlDef?: GenericSheetPropertiesThumbnailQStaticContentUrlDef; [key: string]: any; }; export type GenericSheetPropertiesThumbnailQStaticContentUrlDef = { /** Relative path of the thumbnail. */ qUrl?: string; [key: string]: any; }; export type SheetList = { /** Defines the list of objects in an app. An app object is a generic object created at app level. */ qAppObjectListDef?: SheetListQAppObjectListDef; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** Used to collect meta data. Properties Semantic type with an empty structure. */ qMetaDef?: object; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; [key: string]: any; }; export type SheetListQAppObjectListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: SheetListQAppObjectListDefQData; /** Object type. Default:sheet @defaultValue "sheet" */ qType?: string; [key: string]: any; }; export type SheetListQAppObjectListDefQData = { /** Path to cells in SheetProperties Default:/cells @defaultValue "/cells" */ cells?: string; /** Path to columns in SheetProperties Default:/columns @defaultValue "/columns" */ columns?: string; /** Path to description in SheetProperties Default:/qMetaDef/description @defaultValue "/qMetaDef/description" */ description?: string; /** Path to descriptionExpression in SheetProperties Default:/qMetaDef/descriptionExpression @defaultValue "/qMetaDef/descriptionExpression" */ descriptionExpression?: string; /** Path to labelExpression in SheetProperties Default:/labelExpression @defaultValue "/labelExpression" */ labelExpression?: string; /** Path to rank in SheetProperties Default:/rank @defaultValue "/rank" */ rank?: string; /** Path to rows in SheetProperties Default:/rows @defaultValue "/rows" */ rows?: string; /** Path to showCondition in SheetProperties Default:/showCondition @defaultValue "/showCondition" */ showCondition?: string; /** Path to thumbnail in SheetProperties Default:/qMetaDef/thumbnail @defaultValue "/qMetaDef/thumbnail" */ thumbnail?: string; /** Path to title in SheetProperties Default:/qMetaDef/title @defaultValue "/qMetaDef/title" */ title?: string; [key: string]: any; }; export type GenericVariablePropertiesQNumberPresentation = { /** Defines the decimal separator. Example: **.** */ qDec?: string; /** Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date. */ qFmt?: string; /** Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,** */ qThou?: string; /** One of: U, A, I, R, F, M, D, T, TS, IV. */ qType?: string; /** Defines whether or not a thousands separator must be used. Default is 0. Default:0 */ qUseThou?: number; /** Number of decimals. Default is 10. Default:10 @defaultValue 10 */ qnDec?: number; [key: string]: any; }; export type VariableListQVariableListDef = { /** Contains dynamic JSON data specified by the client. */ qData?: VariableListQVariableListDefQData; /** Shows the system variables if set to true. Default:true @defaultValue true */ qShowConfig?: boolean; /** Shows the reserved variables if set to true. Default:true @defaultValue true */ qShowReserved?: boolean; /** Shows the session variables if set to true. */ qShowSession?: boolean; /** Object type. Default:variable @defaultValue "variable" */ qType?: string; [key: string]: any; }; export type VariableListQVariableListDefQData = { /** Path to tags in VariableProperties Default:/tags @defaultValue "/tags" */ tags?: string; [key: string]: any; }; export type AlfaNumString = { /** Is set to true if the value is a numeric. */ qIsNum?: boolean; /** Calculated value. */ qString?: string; [key: string]: any; }; export type AlternateStateData = { /** List of the selections. */ qFieldItems?: Array; /** Name of the alternate state. Default is current selections: $ */ qStateName?: string; [key: string]: any; }; export type AppEntry = { qFileSize?: number; /** If true the app has section access configured. */ qHasSectionAccess?: boolean; /** Identifier of the app. */ qID?: string; /** Last reload time of the app. */ qLastReloadTime?: string; /** Meta data. */ qMeta?: NxMeta; /** Path of the app. */ qPath?: string; /** Is set to true if the app is read-only. */ qReadOnly?: boolean; /** App thumbnail. */ qThumbnail?: StaticContentUrl; /** Title of the app. */ qTitle?: string; [key: string]: any; }; export type AppObjectList = { /** Information about the list of dimensions. */ qItems?: Array; [key: string]: any; }; export type AppObjectListDef = { /** Data that you want to include in the app list definition. You need to enter the paths to the information you want to retrieve. */ qData?: JsonObject; /** Type of the app list. */ qType?: string; [key: string]: any; }; export type AppScript = { /** True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. */ qIsLocked?: boolean; /** Information about publishing and permissions. This parameter is optional. */ qMeta?: NxMeta; /** Script text. */ qScript?: string; [key: string]: any; }; export type AppScriptMeta = { /** True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS. */ qIsLocked?: boolean; /** Information about publishing and permissions. This parameter is optional. */ qMeta?: NxMeta; [key: string]: any; }; export type ArrayOfNxValuePoint = Array; export type AssociationScore = { /** Association information about the field FieldName1 defined in qFieldPairName . */ qField1Scores?: FieldScores; /** Association information about the field FieldName2 defined in qFieldPairName . */ qField2Scores?: FieldScores; /** 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]: . */ qFieldPairName?: string; /** 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. */ qScoreSummary?: number; [key: string]: any; }; export type BNFDef = { /** If set to true, the definition is related to an aggregation function. This parameter is optional. The default value is false. */ qAggrFunc?: boolean; /** 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). */ qBnf?: Array; /** If set to true, the definition specifies a literal token. This parameter is optional. The default value is false. */ qBnfLiteral?: boolean; /** If set to true, the definition specifies a control statement. This parameter is optional. The default value is false. */ qControlStatement?: boolean; /** Indicates whether a script statement, a chart or a script function is deprecated (not recommended for use). If set to true, the script statement or the function is not recommended for use in Qlik Sense. This parameter is optional. The default value is false. */ qDepr?: boolean; /** 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 • DB or FUNC_GROUP_DB_NATIVE */ qFG?: 'FUNC_GROUP_ALL' | 'FUNC_GROUP_UNKNOWN' | 'FUNC_GROUP_NONE' | 'FUNC_GROUP_AGGR' | 'FUNC_GROUP_NUMERIC' | 'FUNC_GROUP_RANGE' | 'FUNC_GROUP_EXPONENTIAL_AND_LOGARITHMIC' | 'FUNC_GROUP_TRIGONOMETRIC_AND_HYPERBOLIC' | 'FUNC_GROUP_FINANCIAL' | 'FUNC_GROUP_MATH_CONSTANT_AND_PARAM_FREE' | 'FUNC_GROUP_COUNTER' | 'FUNC_GROUP_STRING' | 'FUNC_GROUP_MAPPING' | 'FUNC_GROUP_INTER_RECORD' | 'FUNC_GROUP_CONDITIONAL' | 'FUNC_GROUP_LOGICAL' | 'FUNC_GROUP_NULL' | 'FUNC_GROUP_SYSTEM' | 'FUNC_GROUP_FILE' | 'FUNC_GROUP_TABLE' | 'FUNC_GROUP_DATE_AND_TIME' | 'FUNC_GROUP_NUMBER_INTERPRET' | 'FUNC_GROUP_FORMATTING' | 'FUNC_GROUP_COLOR' | 'FUNC_GROUP_RANKING' | 'FUNC_GROUP_GEO' | 'FUNC_GROUP_EXTERNAL' | 'FUNC_GROUP_PROBABILITY' | 'FUNC_GROUP_ARRAY' | 'FUNC_GROUP_LEGACY' | 'FUNC_GROUP_DB_NATIVE' | string; /** List of groups the function belongs to. */ qFGList?: Array; /** If set to true, the definition is related to a field. This parameter is optional. The default value is false. */ qFieldFlag?: boolean; /** 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. */ qHelpId?: number; /** If set to true, a list of related rule tokens is assigned to qBnf . This parameter is optional. The default value is false. */ qIsBnfRule?: boolean; /** 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 */ qMT?: 'NOT_META' | 'META_DOC_NAME' | 'META_RET_TYPE' | 'META_DEFAULT_VALUE' | string; /** Token name. One of: • A rule name • An identifier • A literal value */ qName?: string; /** Number of the current token definition. */ qNbr?: number; /** Number of the parent rule definition. */ qPNbr?: number; /** 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. */ qQvFunc?: boolean; /** If set to true, the definition specifies a script statement. This parameter is optional. The default value is false. */ qScriptStatement?: boolean; /** Literal string of the token. Examples: 'Round' and '('. */ qStr?: string; [key: string]: any; }; export type BNFDefMetaType = { [key: string]: any; }; export type BNFType = { [key: string]: any; }; export type Blob = { [key: string]: any; }; export type Bookmark = { qAlternateStateData?: Array; qApplyAdditive?: boolean; /** @defaultValue true */ qApplyInputFieldValues?: boolean; qApplyLayoutState?: boolean; qFieldItems?: Array; qForAnnotations?: boolean; qGroups?: Array; qId?: string; qIncludeAllVariables?: boolean; qIncludeScrollPosition?: boolean; /** @defaultValue true */ qIncludeSelectionState?: boolean; qInfoText?: string; qInputFieldItems?: Array; qName?: string; qObjects?: Array; qObjectsLayout?: Array; qOwner?: string; qRecallCount?: number; qSheetId?: string; qShow?: CondDef; qShowPopupInfo?: boolean; qUtcModifyTime?: number; qUtcRecallTime?: number; qVariableItems?: Array; [key: string]: any; }; export type BookmarkApplyAndVerifyResult = { /** Apply successfully or not * */ qApplySuccess?: boolean; /** Field values verfication result * */ qWarnings?: Array; [key: string]: any; }; export type BookmarkFieldItem = { /** 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. */ qAndMode?: boolean; /** Name and type of the field. */ qDef?: FieldDefEx; /** List of excluded values. Either the list of selected values or the list of excluded values is displayed. */ qExcludedValues?: Array; /** Indicates if the field is locked. Default is false. */ qLocked?: boolean; /** If set to true, the field has always one selection (not 0 and not more than 1). If another value is selected, the previous one is unselected. The default value is false. This parameter is not returned if set to false. */ qOneAndOnlyOne?: boolean; /** Information on the selections criteria. */ qSelectInfo?: SelectInfo; qValues?: Array; [key: string]: any; }; export type BookmarkFieldPage = { /** The end value of the range. */ qEndIndex?: number; /** The start value of the range. */ qStartIndex?: number; [key: string]: any; }; export type BookmarkFieldVerifyResultState = { [key: string]: any; }; export type BookmarkFieldVerifyWarning = { /** Field Name * */ qField?: string; qMissingValues?: Array; /** Alternate State * */ qState?: string; /** Field/values verfication result * Defines result of ApplyAndVerify. One of: • NOT_VERIFIED • FIELD_VALUE_MATCH_ALL • FIELD_MISSING • FIELD_VALUE_MISSING • STATE_MISSING @defaultValue "NOT_VERIFIED" */ qVerifyResult?: 'NOT_VERIFIED' | 'FIELD_VALUE_MATCH_ALL' | 'FIELD_MISSING' | 'FIELD_VALUE_MISSING' | 'STATE_MISSING' | string; [key: string]: any; }; export type BookmarkList = { /** Information about the list of bookmarks. */ qItems?: Array; /** Defines the list of bookmarks. */ qBookmarkListDef?: BookmarkListQBookmarkListDef; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** Used to collect meta data. Properties Semantic type with an empty structure. */ qMetaDef?: object; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; [key: string]: any; }; export type BookmarkListDef = { /** Data */ qData?: JsonObject; /** Include the bookmark patches. Patches can be very large and may make the list result unmanageable. */ qIncludePatches?: boolean; /** Type of the list. @defaultValue "bookmark" */ qType?: string; [key: string]: any; }; export type BookmarkVariableItem = { /** The Reporting mode definition of the variable. */ qDefinition?: string; /** Name of the variable. */ qName?: string; /** Value of the variable. */ qValue?: FieldValue; [key: string]: any; }; export type CalendarStrings = { /** List of short day names. */ qDayNames?: Array; /** List of long day names. */ qLongDayNames?: Array; /** List of long month names. */ qLongMonthNames?: Array; /** List of short month names. */ qMonthNames?: Array; [key: string]: any; }; export type CharEncodingType = { [key: string]: any; }; export type CharRange = { /** Number of occurrences found. */ qCharCount?: number; /** Position of the first search occurrence. */ qCharPos?: number; [key: string]: any; }; export type CheckExpressionReturn = { qBadFieldNames?: Array; qDangerousFieldNames?: Array; qErrorMsg?: string; [key: string]: any; }; export type CheckNumberOrExpressionReturn = { qBadFieldNames?: Array; qErrorMsg?: string; [key: string]: any; }; export type ChildList = { /** Information about the items in the app object. */ qItems?: Array; [key: string]: any; }; export type ChildListDef = { /** Data that you want to include in the child list definition. You need to enter the paths to the information you want to retrieve. */ qData?: JsonObject; [key: string]: any; }; export type CodePage = { /** Description of the code page. */ qDescription?: string; /** Name of the code page. */ qName?: string; /** Number of the code page. */ qNumber?: number; [key: string]: any; }; export type CondDef = { /** @defaultValue true */ qAlways?: boolean; qExpression?: ValueExpr; [key: string]: any; }; export type Connection = { /** One of: • ODBC CONNECT TO [] • OLEDB CONNECT TO [] • CUSTOM CONNECT TO [] • "" • "" Connection string. This parameter is mandatory and must be set when creating or modifying a connection. */ qConnectionString?: string; /** Identifier of the connection. Is generated by the engine and is unique. */ qId?: string; /** Select which user credentials to use to connect to the source. • LOG_ON_SERVICE_USER: Disables • LOG_ON_CURRENT_USER: Enables One of: • LOG_ON_SERVICE_USER • LOG_ON_CURRENT_USER */ qLogOn?: 'LOG_ON_SERVICE_USER' | 'LOG_ON_CURRENT_USER' | string; /** Information about the connection. */ qMeta?: NxMeta; /** Is generated by the engine. Creation date of the connection or last modification date of the connection. */ qModifiedDate?: string; /** Name of the connection. This parameter is mandatory and must be set when creating or modifying a connection. */ qName?: string; /** Password of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the password. */ qPassword?: string; /** One of: • ODBC • OLEDB • • 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. */ qType?: string; /** Name of the user who creates the connection. This parameter is optional; it is only used for OLEDB, ODBC and CUSTOM connections. A call to GetConnection Method does not return the user name. */ qUserName?: string; [key: string]: any; }; export type ContentLibraryList = { /** Information about the content library. */ qItems?: Array; [key: string]: any; }; export type ContentLibraryListItem = { /** Is set to true if the library is specific to the app (not a global content library). */ qAppSpecific?: boolean; /** Information about publishing and permissions. */ qMeta?: NxMeta; /** Name of the library. */ qName?: string; [key: string]: any; }; export type CreateTemporaryBookmarkReturn = { qId?: string; qReturn?: boolean; [key: string]: any; }; export type CustomConnector = { /** Name of the custom connector as displayed in the Qlik interface. */ qDisplayName?: string; /** Mode of the machine (64 or 32 bits). One of: • CONNECT_DEFAULT • CONNECT_64 • CONNECT_32 */ qMachineMode?: 'CONNECT_DEFAULT' | 'CONNECT_64' | 'CONNECT_32' | string; /** Name of the parent folder that contains the custom connector file. */ qParent?: string; /** Name of the custom connector file. */ qProvider?: string; qSupportFileStreaming?: boolean; [key: string]: any; }; export type DataField = { /** Is set to true if the field is a primary key. */ qIsKey?: boolean; /** Name of the field. */ qName?: string; /** Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file. */ qOriginalFieldName?: string; [key: string]: any; }; export type DataRecord = { /** 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. */ qValues?: Array; [key: string]: any; }; export type DataTable = { /** Name of the table. */ qName?: string; /** Type of the table. For example: Table or View. */ qType?: string; [key: string]: any; }; export type DataTableEx = { /** List of the fields in the table. */ qFields?: Array; /** List of format specification items, within brackets. Examples of specification items: • file type • embedded labels, no labels • table is */ qFormatSpec?: string; /** Name of the table. */ qName?: string; [key: string]: any; }; export type Database = { /** Is set to true if the database is set by default. */ qIsDefault?: boolean; /** Name of the database. */ qName?: string; [key: string]: any; }; export type DatabaseInfo = { /** If set to true, it means that the database is displayed first, before the owners and tables. */ qDBFirst?: boolean; /** Name of the product accessed by the provider. */ qDBMSName?: string; /** Character string used after the database name. Example with separator " . ": FROM LinkedTablesData.dbo.Months Where: • LinkedTablesData is the database name • dbo is the owner name • Months is the table name */ qDBSeparator?: string; /** If set to true, it means that the data source contains some databases. */ qDBUsage?: boolean; /** Name of the default database. */ qDefaultDatabase?: string; /** List of the script keywords. */ qKeywords?: Array; /** 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 */ qOwnerSeparator?: string; /** If set to true, it means that the data source contains some owners. */ qOwnerUsage?: boolean; /** Prefix used with field, database or owner names that contain special characters or keywords. */ qQuotePreffix?: string; /** Suffix used with field, database or owner names that contain special characters or keywords. */ qQuoteSuffix?: string; /** List of the special characters. */ qSpecialChars?: string; [key: string]: any; }; export type DatabaseOwner = { /** Name of the owner. */ qName?: string; [key: string]: any; }; export type DelimiterInfo = { /** Is set to true if multiple spaces are used to separate the values. */ qIsMultiple?: boolean; /** Name of the delimiter. Example: "Tab_DELIMITER" */ qName?: string; /** Delimiter character number used by the engine to determine how to separate the values. */ qNumber?: number; /** Representation of the delimiter value that is used in the script. Example: "'\t'" */ qScriptCode?: string; [key: string]: any; }; export type DerivedFieldsInTableData = { /** Is set to true is the derived field is in use. */ qActive?: boolean; /** Name of the derived definition. */ qDefinitionName?: string; /** List of tags. */ qTags?: Array; [key: string]: any; }; export type DimensionList = { /** Information about the list of dimensions. */ qItems?: Array; /** Defines the lists of dimensions. */ qDimensionListDef?: DimensionListQDimensionListDef; /** 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. */ qExtendsId?: string; qInfo?: NxInfo; /** Used to collect meta data. Properties Semantic type with an empty structure. */ qMetaDef?: object; /** Name of the alternate state. Default is current selections _$_ . Default:$ @defaultValue "$" */ qStateName?: string; [key: string]: any; }; export type DimensionListDef = { /** Data */ qData?: JsonObject; /** Type of the list. */ qType?: string; [key: string]: any; }; export type DoReloadExParams = { /** Set to true to debug reload. The default value is false. */ qDebug?: boolean; /** 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. */ qMode?: number; /** Set to true for partial reload. The default value is false. */ qPartial?: boolean; /** Optional reload ID. ID will be automatically generated if not set. */ qReloadId?: string; /** If greater than or equal 0, defines max number of rows loaded from a data source. @defaultValue -1 */ qRowLimit?: number; /** Set to true to skip Store statements. The default value is false. */ qSkipStore?: boolean; [key: string]: any; }; export type DoReloadExResult = { /** true if memory limits were exhausted during reload. */ qEndedWithMemoryConstraint?: boolean; /** Path to the script log file. */ qScriptLogFile?: string; /** The reload is successful if True. */ qSuccess?: boolean; [key: string]: any; }; /** @param qGenericId - Object ID. @param qGenericType - The type of the object. @param qHandle - The handle used to connect to object. @param qType - The native type of the object. @param auth - Auth object used to make requests */ export declare class Doc { attributes?: any; global: Global; session: RpcSession; auth: Auth; qGenericId?: string; qGenericType?: string; qHandle?: number; qType?: string; [key: string]: any; constructor({ qGenericId, qGenericType, qHandle, qType, ...rest }: { qGenericId?: string; qGenericType?: string; qHandle?: number; qType?: string; }, session?: RpcSession, auth?: Auth); /** Returns a handle to a field. @param qFieldName - Name of the field. @param qStateName - Name of the alternate state. Default state is current selections. */ getField(qFieldName: string, qStateName?: string): Promise; /** Returns the description of a field. @param qFieldName - Name of the field. */ getFieldDescription(qFieldName: string): Promise; /** Returns a handle to a variable. @deprecated @param qName - Name of the variable. */ getVariable(qName: string): Promise; /** Returns a list of table states. The following states apply: • 0 The table is not loosely coupled. • 1 The table is loosely coupled. • 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API. The last three values in the vector are for internal use. In case of circular references, the engine automatically sets the table state to loosely coupled to avoid creating loops. */ getLooselyCoupledVector(): Promise>; /** Sets a list of table states, one for each table. The following states apply: • 0 The table is not loosely coupled. • 1 The table is loosely coupled. • 2 The table is loosely coupled and cannot be changed to another state using the Qlik Engine API. The last three values in the vector are for internal use. @param qv - The list of table states to set. A state will not be changed if already set to 2. */ setLooselyCoupledVector(qv: Array): Promise; /** Evaluates an expression and returns the result as a string. Example: The client sends: ``` { "handle": 1, "method": "Evaluate", "params": { "qExpression": "Sum(Holes)" }, "id": 6, "jsonrpc": "2.0" } ``` The engine returns: ``` { "jsonrpc": "2.0", "id": 6, "result": { "qReturn": "361716" } } ``` @param qExpression - Expression to evaluate. */ evaluate(qExpression: string): Promise; /** Evaluates an expression and returns the result as a dual. Example: The client sends: ``` { "handle": 1, "method": "EvaluateEx", "params": { "qExpression": "Sum(Holes)" }, "id": 7, "jsonrpc": "2.0" } ``` The engine returns: ``` { "jsonrpc": "2.0", "id": 7, "result": { "qReturn": "361716" } } ``` @param qExpression - Expression to evaluate. */ evaluateEx(qExpression: string): Promise; /** Clear selections in fields for current state. Locked fields are not cleared by default. @param qLockedAlso - When true, clears the selection for locked fields. @param qStateName - Alternate state name. When set, applies to alternate state instead of current */ clearAll(qLockedAlso?: boolean, qStateName?: string): Promise