{ "scriptappy": "1.0.0", "info": { "name": "Sense Client Objects", "description": "Sense Client Objects consists of a collection of properties for defining different types of objects compatible with Qlik Sense Client", "version": "1.4.0", "stability": "stable", "x-qlik-visibility": "public" }, "entries": {}, "definitions": { "appProperties": { "description": "appProperties", "kind": "object", "entries": { "chartAnimations": { "description": "Enable chart animations for all sheet objects Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "disableCellNavMenu": { "description": "Disables the hover menu for all sheet objects Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "Type of the object.\nThis parameter is mandatory. Default:appprops", "optional": true, "defaultValue": "appprops", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" }, "rtl": { "description": "Right to left layout for right-to-left languages Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "sheetLogoPosition": { "description": "Position of the sheet logo. right|left|center", "type": "string" }, "sheetLogoThumbnail": { "kind": "object", "entries": { "qStaticContentUrlDef": { "description": "In addition, this structure can contain dynamic properties.", "kind": "object", "entries": { "qUrl": { "description": "Relative path of the thumbnail.", "type": "string" } } } } }, "sheetTitleBgColor": { "description": "Color of the sheet background. Left side color when using gradient", "type": "string" }, "sheetTitleColor": { "description": "Color of the sheet title text", "type": "string" }, "sheetTitleGradientColor": { "description": "Right side background color when using gradient", "type": "string" }, "theme": { "description": "The theme used across the app Default:horizon", "optional": true, "defaultValue": "horizon", "type": "string" } } }, "appPropertiesList": { "description": "appPropertiesList", "kind": "object", "entries": { "qAppObjectListDef": { "description": "Defines the list of objects in an app.\nAn app object is a generic object created at app level.", "kind": "object", "entries": { "qData": { "description": "Contains dynamic JSON data specified by the client.", "kind": "object", "entries": { "chartAnimations": { "description": "Path to chartAnimations in AppGenericProperties Default:/chartAnimations", "optional": true, "defaultValue": "/chartAnimations", "type": "string" }, "disableCellNavMenu": { "description": "Path to disableCellNavMenu in AppGenericProperties Default:/disableCellNavMenu", "optional": true, "defaultValue": "/disableCellNavMenu", "type": "string" }, "rtl": { "description": "Path to rtl in AppGenericProperties Default:/rtl", "optional": true, "defaultValue": "/rtl", "type": "string" }, "sheetLogoPosition": { "description": "Path to sheetLogoPosition in AppGenericProperties Default:/sheetLogoPosition", "optional": true, "defaultValue": "/sheetLogoPosition", "type": "string" }, "sheetLogoThumbnail": { "description": "Path to sheetLogoThumbnail in AppGenericProperties Default:/sheetLogoThumbnail", "optional": true, "defaultValue": "/sheetLogoThumbnail", "type": "string" }, "sheetTitleBgColor": { "description": "Path to sheetTitleBgColor in AppGenericProperties Default:/sheetTitleBgColor", "optional": true, "defaultValue": "/sheetTitleBgColor", "type": "string" }, "sheetTitleColor": { "description": "Path to sheetTitleColor in AppGenericProperties Default:/sheetTitleColor", "optional": true, "defaultValue": "/sheetTitleColor", "type": "string" }, "sheetTitleGradientColor": { "description": "Path to sheetTitleGradientColor in AppGenericProperties Default:/sheetTitleGradientColor", "optional": true, "defaultValue": "/sheetTitleGradientColor", "type": "string" }, "theme": { "description": "Path to theme in AppGenericProperties Default:/theme", "optional": true, "defaultValue": "/theme", "type": "string" } } }, "qType": { "description": "Object type. Default:appprops", "optional": true, "defaultValue": "appprops", "type": "string" } } }, "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "List object type. Default:AppPropsList", "optional": true, "defaultValue": "AppPropsList", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" } } }, "bookmark": { "description": "bookmark", "kind": "object", "entries": { "creationDate": { "description": "Creation date of the bookmark.", "type": "string" }, "qDistinctValues": { "description": "If true all selected values will be stored distinct, i.e. searchstrings will not be kept. Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qIncludeVariables": { "description": "If true all variables will be stored in the bookmark. Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "Object type. Default:bookmark", "optional": true, "defaultValue": "bookmark", "type": "string" } } }, "qMetaDef": { "description": "The metadata object used by all app objects", "kind": "object", "entries": { "description": { "description": "Short description for the app object", "type": "string" }, "tags": { "description": "Tags for the app object", "kind": "array", "items": { "type": "string" } }, "title": { "description": "Title for the app object", "type": "string" } } }, "selectionFields": { "description": "Fields that have selections made to them.", "type": "string" }, "sheetId": { "description": "Sheet ID of the sheet that the bookmark applies to.", "type": "string" } } }, "bookmarkList": { "description": "Properties for defining list of Bookmarks.", "kind": "object", "entries": { "qBookmarkListDef": { "description": "Defines the list of bookmarks.", "kind": "object", "entries": { "qData": { "description": "Contains dynamic JSON data specified by the client.", "kind": "object", "entries": { "creationDate": { "description": "Path to creationDate in BookmarkProperties Default:/creationDate", "optional": true, "defaultValue": "/creationDate", "type": "string" }, "description": { "description": "Path to description in BookmarkProperties Default:/qMetaDef/description", "optional": true, "defaultValue": "/qMetaDef/description", "type": "string" }, "selectionFields": { "description": "Path to selectionFields in BookmarkProperties Default:/selectionFields", "optional": true, "defaultValue": "/selectionFields", "type": "string" }, "sheetId": { "description": "Path to sheetId in BookmarkProperties Default:/sheetId", "optional": true, "defaultValue": "/sheetId", "type": "string" }, "title": { "description": "Path to title in BookmarkProperties Default:/qMetaDef/title", "optional": true, "defaultValue": "/qMetaDef/title", "type": "string" } } }, "qIncludePatches": { "description": "Include the bookmark patches. Patches can be very large and may make the list result unmanageable.", "type": "boolean" }, "qType": { "description": "Object type. Default:bookmark", "optional": true, "defaultValue": "bookmark", "type": "string" } } }, "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "List object type. Default:BookmarkList", "optional": true, "defaultValue": "BookmarkList", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" } }, "examples": [ "const bookmarkListProps = {\n \"qInfo\": {\n \"qType\": \"BookmarkList\",\n \"qId\": \"\"\n },\n \"qBookmarkListDef\": {\n \"qData\": {\n \"title\": \"/qMetaDef/title\",\n \"description\": \"/qMetaDef/description\",\n \"sheetId\": \"/sheetId\",\n \"selectionFields\": \"/selectionFields\",\n \"creationDate\": \"/creationDate\"\n },\n \"qType\": \"bookmark\",\n \"qIncludePatches\": true\n }\n};\nconst bookmarkList = await doc.createSessionObject(bookmarkListProps).then(list => list.getLayout());" ] }, "currentSelections": { "description": "currentSelections", "kind": "object", "entries": { "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Object id. Default:CurrentSelections", "optional": true, "defaultValue": "CurrentSelections", "type": "string" }, "qType": { "description": "Object type. Default:CurrentSelections", "optional": true, "defaultValue": "CurrentSelections", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qSelectionObjectDef": { "kind": "object", "entries": { "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" } } }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" }, "qType": { "description": "CurrentSelections Object Default:CurrentSelection", "optional": true, "defaultValue": "CurrentSelection", "type": "string" } }, "examples": [ "const currentSelectionsProps = {\n \"qInfo\": {\n \"qType\": \"CurrentSelections\",\n \"qId\": \"CurrentSelections\"\n },\n \"qSelectionObjectDef\": {\n \"qStateName\": \"$\"\n }\n};\nconst currentSelections = await doc.createSessionObject(currentSelectionsProps).then(list => list.getLayout());" ] }, "dimension": { "description": "dimension", "kind": "object", "entries": { "qDim": { "kind": "object", "entries": { "coloring": { "description": "Settings coloring by master dimension.", "kind": "object", "entries": { "baseColor": { "description": "Color information structure. Holds actual color and index in palette.", "kind": "object", "entries": { "color": { "description": "Color as hex string", "type": "string" }, "index": { "description": "Index in palette Default:6", "optional": true, "defaultValue": 6, "type": "integer" } } } } }, "descriptionExpression": { "description": "Properties\nAbbreviated syntax:\n\"qStringExpression\":\"=<expression>\"\nExtended object syntax:\n\"qStringExpression\":{\"qExpr\":\"=<expression>\"}\nWhere:\n< **expression** > is a string\n\nThe \"=\" 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.\nThe result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.", "kind": "object", "entries": { "qExpr": { "type": "string" } } }, "qFieldDefs": { "description": "Array of dimension names.", "kind": "array", "items": { "type": "string" } }, "qFieldLabels": { "description": "Array of dimension labels.", "kind": "array", "items": { "type": "string" } }, "qGrouping": { "description": "One of: N, H, C.", "type": "string" }, "qLabelExpression": { "description": "Name of the dimension as an expression. Only when qGrouping is N.", "type": "string" }, "title": { "description": "Name of the dimension. Used unless label expression is set.", "type": "string" } } }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "Object type. Default:dimension", "optional": true, "defaultValue": "dimension", "type": "string" } } }, "qMetaDef": { "description": "The metadata object used by all app objects", "kind": "object", "entries": { "description": { "description": "Short description for the app object", "type": "string" }, "tags": { "description": "Tags for the app object", "kind": "array", "items": { "type": "string" } }, "title": { "description": "Title for the app object", "type": "string" } } } } }, "dimensionList": { "description": "Properties for defining list of Dimensions.", "kind": "object", "entries": { "qDimensionListDef": { "description": "Defines the lists of dimensions.", "kind": "object", "entries": { "qData": { "description": "Contains dynamic JSON data specified by the client.", "kind": "object", "entries": { "grouping": { "description": "Path to grouping in DimensionProperties Default:/qDim/grouping", "optional": true, "defaultValue": "/qDim/grouping", "type": "string" }, "info": { "description": "Path to qDimInfos in DimensionProperties Default:/qDimInfos", "optional": true, "defaultValue": "/qDimInfos", "type": "string" }, "labelExpression": { "description": "Path to labelExpression in DimensionProperties Default:/qDim/labelExpression", "optional": true, "defaultValue": "/qDim/labelExpression", "type": "string" }, "tags": { "description": "Path to tags in DimensionProperties Default:/qMetaDef/tags", "optional": true, "defaultValue": "/qMetaDef/tags", "type": "string" }, "title": { "description": "Path to title in DimensionProperties Default:/qMetaDef/title", "optional": true, "defaultValue": "/qMetaDef/title", "type": "string" } } }, "qType": { "description": "Object type Default:dimension", "optional": true, "defaultValue": "dimension", "type": "string" } } }, "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "List object type. Default:DimensionList", "optional": true, "defaultValue": "DimensionList", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" } }, "examples": [ "const dimensionListProps = {\n \"qInfo\": {\n \"qType\": \"DimensionList\",\n \"qId\": \"\"\n },\n \"qDimensionListDef\": {\n \"qData\": {\n \"title\": \"/qMetaDef/title\",\n \"tags\": \"/qMetaDef/tags\",\n \"grouping\": \"/qDim/grouping\",\n \"info\": \"/qDimInfos\",\n \"labelExpression\": \"/qDim/labelExpression\"\n },\n \"qType\": \"dimension\"\n }\n};\nconst dimensionList = await doc.createSessionObject(dimensionListProps).then(list => list.getLayout());" ] }, "fieldList": { "description": "fieldList", "kind": "object", "entries": { "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qFieldListDef": { "kind": "object", "entries": { "qShowDefinitionOnly": { "description": "Shows the fields defined on the fly if set to true.\nDefault is false. Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qShowDerivedFields": { "description": "Shows the fields and derived fields if set to true.\nDefault is true. Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "qShowHidden": { "description": "Shows the hidden fields if set to true.\nDefault is false. Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qShowImplicit": { "description": "Shows the Direct Discovery measure fields if set to true.\nDefault is false. Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qShowSemantic": { "description": "Show the semantic fields if set to true.\nDefault is true. Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "qShowSrcTables": { "description": "Shows the tables and fields present in the data model viewer if set to true.\nDefault is true. Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "qShowSystem": { "description": "Shows the system tables if set to true.\nDefault is false. Default:false", "optional": true, "defaultValue": false, "type": "boolean" } } }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Object id. Default:FieldList", "optional": true, "defaultValue": "FieldList", "type": "string" }, "qType": { "description": "Object type. Default:FieldList", "optional": true, "defaultValue": "FieldList", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" }, "qType": { "description": "FieldList Object Default:FieldList", "optional": true, "defaultValue": "FieldList", "type": "string" } }, "examples": [ "const fieldListProps = {\n \"qInfo\": {\n \"qType\": \"FieldList\",\n \"qId\": \"FieldList\"\n },\n \"qFieldListDef\": {\n \"qShowDefinitionOnly\": \"false\",\n \"qShowDerivedFields\": \"true\",\n \"qShowHidden\": \"false\",\n \"qShowImplicit\": \"false\",\n \"qShowSemantic\": \"true\",\n \"qShowSrcTables\": \"true\",\n \"qShowSystem\": \"false\"\n }\n};\nconst fieldList = await doc.createSessionObject(fieldListProps).then(list => list.getLayout());" ] }, "masterobject": { "description": "Base visualizations class with common settings.", "kind": "object", "entries": { "masterVersion": { "description": "Version number. Will default to latest Qlik Sense version if not manually set. Default:0.95", "optional": true, "defaultValue": 0.95, "type": "number" }, "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "Object type. Default:masterobject", "optional": true, "defaultValue": "masterobject", "type": "string" } } }, "qLayoutExclude": { "type": "object" }, "qMetaDef": { "description": "The metadata object used by all app objects", "kind": "object", "entries": { "description": { "description": "Short description for the app object", "type": "string" }, "tags": { "description": "Tags for the app object", "kind": "array", "items": { "type": "string" } }, "title": { "description": "Title for the app object", "type": "string" } } }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" }, "showDetails": { "description": "Show visualization details toggle Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "showTitles": { "description": "Visualization subtitle Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "visualization": { "description": "Visualization type. Must always be set.", "type": "string" } } }, "masterobjectList": { "description": "Properties for defining list of MasterObjects.", "kind": "object", "entries": { "qAppObjectListDef": { "description": "Defines the list of objects in an app.\nAn app object is a generic object created at app level.", "kind": "object", "entries": { "qData": { "description": "Contains dynamic JSON data specified by the client.", "kind": "object", "entries": { "labelExpression": { "description": "Path to labelExpression in MasterObjectProperties Default:/labelExpression", "optional": true, "defaultValue": "/labelExpression", "type": "string" }, "name": { "description": "Path to title in MasterObjectProperties Default:/qMetaDef/title", "optional": true, "defaultValue": "/qMetaDef/title", "type": "string" }, "tags": { "description": "Path to tags in MasterObjectProperties Default:/qMetaDef/tags", "optional": true, "defaultValue": "/qMetaDef/tags", "type": "string" }, "visualization": { "description": "Path to visualization in MasterObjectProperties Default:/visualization", "optional": true, "defaultValue": "/visualization", "type": "string" } } }, "qType": { "description": "Object type Default:masterobject", "optional": true, "defaultValue": "masterobject", "type": "string" } } }, "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "List object type. Default:MasterObjectList", "optional": true, "defaultValue": "MasterObjectList", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" } }, "examples": [ "const masterobjectListProps = {\n \"qInfo\": {\n \"qType\": \"MasterObjectList\",\n \"qId\": \"\"\n },\n \"qAppObjectListDef\": {\n \"qData\": {\n \"name\": \"/qMetaDef/title\",\n \"labelExpression\": \"/labelExpression\",\n \"visualization\": \"/visualization\",\n \"tags\": \"/qMetaDef/tags\"\n },\n \"qType\": \"masterobject\"\n }\n};\nconst masterobjectList = await doc.createSessionObject(masterobjectListProps).then(list => list.getLayout());" ] }, "measure": { "description": "measure", "kind": "object", "entries": { "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "Object type. Default:measure", "optional": true, "defaultValue": "measure", "type": "string" } } }, "qMeasure": { "kind": "object", "entries": { "coloring": { "description": "Settings coloring by master measure.", "kind": "object", "entries": { "baseColor": { "description": "Color information structure. Holds actual color and index in palette.", "kind": "object", "entries": { "color": { "description": "Color as hex string", "type": "string" }, "index": { "description": "Index in palette Default:6", "optional": true, "defaultValue": 6, "type": "integer" } } }, "gradient": { "description": "Color map used in by dimension color modes.", "kind": "object", "entries": { "breakTypes": { "description": "Specifies how to blend in color intersections. Should be of length one less than the number of colors.", "kind": "array", "items": { "type": "boolean" } }, "colors": { "description": "Colors to map against measure values", "kind": "array", "items": { "entries": { "color": { "description": "Color as hex string", "type": "string" }, "index": { "description": "Index in palette Default:6", "optional": true, "defaultValue": 6, "type": "integer" } }, "kind": "object" } }, "limitType": { "description": "percent|absolute Default:percent", "optional": true, "defaultValue": "percent", "type": "string" }, "limits": { "description": "Specifies where to place the color breakpoints. Should be of length one less than the number of colors.", "kind": "array", "items": { "type": "integer" } } } } } }, "descriptionExpression": { "description": "Properties\nAbbreviated syntax:\n\"qStringExpression\":\"=<expression>\"\nExtended object syntax:\n\"qStringExpression\":{\"qExpr\":\"=<expression>\"}\nWhere:\n< **expression** > is a string\n\nThe \"=\" 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.\nThe result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string.", "kind": "object", "entries": { "qExpr": { "type": "string" } } }, "isCustomFormatted": { "description": "Denotes whether the measure has custom formatting applied Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "numFormatFromTemplate": { "description": "Denotes whether the number formatting comes from a template Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qActiveExpression": { "description": "Index to the active expression in a measure.", "type": "integer" }, "qDef": { "description": "Definition of the measure.", "type": "string" }, "qExpressions": { "description": "Array of expressions.", "kind": "array", "items": { "type": "string" } }, "qGrouping": { "description": "One of: N, H, C.", "type": "string" }, "qLabel": { "description": "Name of the Measure", "type": "string" }, "qLabelExpression": { "description": "Optional expression used for dynamic label.", "type": "string" }, "qNumFormat": { "description": "Sets the formatting of a field.\nThe properties of _qFieldAttributes_ and the formatting mechanism are described below.\n\nFormatting mechanism\nThe formatting mechanism depends on the type set in _qType,_ as shown below:\nIn case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.\n\nType is DATE, TIME, TIMESTAMP or INTERVAL\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .\nIf _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).\nThe properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.\n\nType is INTEGER\nThe following applies:\nIf 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_ ).\nIf 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 .\n\nType is REAL\nThe following applies:\nIf 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_ ).\nIf 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.\nIf 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.\nIf 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.\n\nType is FIX\nThe following applies:\nIf 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_ ).\nIf 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.\n\nType is MONEY\nThe following applies:\nIf 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_ ).\nIf no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).\n\nType is ASCII\nNo formatting, _qFmt_ is ignored.", "kind": "object", "entries": { "qDec": { "description": "Defines the decimal separator.\nExample: **.**", "type": "string" }, "qFmt": { "description": "Defines the format pattern that applies to _qText_ .\nIs used in connection to the type of the field (parameter **qType** ).\nFor more information, see _Formatting mechanism_.\nExample: _YYYY-MM-DD_ for a date.", "type": "string" }, "qThou": { "description": "Defines the thousand separator (if any).\nIs used if **qUseThou** is set to 1.\nExample: **,**", "type": "string" }, "qType": { "description": "One of: U, A, I, R, F, M, D, T, TS, IV.", "type": "string" }, "qUseThou": { "description": "Defines whether or not a thousands separator must be used.\nDefault is 0. Default:0", "optional": true, "defaultValue": 0, "type": "integer" }, "qnDec": { "description": "Number of decimals.\nDefault is 10. Default:10", "optional": true, "defaultValue": 10, "type": "integer" } } } } }, "qMetaDef": { "description": "The metadata object used by all app objects", "kind": "object", "entries": { "description": { "description": "Short description for the app object", "type": "string" }, "tags": { "description": "Tags for the app object", "kind": "array", "items": { "type": "string" } }, "title": { "description": "Title for the app object", "type": "string" } } } } }, "measureList": { "description": "Properties for defining list of Measures.", "kind": "object", "entries": { "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "List object type. Default:MeasureList", "optional": true, "defaultValue": "MeasureList", "type": "string" } } }, "qMeasureListDef": { "description": "Defines the list of measures.", "kind": "object", "entries": { "qData": { "description": "Contains dynamic JSON data specified by the client.", "kind": "object", "entries": { "labelExpression": { "description": "Path to labelExpression in MeasureProperties Default:/qMeasure/qLabelExpression", "optional": true, "defaultValue": "/qMeasure/qLabelExpression", "type": "string" }, "tags": { "description": "Path to tags in MeasureProperties Default:/qMetaDef/tags", "optional": true, "defaultValue": "/qMetaDef/tags", "type": "string" }, "title": { "description": "Path to title in MeasureProperties Default:/qMetaDef/title", "optional": true, "defaultValue": "/qMetaDef/title", "type": "string" } } }, "qType": { "description": "Object type Default:measure", "optional": true, "defaultValue": "measure", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" } }, "examples": [ "const measureListProps = {\n \"qInfo\": {\n \"qType\": \"MeasureList\",\n \"qId\": \"\"\n },\n \"qMeasureListDef\": {\n \"qData\": {\n \"title\": \"/qMetaDef/title\",\n \"tags\": \"/qMetaDef/tags\",\n \"labelExpression\": \"/qMeasure/qLabelExpression\"\n },\n \"qType\": \"measure\"\n }\n};\nconst measureList = await doc.createSessionObject(measureListProps).then(list => list.getLayout());" ] }, "sheet": { "description": "sheet", "kind": "object", "entries": { "cells": { "description": "Sheet cells.", "kind": "array", "items": { "entries": { "bounds": { "description": "Cell position and size in % of view", "kind": "object", "entries": { "height": { "description": "height in %, valid numbers are 0 list.getLayout());" ] }, "variable": { "description": "variable", "kind": "object", "entries": { "qComment": { "description": "Comment related to the variable.\nThis parameter is optional.", "type": "string" }, "qDefinition": { "description": "Definition of the variable.", "type": "string" }, "qIncludeInBookmark": { "description": "Set this property to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark.\nThe value of a variable can affect the state of the selections.\nScript variables cannot be persisted in the bookmark.\nThe default value is false. Default:false", "optional": true, "defaultValue": false, "type": "boolean" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "Object type. Default:variable", "optional": true, "defaultValue": "variable", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qName": { "description": "Name of the variable.\nThe name must be unique.\nThis parameter is mandatory.", "type": "string" }, "qNumberPresentation": { "description": "Sets the formatting of a field.\nThe properties of _qFieldAttributes_ and the formatting mechanism are described below.\n\nFormatting mechanism\nThe formatting mechanism depends on the type set in _qType,_ as shown below:\nIn case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.\n\nType is DATE, TIME, TIMESTAMP or INTERVAL\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .\nIf _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).\nThe properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.\n\nType is INTEGER\nThe following applies:\nIf 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_ ).\nIf 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 .\n\nType is REAL\nThe following applies:\nIf 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_ ).\nIf 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.\nIf 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.\nIf 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.\n\nType is FIX\nThe following applies:\nIf 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_ ).\nIf 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.\n\nType is MONEY\nThe following applies:\nIf 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_ ).\nIf no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).\n\nType is ASCII\nNo formatting, _qFmt_ is ignored.", "kind": "object", "entries": { "qDec": { "description": "Defines the decimal separator.\nExample: **.**", "type": "string" }, "qFmt": { "description": "Defines the format pattern that applies to _qText_ .\nIs used in connection to the type of the field (parameter **qType** ).\nFor more information, see _Formatting mechanism_.\nExample: _YYYY-MM-DD_ for a date.", "type": "string" }, "qThou": { "description": "Defines the thousand separator (if any).\nIs used if **qUseThou** is set to 1.\nExample: **,**", "type": "string" }, "qType": { "description": "One of: U, A, I, R, F, M, D, T, TS, IV.", "type": "string" }, "qUseThou": { "description": "Defines whether or not a thousands separator must be used.\nDefault is 0. Default:0", "optional": true, "defaultValue": 0, "type": "integer" }, "qnDec": { "description": "Number of decimals.\nDefault is 10. Default:10", "optional": true, "defaultValue": 10, "type": "integer" } } }, "tags": { "description": "Tags added to the variable. Optional.", "kind": "array", "items": { "type": "string" } } } }, "variableList": { "description": "Properties for defining list of Variables.", "kind": "object", "entries": { "qExtendsId": { "description": "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).\nIf you do not want to link your object, set this parameter to an empty string.", "type": "string" }, "qInfo": { "kind": "object", "entries": { "qId": { "description": "Identifier of the object.\nIf the chosen identifier is already in use, the engine automatically sets another one.\nIf an identifier is not set, the engine automatically sets one.\nThis parameter is optional.", "type": "string" }, "qType": { "description": "List object type. Default:VariableList", "optional": true, "defaultValue": "VariableList", "type": "string" } } }, "qMetaDef": { "description": "Used to collect meta data.\n\nProperties\nSemantic type with an empty structure.", "type": "object" }, "qStateName": { "description": "Name of the alternate state.\nDefault is current selections _$_ . Default:$", "optional": true, "defaultValue": "$", "type": "string" }, "qVariableListDef": { "description": "Defines the list of variables in an app.", "kind": "object", "entries": { "qData": { "description": "Contains dynamic JSON data specified by the client.", "kind": "object", "entries": { "tags": { "description": "Path to tags in VariableProperties Default:/tags", "optional": true, "defaultValue": "/tags", "type": "string" } } }, "qShowConfig": { "description": "Shows the system variables if set to true. Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "qShowReserved": { "description": "Shows the reserved variables if set to true. Default:true", "optional": true, "defaultValue": true, "type": "boolean" }, "qShowSession": { "description": "Shows the session variables if set to true.", "type": "boolean" }, "qType": { "description": "Object type. Default:variable", "optional": true, "defaultValue": "variable", "type": "string" } } } }, "examples": [ "const variableListProps = {\n \"qInfo\": {\n \"qType\": \"VariableList\",\n \"qId\": \"\"\n },\n \"qVariableListDef\": {\n \"qData\": {\n \"tags\": \"/tags\"\n },\n \"qType\": \"variable\",\n \"qShowReserved\": \"true\",\n \"qShowConfig\": \"true\",\n \"qShowSession\": true\n }\n};\nconst variableList = await doc.createSessionObject(variableListProps).then(list => list.getLayout());" ] } } }