;
};
/**
* Defines the properties of an object group.
*
* Stability: *experimental*
*/
type NxGroupDef = {
/**
* Specifies the class of the group's object members.
*
* One of:
* * bookmark or MEMBER_BOOKMARK
* * object or MEMBER_OBJECT
*/
qClass?: NxGroupMemberClass;
/**
* Specifies the type of the group's object members.
*/
qObjectType?: string;
/**
* Specifies the type of the group's subgroup members.
*/
qGroupType?: string;
/**
* The group's label. Will be evaluated as an expression if it starts with '='.
*/
qLabel?: string;
/**
* Include all groups of the relevant type, by adding those groups last that are not explicitly included in the hierarchy (orphans)
*/
qIncludeOrphanGroups?: boolean;
/**
* The objects and sub-groups that are members of the group.
*/
qMemberIds?: NxGroupObjectId[];
};
type NxGroupMemberClass = "bookmark" | "MEMBER_BOOKMARK" | "object" | "MEMBER_OBJECT";
/**
* Holds the ID of a _NxGroupDef_'s member.
* _GroupId_ holds the ID of a sub-group while _ObjectId_ holds the ID of an object.
* Only one Id should be set. _GroupId_ takes precedence if both are set.
*
* Stability: *experimental*
*/
type NxGroupObjectId = {
qGroupId?: string;
qObjectId?: string;
};
type NxGroupTail = {
/**
* Number of elements that are part of the previous tail.
* This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ .
* Is not shown if the value is 0.
* This parameter is optional.
*/
qUp?: number;
/**
* Number of elements that are part of the next tail.
* This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_
* Is not shown if the value is 0.
* This parameter is optional.
*/
qDown?: number;
};
type NxGrpType = "N" | "GRP_NX_NONE" | "H" | "GRP_NX_HIEARCHY" | "C" | "GRP_NX_COLLECTION";
type NxHighlightRanges = {
/**
* Ranges of highlighted values.
*/
qRanges?: CharRange[];
};
type NxHypercubeMode = "S" | "DATA_MODE_STRAIGHT" | "P" | "DATA_MODE_PIVOT" | "K" | "DATA_MODE_PIVOT_STACK" | "T" | "DATA_MODE_TREE" | "D" | "DATA_MODE_DYNAMIC";
type NxInfo = {
/**
* Identifier of the object.
* If the chosen identifier is already in use, the engine automatically sets another one.
* If an identifier is not set, the engine automatically sets one.
* This parameter is optional.
*/
qId?: string;
/**
* Type of the object.
* This parameter is mandatory.
*/
qType?: string;
};
type NxInlineDimensionDef = {
/**
* Used to define a cyclic group or drill-down group.
* Default value is no grouping.
* This parameter is optional.
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
/**
* Array of field names.
* When creating a grouped dimension, more than one field name is defined.
* This parameter is optional.
*/
qFieldDefs?: string[];
/**
* Array of field labels.
* This parameter is optional.
*/
qFieldLabels?: string[];
/**
* Defines the sorting criteria in the field.
* Default is to sort by alphabetical order, ascending.
* This parameter is optional.
*/
qSortCriterias?: SortCriteria[];
/**
* Defines the format of the value.
* This parameter is optional.
*/
qNumberPresentations?: FieldAttributes[];
/**
* If set to true, it inverts the sort criteria in the field.
*/
qReverseSort?: boolean;
/**
* Index of the active field in a cyclic dimension.
* This parameter is optional. The default value is 0.
* This parameter is used in case of cyclic dimensions ( _qGrouping_ is C).
*/
qActiveField?: number;
/**
* Label expression.
* This parameter is optional.
*/
qLabelExpression?: string;
/**
* Alias of the dimension.
*/
qAlias?: string;
};
type NxInlineMeasureDef = {
/**
* Name of the measure.
* An empty string is returned as a default value.
* This parameter is optional.
*/
qLabel?: string;
/**
* Description of the measure.
* An empty string is returned as a default value.
* This parameter is optional.
*/
qDescription?: string;
/**
* Name connected to the measure that is used for search purposes.
* A measure can have several tags.
* This parameter is optional.
*/
qTags?: string[];
/**
* Default value is no grouping.
* This parameter is optional.
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
/**
* Definition of the expression in the measure.
* Example: _Sum (OrderTotal)_
* This parameter is mandatory.
*/
qDef?: string;
/**
* Format of the field.
* This parameter is optional.
*/
qNumFormat?: FieldAttributes;
/**
* If set to true, percentage values are returned instead of absolute numbers.
* Default value is false.
* This parameter is optional.
*/
qRelative?: boolean;
/**
* If set to true, the sum of rows total should be used rather than real expression total.
* This parameter is optional and applies to straight tables.
* Default value is false.
* If using the Qlik Sense interface, it means that the total mode is set to **Expression Total** .
*/
qBrutalSum?: boolean;
/**
* Flag indicating how the measure should be aggregated to create a grand total.
* "None" - No total calculation.
* "Expr" - Calculate total according to the measure expression.
* "" - Empty string is default and has same effect as "Expr".
* This parameter is optional.
*/
qAggrFunc?: string;
/**
* * 0 means no accumulation
* * 1 means full accumulation (each y-value accumulates all previous y-values of the expression)
* * ≥ 2 means accumulate as many steps as the _qAccumulate_ value
* Default value is 0.
* This parameter is optional.
*/
qAccumulate?: number;
/**
* If set to true, it inverts the sort criteria in the field.
*/
qReverseSort?: boolean;
/**
* Index of the active expression in a cyclic measure. The indexing starts from 0.
* The default value is 0.
* This parameter is optional.
*/
qActiveExpression?: number;
/**
* Array of expressions. This parameter is used in case of cyclic measures ( _qGrouping_ is C). List of the expressions in the cyclic group.
*/
qExpressions?: string[];
/**
* Label expression.
* This parameter is optional.
*/
qLabelExpression?: string;
};
type NxLTrendlineType = "AVERAGE" | "Average" | "LINEAR" | "Linear" | "POLYNOMIAL2" | "Polynomial2" | "POLYNOMIAL3" | "Polynomial3" | "POLYNOMIAL4" | "Polynomial4" | "EXPONENTIAL" | "Exponential" | "POWER" | "Power" | "LOG" | "Logarithmic";
type NxLayoutErrors = {
/**
* Error code.
*/
qErrorCode?: number;
};
type NxLibraryDimension = {
/**
* Information about the grouping.
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
/**
* Array of dimension names.
*/
qFieldDefs?: string[];
/**
* Array of dimension labels.
*/
qFieldLabels?: string[];
qLabelExpression?: string;
/**
* Alias of the dimension.
*/
qAlias?: string;
qScriptGenerated?: boolean;
};
type NxLibraryDimensionDef = {
/**
* Information about the grouping.
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
/**
* Array of dimension names.
*/
qFieldDefs?: string[];
/**
* Array of dimension labels.
*/
qFieldLabels?: string[];
qLabelExpression?: string;
/**
* Alias of the dimension.
*/
qAlias?: string;
qScriptGenerated?: boolean;
};
/**
* Information about the library measure. Is the layout for _NxLibraryMeasureDef_.
*/
type NxLibraryMeasure = {
qLabel?: string;
qDef?: string;
/**
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
qExpressions?: string[];
qActiveExpression?: number;
qLabelExpression?: string;
/**
* Format of the field.
* This parameter is optional.
*/
qNumFormat?: FieldAttributes;
qScriptGenerated?: boolean;
};
type NxLibraryMeasureDef = {
/**
* Label of the measure.
*/
qLabel?: string;
/**
* Definition of the measure.
*/
qDef?: string;
/**
* Used to define a cyclic group or drill-down group.
* Default value is no grouping.
* This parameter is optional.
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
/**
* Array of expressions.
*/
qExpressions?: string[];
/**
* Index to the active expression in a measure.
*/
qActiveExpression?: number;
/**
* Optional expression used for dynamic label.
*/
qLabelExpression?: string;
/**
* Format of the field.
* This parameter is optional.
*/
qNumFormat?: FieldAttributes;
qScriptGenerated?: boolean;
};
type NxLinkedObjectInfo = {
/**
* Identifier of the root object.
* If the linked object is a child, the root identifier is the identifier of the parent.
* If the linked object is an app object, the root identifier is the same than the identifier of the linked object since the linked object is a root object.
*/
qRootId?: string;
/**
* Information about the linked object.
*/
qInfo?: NxInfo;
};
type NxListObjectExpression = {
/**
* Value of the expression.
*/
qExpr?: string;
/**
* Gives information on the error.
* This parameter is optional.
*/
qError?: NxLayoutErrors;
};
type NxListObjectExpressionDef = {
/**
* Value of the expression.
*/
qExpr?: string;
/**
* Refers to an expression stored in the library.
*/
qLibraryId?: string;
};
type NxLocalizedErrorCode = "LOCERR_INTERNAL_ERROR" | "LOCERR_GENERIC_UNKNOWN" | "LOCERR_GENERIC_OK" | "LOCERR_GENERIC_NOT_SET" | "LOCERR_GENERIC_NOT_FOUND" | "LOCERR_GENERIC_ALREADY_EXISTS" | "LOCERR_GENERIC_INVALID_PATH" | "LOCERR_GENERIC_ACCESS_DENIED" | "LOCERR_GENERIC_OUT_OF_MEMORY" | "LOCERR_GENERIC_NOT_INITIALIZED" | "LOCERR_GENERIC_INVALID_PARAMETERS" | "LOCERR_GENERIC_EMPTY_PARAMETERS" | "LOCERR_GENERIC_INTERNAL_ERROR" | "LOCERR_GENERIC_CORRUPT_DATA" | "LOCERR_GENERIC_MEMORY_INCONSISTENCY" | "LOCERR_GENERIC_INVISIBLE_OWNER_ABORT" | "LOCERR_GENERIC_PROHIBIT_VALIDATE" | "LOCERR_GENERIC_ABORTED" | "LOCERR_GENERIC_CONNECTION_LOST" | "LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION" | "LOCERR_GENERIC_REST_CONNECTION_FAILURE" | "LOCERR_GENERIC_MEMORY_LIMIT_REACHED" | "LOCERR_GENERIC_NOT_IMPLEMENTED" | "LOCERR_GENERIC_ENGINE_TERMINATED" | "LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED" | "LOCERR_HTTP_400" | "LOCERR_HTTP_401" | "LOCERR_HTTP_402" | "LOCERR_HTTP_403" | "LOCERR_HTTP_404" | "LOCERR_HTTP_405" | "LOCERR_HTTP_406" | "LOCERR_HTTP_407" | "LOCERR_HTTP_408" | "LOCERR_HTTP_409" | "LOCERR_HTTP_410" | "LOCERR_HTTP_411" | "LOCERR_HTTP_412" | "LOCERR_HTTP_413" | "LOCERR_HTTP_414" | "LOCERR_HTTP_415" | "LOCERR_HTTP_416" | "LOCERR_HTTP_417" | "LOCERR_HTTP_422" | "LOCERR_HTTP_423" | "LOCERR_HTTP_429" | "LOCERR_HTTP_500" | "LOCERR_HTTP_501" | "LOCERR_HTTP_502" | "LOCERR_HTTP_503" | "LOCERR_HTTP_504" | "LOCERR_HTTP_505" | "LOCERR_HTTP_509" | "LOCERR_HTTP_COULD_NOT_RESOLVE_HOST" | "LOCERR_APP_ALREADY_EXISTS" | "LOCERR_APP_INVALID_NAME" | "LOCERR_APP_ALREADY_OPEN" | "LOCERR_APP_NOT_FOUND" | "LOCERR_APP_IMPORT_FAILED" | "LOCERR_APP_SAVE_FAILED" | "LOCERR_APP_CREATE_FAILED" | "LOCERR_APP_INVALID" | "LOCERR_APP_CONNECT_FAILED" | "LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE" | "LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE" | "LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION" | "LOCERR_APP_MIGRATION_FAILURE" | "LOCERR_APP_SCRIPT_MISSING" | "LOCERR_APP_EXPORT_FAILED" | "LOCERR_APP_SIZE_EXCEEDED" | "LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED" | "LOCERR_APP_NOT_OPEN" | "LOCERR_APP_EVENT_SOURCE_TIMEOUT" | "LOCERR_CONNECTION_ALREADY_EXISTS" | "LOCERR_CONNECTION_NOT_FOUND" | "LOCERR_CONNECTION_FAILED_TO_LOAD" | "LOCERR_CONNECTION_FAILED_TO_IMPORT" | "LOCERR_CONNECTION_NAME_IS_INVALID" | "LOCERR_CONNECTION_MISSING_CREDENTIALS" | "LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT" | "LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE" | "LOCERR_FILE_ACCESS_DENIED" | "LOCERR_FILE_NAME_INVALID" | "LOCERR_FILE_CORRUPT" | "LOCERR_FILE_NOT_FOUND" | "LOCERR_FILE_FORMAT_UNSUPPORTED" | "LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE" | "LOCERR_FILE_TABLE_NOT_FOUND" | "LOCERR_USER_ACCESS_DENIED" | "LOCERR_USER_IMPERSONATION_FAILED" | "LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS" | "LOCERR_SERVER_OUT_OF_SESSION_CALS" | "LOCERR_SERVER_OUT_OF_USAGE_CALS" | "LOCERR_SERVER_OUT_OF_CALS" | "LOCERR_SERVER_OUT_OF_NAMED_CALS" | "LOCERR_SERVER_OFF_DUTY" | "LOCERR_SERVER_BUSY" | "LOCERR_SERVER_LICENSE_EXPIRED" | "LOCERR_SERVER_AJAX_DISABLED" | "LOCERR_SERVER_NO_TOKEN" | "LOCERR_HC_INVALID_OBJECT" | "LOCERR_HC_RESULT_TOO_LARGE" | "LOCERR_HC_INVALID_OBJECT_STATE" | "LOCERR_HC_MODAL_OBJECT_ERROR" | "LOCERR_CALC_INVALID_DEF" | "LOCERR_CALC_NOT_IN_LIB" | "LOCERR_CALC_HEAP_ERROR" | "LOCERR_CALC_TOO_LARGE" | "LOCERR_CALC_TIMEOUT" | "LOCERR_CALC_EVAL_CONDITION_FAILED" | "LOCERR_CALC_MIXED_LINKED_AGGREGATION" | "LOCERR_CALC_MISSING_LINKED" | "LOCERR_CALC_INVALID_COL_SORT" | "LOCERR_CALC_PAGES_TOO_LARGE" | "LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED" | "LOCERR_CALC_VALIDATION_STATE_INVALID" | "LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS" | "LOCERR_CALC_MISSING_LINKED_FIELD" | "LOCERR_CALC_NOT_CALCULATED" | "LOCERR_LAYOUT_EXTENDS_INVALID_ID" | "LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND" | "LOCERR_LAYOUT_LINKED_OBJECT_INVALID" | "LOCERR_PERSISTENCE_WRITE_FAILED" | "LOCERR_PERSISTENCE_READ_FAILED" | "LOCERR_PERSISTENCE_DELETE_FAILED" | "LOCERR_PERSISTENCE_NOT_FOUND" | "LOCERR_PERSISTENCE_UNSUPPORTED_VERSION" | "LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY" | "LOCERR_PERSISTENCE_MIGRATION_CANCELLED" | "LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED" | "LOCERR_PERSISTENCE_DISK_FULL" | "LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP" | "LOCERR_PERSISTENCE_MOVE_FAILED" | "LOCERR_PERSISTENCE_OBJECT_LOCKED" | "LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING" | "LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS" | "LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS" | "LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED" | "LOCERR_RELOAD_IN_PROGRESS" | "LOCERR_RELOAD_TABLE_X_NOT_FOUND" | "LOCERR_RELOAD_UNKNOWN_STATEMENT" | "LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_FIELD_X_NOT_FOUND" | "LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND" | "LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND" | "LOCERR_RELOAD_NAME_ALREADY_TAKEN" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED" | "LOCERR_RELOAD_OPEN_FILE_ERROR" | "LOCERR_RELOAD_AUTO_GENERATE_COUNT" | "LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB" | "LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE" | "LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE" | "LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS" | "LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS" | "LOCERR_RELOAD_NO_OPEN_DATABASE" | "LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY" | "LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE" | "LOCERR_RELOAD_ODBC_CONNECT_FAILED" | "LOCERR_RELOAD_OLEDB_CONNECT_FAILED" | "LOCERR_RELOAD_CUSTOM_CONNECT_FAILED" | "LOCERR_RELOAD_ODBC_READ_FAILED" | "LOCERR_RELOAD_OLEDB_READ_FAILED" | "LOCERR_RELOAD_CUSTOM_READ_FAILED" | "LOCERR_RELOAD_BINARY_LOAD_PROHIBITED" | "LOCERR_RELOAD_CONNECTOR_START_FAILED" | "LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING" | "LOCERR_RELOAD_CONNECTOR_REPLY_ERROR" | "LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR" | "LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR" | "LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS" | "LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD" | "LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT" | "LOCERR_PERSONAL_NEW_VERSION_AVAILABLE" | "LOCERR_PERSONAL_VERSION_EXPIRED" | "LOCERR_PERSONAL_SECTION_ACCESS_DETECTED" | "LOCERR_PERSONAL_APP_DELETION_FAILED" | "LOCERR_USER_AUTHENTICATION_FAILURE" | "LOCERR_EXPORT_OUT_OF_MEMORY" | "LOCERR_EXPORT_NO_DATA" | "LOCERR_SYNC_INVALID_OFFSET" | "LOCERR_SEARCH_TIMEOUT" | "LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL" | "LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW" | "LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT" | "LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED" | "LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED" | "LOCERR_SMART_LOAD_TABLE_NOT_FOUND" | "LOCERR_SMART_LOAD_TABLE_DUPLICATED" | "LOCERR_VARIABLE_NO_NAME" | "LOCERR_VARIABLE_DUPLICATE_NAME" | "LOCERR_VARIABLE_INCONSISTENCY" | "LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY" | "LOCERR_VARIABLE_CONSTRAINT_FAILED" | "LOCERR_MEDIA_LIBRARY_LIST_FAILED" | "LOCERR_MEDIA_LIBRARY_CONTENT_FAILED" | "LOCERR_MEDIA_BUNDLING_FAILED" | "LOCERR_MEDIA_UNBUNDLING_FAILED" | "LOCERR_MEDIA_LIBRARY_NOT_FOUND" | "LOCERR_FEATURE_DISABLED" | "LOCERR_LOAD_TOO_MANY_FIELDS" | "LOCERR_LOAD_TOO_MANY_TABLES" | "LOCERR_JSON_RPC_INVALID_REQUEST" | "LOCERR_JSON_RPC_METHOD_NOT_FOUND" | "LOCERR_JSON_RPC_INVALID_PARAMETERS" | "LOCERR_JSON_RPC_INTERNAL_ERROR" | "LOCERR_JSON_RPC_RESPONSE_TOO_LARGE" | "LOCERR_JSON_RPC_PARSE_ERROR" | "LOCERR_MQ_SOCKET_CONNECT_FAILURE" | "LOCERR_MQ_SOCKET_OPEN_FAILURE" | "LOCERR_MQ_PROTOCOL_NO_RESPONE" | "LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION" | "LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED" | "LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED" | "LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR" | "LOCERR_MQ_PROTOCOL_INVALID_STATUS" | "LOCERR_EXTENGINE_GRPC_STATUS_OK" | "LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED" | "LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN" | "LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT" | "LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED" | "LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND" | "LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS" | "LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED" | "LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED" | "LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION" | "LOCERR_EXTENGINE_GRPC_STATUS_ABORTED" | "LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE" | "LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED" | "LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL" | "LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE" | "LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS" | "LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED" | "LOCERR_LXW_INVALID_OBJ" | "LOCERR_LXW_INVALID_FILE" | "LOCERR_LXW_INVALID_SHEET" | "LOCERR_LXW_INVALID_EXPORT_RANGE" | "LOCERR_LXW_ERROR" | "LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED" | "LOCERR_LXW_ERROR_CREATING_XLSX_FILE" | "LOCERR_LXW_ERROR_CREATING_TMPFILE" | "LOCERR_LXW_ERROR_ZIP_FILE_OPERATION" | "LOCERR_LXW_ERROR_ZIP_FILE_ADD" | "LOCERR_LXW_ERROR_ZIP_CLOSE" | "LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED" | "LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED" | "LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED" | "LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND" | "LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE" | "LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED" | "LOCERR_BDI_STATUS_OK" | "LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED" | "LOCERR_TRENDLINE_INVALID_DEF" | "LOCERR_TRENDLINE_INVALID_MATH_ERROR" | "LOCERR_CURL_UNSUPPORTED_PROTOCOL" | "LOCERR_CURL_COULDNT_RESOLVE_PROXY" | "LOCERR_CURL_COULDNT_CONNECT" | "LOCERR_CURL_REMOTE_ACCESS_DENIED" | "LOCERR_CURL_FTP_ACCEPT_FAILED" | "LOCERR_CURL_FTP_ACCEPT_TIMEOUT" | "LOCERR_CURL_FTP_CANT_GET_HOST" | "LOCERR_CURL_PARTIAL_FILE" | "LOCERR_CURL_QUOTE_ERROR" | "LOCERR_CURL_WRITE_ERROR" | "LOCERR_CURL_UPLOAD_FAILED" | "LOCERR_CURL_OUT_OF_MEMORY" | "LOCERR_CURL_OPERATION_TIMEDOUT" | "LOCERR_CURL_FTP_COULDNT_USE_REST" | "LOCERR_CURL_HTTP_POST_ERROR" | "LOCERR_CURL_SSL_CONNECT_ERROR" | "LOCERR_CURL_FILE_COULDNT_READ_FILE" | "LOCERR_CURL_LDAP_CANNOT_BIND" | "LOCERR_CURL_LDAP_SEARCH_FAILED" | "LOCERR_CURL_TOO_MANY_REDIRECTS" | "LOCERR_CURL_PEER_FAILED_VERIFICATION" | "LOCERR_CURL_GOT_NOTHING" | "LOCERR_CURL_SSL_ENGINE_NOTFOUND" | "LOCERR_CURL_SSL_ENGINE_SETFAILED" | "LOCERR_CURL_SSL_CERTPROBLEM" | "LOCERR_CURL_SSL_CIPHER" | "LOCERR_CURL_SSL_CACERT" | "LOCERR_CURL_BAD_CONTENT_ENCODING" | "LOCERR_CURL_LDAP_INVALID_URL" | "LOCERR_CURL_USE_SSL_FAILED" | "LOCERR_CURL_SSL_ENGINE_INITFAILED" | "LOCERR_CURL_LOGIN_DENIED" | "LOCERR_CURL_TFTP_NOTFOUND" | "LOCERR_CURL_TFTP_ILLEGAL" | "LOCERR_CURL_SSH" | "LOCERR_SETEXPRESSION_TOO_LARGE" | "LOCERR_RELOAD_MERGE_LOAD_ERROR" | "LOCERR_WIN_FTP_DROPPED" | "LOCERR_WIN_FTP_NO_PASSIVE_MODE" | "LOCERR_WIN_HTTP_DOWNLEVEL_SERVER" | "LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE" | "LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION" | "LOCERR_WIN_INTERNET_FORCE_RETRY" | "LOCERR_WIN_INTERNET_CANNOT_CONNECT" | "LOCERR_WIN_INTERNET_CONNECTION_ABORTED" | "LOCERR_WIN_INTERNET_CONNECTION_RESET" | "LOCERR_WIN_INTERNET_DISCONNECTED" | "LOCERR_WIN_INTERNET_INCORRECT_FORMAT" | "LOCERR_WIN_INTERNET_INVALID_CA" | "LOCERR_WIN_INTERNET_INVALID_OPERATION" | "LOCERR_WIN_INTERNET_INVALID_URL" | "LOCERR_WIN_INTERNET_ITEM_NOT_FOUND" | "LOCERR_WIN_INTERNET_LOGIN_FAILURE" | "LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED" | "LOCERR_WIN_INTERNET_NEED_UI" | "LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID" | "LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID" | "LOCERR_WIN_INTERNET_SEC_CERT_ERRORS" | "LOCERR_WIN_INTERNET_SEC_INVALID_CERT" | "LOCERR_WIN_INTERNET_SERVER_UNREACHABLE" | "LOCERR_BM_RESULT_TOO_LARGE";
type NxLocalizedWarningCode = "LOCWARN_PERSONAL_RELOAD_REQUIRED" | "LOCWARN_PERSONAL_VERSION_EXPIRES_SOON" | "LOCWARN_EXPORT_DATA_TRUNCATED" | "LOCWARN_COULD_NOT_OPEN_ALL_OBJECTS" | "LOCWARN_SEARCH_INVALID_SEARCHFIELD_DETECTED";
type NxMatchingFieldInfo = {
/**
* Name of the field.
*/
qName?: string;
/**
* List of tags.
*/
qTags?: string[];
};
type NxMatchingFieldMode = "MATCHINGFIELDMODE_MATCH_ALL" | "MATCHINGFIELDMODE_MATCH_ONE";
/**
* Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used.
If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.
A measure that is set in the library can be used by many objects.
* expressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure.
* Attribute expressions do not affect the layout of an object. The sorting order is unchanged.
*
*/
type NxMeasure = {
/**
* Refers to a measure stored in the library.
*/
qLibraryId?: string;
/**
* Refers to a measure stored in the hypercube.
*/
qDef?: NxInlineMeasureDef;
/**
* Defines the sort criteria.
* The default value is sort by ascending alphabetic order.
* This property is optional.
*/
qSortBy?: SortCriteria;
/**
* List of attribute expressions.
*/
qAttributeExpressions?: NxAttrExprDef[];
/**
* List of attribute dimensions.
*/
qAttributeDimensions?: NxAttrDimDef[];
/**
* Specifies a calculation condition, which must be fulfilled for the measure to be calculated.
* If the calculation condition is not met, the measure is excluded from the calculation.
* By default, there is no calculation condition.
* This property is optional.
*/
qCalcCond?: ValueExpr;
/**
* Specifies a calculation condition object.
* If CalcCondition.Cond is not fulfilled, the measure is excluded from the calculation and CalcCondition.Msg is evaluated.
* By default, there is no calculation condition.
* This property is optional.
*/
qCalcCondition?: NxCalcCond;
/**
* Specifies trendlines for this measure.
*/
qTrendLines?: NxTrendlineDef[];
qMiniChartDef?: NxMiniChartDef;
};
/**
* Layout for _NxInlineMeasureDef_.
*/
type NxMeasureInfo = {
/**
* Corresponds to the label of the measure.
* If the label is not defined then the measure name is used.
*/
qFallbackTitle?: string;
/**
* Length of the longest value in the field.
*/
qApprMaxGlyphCount?: number;
/**
* Number of distinct field values.
*/
qCardinal?: number;
/**
* Sort indicator.
* The default value is no sorting.
* This parameter is optional.
*
* One of:
* * N or NX_SORT_INDICATE_NONE
* * A or NX_SORT_INDICATE_ASC
* * D or NX_SORT_INDICATE_DESC
*/
qSortIndicator?: NxSortIndicatorType;
/**
* Format of the field.
* This parameter is optional.
*/
qNumFormat?: FieldAttributes;
/**
* Lowest value in the range.
*/
qMin?: number;
/**
* Highest value in the range.
*/
qMax?: number;
/**
* This parameter is optional.
* Gives information on the error.
*/
qError?: NxValidationError;
/**
* If set to true, it inverts the sort criteria in the field.
*/
qReverseSort?: boolean;
/**
* This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's expression.
*/
qIsAutoFormat?: boolean;
/**
* List of attribute expressions.
*/
qAttrExprInfo?: NxAttrExprInfo[];
/**
* List of attribute dimensions.
*/
qAttrDimInfo?: NxAttrDimInfo[];
/**
* The message displayed if calculation condition is not fulfilled.
*/
qCalcCondMsg?: string;
/**
* Refers to a dimension stored in the library.
*/
qLibraryId?: string;
/**
* Calculated trendlines
*/
qTrendLines?: NxTrendline[];
qMiniChart?: NxMiniChart;
};
/**
* Layout for _NxMetaDef_.
*/
type NxMeta = {
/**
* Name.
* This property is optional.
*/
qName?: string;
};
/**
* Used to collect meta data.
*
* ### Properties
* Semantic type with an empty structure.
*/
type NxMetaDef = object;
type NxMiniChart = {
qYMin?: number;
qYMax?: number;
qXMin?: number;
qXMax?: number;
/**
* List of attribute expressions.
*/
qAttrExprInfo?: NxAttrExprInfo[];
/**
* This parameter is optional and is displayed in case of error.
*/
qError?: NxValidationError;
};
type NxMiniChartCell = {
/**
* Some text.
*/
qText?: string;
/**
* A value.
* This parameter is optional.
*/
qNum?: number;
/**
* Rank number of the value, starting from 0.
* If the element number is a negative number, it means that the returned value is not an element number.
* You can get the following negative values:
* * -1: the cell is a _Total_ cell. It shows a total.
* * -2: the cell is a _Null_ cell.
* * -3: the cell belongs to the group _Others_ .
* * -4: the cell is empty. Applies to pivot tables.
*/
qElemNumber?: number;
/**
* Attribute expressions values.
*/
qAttrExps?: NxAttributeExpressionValues;
};
type NxMiniChartData = {
/**
* Array of data.
*/
qMatrix?: NxMiniChartRows[];
qMin?: number;
qMax?: number;
/**
* This parameter is optional and is displayed in case of error.
*/
qError?: NxValidationError;
};
type NxMiniChartDef = {
/**
* Expression or field name.
*/
qDef?: string;
/**
* LibraryId for dimension.
*/
qLibraryId?: string;
/**
* Sorting.
*/
qSortBy?: SortCriteria;
qOtherTotalSpec?: OtherTotalSpecProp;
qMaxNumberPoints?: number;
/**
* List of attribute expressions.
*/
qAttributeExpressions?: NxAttrExprDef[];
/**
* If set to true, no null values are returned.
*/
qNullSuppression?: boolean;
};
type NxMiniChartRows = NxMiniChartCell[];
type NxMultiRangeSelectInfo = {
qRanges?: NxRangeSelectInfo[];
qColumnsToSelect?: number[];
};
type NxPage = {
/**
* Position from the left.
* Corresponds to the first column.
*/
qLeft?: number;
/**
* Position from the top.
* Corresponds to the first row.
*/
qTop?: number;
/**
* Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ).
*/
qWidth?: number;
/**
* Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ).
*/
qHeight?: number;
};
type NxPageTreeLevel = {
/**
* The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order.
*/
qLeft?: number;
/**
* Number of dimensions to include in the tree.
*/
qDepth?: number;
};
/**
* Defines an area of the tree to be fetched.
*
* Stability: *stable*
*/
type NxPageTreeNode = {
/**
* The area of the tree to be fetched. If no area is defined on a dimension, all existing nodes are included.
*/
qArea?: Rect;
/**
* When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not.
*/
qAllValues?: boolean;
};
type NxPatch = {
/**
* Operation to perform.
*
* One of:
* * add or Add
* * remove or Remove
* * replace or Replace
*/
qOp?: NxPatchOperationType;
/**
* Path to the property to add, remove or replace.
*/
qPath?: string;
/**
* This parameter is not used in a remove operation.
* Corresponds to the value of the property to add or to the new value of the property to update.
* Examples:
* "false", "2", "\"New title\""
*/
qValue?: string;
};
type NxPatchOperationType = "add" | "Add" | "remove" | "Remove" | "replace" | "Replace";
type NxPatches = {
/**
* Identifier and type of the object.
*/
qInfo?: NxInfo;
/**
* Array with patches.
*/
qPatches?: NxPatch[];
/**
* Array with child objects and their patches.
*/
qChildren?: NxPatches[];
};
type NxPivotDimensionCell = {
/**
* Some text.
*/
qText?: string;
/**
* Rank number of the value.
* If set to -1, it means that the value is not an element number.
*/
qElemNo?: number;
/**
* Value of the cell.
* Is set to _NaN_ , if the value is not a number.
*/
qValue?: number;
/**
* If set to true, it means that the cell can be expanded.
* This parameter is not returned if it is set to false.
*/
qCanExpand?: boolean;
/**
* If set to true, it means that the cell can be collapsed.
* This parameter is not returned if it is set to false.
*/
qCanCollapse?: boolean;
/**
* Type of the cell.
*
* One of:
* * V or NX_DIM_CELL_VALUE
* * E or NX_DIM_CELL_EMPTY
* * N or NX_DIM_CELL_NORMAL
* * T or NX_DIM_CELL_TOTAL
* * O or NX_DIM_CELL_OTHER
* * A or NX_DIM_CELL_AGGR
* * P or NX_DIM_CELL_PSEUDO
* * R or NX_DIM_CELL_ROOT
* * U or NX_DIM_CELL_NULL
* * G or NX_DIM_CELL_GENERATED
*/
qType?: NxDimCellType;
/**
* Number of elements that are part of the previous tail.
* This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ .
*/
qUp?: number;
/**
* Number of elements that are part of the next tail.
* This number depends on the paging, more particularly it depends on the values defined in _qTop_ and _qHeight_ .
*/
qDown?: number;
/**
* Information about sub nodes (or sub cells).
* The array is empty _[ ]_ when there is no sub nodes.
*/
qSubNodes?: NxPivotDimensionCell[];
/**
* Information about attribute expressions.
* The array is empty _[ ]_ when there is no attribute expressions.
*/
qAttrExps?: NxAttributeExpressionValues;
/**
* Information about attribute dimensions.
*/
qAttrDims?: NxAttributeDimValues;
};
type NxPivotPage = {
/**
* Information about the left dimension values of a pivot table.
*/
qLeft?: NxPivotDimensionCell[];
/**
* Information about the top dimension values of a pivot table. If there is no top dimension in the pivot table, information about the measures are given.
*/
qTop?: NxPivotDimensionCell[];
/**
* Array of data.
*/
qData?: ArrayOfNxValuePoint[];
/**
* Size and offset of the data in the matrix.
*/
qArea?: Rect;
};
type NxPivotValuePoint = {
/**
* Label of the cell.
* This parameter is optional.
*/
qLabel?: string;
/**
* Some text related to the cell.
*/
qText?: string;
/**
* Value of the cell.
*/
qNum?: number;
/**
* Type of the cell.
*
* One of:
* * V or NX_DIM_CELL_VALUE
* * E or NX_DIM_CELL_EMPTY
* * N or NX_DIM_CELL_NORMAL
* * T or NX_DIM_CELL_TOTAL
* * O or NX_DIM_CELL_OTHER
* * A or NX_DIM_CELL_AGGR
* * P or NX_DIM_CELL_PSEUDO
* * R or NX_DIM_CELL_ROOT
* * U or NX_DIM_CELL_NULL
* * G or NX_DIM_CELL_GENERATED
*/
qType?: NxDimCellType;
/**
* Attribute expressions values.
*/
qAttrExps?: NxAttributeExpressionValues;
qAttrDims?: NxAttributeDimValues;
};
type NxRange = {
/**
* Position in the expression of the first character of the field name.
*/
qFrom?: number;
/**
* Number of characters in the field name.
*/
qCount?: number;
};
type NxRangeSelectInfo = {
/**
* Range of values.
*/
qRange?: QRange;
/**
* Number of the measure to select.
* Numbering starts from 0.
*/
qMeasureIx?: number;
};
type NxSelectionCell = {
/**
* Type of cells to select.
*
* One of:
* * D or NX_CELL_DATA
* * T or NX_CELL_TOP
* * L or NX_CELL_LEFT
*/
qType?: NxSelectionCellType;
/**
* Column index to select.
* Indexing starts from 0.
* If the cell's type is:
* * D, the index is based on the data matrix.
* * T, the index is based on the data matrix.
* * L, the index is based on the left dimensions indexes.
*/
qCol?: number;
/**
* Row index to select.
* Indexing starts from 0.
* If the cell's type is:
* * D, the index is based on the data matrix.
* * T, the index is based on the top dimensions indexes.
* * L, the index is based on the data matrix.
*/
qRow?: number;
};
type NxSelectionCellType = "D" | "NX_CELL_DATA" | "T" | "NX_CELL_TOP" | "L" | "NX_CELL_LEFT";
type NxSelectionInfo = {
/**
* Is set to true if the visualization is in selection mode.
* For more information about the selection mode, see _BeginSelections Method_.
*/
qInSelections?: boolean;
/**
* Is set to true if the visualization is in selection mode and if some selections have been made while in selection mode.
* For more information about the selection mode, see _BeginSelections Method_.
*/
qMadeSelections?: boolean;
};
type NxSimpleDimValue = {
/**
* Text related to the attribute expression value.
* This property is optional. No text is returned if the attribute expression value is a numeric.
*/
qText?: string;
/**
* Element number.
*/
qElemNo?: number;
};
type NxSimpleValue = {
/**
* Text related to the attribute expression value.
*/
qText?: string;
/**
* Numeric value of the attribute expression.
* Set to NaN (Not a Number) if the attribute expression value is not numeric.
*/
qNum?: number;
};
type NxSortIndicatorType = "N" | "NX_SORT_INDICATE_NONE" | "A" | "NX_SORT_INDICATE_ASC" | "D" | "NX_SORT_INDICATE_DESC";
type NxStackPage = {
/**
* Array of data.
*/
qData?: NxStackedPivotCell[];
/**
* Size and offset of the data in the matrix.
*/
qArea?: Rect;
};
type NxStackedPivotCell = {
/**
* Some text.
*/
qText?: string;
/**
* Rank number of the value.
* If set to -1, it means that the value is not an element number.
*/
qElemNo?: number;
/**
* Value of the cell.
* Is set to _NaN_ , if the value is not a number.
*/
qValue?: number;
/**
* If set to true, it means that the cell can be expanded.
* This parameter is not returned if it is set to false.
*/
qCanExpand?: boolean;
/**
* If set to true, it means that the cell can be collapsed.
* This parameter is not returned if it is set to false.
*/
qCanCollapse?: boolean;
/**
* Type of the cell.
*
* One of:
* * V or NX_DIM_CELL_VALUE
* * E or NX_DIM_CELL_EMPTY
* * N or NX_DIM_CELL_NORMAL
* * T or NX_DIM_CELL_TOTAL
* * O or NX_DIM_CELL_OTHER
* * A or NX_DIM_CELL_AGGR
* * P or NX_DIM_CELL_PSEUDO
* * R or NX_DIM_CELL_ROOT
* * U or NX_DIM_CELL_NULL
* * G or NX_DIM_CELL_GENERATED
*/
qType?: NxDimCellType;
/**
* Total of the positive values in the current group of cells.
*/
qMaxPos?: number;
/**
* Total of the negative values in the current group of cells.
*/
qMinNeg?: number;
/**
* Number of elements that are part of the previous tail.
*/
qUp?: number;
/**
* Number of elements that are part of the next tail.
*/
qDown?: number;
/**
* Row index in the data matrix.
* The indexing starts from 0.
*/
qRow?: number;
/**
* Information about sub nodes (or sub cells).
* The array is empty _[ ]_ when there are no sub nodes.
*/
qSubNodes?: NxStackedPivotCell[];
/**
* Attribute expressions values.
*/
qAttrExps?: NxAttributeExpressionValues;
/**
* Attribute dimensions values.
*/
qAttrDims?: NxAttributeDimValues;
};
type NxStateCounts = {
/**
* Number of values in locked state.
*/
qLocked?: number;
/**
* Number of values in selected state.
*/
qSelected?: number;
/**
* Number of values in optional state.
*/
qOption?: number;
/**
* Number of values in deselected state.
*/
qDeselected?: number;
/**
* Number of values in alternative state.
*/
qAlternative?: number;
/**
* Number of values in excluded state.
*/
qExcluded?: number;
/**
* Number of values in selected excluded state.
*/
qSelectedExcluded?: number;
/**
* Number of values in locked excluded state.
*/
qLockedExcluded?: number;
};
/**
* This struct is deprecated (not recommended to use).
*
* @deprecated: This will be removed in a future version
*/
type NxStreamListEntry = {
/**
* Name of the stream.
*/
qName?: string;
/**
* Identifier of the stream.
*/
qId?: string;
};
type NxTempBookmarkOptions = {
/**
* IncludeVariables If true all variables will be stored in the temporary bookmark
*/
qIncludeVariables?: boolean;
/**
* IncludeAllPatches If true all patches will be stored in the temporary bookmark, if false ObjectIdsToPatch will determine what patches to include
*/
qIncludeAllPatches?: boolean;
};
type NxTickCell = {
/**
* Tick's label.
*/
qText?: string;
/**
* Start value.
*/
qStart?: number;
/**
* End value.
*/
qEnd?: number;
};
/**
* Specifies all the paging filters needed to define the tree to be fetched.
*
* Stability: *stable*
*/
type NxTreeDataOption = {
/**
* Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted.
*/
qMaxNbrOfNodes?: number;
/**
* Defines areas of the tree to be fetched. Areas must be defined left to right.
*/
qTreeNodes?: NxPageTreeNode[];
/**
* Filters out complete dimensions from the fetched tree.
*/
qTreeLevels?: NxPageTreeLevel;
};
type NxTreeDimensionDef = {
/**
* Refers to a dimension stored in the library.
*/
qLibraryId?: string;
/**
* Refers to a dimension.
*/
qDef?: NxInlineDimensionDef;
/**
* List of measures.
*/
qValueExprs?: NxMeasure[];
/**
* If set to true, no null values are returned.
*/
qNullSuppression?: boolean;
/**
* Sets the dimension limits. Each dimension of a hypercube is configured separately.
* Defines if some values (grouped as _Others_ ) should be grouped together in the visualization.
* For example in a pie chart all values lower than 200 could be grouped together.
*/
qOtherTotalSpec?: OtherTotalSpecProp;
/**
* If set to true, all dimension values are shown.
*/
qShowAll?: boolean;
/**
* This property is used when some dimension limits are set.
* Label of the _Others_ group. The default label is _Others_ .
* Example:
* _"qOtherLabel":"= <label>"_
* or
* _"qOtherLabel":{"qExpr":"= <label>"}_
* Where:
* * < _label_ > is the label of the _Others_ group.
*/
qOtherLabel?: StringExpr;
/**
* If this property is set, the total of the calculated values is returned.
* The default label is _Total_ .
* Example:
* _"qTotalLabel":"= <label>"_
* or
* _"qTotalLabel":{"qExpr":"= <label>"}_
* Where:
* * < _label_ > is the label of the _Total_ group.
*/
qTotalLabel?: StringExpr;
/**
* Specifies a calculation condition object.
* If CalcCondition.Cond is not fulfilled, the dimension is excluded from the calculation and CalcCondition.Msg is evaluated.
* By default, there is no calculation condition.
* This property is optional.
*/
qCalcCondition?: NxCalcCond;
/**
* List of attribute expressions.
*/
qAttributeExpressions?: NxAttrExprDef[];
/**
* List of attribute dimensions.
*/
qAttributeDimensions?: NxAttrDimDef[];
};
type NxTreeDimensionInfo = {
/**
* Corresponds to the label of the dimension that is selected.
* If the label is not defined then the field name is used.
*/
qFallbackTitle?: string;
/**
* Length of the longest value in the field.
*/
qApprMaxGlyphCount?: number;
/**
* Number of distinct field values.
*
* @deprecated: This will be removed in a future version
*/
qCardinal?: number;
/**
* Is set to true if the field is locked.
*/
qLocked?: boolean;
/**
* Sort indicator.
* The default value is no sorting.
* This parameter is optional.
*
* One of:
* * N or NX_SORT_INDICATE_NONE
* * A or NX_SORT_INDICATE_ASC
* * D or NX_SORT_INDICATE_DESC
*/
qSortIndicator?: NxSortIndicatorType;
/**
* Array of dimension labels.
* Contains the labels of all dimensions in a hierarchy group (for example the labels of all dimensions in a drill down group).
*/
qGroupFallbackTitles?: string[];
/**
* Index of the dimension that is currently in use.
* _qGroupPos_ is set to 0 if there are no hierarchical groups (drill-down groups) or cycle groups.
*/
qGroupPos?: number;
/**
* Number of values in a particular state.
*/
qStateCounts?: NxStateCounts;
/**
* Gives information on a field. For example, it can return the type of the field.
* Examples: key, text, ASCII
*/
qTags?: string[];
/**
* This parameter is optional.
* Gives information on the error.
*/
qError?: NxValidationError;
/**
* Binary format of the field.
*
* One of:
* * D or NX_DIMENSION_TYPE_DISCRETE
* * N or NX_DIMENSION_TYPE_NUMERIC
* * T or NX_DIMENSION_TYPE_TIME
*/
qDimensionType?: NxDimensionType;
/**
* If set to true, it inverts the sort criteria in the field.
*/
qReverseSort?: boolean;
/**
* Defines the grouping.
*
* One of:
* * N or GRP_NX_NONE
* * H or GRP_NX_HIEARCHY
* * C or GRP_NX_COLLECTION
*/
qGrouping?: NxGrpType;
/**
* If set to true, it means that the field is a semantic.
*/
qIsSemantic?: boolean;
/**
* Format of the field.
* This parameter is optional.
*/
qNumFormat?: FieldAttributes;
/**
* This parameter is set to true if _qNumFormat_ is set to _U_ (unknown). The engine guesses the type of the field based on the field's definition.
*/
qIsAutoFormat?: boolean;
/**
* Array of field names.
*/
qGroupFieldDefs?: string[];
/**
* Minimum value.
*/
qMin?: number;
/**
* Maximum value.
*/
qMax?: number;
/**
* Is continuous axis used.
*/
qContinuousAxes?: boolean;
/**
* Is a cyclic dimension used.
*/
qIsCyclic?: boolean;
/**
* Is derived field is used as a dimension.
*/
qDerivedField?: boolean;
/**
* A List of measures to be calculated on this TreeDimension.
*/
qMeasureInfo?: NxMeasureInfo[];
/**
* List of attribute expressions.
*/
qAttrExprInfo?: NxAttrExprInfo[];
/**
* List of attribute dimensions.
*/
qAttrDimInfo?: NxAttrDimInfo[];
/**
* The message displayed if calculation condition is not fulfilled.
*/
qCalcCondMsg?: string;
/**
* True if this is a calculated dimension.
*/
qIsCalculated?: boolean;
/**
* If set to true, it means that the field always has one and only one selected value.
*/
qIsOneAndOnlyOne?: boolean;
/**
* Dimension Cardinalities
*/
qCardinalities?: NxCardinalities;
/**
* Refers to a dimension stored in the library.
*/
qLibraryId?: string;
/**
* The expanded and stripped dimension name used internally in engine.
*
* Stability: *experimental*
*/
qEffectiveDimensionName?: string;
};
type NxTreeMultiRangeSelectInfo = {
/**
* An array of Ranges.
*/
qRanges?: NxTreeRangeSelectInfo[];
};
/**
* Represents a dimension in the tree.
*
* Stability: *stable*
*/
type NxTreeNode = {
/**
* The text version of the value, if available.
*/
qText?: string;
/**
* Value of the cell.
* Is set to _NaN_ , if the value is not a number.
*/
qValue?: number;
/**
* Element number.
*/
qElemNo?: number;
/**
* The position of this node inside it's group in the complete tree, i.e. Not dependant om what part is fetched.
*/
qGroupPos?: number;
/**
* Nbr of nodes connected to this node on the next level of the tree. Not dependant on what part is fetched.
*/
qGroupSize?: number;
/**
* Row index in the data matrix.
* The indexing starts from 0.
*/
qRow?: number;
/**
* Type of the cell.
*
* One of:
* * V or NX_DIM_CELL_VALUE
* * E or NX_DIM_CELL_EMPTY
* * N or NX_DIM_CELL_NORMAL
* * T or NX_DIM_CELL_TOTAL
* * O or NX_DIM_CELL_OTHER
* * A or NX_DIM_CELL_AGGR
* * P or NX_DIM_CELL_PSEUDO
* * R or NX_DIM_CELL_ROOT
* * U or NX_DIM_CELL_NULL
* * G or NX_DIM_CELL_GENERATED
*/
qType?: NxDimCellType;
/**
* The measures for this node.
*/
qValues?: NxTreeValue[];
/**
* The children of this node in the fetched tree structure.
*/
qNodes?: NxTreeNode[];
/**
* Attribute expression values.
*/
qAttrExps?: NxAttributeExpressionValues;
/**
* Attribute dimension values.
*/
qAttrDims?: NxAttributeDimValues;
/**
* Total of the positive values in the current group of cells.
*/
qMaxPos?: number[];
/**
* Total of the negative values in the current group of cells.
*/
qMinNeg?: number[];
/**
* If set to true, it means that the cell can be expanded.
* This parameter is not returned if it is set to false.
*/
qCanExpand?: boolean;
/**
* If set to true, it means that the cell can be collapsed.
* This parameter is not returned if it is set to false.
*/
qCanCollapse?: boolean;
/**
* Selection State of the value.
* The default state for a measure is L(Locked).
*
* One of:
* * L or LOCKED
* * S or SELECTED
* * O or OPTION
* * D or DESELECTED
* * A or ALTERNATIVE
* * X or EXCLUDED
* * XS or EXCL_SELECTED
* * XL or EXCL_LOCKED
* * NSTATES
*/
qState?: StateEnumType;
/**
* The GroupPos of all prior nodes connected to this one, one position for each level of the tree.
* If this node is attached directly to the root, this array is empty.
*/
qTreePath?: number[];
};
type NxTreeRangeSelectInfo = {
/**
* Range of values.
*/
qRange?: QRange;
/**
* Number of the measure to select.
* Numbering starts from 0.
*/
qMeasureIx?: number;
/**
* Number of the dimension to select
* measure from. Numbering starts from 0.
*/
qDimensionIx?: number;
};
/**
* Represents a measure.
*
* Stability: *stable*
*/
type NxTreeValue = {
/**
* The text version of the value, if available.
*/
qText?: string;
/**
* Value of the cell.
* Is set to _NaN_ , if the value is not a number.
*/
qValue?: number;
/**
* Attribute expression values.
*/
qAttrExps?: NxAttributeExpressionValues;
/**
* Attribute dimension values.
*/
qAttrDims?: NxAttributeDimValues;
};
/**
* Information about the calculated trendline.
*
* Stability: *experimental*
*/
type NxTrendline = {
/**
* Type of trendline
*
* One of:
* * AVERAGE or Average
* * LINEAR or Linear
* * POLYNOMIAL2 or Polynomial2
* * POLYNOMIAL3 or Polynomial3
* * POLYNOMIAL4 or Polynomial4
* * EXPONENTIAL or Exponential
* * POWER or Power
* * LOG or Logarithmic
*/
qType?: NxLTrendlineType;
/**
* This parameter is optional and is displayed in case of error.
*/
qError?: NxValidationError;
/**
* Coefficent c0..cN depending on the trendline type.
*/
qCoeff?: number[];
/**
* R2 score. Value between 0..1 that shows the correlation between the trendline and the data. Higher value means higher correlation.
*/
qR2?: number;
/**
* Trendline expression
*/
qExpression?: string;
/**
* Inner Dim elem no
*/
qElemNo?: number;
};
/**
* Trendline input definition
*
* Stability: *experimental*
*/
type NxTrendlineDef = {
/**
* The type of trendline to calculate
*
* One of:
* * AVERAGE or Average
* * LINEAR or Linear
* * POLYNOMIAL2 or Polynomial2
* * POLYNOMIAL3 or Polynomial3
* * POLYNOMIAL4 or Polynomial4
* * EXPONENTIAL or Exponential
* * POWER or Power
* * LOG or Logarithmic
*/
qType?: NxLTrendlineType;
/**
* The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure
*/
qXColIx?: number;
/**
* Set to true to calulatate the R2 score
*/
qCalcR2?: boolean;
/**
* Set if the numerical value of x axis dimension should be used
*
* One of:
* * Never or CONTINUOUS_NEVER
* * Possible or CONTINUOUS_IF_POSSIBLE
* * Time or CONTINUOUS_IF_TIME
*/
qContinuousXAxis?: NxContinuousMode;
/**
* If you have a hypercube with two dimensions and qXColIx refers to a dimension
* This determines if you get one trendline of each value in the other dimension or
* Or trendline based on the sum of the value in the other dimension
* The sum variant is only supported when qXColIx is 0 and qMode (on the hypercube) is K or T
*
* One of:
* * Multi or TRENDLINE_MULTILINE
* * Sum or TRENDLINE_SUM
*/
qMultiDimMode?: NxTrendlineMode;
};
type NxTrendlineMode = "Multi" | "TRENDLINE_MULTILINE" | "Sum" | "TRENDLINE_SUM";
type NxValidationError = {
/**
* Error code.
* This parameter is always displayed in case of error.
*/
qErrorCode?: number;
/**
* Context related to the error, from the user app domain.
* It can be the identifier of an object, a field name, a table name.
* This parameter is optional.
*/
qContext?: string;
/**
* Internal information from the server.
* This parameter is optional.
*/
qExtendedMessage?: string;
};
type NxVariableListItem = {
/**
* Name of the variable.
*/
qName?: string;
/**
* Description of the variable.
*/
qDescription?: string;
/**
* Definition of the variable. It can be a value or an expression.
*/
qDefinition?: string;
/**
* If set to true, it means that the variable is a system variable.
* A system variable provides information about the system and is set by the engine. The content cannot be changed by the user.
* This parameter is optional.
* The default value is false.
*/
qIsConfig?: boolean;
/**
* If set to true, it means that the variable is reserved.
* The default value is false.
* This parameter is optional.
* Examples:
* * _ScriptError_ is a reserved variable, set by the engine.
* * _DayNames_ is a reserved variable, set by the user.
*/
qIsReserved?: boolean;
/**
* Information about publishing and permissions.
* This parameter is optional.
*/
qMeta?: NxMeta;
/**
* Identifier and type of the object.
* This parameter is mandatory.
*/
qInfo?: NxInfo;
/**
* Data.
*/
qData?: QData;
/**
* If set to true, it means that the variable was defined via script.
*/
qIsScriptCreated?: boolean;
};
type NxVariableProperties = {
/**
* Name of the variable.
*/
qName?: string;
/**
* Defines the format of the value of a variable.
*/
qNumberPresentation?: FieldAttributes;
/**
* Set this property to true to update the variable when applying a bookmark.
* The value of a variable can affect the state of the selections.
* The default value is false.
*/
qIncludeInBookmark?: boolean;
/**
* The value of a variable can be an enumeration.
* Set this property to true to reflect the predefined values in an enumeration.
*/
qUsePredefListedValues?: boolean;
/**
* List of enumerations.
* This property is used if _qUsePredefListedValues_ is set to true.
*/
qPreDefinedList?: string[];
};
type NxViewPort = {
/**
* Width of the canvas in pixels.
*/
qWidth?: number;
/**
* Height of the canvas in pixels.
*/
qHeight?: number;
/**
* Zoom level.
*/
qZoomLevel?: number;
};
type ObjectInterface = {
/**
* The native type of the object.
*/
qType?: string;
/**
* The handle used to connect to object.
*/
qHandle?: number;
/**
* The type of the object.
*/
qGenericType?: string;
/**
* Object ID.
*/
qGenericId?: string;
};
type OdbcDsn = {
/**
* Name of the ODBC connection.
*/
qName?: string;
/**
* Description of the ODBC connection.
*/
qDescription?: string;
/**
* Is set to true if the version of ODBC is 32-bit.
* This parameter is optional. Default is false.
*/
qBit32?: boolean;
/**
* Is set to true if the connection is User DSN. The connection works only for a specific user.
* Default is false.
* This parameter is optional.
*/
qUserOnly?: boolean;
};
type OleDbProvider = {
/**
* Name of the OLEDB provider.
*/
qName?: string;
/**
* Description of the OLEDB provider.
*/
qDescription?: string;
/**
* Is set to true if the version of the OLEDB provider is 32-bit.
* Default is false.
* This parameter is optional.
*/
qBit32?: boolean;
};
type OtherLimitMode = "OTHER_GE_LIMIT" | "OTHER_LE_LIMIT" | "OTHER_GT_LIMIT" | "OTHER_LT_LIMIT";
type OtherMode = "OTHER_OFF" | "OTHER_COUNTED" | "OTHER_ABS_LIMITED" | "OTHER_ABS_ACC_TARGET" | "OTHER_REL_LIMITED" | "OTHER_REL_ACC_TARGET";
type OtherSortMode = "OTHER_SORT_DEFAULT" | "OTHER_SORT_DESCENDING" | "OTHER_SORT_ASCENDING";
type OtherTotalSpecProp = {
/**
* Determines how many dimension values are displayed.
* The default value is _OTHER_OFF_ .
*
* One of:
* * OTHER_OFF
* * OTHER_COUNTED
* * OTHER_ABS_LIMITED
* * OTHER_ABS_ACC_TARGET
* * OTHER_REL_LIMITED
* * OTHER_REL_ACC_TARGET
*/
qOtherMode?: OtherMode;
/**
* Number of values to display. The number of values can be entered as a calculated formula.
* This parameter is used when _qOtherMode_ is set to _OTHER_COUNTED_ .
*/
qOtherCounted?: ValueExpr;
/**
* Value used to limit the dimension values. The limit can be entered as a calculated formula.
* This parameter is used when _qOtherMode_ is set to:
* * OTHER_ABS_LIMITED
* * OTHER_REL_LIMITED
* * OTHER_ABS_ACC_TARGET
* OTHER_REL_ACC_TARGET
*/
qOtherLimit?: ValueExpr;
/**
* Sets the limit for the _Others_ mode.
* This parameter is used when _qOtherMode_ is set to:
* * OTHER_ABS_LIMITED
* * OTHER_REL_LIMITED
* * OTHER_ABS_ACC_TARGET
* OTHER_REL_ACC_TARGET
*
* One of:
* * OTHER_GE_LIMIT
* * OTHER_LE_LIMIT
* * OTHER_GT_LIMIT
* * OTHER_LT_LIMIT
*/
qOtherLimitMode?: OtherLimitMode;
/**
* If set to true, the group _Others_ is not displayed as a dimension value.
* The default value is false.
*/
qSuppressOther?: boolean;
/**
* This parameter is used when _qOtherMode_ is set to:
* * OTHER_ABS_LIMITED
* * OTHER_REL_LIMITED
* * OTHER_ABS_ACC_TARGET
* OTHER_REL_ACC_TARGET
*
* and when the dimension values include not numeric values.
* Set this parameter to true to include text values in the returned values.
* The default value is true.
*/
qForceBadValueKeeping?: boolean;
/**
* Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes.
* For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe.
* The default value is true.
*/
qApplyEvenWhenPossiblyWrongResult?: boolean;
/**
* This parameter applies to inner dimensions.
* If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored.
* The default value is false.
*/
qGlobalOtherGrouping?: boolean;
/**
* If set to true, it collapses the inner dimensions (if any) in the group _Others_ .
* The default value is false.
*/
qOtherCollapseInnerDimensions?: boolean;
/**
* Defines the sort order of the dimension values.
* The default value is _OTHER_SORT_DESCENDING_ .
*
* One of:
* * OTHER_SORT_DEFAULT
* * OTHER_SORT_DESCENDING
* * OTHER_SORT_ASCENDING
*/
qOtherSortMode?: OtherSortMode;
/**
* If set to _TOTAL_EXPR_ , the total of the dimension values is returned.
* The default value is _TOTAL_OFF_ .
*
* One of:
* * TOTAL_OFF
* * TOTAL_EXPR
*/
qTotalMode?: TotalMode;
/**
* This parameter applies when there are several measures.
* Name of the measure to use for the calculation of _Others_ for a specific dimension.
*/
qReferencedExpression?: StringExpr;
};
type Point = {
/**
* x-coordinate in pixels.
* The origin is the top left of the screen.
*/
qx?: number;
/**
* y-coordinate in pixels.
* The origin is the top left of the screen.
*/
qy?: number;
};
type PositionMark = {
qDimName?: string;
qElemNo?: number[];
qElemValues?: string[];
};
type ProgressData = {
/**
* True if the request is started.
*/
qStarted?: boolean;
/**
* True if the request is finished.
*/
qFinished?: boolean;
/**
* This property is not used.
*/
qCompleted?: number;
/**
* This property is not used.
*/
qTotal?: number;
/**
* This property is not used.
*/
qKB?: number;
/**
* Request duration in milliseconds.
*/
qMillisecs?: number;
/**
* True when the engine pauses the script execution and waits for a user interaction.
*/
qUserInteractionWanted?: boolean;
/**
* A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source or tell that the app was saved. All persistent progress messages between two *GetProgress* calls are summarized in this string. Contrarily to *qPersistentProgressMessages*, the content of the localized message string is displayed (not its message code).
*/
qPersistentProgress?: string;
/**
* A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two *GetProgress* calls are summarized in this string. Contrarily to *qTransientProgressMessage*, the content of the localized message string is displayed (not its message code).
*/
qTransientProgress?: string;
/**
* Information about the error messages that occur during the script execution.
*/
qErrorData?: ErrorData[];
/**
* List of persistent progress messages.
*/
qPersistentProgressMessages?: ProgressMessage[];
/**
* Transient progress message.
*/
qTransientProgressMessage?: ProgressMessage;
};
type ProgressMessage = {
/**
* Code number to the corresponding localized message string.
*/
qMessageCode?: number;
/**
* Parameters to be inserted in the localized message string.
*/
qMessageParameters?: string[];
};
type QRange = {
/**
* Lowest value in the range
*/
qMin?: number;
/**
* Highest value in the range
*/
qMax?: number;
/**
* If set to true, the range includes the lowest value in the range of selections (Equals to ). [bn(50500)]
* Example:
* The range is [1,10]. If _qMinInclEq_ is set to true it means that 1 is included in the range of selections.
*/
qMinInclEq?: boolean;
/**
* If set to true, the range includes the highest value in the range of selections (Equals to ). [bn(50500)]
* Example:
* The range is [1,10]. If _qMinInclEq_ is set to true it means that 10 is included in the range of selections.
*/
qMaxInclEq?: boolean;
};
type RangeSelectInfo = {
/**
* Lowest value in the range.
*/
qRangeLo?: number;
/**
* Highest value in the range.
*/
qRangeHi?: number;
/**
* Label of the measure.
*/
qMeasure?: string;
};
type Rect = {
/**
* Position from the left.
* Corresponds to the first column.
*/
qLeft?: number;
/**
* Position from the top.
* Corresponds to the first row.
*/
qTop?: number;
/**
* Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ).
*/
qWidth?: number;
/**
* Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ ).
*/
qHeight?: number;
};
type ReloadError = {
/**
* Type of error.
*/
qError?: string;
/**
* Description of error.
*/
qDescription?: string;
/**
* Script line text where error occurred.
*/
qLine?: string;
/**
* Script line number where error occurred.
*/
qLineNumber?: number;
/**
* Error code.
*/
qCode?: number;
/**
* Enum name of the error code.
*
* One of:
* * LOCERR_INTERNAL_ERROR
* * LOCERR_GENERIC_UNKNOWN
* * LOCERR_GENERIC_OK
* * LOCERR_GENERIC_NOT_SET
* * LOCERR_GENERIC_NOT_FOUND
* * LOCERR_GENERIC_ALREADY_EXISTS
* * LOCERR_GENERIC_INVALID_PATH
* * LOCERR_GENERIC_ACCESS_DENIED
* * LOCERR_GENERIC_OUT_OF_MEMORY
* * LOCERR_GENERIC_NOT_INITIALIZED
* * LOCERR_GENERIC_INVALID_PARAMETERS
* * LOCERR_GENERIC_EMPTY_PARAMETERS
* * LOCERR_GENERIC_INTERNAL_ERROR
* * LOCERR_GENERIC_CORRUPT_DATA
* * LOCERR_GENERIC_MEMORY_INCONSISTENCY
* * LOCERR_GENERIC_INVISIBLE_OWNER_ABORT
* * LOCERR_GENERIC_PROHIBIT_VALIDATE
* * LOCERR_GENERIC_ABORTED
* * LOCERR_GENERIC_CONNECTION_LOST
* * LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION
* * LOCERR_GENERIC_REST_CONNECTION_FAILURE
* * LOCERR_GENERIC_MEMORY_LIMIT_REACHED
* * LOCERR_GENERIC_NOT_IMPLEMENTED
* * LOCERR_GENERIC_ENGINE_TERMINATED
* * LOCERR_GENERIC_WRITE_OPERATIONS_LIMIT_REACHED
* * LOCERR_HTTP_400
* * LOCERR_HTTP_401
* * LOCERR_HTTP_402
* * LOCERR_HTTP_403
* * LOCERR_HTTP_404
* * LOCERR_HTTP_405
* * LOCERR_HTTP_406
* * LOCERR_HTTP_407
* * LOCERR_HTTP_408
* * LOCERR_HTTP_409
* * LOCERR_HTTP_410
* * LOCERR_HTTP_411
* * LOCERR_HTTP_412
* * LOCERR_HTTP_413
* * LOCERR_HTTP_414
* * LOCERR_HTTP_415
* * LOCERR_HTTP_416
* * LOCERR_HTTP_417
* * LOCERR_HTTP_422
* * LOCERR_HTTP_423
* * LOCERR_HTTP_429
* * LOCERR_HTTP_500
* * LOCERR_HTTP_501
* * LOCERR_HTTP_502
* * LOCERR_HTTP_503
* * LOCERR_HTTP_504
* * LOCERR_HTTP_505
* * LOCERR_HTTP_509
* * LOCERR_HTTP_COULD_NOT_RESOLVE_HOST
* * LOCERR_APP_ALREADY_EXISTS
* * LOCERR_APP_INVALID_NAME
* * LOCERR_APP_ALREADY_OPEN
* * LOCERR_APP_NOT_FOUND
* * LOCERR_APP_IMPORT_FAILED
* * LOCERR_APP_SAVE_FAILED
* * LOCERR_APP_CREATE_FAILED
* * LOCERR_APP_INVALID
* * LOCERR_APP_CONNECT_FAILED
* * LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE
* * LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE
* * LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION
* * LOCERR_APP_MIGRATION_FAILURE
* * LOCERR_APP_SCRIPT_MISSING
* * LOCERR_APP_EXPORT_FAILED
* * LOCERR_APP_SIZE_EXCEEDED
* * LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED
* * LOCERR_APP_NOT_OPEN
* * LOCERR_APP_EVENT_SOURCE_TIMEOUT
* * LOCERR_CONNECTION_ALREADY_EXISTS
* * LOCERR_CONNECTION_NOT_FOUND
* * LOCERR_CONNECTION_FAILED_TO_LOAD
* * LOCERR_CONNECTION_FAILED_TO_IMPORT
* * LOCERR_CONNECTION_NAME_IS_INVALID
* * LOCERR_CONNECTION_MISSING_CREDENTIALS
* * LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT
* * LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE
* * LOCERR_FILE_ACCESS_DENIED
* * LOCERR_FILE_NAME_INVALID
* * LOCERR_FILE_CORRUPT
* * LOCERR_FILE_NOT_FOUND
* * LOCERR_FILE_FORMAT_UNSUPPORTED
* * LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE
* * LOCERR_FILE_TABLE_NOT_FOUND
* * LOCERR_USER_ACCESS_DENIED
* * LOCERR_USER_IMPERSONATION_FAILED
* * LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS
* * LOCERR_SERVER_OUT_OF_SESSION_CALS
* * LOCERR_SERVER_OUT_OF_USAGE_CALS
* * LOCERR_SERVER_OUT_OF_CALS
* * LOCERR_SERVER_OUT_OF_NAMED_CALS
* * LOCERR_SERVER_OFF_DUTY
* * LOCERR_SERVER_BUSY
* * LOCERR_SERVER_LICENSE_EXPIRED
* * LOCERR_SERVER_AJAX_DISABLED
* * LOCERR_SERVER_NO_TOKEN
* * LOCERR_HC_INVALID_OBJECT
* * LOCERR_HC_RESULT_TOO_LARGE
* * LOCERR_HC_INVALID_OBJECT_STATE
* * LOCERR_HC_MODAL_OBJECT_ERROR
* * LOCERR_CALC_INVALID_DEF
* * LOCERR_CALC_NOT_IN_LIB
* * LOCERR_CALC_HEAP_ERROR
* * LOCERR_CALC_TOO_LARGE
* * LOCERR_CALC_TIMEOUT
* * LOCERR_CALC_EVAL_CONDITION_FAILED
* * LOCERR_CALC_MIXED_LINKED_AGGREGATION
* * LOCERR_CALC_MISSING_LINKED
* * LOCERR_CALC_INVALID_COL_SORT
* * LOCERR_CALC_PAGES_TOO_LARGE
* * LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED
* * LOCERR_CALC_VALIDATION_STATE_INVALID
* * LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS
* * LOCERR_CALC_MISSING_LINKED_FIELD
* * LOCERR_CALC_NOT_CALCULATED
* * LOCERR_LAYOUT_EXTENDS_INVALID_ID
* * LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND
* * LOCERR_LAYOUT_LINKED_OBJECT_INVALID
* * LOCERR_PERSISTENCE_WRITE_FAILED
* * LOCERR_PERSISTENCE_READ_FAILED
* * LOCERR_PERSISTENCE_DELETE_FAILED
* * LOCERR_PERSISTENCE_NOT_FOUND
* * LOCERR_PERSISTENCE_UNSUPPORTED_VERSION
* * LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY
* * LOCERR_PERSISTENCE_MIGRATION_CANCELLED
* * LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED
* * LOCERR_PERSISTENCE_DISK_FULL
* * LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP
* * LOCERR_PERSISTENCE_MOVE_FAILED
* * LOCERR_PERSISTENCE_OBJECT_LOCKED
* * LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING
* * LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS
* * LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS
* * LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED
* * LOCERR_RELOAD_IN_PROGRESS
* * LOCERR_RELOAD_TABLE_X_NOT_FOUND
* * LOCERR_RELOAD_UNKNOWN_STATEMENT
* * LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN
* * LOCERR_RELOAD_FIELD_X_NOT_FOUND
* * LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND
* * LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND
* * LOCERR_RELOAD_NAME_ALREADY_TAKEN
* * LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF
* * LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF
* * LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED
* * LOCERR_RELOAD_OPEN_FILE_ERROR
* * LOCERR_RELOAD_AUTO_GENERATE_COUNT
* * LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB
* * LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR
* * LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND
* * LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID
* * LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE
* * LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE
* * LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS
* * LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS
* * LOCERR_RELOAD_NO_OPEN_DATABASE
* * LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY
* * LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE
* * LOCERR_RELOAD_ODBC_CONNECT_FAILED
* * LOCERR_RELOAD_OLEDB_CONNECT_FAILED
* * LOCERR_RELOAD_CUSTOM_CONNECT_FAILED
* * LOCERR_RELOAD_ODBC_READ_FAILED
* * LOCERR_RELOAD_OLEDB_READ_FAILED
* * LOCERR_RELOAD_CUSTOM_READ_FAILED
* * LOCERR_RELOAD_BINARY_LOAD_PROHIBITED
* * LOCERR_RELOAD_CONNECTOR_START_FAILED
* * LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING
* * LOCERR_RELOAD_CONNECTOR_REPLY_ERROR
* * LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR
* * LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR
* * LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS
* * LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE
* * LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD
* * LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT
* * LOCERR_PERSONAL_NEW_VERSION_AVAILABLE
* * LOCERR_PERSONAL_VERSION_EXPIRED
* * LOCERR_PERSONAL_SECTION_ACCESS_DETECTED
* * LOCERR_PERSONAL_APP_DELETION_FAILED
* * LOCERR_USER_AUTHENTICATION_FAILURE
* * LOCERR_EXPORT_OUT_OF_MEMORY
* * LOCERR_EXPORT_NO_DATA
* * LOCERR_SYNC_INVALID_OFFSET
* * LOCERR_SEARCH_TIMEOUT
* * LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL
* * LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW
* * LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT
* * LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED
* * LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED
* * LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED
* * LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED
* * LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED
* * LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED
* * LOCERR_SMART_LOAD_TABLE_NOT_FOUND
* * LOCERR_SMART_LOAD_TABLE_DUPLICATED
* * LOCERR_VARIABLE_NO_NAME
* * LOCERR_VARIABLE_DUPLICATE_NAME
* * LOCERR_VARIABLE_INCONSISTENCY
* * LOCERR_VARIABLE_CONSTRAINT_INCONSISTENCY
* * LOCERR_VARIABLE_CONSTRAINT_FAILED
* * LOCERR_MEDIA_LIBRARY_LIST_FAILED
* * LOCERR_MEDIA_LIBRARY_CONTENT_FAILED
* * LOCERR_MEDIA_BUNDLING_FAILED
* * LOCERR_MEDIA_UNBUNDLING_FAILED
* * LOCERR_MEDIA_LIBRARY_NOT_FOUND
* * LOCERR_FEATURE_DISABLED
* * LOCERR_LOAD_TOO_MANY_FIELDS
* * LOCERR_LOAD_TOO_MANY_TABLES
* * LOCERR_JSON_RPC_INVALID_REQUEST
* * LOCERR_JSON_RPC_METHOD_NOT_FOUND
* * LOCERR_JSON_RPC_INVALID_PARAMETERS
* * LOCERR_JSON_RPC_INTERNAL_ERROR
* * LOCERR_JSON_RPC_RESPONSE_TOO_LARGE
* * LOCERR_JSON_RPC_PARSE_ERROR
* * LOCERR_MQ_SOCKET_CONNECT_FAILURE
* * LOCERR_MQ_SOCKET_OPEN_FAILURE
* * LOCERR_MQ_PROTOCOL_NO_RESPONE
* * LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION
* * LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED
* * LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED
* * LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR
* * LOCERR_MQ_PROTOCOL_INVALID_STATUS
* * LOCERR_EXTENGINE_GRPC_STATUS_OK
* * LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED
* * LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN
* * LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT
* * LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED
* * LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND
* * LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS
* * LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED
* * LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED
* * LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION
* * LOCERR_EXTENGINE_GRPC_STATUS_ABORTED
* * LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE
* * LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED
* * LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL
* * LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE
* * LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS
* * LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED
* * LOCERR_LXW_INVALID_OBJ
* * LOCERR_LXW_INVALID_FILE
* * LOCERR_LXW_INVALID_SHEET
* * LOCERR_LXW_INVALID_EXPORT_RANGE
* * LOCERR_LXW_ERROR
* * LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED
* * LOCERR_LXW_ERROR_CREATING_XLSX_FILE
* * LOCERR_LXW_ERROR_CREATING_TMPFILE
* * LOCERR_LXW_ERROR_ZIP_FILE_OPERATION
* * LOCERR_LXW_ERROR_ZIP_FILE_ADD
* * LOCERR_LXW_ERROR_ZIP_CLOSE
* * LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED
* * LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED
* * LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED
* * LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND
* * LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE
* * LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED
* * LOCERR_BDI_STATUS_OK
* * LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED
* * LOCERR_TRENDLINE_INVALID_DEF
* * LOCERR_TRENDLINE_INVALID_MATH_ERROR
* * LOCERR_CURL_UNSUPPORTED_PROTOCOL
* * LOCERR_CURL_COULDNT_RESOLVE_PROXY
* * LOCERR_CURL_COULDNT_CONNECT
* * LOCERR_CURL_REMOTE_ACCESS_DENIED
* * LOCERR_CURL_FTP_ACCEPT_FAILED
* * LOCERR_CURL_FTP_ACCEPT_TIMEOUT
* * LOCERR_CURL_FTP_CANT_GET_HOST
* * LOCERR_CURL_PARTIAL_FILE
* * LOCERR_CURL_QUOTE_ERROR
* * LOCERR_CURL_WRITE_ERROR
* * LOCERR_CURL_UPLOAD_FAILED
* * LOCERR_CURL_OUT_OF_MEMORY
* * LOCERR_CURL_OPERATION_TIMEDOUT
* * LOCERR_CURL_FTP_COULDNT_USE_REST
* * LOCERR_CURL_HTTP_POST_ERROR
* * LOCERR_CURL_SSL_CONNECT_ERROR
* * LOCERR_CURL_FILE_COULDNT_READ_FILE
* * LOCERR_CURL_LDAP_CANNOT_BIND
* * LOCERR_CURL_LDAP_SEARCH_FAILED
* * LOCERR_CURL_TOO_MANY_REDIRECTS
* * LOCERR_CURL_PEER_FAILED_VERIFICATION
* * LOCERR_CURL_GOT_NOTHING
* * LOCERR_CURL_SSL_ENGINE_NOTFOUND
* * LOCERR_CURL_SSL_ENGINE_SETFAILED
* * LOCERR_CURL_SSL_CERTPROBLEM
* * LOCERR_CURL_SSL_CIPHER
* * LOCERR_CURL_SSL_CACERT
* * LOCERR_CURL_BAD_CONTENT_ENCODING
* * LOCERR_CURL_LDAP_INVALID_URL
* * LOCERR_CURL_USE_SSL_FAILED
* * LOCERR_CURL_SSL_ENGINE_INITFAILED
* * LOCERR_CURL_LOGIN_DENIED
* * LOCERR_CURL_TFTP_NOTFOUND
* * LOCERR_CURL_TFTP_ILLEGAL
* * LOCERR_CURL_SSH
* * LOCERR_SETEXPRESSION_TOO_LARGE
* * LOCERR_RELOAD_MERGE_LOAD_ERROR
* * LOCERR_WIN_FTP_DROPPED
* * LOCERR_WIN_FTP_NO_PASSIVE_MODE
* * LOCERR_WIN_HTTP_DOWNLEVEL_SERVER
* * LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE
* * LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION
* * LOCERR_WIN_INTERNET_FORCE_RETRY
* * LOCERR_WIN_INTERNET_CANNOT_CONNECT
* * LOCERR_WIN_INTERNET_CONNECTION_ABORTED
* * LOCERR_WIN_INTERNET_CONNECTION_RESET
* * LOCERR_WIN_INTERNET_DISCONNECTED
* * LOCERR_WIN_INTERNET_INCORRECT_FORMAT
* * LOCERR_WIN_INTERNET_INVALID_CA
* * LOCERR_WIN_INTERNET_INVALID_OPERATION
* * LOCERR_WIN_INTERNET_INVALID_URL
* * LOCERR_WIN_INTERNET_ITEM_NOT_FOUND
* * LOCERR_WIN_INTERNET_LOGIN_FAILURE
* * LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED
* * LOCERR_WIN_INTERNET_NEED_UI
* * LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID
* * LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID
* * LOCERR_WIN_INTERNET_SEC_CERT_ERRORS
* * LOCERR_WIN_INTERNET_SEC_INVALID_CERT
* * LOCERR_WIN_INTERNET_SERVER_UNREACHABLE
* * LOCERR_BM_RESULT_TOO_LARGE
*/
qTitle?: NxLocalizedErrorCode;
};
type SampleResult = {
/**
* Name of field or column.
*/
qFieldOrColumn?: FieldOrColumn;
/**
* Matched values part of the sample.
*/
qValues?: FieldValue[];
};
type ScriptSyntaxError = {
/**
* Length of the word where the error is located.
*/
qErrLen?: number;
/**
* Number of the faulty section.
*/
qTabIx?: number;
/**
* Line number in the section where the error is located.
*/
qLineInTab?: number;
/**
* Position of the erroneous text from the beginning of the line.
*/
qColInLine?: number;
/**
* Position of the erroneous text from the beginning of the script.
*/
qTextPos?: number;
/**
* The default value is false.
*/
qSecondaryFailure?: boolean;
};
type ScrollPosition = {
qUsePosition?: boolean;
qPos?: Point;
};
type SearchAssociationResult = {
/**
* List of the fields that contains search associations.
*/
qFieldNames?: string[];
/**
* List of the search terms.
*/
qSearchTerms?: string[];
/**
* Information about the fields containing search hits.
*/
qFieldDictionaries?: SearchFieldDictionary[];
/**
* List of search results.
* The maximum number of search results in this list is set by _qPage/qCount_ .
*/
qSearchTermsMatched?: SearchMatchCombinations[];
/**
* Total number of search results.
* This number is not limited by _qPage/qCount_ .
*/
qTotalSearchResults?: number;
};
type SearchAttribute = {
/**
* String corresponding to _SearchObjectOptions.qAttributes_. It will be _qProperty_ for _SearchObjectOptions_.
*/
qKey?: string;
/**
* String corresponding to _qKey_ for the current _SearchGroupItemMatch_. For example, if the match is _Make by Price_ found in the title of a generic object, _qValue_ will be _qMetaDef/title_.
*/
qValue?: string;
};
type SearchCharRange = {
/**
* Starting position of the match in the search result, starting from 0.
*/
qCharPos?: number;
/**
* Length of the match in the search result.
*/
qCharCount?: number;
/**
* Position of the term in the list of search terms, starting from 0.
*/
qTerm?: number;
};
type SearchCombinationOptions = {
/**
* List of the search fields.
* If empty, the search is performed in all fields of the app.
*/
qSearchFields?: string[];
/**
* Search context.
* The default value is _LockedFieldsOnly_ .
*
* One of:
* * Cleared or CONTEXT_CLEARED
* * LockedFieldsOnly or CONTEXT_LOCKED_FIELDS_ONLY
* * CurrentSelections or CONTEXT_CURRENT_SELECTIONS
*/
qContext?: SearchContextType;
/**
* Encoding used to compute qRanges of type SearchCharRange.
* Only affects the computation of the ranges. It does not impact the encoding of the text.
*
* One of:
* * Utf8 or CHAR_ENCODING_UTF8
* * Utf16 or CHAR_ENCODING_UTF16
*/
qCharEncoding?: CharEncodingType;
/**
* Optional.
* * For SearchSuggest method, this array is empty.
* * For SearchObjects method, this array is empty or contain _qProperty_ .
* * For SearchResults method, this array is empty, or contains _qNum_ and/or _qElemNum_ . It allows the user to request details in the outputted _SearchGroupItemMatch_ . For more information, see _SearchGroupItemMatch_.
*/
qAttributes?: string[];
};
type SearchContextType = "Cleared" | "CONTEXT_CLEARED" | "LockedFieldsOnly" | "CONTEXT_LOCKED_FIELDS_ONLY" | "CurrentSelections" | "CONTEXT_CURRENT_SELECTIONS";
type SearchFieldDictionary = {
/**
* Position of the field in the list of fields, starting from 0.
* The list of fields is defined in _qResults/qFieldNames_ and contains the search associations.
*/
qField?: number;
/**
* List of the matching values.
* The maximum number of values in this list is set by _qMaxNbrFieldMatches_ .
*/
qResult?: SearchTermResult[];
};
type SearchFieldMatch = {
/**
* Position of the field in the list of fields, starting from 0.
* The list of fields is defined in _qResults/qFieldNames_ and contains the search associations.
*/
qField?: number;
/**
* Positions of the matching values in the search results.
* The maximum number of values in this list is defined by _qMaxNbrFieldMatches_ .
*/
qValues?: number[];
/**
* Positions of the search terms, starting from 0.
*/
qTerms?: number[];
/**
* Number of search hits in the field.
* The number of values in _qValues_ and the value of _qNoOfMatches_ are equal if _qMaxNbrFieldMatches_ is -1.
*/
qNoOfMatches?: number;
};
type SearchFieldMatchType = "FieldMatchNone" | "FM_NONE" | "FieldMatchSubString" | "FM_SUBSTRING" | "FieldMatchWord" | "FM_WORD" | "FieldMatchExact" | "FM_EXACT" | "FieldMatchLast" | "FM_LAST";
type SearchFieldMatchesItem = {
qText?: string;
qElemNo?: number;
qSearchTermsMatched?: number[];
};
type SearchFieldSelectionMode = "OneAndOnlyOne" | "ONE_AND_ONLY_ONE";
type SearchFieldValueItem = {
/**
* Field name of matches.
*/
qFieldName?: string;
/**
* List of search matches.
*/
qValues?: SearchFieldMatchesItem[];
};
type SearchGroup = {
/**
* Identifier of the search group.
*/
qId?: number;
/**
* Type of the search group.
*
* One of:
* * DatasetType or DATASET_GROUP
* * GenericObjectsType or GENERIC_OBJECTS_GROUP
*/
qGroupType?: SearchGroupType;
/**
* Indexes of the search terms that are included in the group. These search terms are related to the list of terms defined in _SearchResult.qSearchTerms_ .
*/
qSearchTermsMatched?: number[];
/**
* Total number of distinct items in the search group.
*/
qTotalNumberOfItems?: number;
/**
* List of items in the search group.
* The group items are numbered from the value of _SearchGroupOptions.qOffset_ to the value of _SearchGroupOptions.qOffset_ \+ _SearchGroupOptions.qCount_
*/
qItems?: SearchGroupItem[];
};
type SearchGroupItem = {
/**
* Type of the group item.
*
* One of:
* * Field or FIELD
* * GenericObject or GENERIC_OBJECT
*/
qItemType?: SearchGroupItemType;
/**
* Total number of distinct matches in the search group item.
*/
qTotalNumberOfMatches?: number;
/**
* Identifier of the item.
* It corresponds to:
* * The name of the field, if the type of the search group is data set.
* * The id of the generic object if the type of the search group is generic object.
*/
qIdentifier?: string;
/**
* List of matches in the search group item.
* The group item matches are numbered from the value of _SearchGroupItemOptions.qOffset_ to the value of _SearchGroupItemOptions.qOffset_ \+ _SearchGroupItemOptions.qCount_ .
*/
qItemMatches?: SearchGroupItemMatch[];
/**
* Indexes of the search terms that are included in the group item. These search terms are related to the list of terms defined in _SearchResult.qSearchTerms_ .
*/
qSearchTermsMatched?: number[];
/**
* Match type applied in this result group.
*
* One of:
* * FieldMatchNone or FM_NONE
* * FieldMatchSubString or FM_SUBSTRING
* * FieldMatchWord or FM_WORD
* * FieldMatchExact or FM_EXACT
* * FieldMatchLast or FM_LAST
*/
qMatchType?: SearchFieldMatchType;
};
type SearchGroupItemMatch = {
/**
* Search match value.
* Value of the search group item.
* If the match is found in a field, it corresponds to the value of the field.
* If the match is found in a generic object property, it corresponds to the property value.
*/
qText?: string;
/**
* Selection mode of a field.
* Suppressed by default. One and always one field value is selected when set to _OneAndOnlyOne_.
*/
qFieldSelectionMode?: SearchFieldSelectionMode;
/**
* List of ranges.
* For example, if the search terms are Price and Make, and the search group item value is Make by Price vs Mileage, then there are two ranges: one for Price and one for Make.
*/
qRanges?: SearchCharRange[];
/**
* Provides detail of the match as requested by the user in _SearchObjectsOptions.qAttributes_ or _SearchCombinationOptions.qAttributes_
* If the user requests _SearchObjects_ or _SearchResults_ with an empty _qAttributes_ option, the outputted _qAttributes_ is returned empty.
* For _SearchObjects_ requested with _qProperty_ , the _SearchGroupItemMatch.qAttributes_ return value contains _[“qProperty”, "qMetaDef/title”]_ if the match has been found in the title of the item. For dimension values, the returned _qProperty_ will be _“*”_ .
* For _SearchResults_ requested with _qNum_ , the _SearchGroupItemMatch.qAttributes_ return value contains _["qNum", N]_ where _N_ is the numeric value of the element or _NaN_ if the value is not numeric.
* For _SearchResults_ requested with _qElemNum_ , the _SearchGroupItemMatch.qAttributes_ return value contains _["qElemNum", N]_ where _N_ is the value index of the element.
*/
qAttributes?: SearchAttribute[];
};
type SearchGroupItemOptions = {
/**
* Type of the group item. Can be:
* * GenericObject: the type of the search group item is a generic object. Group items have this type when you are calling _SearchObjects_ .
* * Field: the type of the search group item is a field. Group items have this type when you are calling _SearchResults_ .
*
* One of:
* * Field or FIELD
* * GenericObject or GENERIC_OBJECT
*/
qGroupItemType?: SearchGroupItemType;
/**
* Position starting from 0.
* The default value is 0.
*/
qOffset?: number;
/**
* Maximum number of matches per item (in _qItemMatches[ ]_ ).
* The default value is -1: all values are returned.
*/
qCount?: number;
};
type SearchGroupItemType = "Field" | "FIELD" | "GenericObject" | "GENERIC_OBJECT";
type SearchGroupOptions = {
/**
* Type of the group. Can be:
* * GenericObjectType: the type of the search group item is a generic object. Groups have this type when you are calling _SearchObjects_ .
* * DatasetType: type of the search group item is a dataset association. Groups have this type when you are calling _SearchResults_ .
*
* One of:
* * DatasetType or DATASET_GROUP
* * GenericObjectsType or GENERIC_OBJECTS_GROUP
*/
qGroupType?: SearchGroupType;
/**
* Position starting from 0.
* The default value is 0.
*/
qOffset?: number;
/**
* Maximum number of items per group (in _qItems[ ]_ ).
* The default value is -1; all values are returned.
*/
qCount?: number;
};
type SearchGroupType = "DatasetType" | "DATASET_GROUP" | "GenericObjectsType" | "GENERIC_OBJECTS_GROUP";
type SearchMatchCombination = {
/**
* Index of the search result, starting from 0.
*/
qId?: number;
/**
* Information about the search matches.
*/
qFieldMatches?: SearchFieldMatch[];
};
type SearchMatchCombinations = SearchMatchCombination[];
type SearchObjectOptions = {
/**
* This array is either empty or contains _qProperty_ .
*/
qAttributes?: string[];
/**
* Encoding used to compute qRanges of type SearchCharRange.
* Only affects the computation of the ranges. It does not impact the encoding of the text.
*
* One of:
* * Utf8 or CHAR_ENCODING_UTF8
* * Utf16 or CHAR_ENCODING_UTF16
*/
qCharEncoding?: CharEncodingType;
};
type SearchPage = {
/**
* Position from the top, starting from 0.
* If the offset is set to 0, the first search result to be returned is at position 0.
*/
qOffset?: number;
/**
* Number of search groups to return (in _qSearchGroupArray_ ).
*/
qCount?: number;
/**
* Maximum number of matching values to return per search result.
* The default value is -1; all values are returned.
* This property is to be used with the _SearchAssociations method_.
*/
qMaxNbrFieldMatches?: number;
/**
* Options of the search groups.
* If this property is not set, all values are returned.
* This property is to be used with the _SearchResults method_ or the _SearchObjects method_.
*/
qGroupOptions?: SearchGroupOptions[];
/**
* Options of the search group items.
* If this property is not set, all values are returned.
* This property is to be used with the _SearchResults method_ or the _SearchObjects method_.
*/
qGroupItemOptions?: SearchGroupItemOptions[];
};
type SearchResult = {
/**
* List of the search terms.
*/
qSearchTerms?: string[];
/**
* Total number of groups.
*/
qTotalNumberOfGroups?: number;
/**
* List of search groups.
* The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ .
*/
qSearchGroupArray?: SearchGroup[];
};
type SearchSuggestItem = {
/**
* Value of the suggestion.
*/
qValue?: string;
/**
* Index of the suggestion value.
* The indexing starts from 0 and from the left.
*/
qTerm?: number;
};
type SearchSuggestionResult = {
/**
* List of suggestions.
*/
qSuggestions?: SearchSuggestItem[];
/**
* List of field names that contain search hits.
*/
qFieldNames?: string[];
};
type SearchTermResult = {
/**
* Text of the associated value.
*/
qText?: string;
/**
* Element number of the associated value.
*/
qElemNumber?: number;
/**
* List of ranges.
* For example, if the user searches the term _read_ and the associative value is _Reading_ , then the corresponding range would be _Read_ in _Reading_ .
*/
qRanges?: SearchCharRange[];
};
type SearchValueOptions = {
/**
* List of the search fields.
* If empty, the search is performed in all fields of the app.
*/
qSearchFields?: string[];
};
type SearchValuePage = {
/**
* Position from the top, starting from 0.
* If the offset is set to 0, the first search result to be returned is at position 0.
*/
qOffset?: number;
/**
* Number of search fields to return
*/
qCount?: number;
/**
* Maximum number of matching values to return per search result.
*/
qMaxNbrFieldMatches?: number;
};
type SearchValueResult = {
/**
* List of the search terms.
*/
qSearchTerms?: string[];
/**
* List of search groups.
* The groups are numbered from the value of _SearchPage.qOffset_ to the value of _SearchPage.qOffset + SearchPage.qCount_ .
*/
qFieldMatches?: SearchFieldValueItem[];
};
type SelectInfo = {
/**
* Text search string.
* Everything that matches the text is selected.
* This parameter is optional.
*/
qTextSearch?: string;
/**
* Lower value of the search range.
* This parameter is used when performing range selections or text searches in dimensions.
* Default is Null.
*/
qRangeLo?: number;
/**
* Highest value of the search range.
* This parameter is used when performing range selections or text searches in dimensions.
* Default is Null.
*/
qRangeHi?: number;
/**
* Gives information about the formatting of the range.
* This parameter is used when performing range selections or text searches in dimensions.
*/
qNumberFormat?: FieldAttributes;
/**
* This parameter is used when performing range selections or text searches in measures.
* Gives information about the range of selections.
*/
qRangeInfo?: RangeSelectInfo[];
/**
* Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*/
qSoftLock?: boolean;
/**
* List of information about ranges for selections.
*/
qContinuousRangeInfo?: QRange[];
/**
* This parameter is true if the TextSearch is a result of a Select Field operation.
*/
qSelectFieldSearch?: boolean;
};
/**
* Indicates which selections are currently applied. It gives the current selections. Is the layout for _SelectionObjectDef_.
*/
type SelectionObject = {
/**
* Number of steps back.
*/
qBackCount?: number;
/**
* Number of steps forward.
*/
qForwardCount?: number;
/**
* Lists the fields that are selected.
*/
qSelections?: NxCurrentSelectionItem[];
/**
* Name of the alternate state.
* Default is current selections _$_ .
*/
qStateName?: string;
};
/**
* To display the current selections.
* Can be added to any generic object but is particularly meaningful when using session objects to monitor an app.
*
* ### Properties
* "qSelectionObjectDef": {}
*/
type SelectionObjectDef = {
/**
* Name of the alternate state.
* Default is current selections _$_ .
*/
qStateName?: string;
};
type Size = {
/**
* Number of pixels on the _x_ axis.
*/
qcx?: number;
/**
* Number of pixels on the _y_ axis.
*/
qcy?: number;
};
type SortCriteria = {
/**
* Sorts the field values according to their logical state (selected, optional, alternative or excluded).
*/
qSortByState?: number;
/**
* Sorts the field values by frequency (number of occurrences in the field).
*/
qSortByFrequency?: number;
/**
* Sorts the field values by numeric value.
*/
qSortByNumeric?: number;
/**
* Sorts the field by alphabetical order.
*/
qSortByAscii?: number;
/**
* Sorts the field values by the initial load order.
*/
qSortByLoadOrder?: number;
/**
* Sorts the field by expression.
*/
qSortByExpression?: number;
/**
* Sort by expression.
*/
qExpression?: ValueExpr;
qSortByGreyness?: number;
};
type SourceKeyRecord = {
/**
* Name of the key field.
*/
qKeyFields?: string[];
/**
* Table the key belongs to.
*/
qTables?: string[];
};
type StateEnumType = "L" | "LOCKED" | "S" | "SELECTED" | "O" | "OPTION" | "D" | "DESELECTED" | "A" | "ALTERNATIVE" | "X" | "EXCLUDED" | "XS" | "EXCL_SELECTED" | "XL" | "EXCL_LOCKED" | "NSTATES";
type StateFieldValues = {
/**
* Name of the state.
*/
qStateName?: string;
/**
* The field values associated with the state.
*/
qFieldValues?: FieldValue[];
};
type StaticContentList = {
/**
* Information about the list of content files.
*/
qItems?: StaticContentListItem[];
};
/**
* In addition, this structure can return dynamic properties.
*/
type StaticContentListItem = {
/**
* Relative path to the content file. The URL is static.
* In Qlik Sense Enterprise, content files located:
* * In the _/content/ <content library name>/_ folder are part of a global content library.
* * In the _/appcontent/_ folder are part of the app specific library.
* The content files are never embedded in the _qvf_ file.
* In Qlik Sense Desktop, content files located:
* * In the _/content/default/_ folder are outside the qvf file.
* * In the _/media/ folder_ are embedded in the qvf file.
*/
qUrlDef?: string;
/**
* Relative path to the content file. The URL is static.
* In Qlik Sense Enterprise, content files located:
* * In the _/content/ <content library name>/_ folder are part of a global content library.
* * In the _/appcontent/_ folder are part of the app specific library.
* The content files are never embedded in the _qvf_ file.
* In Qlik Sense Desktop, content files located:
* * In the _/content/default/_ folder are outside the qvf file.
* * In the _/media/ folder_ are embedded in the qvf file.
*/
qUrl?: string;
};
/**
* In addition, this structure can return dynamic properties.
*/
type StaticContentUrl = {
/**
* Relative path of the thumbnail.
*/
qUrl?: string;
};
/**
* In addition, this structure can contain dynamic properties.
*/
type StaticContentUrlDef = {
/**
* Relative path of the thumbnail.
*/
qUrl?: string;
};
type StringExpr = {
/**
* Expression evaluated to string.
*/
qv?: string;
};
/**
* ### 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.
*/
type StringExpression = {
qExpr?: string;
};
type SymbolFrequency = {
/**
* Symbol. Either string and NaN or number alone
*/
qSymbol?: SymbolValue;
/**
* Frequency of the above symbol in the field
*/
qFrequency?: number;
};
type SymbolValue = {
/**
* String value of the symbol. This parameter is optional and present only if Symbol is a string.
*/
qText?: string;
/**
* Numeric value of the symbol. NaN otherwise.
*/
qNumber?: number;
};
type TableProfilingData = {
/**
* Number of rows in the table.
*/
qNoOfRows?: number;
/**
* Field values profiling info
*/
qFieldProfiling?: FieldInTableProfilingData[];
};
type TableRecord = {
/**
* Name of the table.
*/
qName?: string;
/**
* This property is set to true if the table is loose.
*/
qLoose?: boolean;
/**
* Number of rows in the table.
*/
qNoOfRows?: number;
/**
* Information about the fields in the table.
*/
qFields?: FieldInTableData[];
/**
* Information about the position of the table.
*/
qPos?: Point;
/**
* Comment related to the table.
*/
qComment?: string;
/**
* If set to true, Direct Discovery is used.
* Direct Discovery fields are not loaded into memory and remain in the external database.
*/
qIsDirectDiscovery?: boolean;
/**
* This property is set to true if the table contains a synthetic key.
*/
qIsSynthetic?: boolean;
/**
* List of tags related to the table.
*/
qTableTags?: string[];
/**
* Profiling information of the table.
*/
qProfilingData?: TableProfilingData;
};
type TableRow = {
/**
* Array of field values.
*/
qValue?: FieldValue[];
};
type TableViewBroomPointSaveInfo = {
/**
* Information about the position of the broom point.
*/
qPos?: Point;
/**
* Name of the table.
*/
qTable?: string;
/**
* List of fields in the table.
*/
qFields?: string[];
};
type TableViewConnectionPointSaveInfo = {
/**
* Information about the position of the connection point.
*/
qPos?: Point;
/**
* List of the fields in the table.
*/
qFields?: string[];
};
type TableViewCtlSaveInfo = {
/**
* Internal view mode.
*/
qInternalView?: TableViewSaveInfo;
/**
* Source view mode.
*/
qSourceView?: TableViewSaveInfo;
};
type TableViewDlgSaveInfo = {
/**
* Information about the position of the dialog window.
* Not used in Qlik Sense.
*/
qPos?: Rect;
/**
* Set of data for internal and source view modes.
*/
qCtlInfo?: TableViewCtlSaveInfo;
/**
* View mode to display when opening Qlik Sense data model viewer.
* One of:
* * 0 for internal view mode.
* * 1 for source view mode.
*/
qMode?: number;
};
type TableViewSaveInfo = {
/**
* List of the tables in the database model viewer.
*/
qTables?: TableViewTableWinSaveInfo[];
/**
* List of the broom points in the database model viewer.
* Not used in Qlik Sense.
*/
qBroomPoints?: TableViewBroomPointSaveInfo[];
/**
* List of connection points in the database model viewer.
* Not used in Qlik Sense.
*/
qConnectionPoints?: TableViewConnectionPointSaveInfo[];
/**
* Zoom factor in the database model viewer.
* The default value is 1.0.
*/
qZoomFactor?: number;
};
type TableViewTableWinSaveInfo = {
/**
* Information about the position of the table.
*/
qPos?: Rect;
/**
* Table name.
*/
qCaption?: string;
};
type TextMacro = {
/**
* Name of the variable.
*/
qTag?: string;
/**
* Order in which the variable was referenced during the script execution.
* The same number sequence is used for both _qRefSeqNo_ and _qSetSeqNo_ .
*/
qRefSeqNo?: number;
/**
* Order in which the variable was updated during the script execution.
* The same number sequence is used for both _qRefSeqNo_ and _qSetSeqNo_ .
*/
qSetSeqNo?: number;
/**
* Variable value.
*/
qDisplayString?: string;
/**
* Is set to true if the variable is a system variable.
*/
qIsSystem?: boolean;
/**
* Is set to true if the variable is a reserved variable.
*/
qIsReserved?: boolean;
};
type TotalMode = "TOTAL_OFF" | "TOTAL_EXPR";
type TransformAppParameters = {
/**
* The name (title) of the application
*/
qName?: string;
/**
* ID of the space where the app is to be created. Empty value implies Personal space
*/
qSpaceId?: string;
/**
* Prefix to be used on inserted ScriptParameters, only applicable for template apps
*/
qScriptParameterPrefix?: string;
};
type TransformAppResult = {
/**
* ID of created App
*/
qAppId?: string;
};
/**
* Renders the properties of a TreeData object. Is the layout for TreeDataDef.
* For more information about the definition of TreeData, see _Generic object_.
* To retrieve data from the TreeData object, use the method called GetHyperCubeTreeData.
*
* Stability: *stable*
*/
type TreeData = {
/**
* Name of the alternate state.
* Default is current selections _$_ .
*/
qStateName?: string;
/**
* The total number of nodes on each dimension.
*/
qNodesOnDim?: number[];
/**
* This parameter is optional and is displayed in case of error.
*/
qError?: NxValidationError;
/**
* Information on the dimension.
*/
qDimensionInfo?: NxTreeDimensionInfo[];
/**
* Defines the order of the dimenion levels/columns in the TreeData object.
* Column numbers are separated by a comma.
* Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.
*/
qEffectiveInterColumnSortOrder?: number[];
/**
* True if other row exists.
*/
qHasOtherValues?: boolean;
/**
* Title of the TreeData object, for example the title of a chart.
*/
qTitle?: string;
/**
* Position of the last expended cell.
* This property is optional.
*/
qLastExpandedPos?: NxCellPosition;
/**
* The message displayed if calculation condition is not fulfilled.
*/
qCalcCondMsg?: string;
/**
* Set of data.
* Is empty if nothing has been defined in **qInitialDataFetch** in _TreeDataDef_.
*/
qTreeDataPages?: NxTreeNode[];
/**
* Information on the measures calculated on the whole tree.
*/
qMeasureInfo?: NxMeasureInfo[];
};
/**
* Defines the properties of a TreeData object.
* For more information about the definition of a TreeData object, see _Generic object_.
*
* Stability: *stable*
*/
type TreeDataDef = {
/**
* Name of the alternate state.
* Default is current selections _$_ .
*/
qStateName?: string;
/**
* Array of dimensions.
*/
qDimensions?: NxTreeDimensionDef[];
/**
* Defines the order of the dimension levels/columns in the TreeData object.
* Column numbers are separated by a comma.
* Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2.
* The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef.
*/
qInterColumnSortOrder?: number[];
/**
* Removes zero values.
*/
qSuppressZero?: boolean;
/**
* Removes missing values.
*/
qSuppressMissing?: boolean;
/**
* If this property is set to true, the cells are opened expanded. The default value is false.
*/
qOpenFullyExpanded?: boolean;
/**
* If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string.
* The default value is false.
*/
qPopulateMissing?: boolean;
/**
* Specifies a calculation condition object.
* If CalcCondition.Cond is not fulfilled, the TreeData is excluded from the calculation and CalcCondition.Msg is evaluated.
* By default, there is no calculation condition.
* This property is optional.
*/
qCalcCondition?: NxCalcCond;
/**
* Title of the TreeData object, for example the title of a chart.
*/
qTitle?: StringExpr;
/**
* Initial data set.
* This property is optional.
*/
qInitialDataFetch?: NxTreeDataOption[];
/**
* Expansion state per dimension.
*
* Stability: *experimental*
*/
qExpansionState?: ExpansionData[];
/**
* List of measures to calculate on the whole tree.
*/
qValueExprs?: NxMeasure[];
/**
* Set Expression valid for the whole cube. Used to limit computations to the set specified.
*/
qContextSetExpression?: string;
};
/**
* Displays information about the number of possible undos and redos. Is the layout for _UndoInfoDef_.
*/
type UndoInfo = {
/**
* Number of possible undos.
*/
qUndoCount?: number;
/**
* Number of possible redos.
*/
qRedoCount?: number;
};
/**
* Defines if an object should contain information on the number of possible undo and redo.
*
* ### Properties
* "qUndoInfoDef": {}
* The numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed.
*/
type UndoInfoDef = object;
type UsageEnum = "ANALYTICS" | "DATA_PREPARATION" | "DATAFLOW_PREP" | "SINGLE_TABLE_PREP";
type ValueExpr = {
/**
* Expression evaluated to dual.
*/
qv?: string;
};
/**
* ### Properties
* Abbreviated syntax:
* "qValueExpression":"=<expression>"
* Extended object syntax:
* "qValueExpression":{"qExpr":"=<expression>"}
* Where:
* * < **expression** > is a string.
*
* The "=" sign in the value expression is not mandatory. Even if the "=" sign is not given, the expression is evaluated.
* The expression is evaluated as a numeric.
*/
type ValueExpression = {
qExpr?: string;
};
/**
* Lists the variables in an app. Is the layout for _VariableListDef_.
*/
type VariableList = {
/**
* List of the variables.
*/
qItems?: NxVariableListItem[];
};
/**
* Defines the list of variables in an app.
*/
type VariableListDef = {
/**
* Type of variables to include in the list.
*/
qType?: string;
/**
* Shows the reserved variables if set to true.
*/
qShowReserved?: boolean;
/**
* Shows the system variables if set to true.
*/
qShowConfig?: boolean;
/**
* Data
*/
qData?: Record;
/**
* Shows the session variables if set to true.
*/
qShowSession?: boolean;
};
type NativeDocFunctions = {
/**
* Aborts any selection mode in an app. For more information about selection mode, see _BeginSelections method_.
*
* Parameters:
*
* - `accept` - Set this parameter to true to accept the selections before exiting the selection mode.
*
* Stability: *locked*
*/
abortModal: (accept: boolean) => Promise;
/**
* Adds an alternate state in the app.
* You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.
*
* Parameters:
*
* - `stateName` - Name of the alternate state.
*
* Stability: *locked*
*/
addAlternateState: (stateName: string) => Promise;
/**
* Adds a field on the fly.
* The expression of a field on the fly is persisted but not its values.
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `name` - Name of the field.
* - `expr` - Expression value.
* It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the _Sum_ or _Count_ aggregation functions.
*
* Stability: *locked*
*/
addFieldFromExpression: (name: string, expr: string) => Promise;
/**
* Adds an session alternate state in the app.
* You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.
* A session alternate state is not persisted and is not included in the StateNames array in the AppLayout.
* You can use the optional second parameter to choose any other state to get the initial selection on the new state from
*
* Parameters:
*
* - `stateName` - Name of the alternate state.
* - `sourceStateName` - Name of existing state to copy the initial selections from
*
* Stability: *locked*
*/
addSessionAlternateState: (stateName: string, sourceStateName?: string) => Promise;
/**
* Applies a bookmark and verifies result dataset against originally selected values.
* The operation is successful if **qApplySuccess** is set to true. **qWarnings** lists state and field with unmatching values
*
* Parameters:
*
* - `id` - Identifier of the bookmark.
*
* Stability: *experimental*
*/
applyAndVerifyBookmark: (id: string) => Promise;
/**
* Applies a bookmark.
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the bookmark.
*
* Stability: *locked*
*/
applyBookmark: (id: string) => Promise;
applyGroupStates: (groupStates: GroupState[]) => Promise;
/**
* Apply temporary bookmark identified by Id.
* ApplyTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.
*
* Parameters:
*
* - `id` - Identifier of the temporary selection state
*
* Stability: *locked*
*/
applyTemporaryBookmark: (id: string) => Promise;
/**
* Loads the last logical operation (if any).
*
* Stability: *locked*
*/
back: () => Promise;
/**
* Returns the number of entries on the back stack.
*
* Stability: *locked*
*/
backCount: () => Promise;
/**
* Change the owner of a session app.
* Can be used by a privileged user when creating a session app to be consumed by another user.
* Only useful in environments where it is possible to reconnect to a session app, currently only in cloud deployments.
*
* Parameters:
*
* - `newOwnerId` - Identifier of the new app owner.
*
* Stability: *experimental*
*/
changeSessionAppOwner: (newOwnerId: string) => Promise;
/**
* Add a session app to a space.
* Can be used by a privileged user when creating a session app to be consumed by other users.
* Only useful in environments where it is possible to reconnect to a session app, currently only in cloud deployments.
*
* Parameters:
*
* - `spaceId` - Identifier of the new space.
*
* Stability: *experimental*
*/
changeSessionAppSpace: (spaceId: string) => Promise;
/**
* Checks if a given expression is valid.
* The expression is correct if the parameters _qErrorMsg_ , _qBadFieldNames_ and _qDangerousFieldNames_ are empty.
*
* Parameters:
*
* - `expr` - Expression to check.
* - `labels` - List of labels.
*
* Stability: *locked*
*/
checkExpression: (expr: string, labels?: string[]) => Promise;
/**
* Checks if:
* * A given expression is valid.
* * A number is correct according to the locale.
*
* Parameters:
*
* - `expr` - Expression to check.
*
* Stability: *locked*
*/
checkNumberOrExpression: (expr: string) => Promise;
/**
* Checks the syntax of a script.
*
* ### Example
* "result": { "qErrors": [ { "qErrLen": 3, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 0, "qTextPos": 0 }, { "qErrLen": 5, "qTabIx": 0, "qLineInTab": 0, "qColInLine": 1, "qTextPos": 4, "qSecondaryFailure": true } ] }
* The first area is the primary error area, the second area is the secondary error area. The second area is optional and is shown only if qSecondaryFailure is set to true. The second area ends when the next statement in the script begins.
* The list of syntax errors in the script.
* If there are no errors, the engine returns:
* If there are errors, the engine returns the following properties in the response:
*
*
* | Name |
* Description |
* Type |
*
*
* | qErrLen |
* Length of the word where the error is located. |
* Integer |
*
*
* | qTabIx |
* Number of the faulty section. |
* Integer |
*
*
* | qLineInTab |
* Line number in the section where the error is located. |
* Integer |
*
*
* | qColInLine |
* Position of the erroneous text from the beginning of the line. |
* Integer |
*
*
* | qTextPos |
* Position of the erroneous text from the beginning of the script. |
* Integer |
*
*
* | qSecondaryFailure |
* The default value is false. |
* Boolean |
*
*
*
* Stability: *locked*
*/
checkScriptSyntax: () => Promise;
/**
* Clear selections in fields for current state. Locked fields are not cleared by default.
*
* Parameters:
*
* - `lockedAlso` - When true, clears the selection for locked fields.
* - `stateName` - Alternate state name. When set, applies to alternate state instead of current
*
* Stability: *locked*
*/
clearAll: (lockedAlso?: boolean, stateName?: string) => Promise;
/**
* Clear the soft properties of all generic objects in the app
*
* Stability: *experimental*
*/
clearAllSoftPatches: () => Promise;
/**
* Clears entirely the undo and redo buffer.
*
* Stability: *locked*
*/
clearUndoBuffer: () => Promise;
/**
* Clones a bookmark.
* The identifier is set by the engine.
*
* Parameters:
*
* - `id` - Identifier of the object to clone.
*
* Stability: *locked*
*/
cloneBookmark: (id: string) => Promise;
/**
* Clones a dimension.
*
* The identifier is set by the engine.
*
* Parameters:
*
* - `id` - Identifier of the object to clone.
*
* Stability: *locked*
*/
cloneDimension: (id: string) => Promise;
/**
* Clones a measure.
*
* The identifier is set by the engine.
*
* Parameters:
*
* - `id` - Identifier of the object to clone.
*
* Stability: *locked*
*/
cloneMeasure: (id: string) => Promise;
/**
* Clones root level objects, such as sheets and stories. The CloneObject method works for both app objects and child objects.
* When you clone an object that contains children, the children are cloned as well.
* If you for example want to clone a visualization, you must provide the qID of the root object, in this case the sheet since CloneObject clones root level objects.
* It is not possible to clone a session object.
*
* The identifier is set by the engine.
*
* Parameters:
*
* - `id` - Identifier of the object to clone. The identifier must be a root object.
*
* Stability: *locked*
*/
cloneObject: (id: string) => Promise;
/**
* Commits the draft of an object that was previously created by invoking the _CreateDraft method_.
* Committing a draft replaces the corresponding published object.
*
* Parameters:
*
* - `id` - Identifier of the draft to commit.
*
* @deprecated: This will be removed in a future version
*
* Stability: *locked*
*/
commitDraft: (id: string) => Promise;
/**
* Commits the current script version so that any future changes will be part of a new version.
*
* Parameters:
*
* - `commitMessage` - Name of the version.
* Only applicable to QCS.
*
* Stability: *experimental*
*/
commitScript: (commitMessage?: string) => Promise;
/**
* Creates a bookmark.
*
* Parameters:
*
* - `prop` - Properties for the object.
*
* Stability: *locked*
*/
createBookmark: (prop: GenericBookmarkProperties) => Promise;
/**
* Creates a bookmark with softpatches.
*
* Parameters:
*
* - `prop` - Properties for the object.
* - `objectIdsToPatch` - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark.
*
* Stability: *experimental*
*/
createBookmarkEx: (prop: GenericBookmarkProperties, objectIdsToPatch?: string[]) => Promise;
/**
* Creates a connection.
* A connection indicates from which data source the data should be taken.
*
* Parameters:
*
* - `connection` - Information about the connection.
*
* Stability: *locked*
*/
createConnection: (connection: Connection) => Promise;
/**
* Creates a master dimension.
* A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.
*
* Parameters:
*
* - `prop` - Information about the properties.
*
* Stability: *locked*
*/
createDimension: (prop: GenericDimensionProperties) => Promise;
/**
* Creates a draft of an object.
* This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published.
* Replace the published object by the content of the draft by invoking the _CommitDraft method_.
*
* The identifier is set by the engine.
*
* Parameters:
*
* - `id` - Identifier of the object to create a draft from.
*
* @deprecated: This will be removed in a future version
*
* Stability: *locked*
*/
createDraft: (id: string) => Promise;
/**
* Creates a master measure.
* A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.
*
* Parameters:
*
* - `prop` - Information about the properties.
*
* Stability: *locked*
*/
createMeasure: (prop: GenericMeasureProperties) => Promise;
/**
* Creates a generic object at app level. For more information on generic objects, see _Generic object_.
* It is possible to create a generic object that is linked to another object.
* A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in _qExtendsId_ ).
* The linked object has the same properties as the linking object.
* The linking object cannot be a transient object.
*
* Parameters:
*
* - `prop` - Information about the object.
*
* Stability: *locked*
*/
createObject: (prop: CustomProperties) => Promise;
/**
* Creates a transient object. For example, you can use a transient object to create an app overview or a story overview.
* It is possible to create a transient object that is linked to another object.
* A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in _qExtendsId_ ).
* The linked object has the same properties as the linking object.
* The linking object cannot be a transient object.
*
* Parameters:
*
* - `prop` - Information about the object.
*
* Stability: *locked*
*/
createSessionObject: (prop: CustomProperties) => Promise;
/**
* Creates a transient variable.
* To set some properties to the variable, use the _SetProperties method_.
*
* ### Definition
* A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.
* When a variable is used in an expression, it is substituted by its value or the variable's definition.
*
* ### Example
* The variable _x_ contains the text string _Sum(Sales)_ .
* In a chart, you define the expression _$(x)/12_ . The effect is exactly the same as having the chart expression _Sum(Sales)/12_ .
* However, if you change the value of the variable _x_ to _Sum(Budget)_ , the data in the chart are immediately recalculated with the expression interpreted as _Sum(Budget)/12_ .
*
* Parameters:
*
* - `prop` - Name of the variable. Variable names are case sensitive.
*
* Stability: *locked*
*/
createSessionVariable: (prop: GenericVariableProperties) => Promise;
/**
* Create temporary bookmark
* CreateTemporaryBookmark method is only supported in SaaS Editions of Qlik Sense.
*
* Parameters:
*
* - `options` - Options for the temporary bookmark
* - `objectIdsToPatch` - Add softpatches for these objects to the bookmark if available. If IncludePatches is true, softpatches are included for all objects.
* Any session objects included are also added to the bookmark. IncludePatches has no effect on the patching of session objects.
*
* Stability: *locked*
*/
createTemporaryBookmark: (options: NxTempBookmarkOptions, objectIdsToPatch?: string[]) => Promise;
/**
* Creates a variable.
*
* Parameters:
*
* - `name` - Name of the variable. Variable names are case sensitive.
*
* @deprecated: Use _Doc::CreateVariableEx_ method instead
*
* Stability: *locked*
*/
createVariable: (name: string) => Promise;
/**
* Creates a variable.
* To create a variable via a script, you need to use the _SetScript method_. For more information, see _Create a variable_.
* To set some properties to the variable, use the _SetProperties method_.
In a published app, only transient variables can be created. See _CreateSessionVariable method_.
*
* ### Definition
* A variable in Qlik Sense is a named entity, containing a data value. This value can be static or be the result of a calculation. A variable acquires its value at the same time that the variable is created or after when updating the properties of the variable. Variables can be used in bookmarks and can contain numeric or alphanumeric data. Any change made to the variable is applied everywhere the variable is used.
* When a variable is used in an expression, it is substituted by its value or the variable's definition.
*
* ### Example
* The variable _x_ contains the text string _Sum(Sales)_ .
* In a chart, you define the expression _$(x)/12_ . The effect is exactly the same as having the chart expression _Sum(Sales)/12_ .
* However, if you change the value of the variable _x_ to _Sum(Budget)_ , the data in the chart are immediately recalculated with the expression interpreted as _Sum(Budget)/12_ .
*
* Parameters:
*
* - `prop` - Name of the variable. Variable names are case sensitive and must be unique.
*
* Stability: *locked*
*/
createVariableEx: (prop: GenericVariableProperties) => Promise;
/**
* Deletes a connection.
* In Qlik Sense Enterprise, there is an additional file connection named _AttachedFiles_ . The AttachedFiles connection can only be removed by the administrator of the system.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection to remove.
*
* Stability: *locked*
*/
deleteConnection: (connectionId: string) => Promise;
/**
* Removes a bookmark.
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the bookmark.
*
* Stability: *locked*
*/
destroyBookmark: (id: string) => Promise;
/**
* Removes a dimension.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the dimension to remove.
*
* Stability: *locked*
*/
destroyDimension: (id: string) => Promise;
/**
* Removes the draft of an object.
* The children of the draft object (if any) are removed as well.
* This method can be used to cancel the work on the draft of an object. For example, if you had created a draft of a sheet that is published, you might not want anymore to replace the published sheet.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the draft object to remove.
* - `sourceId` - Identifier of the source object (the object from which a draft was created).
*
* @deprecated: This will be removed in a future version
*
* Stability: *locked*
*/
destroyDraft: (id: string, sourceId: string) => Promise;
/**
* Removes a generic measure.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the measure to remove.
*
* Stability: *locked*
*/
destroyMeasure: (id: string) => Promise;
/**
* Removes an app object.
* The children of the object (if any) are removed as well.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the object to remove.
*
* Stability: *locked*
*/
destroyObject: (id: string) => Promise;
/**
* Removes a transient object.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the transient object to remove.
*
* Stability: *locked*
*/
destroySessionObject: (id: string) => Promise;
/**
* Removes a transient variable.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the variable.
*
* Stability: *locked*
*/
destroySessionVariable: (id: string) => Promise;
/**
* Removes a transient variable.
*
* **qSuccess** is set to true if the operation is successful.
*
* Parameters:
*
* - `id` - Identifier of the variable.
*
* Stability: *locked*
*/
destroySessionVariableById: (id: string) => Promise;
/**
* Removes a transient variable.
*
* **qSuccess** is set to true if the operation is successful.
*
* Parameters:
*
* - `name` - Name of the variable.
*
* Stability: *locked*
*/
destroySessionVariableByName: (name: string) => Promise;
/**
* Removes a variable.
* Script-defined variables cannot be removed using the _DestroyVariableById method_ or the _DestroyVariableByName method_. For more information, see _Remove a variable_.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `id` - Identifier of the variable.
*
* Stability: *locked*
*/
destroyVariableById: (id: string) => Promise;
/**
* Removes a variable.
* Script-defined variables cannot be removed using the _DestroyVariableById method_ or the _DestroyVariableByName method_. For more information, see _Remove a variable_.
*
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `name` - Name of the variable.
*
* Stability: *locked*
*/
destroyVariableByName: (name: string) => Promise;
/**
* Reloads the script that is set in an app.
*
* ### Logs
* When this method is called, audit activity logs are produced to track the user activity.
* In the case of errors, both audit activity logs and system services logs are produced.
* The log files are named as follows:
*
*
* | Audit activity log |
* System service log |
*
*
* <MachineName>_AuditActivity_Engine.txt in Qlik Sense Enterprise <MachineName>_AuditActivity_Engine.log in Qlik Sense Desktop |
* <MachineName>_Service_Engine.txt in Qlik Sense Enterprise <MachineName>_Service_Engine.log in Qlik Sense Desktop |
*
*
*
* ### Where to find the log files
* The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.
*
*
* | Qlik Sense Enterprise |
* Qlik Sense Desktop |
*
*
* | %ProgramData%/Qlik/Sense/Log/Engine |
* %UserProfile%/Documents/Qlik/Sense/Log |
*
*
*
* Parameters:
*
* - `mode` - Error handling mode
* One of:
* * 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.
* - `partial` - Set to true for partial reload.
* The default value is false.
* - `debug` - Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode.
* The default value is false.
*
* Stability: *locked*
*/
doReload: (mode?: number, partial?: boolean, debug?: boolean) => Promise;
/**
* Reloads the script that is set in an app and returns the path to the script log file.
* A log file is created per reload.
*
* ### Logs
* When this method is called, audit activity logs are produced to track the user activity.
* In the case of errors, both audit activity logs and system services logs are produced.
* The log files are named as follows:
*
*
*
* | Audit activity log |
* System service log |
*
*
* < MachineName> AuditActivity Engine.txt in Qlik Sense Enterprise < MachineName> AuditActivity Engine.log in Qlik Sense Desktop |
* < MachineName> Service Engine.txt in Qlik Sense Enterprise < MachineName> Service Engine.log in Qlik Sense Desktop |
*
*
*
*
* ### Where to find the log files
* The location of the log files depends on whether you have installed Qlik Sense Enterprise or Qlik Sense Desktop.
*
*
*
* | Qlik Sense Enterprise |
* Qlik Sense Desktop |
*
*
* | %ProgramData%/Qlik/Sense/Log/Engine |
* %UserProfile%/Documents/Qlik/Sense/Log |
*
*
*
*
* ### DoReloadExParams
*
*
*
* | Name |
* Description |
* Type |
*
*
* | qMode |
* Error handling mode One of:
*
* - 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.
*
* |
* Integer |
*
*
* | qPartial |
* Set to true for partial reload. The default value is false. |
* Boolean |
*
*
* | qDebug |
* Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. The default value is false. |
* Boolean |
*
*
*
*
* ### DoReloadExResult
*
*
*
* | Name |
* Description |
* Type |
*
*
* | qSuccess |
* The operation is successful if qSuccess is set to True. |
* Boolean |
*
*
* | qScriptLogFile |
* Path to the script log file. |
* String |
*
*
*
*
* If the data load has successfully finished, no matter how the indexing behaves, _true_ is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.
*
* Stability: *locked*
*/
doReloadEx: (params?: DoReloadExParams) => Promise;
/**
* Saves an app. All objects and data in the data model are saved.
*
* Parameters:
*
* - `fileName` - Name of the file to save.
*
* Stability: *locked*
*/
doSave: (fileName?: string) => 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"
* }
* }
* ```
*
* Parameters:
*
* - `expression` - Expression to evaluate.
*
* Stability: *locked*
*/
evaluate: (expression: 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"
* }
* }
* ```
*
* Parameters:
*
* - `expression` - Expression to evaluate.
*
* Stability: *locked*
*/
evaluateEx: (expression: string) => Promise;
/**
* Expands the expression.
*
* Parameters:
*
* - `expression` - The expression string to expand.
*
* Stability: *locked*
*/
expandExpression: (expression: string) => Promise;
/**
* Applies a bookmark to reduce (slice) the data on. Returns a url and file size to the reduced application. Section Access is always applied.
* This API is only available on Sense Enterprise on Windows
*
* Parameters:
*
* - `options` - BookmarkId used to reduced the app on and an expire time.
*
* Stability: *locked*
*/
exportReducedData: (options?: NxDownloadOptions) => Promise;
/**
* Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags.
* Tags set by Qlik Sense are prefixed by the _$_ sign.
*
* Parameters:
*
* - `fieldName` - Name of the field.
* This method looks for fields that belong to the same archipelago as this specified field.
* - `tags` - List of tags.
* This method looks for fields that match at least one of the tags in this list.
*
* Stability: *locked*
*/
findMatchingFields: (fieldName: string, tags: string[]) => Promise;
/**
* Loads the next logical operation (if any).
*
* Stability: *locked*
*/
forward: () => Promise;
/**
* Returns the number of entries on the Forward stack.
*
* Stability: *locked*
*/
forwardCount: () => Promise;
/**
* Returns the identifier and the type of any generic object in the app.
*
* Stability: *locked*
*/
getAllInfos: () => Promise;
/**
* Evaluates an app.
* Returns dynamic properties (if any) in addition to the engine (fixed) properties.
* A data set is returned.
*
* Stability: *locked*
*/
getAppLayout: () => Promise;
/**
* Gets the properties of an app.
*
* Stability: *locked*
*/
getAppProperties: () => Promise;
/**
* Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.
* When a table contains some synthetic keys, all fields in the synthetic key tables are analyzed against fields in other tables. To denote that a field is a synthetic key, the field name is prefixed by _[Synthetic Key]:_ .
*
* Parameters:
*
* - `table1` - Name of the first table.
* - `table2` - Name of the second table.
*
* Stability: *locked*
*/
getAssociationScores: (table1: string, table2: string) => Promise;
/**
* Returns the handle of a bookmark.
*
* Parameters:
*
* - `id` - Identifier of the bookmark.
*
* Stability: *locked*
*/
getBookmark: (id: string) => Promise;
/**
* Returns all bookmarks compatible with options.
*
* Parameters:
*
* - `options` - Bookmark type filter and requested properties.
*
* Stability: *locked*
*/
getBookmarks: (options: NxGetBookmarkOptions) => Promise[]>;
/**
* Retrieves a connection and returns:
* * The creation time of the connection.
* * The identifier of the connection.
* * The type of the connection.
* * The name of the connection.
* * The connection string.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
*
* Stability: *locked*
*/
getConnection: (connectionId: string) => Promise;
/**
* Lists the connections in an app.
* In Qlik Sense Enterprise, there is an additional file connection named _AttachedFiles_ . This connection is stored in the Qlik Sense repository.
*
* Stability: *locked*
*/
getConnections: () => Promise;
/**
* Lists the content libraries.
* To differentiate a global content library from an app specific content library, you can check the property _qAppSpecific_ . If this property is set to true, it means that the content library is app specific.
* There is always one specific content library per app.
*
* ### Qlik Sense
* Returns the global content libraries and the app specific content library.
* When using Qlik Sense, you can have more than one global content library. The global content libraries are common to all apps in the Qlik Sense repository.
* By default, there is one global content library named _Default_ .
*
* ### Qlik Sense Desktop
* Returns the global content library and the app specific content library from the disk.
*
* Stability: *locked*
*/
getContentLibraries: () => Promise;
/**
* Gives information about an ODBC, OLEDB or CUSTOM connection. See _Outputs_ for more details.
*
* Parameters:
*
* - `connectionId` - Name of the connection.
*
* Stability: *locked*
*/
getDatabaseInfo: (connectionId: string) => Promise;
/**
* Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `database` - Name of the database.
*
* Stability: *locked*
*/
getDatabaseOwners: (connectionId: string, database?: string) => Promise;
/**
* Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `database` - Name of the database.
* If _qDatabase_ is not set then _qOwner_ must be set.
* - `owner` - Owner of the database.
* If _qOwner_ is not set then _qDatabase_ must be set.
* - `table` - Name of the table.
*
* Stability: *locked*
*/
getDatabaseTableFields: (connectionId: string, database: string | undefined, owner: string | undefined, table: string) => Promise;
/**
* Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `database` - Name of the database.
* If _qDatabase_ is not set then _qOwner_ must be set.
* - `owner` - Owner of the database.
* If _qOwner_ is not set then _qDatabase_ must be set.
* - `table` - Name of the table.
* - `conditions` -
*
* Stability: *locked*
*/
getDatabaseTablePreview: (connectionId: string, database: string | undefined, owner: string | undefined, table: string, conditions?: FilterInfo) => Promise;
/**
* Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `database` - Name of the database.
* If _qDatabase_ is not set then _qOwner_ must be set.
* - `owner` - Owner of the database.
* If _qOwner_ is not set then _qDatabase_ must be set.
*
* Stability: *locked*
*/
getDatabaseTables: (connectionId: string, database?: string, owner?: string) => Promise;
/**
* Lists the databases inside a ODBC, OLEDB or CUSTOM data source.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
*
* Stability: *locked*
*/
getDatabases: (connectionId: string) => Promise;
/**
* Returns the handle of a dimension.
*
* Parameters:
*
* - `id` - Identifier of the dimension.
*
* Stability: *locked*
*/
getDimension: (id: string) => Promise;
/**
* Creates a script that contains one section. This section contains **SET** statements that give localized information from the regional settings of the computer.
* The computer regional settings are retrieved when the engine starts.
*
* Parameters:
*
* - `localizedMainSection` - Name of the script section.
* The default value is _Main_ .
*
* Stability: *locked*
*/
getEmptyScript: (localizedMainSection?: string) => Promise;
/**
* Gets the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.
*
* Stability: *experimental*
*/
getExpressionBNF: () => Promise;
/**
* Gets a string hash calculated from the current Backus-Naur Form (BNF) grammar of the Qlik chart expressions supported within a given App.
*
* Stability: *experimental*
*/
getExpressionBNFHash: () => Promise;
/**
* Retrieves the variables that are tagged as favorite.
*
* Stability: *locked*
*/
getFavoriteVariables: () => Promise;
/**
* Returns a handle to a field.
*
* Parameters:
*
* - `fieldName` - Name of the field.
* - `stateName` - Name of the alternate state.
* Default state is current selections.
*
* Stability: *locked*
*/
getField: (fieldName: string, stateName?: string) => Promise;
/**
* Get sample values from either a column in a table or from a field.
* Supports wildcard matches in tables or field names:
* - '*' for zero or more characters.
* - '?' for one character.
*
* Parameters:
*
* - `fieldsOrColumnsWithWildcards` - Pairs of table (optionally) and field names. Support wildcard matches.
* - `maxNumberOfValues` - Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned.
* - `randSeed` - Optional. Sets the random number seed. Should only be set for test purposes.
*
* Stability: *locked*
*/
getFieldAndColumnSamples: (fieldsOrColumnsWithWildcards: FieldOrColumn[], maxNumberOfValues: number, randSeed?: number) => Promise;
/**
* Returns the description of a field.
*
* Parameters:
*
* - `fieldName` - Name of the field.
*
* Stability: *locked*
*/
getFieldDescription: (fieldName: string) => Promise;
/**
* Find the field-on-the-fly by passing its readable name.
*
* Parameters:
*
* - `readableName` - Readable name of the field-on-the-fly.
*
* Stability: *locked*
*/
getFieldOnTheFlyByName: (readableName: string) => Promise;
/**
* Retrives any fields from an expression.
*
* Parameters:
*
* - `expr` - Expression to get fields from.
*
* Stability: *locked*
*/
getFieldsFromExpression: (expr: string) => Promise;
/**
* Returns a list of resource ids (QRI) for fields that belongs to the datamodel.
* Key fields (that belongs to multiple tables), returns one resource identifier per table.
* GetFieldsResourceIds method is only supported in SaaS Editions of Qlik Sense.
*
* Parameters:
*
* - `fieldNames` - List of fields names that resource ids should be returned from.
*
* Stability: *locked*
*/
getFieldsResourceIds: (fieldNames: string[]) => Promise;
/**
* Lists the fields of a table for a folder connection.
*
* ### FileType
* Recognized file formats are:
* * _CSV_ for Delimited
* * _FIX_ for Fixed Record
* * _DIF_ for Data Interchange Format
* * _EXCEL_BIFF_ for Microsoft Excel (XLS)
* * _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* * _HTML_ for HTML
* * _QVD_ for QVD file
* * _XML_ for XML
* * _QVX_ for QVX file
* * _JSON_ for JSON format
* * _KML_ for KML file
* * _PARQUET_ for PARQUET file
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `relativePath` - Path of the connection file.
* - `dataFormat` - Type of the file.
* - `table` - Name of the table.
* This parameter must be set for _XLS_ , _XLSX_ , _HTML _ and _XML_ files.
*
* Stability: *locked*
*/
getFileTableFields: (connectionId: string, relativePath: string | undefined, dataFormat: FileDataFormat, table: string) => Promise;
/**
* Lists the values in a table for a folder connection.
*
* ### FileType
* Recognized file formats are:
* * _CSV_ for Delimited
* * _FIX_ for Fixed Record
* * _DIF_ for Data Interchange Format
* * _EXCEL_BIFF_ for Microsoft Excel (XLS)
* * _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* * _HTML_ for HTML
* * _QVD_ for QVD file
* * _XML_ for XML
* * _QVX_ for QVX file
* * _JSON_ for JSON format
* * _KML_ for KML file
* * _PARQUET_ for PARQUET file
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `relativePath` - Path of the connection file.
* - `dataFormat` - Type of the file.
* - `table` - Name of the table.
* This parameter must be set for _XLS_ , _XLSX_ , _HTML _ and _XML_ files.
*
* Stability: *locked*
*/
getFileTablePreview: (connectionId: string, relativePath: string | undefined, dataFormat: FileDataFormat, table: string) => Promise;
/**
* Lists the tables for a folder connection.
*
* ### FileType
* Recognized file formats are:
* * _CSV_ for Delimited
* * _FIX_ for Fixed Record
* * _DIF_ for Data Interchange Format
* * _EXCEL_BIFF_ for Microsoft Excel (XLS)
* * _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* * _HTML_ for HTML
* * _QVD_ for QVD file
* * _XML_ for XML
* * _QVX_ for QVX file
* * _JSON_ for JSON format
* * _KML_ for KML file
* * _PARQUET_ for PARQUET file
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `relativePath` - Path of the connection file.
* - `dataFormat` - Type of the file.
*
* Stability: *locked*
*/
getFileTables: (connectionId: string, relativePath: string | undefined, dataFormat: FileDataFormat) => Promise;
/**
* Lists the tables and fields of a JSON or XML file for a folder connection.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `relativePath` - Path of the connection file.
* - `dataFormat` - Type of the file.
*
* Stability: *locked*
*/
getFileTablesEx: (connectionId: string, relativePath: string | undefined, dataFormat: FileDataFormat) => Promise;
/**
* Lists the items for a folder connection.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `relativePath` - Relative path of the connection.
*
* Stability: *locked*
*/
getFolderItemsForConnection: (connectionId: string, relativePath?: string) => Promise;
getGroupStates: () => Promise;
/**
* Gets the content of a file.
*
* Parameters:
*
* - `path` - ["lib://CONNECTION_NAME\\\<the name of the file you want to use>.txt"]
* OR
* ["lib://Connection_Name\\\<Folder under your connection>\\\<the name of the file you want to use>.txt"]
* [ ] should be used when the first variable contains a lib reference.
*
* Stability: *locked*
*/
getIncludeFileContent: (path: string) => Promise;
/**
* Returns the content of a library.
*
* ### Global content library
* In Qlik Sense Desktop, the content files are retrieved from:
* _%userprofile%\Documents\Qlik\Sense\Content\Default_
* In Qlik Sense Enterprise, the content files are retrieved from the Qlik Sense repository.
*
* ### App specific content library
* The embedded files are returned.
*
* Parameters:
*
* - `name` - Name of the content library.
* It corresponds to the property _qContentLibraryListItem/qName_ returned by the _GetContentLibraries method_.
*
* Stability: *locked*
*/
getLibraryContent: (name: string) => Promise;
/**
* Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from the data load script associated with this app.
* An array of lineage information.
*
* Stability: *locked*
*/
getLineage: () => Promise;
/**
* Returns locale information.
*
* Stability: *locked*
*/
getLocaleInfo: () => 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.
*
* Stability: *locked*
*/
getLooselyCoupledVector: () => Promise;
/**
* Retrieves any fields that match all of the specified tags or just one of them in the data model of an app.
* Tags set by Qlik Sense are prefixed by the _$_ sign.
*
* Parameters:
*
* - `tags` - List of tags.
* The _GetMatchingFields_ method looks for fields that match one or all of the tags in this list, depending on the value of _qMatchingFieldMode_ .
* - `matchingFieldMode` - Matching field mode.
* The default value is MATCHINGFIELDMODE_MATCH_ALL.
*
* One of:
* * MATCHINGFIELDMODE_MATCH_ALL
* * MATCHINGFIELDMODE_MATCH_ONE
*
* Stability: *locked*
*/
getMatchingFields: (tags: string[], matchingFieldMode?: string) => Promise;
/**
* Returns the handle of a measure.
*
* Parameters:
*
* - `id` - Identifier of the measure.
*
* Stability: *locked*
*/
getMeasure: (id: string) => Promise;
/**
* Returns the handle of a measure with a label.
* If multiple measures has the same label the first is returned.
*
* Parameters:
*
* - `label` - is the label of the measure to be returned.
*
* Stability: *locked*
*/
getMeasureWithLabel: (label: string) => Promise;
/**
* Lists the media files.
*
* @deprecated: Use _GetLibraryContent_ method instead
*
* Stability: *locked*
*/
getMediaList: () => Promise;
/**
* Returns the type of the app object and the corresponding handle.
*
* Parameters:
*
* - `id` - Identifier of the object to retrieve.
*
* Stability: *locked*
*/
getObject: (id: string) => Promise;
/**
* Returns all objects compatible with options.
*
* Parameters:
*
* - `options` - Object type filter and requested properties.
*
* Stability: *locked*
*/
getObjects: (options: NxGetObjectOptions) => Promise[]>;
/**
* Get or create a generic object at app level with a specific Id and Type.
* Id and Type are specified in the GenericObjectProperties passed in.
* All other fields in this parameter serve as default properties.
* If the object does not exist with that Id, it is created and initialized from the default properties.
* If the object already exists, it is not changed. The properties passed in are not used.
* The call will fail if the Id is already used for another purpose, such as for an object of a different Type.
*
* Parameters:
*
* - `prop` - GenericObjectProperties with at least Info : { "qId": "<identifier of the new generic object>", "qType": "<type of the new generic object>" }
*
* Stability: *experimental*
*/
getOrCreateObject: (prop: CustomProperties) => Promise;
/**
* Gets values in script.
*
* Stability: *locked*
*/
getScript: () => Promise;
/**
* Lists the breakpoints in the script of an app.
*
* Stability: *locked*
*/
getScriptBreakpoints: () => Promise;
/**
* Gets script and script meta-data.
*
* Stability: *locked*
*/
getScriptEx: () => Promise;
/**
* Gets script meta-data.
*
* Stability: *experimental*
*/
getScriptMeta: () => Promise;
/**
* Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.
* | | BookmarkId empty | BookmarkId set |
* |-----------------------|--------------------------------------|----------------------------------------------------|
* |StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |
* |StateName set | State selections is returned. | State in bookmark with id is returned. |
*
* Parameters:
*
* - `stateName` - Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.
* - `bookmarkId` - Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.
*
* Stability: *locked*
*/
getSetAnalysis: (stateName?: string, bookmarkId?: string) => Promise;
/**
* Retrieves the data of a specific table.
*
* Parameters:
*
* - `offset` - Position from the top, starting from 0.
* If the offset is set to 0, the rows starting from the position/index 0 are shown.
* - `rows` - Number of rows to show.
* - `syntheticMode` - If this parameter is set to true, the internal data/table representation is shown. Synthetic fields are present (if any).
* - `tableName` - Name of the table.
*
* Stability: *locked*
*/
getTableData: (offset: number, rows: number, syntheticMode: boolean, tableName: string) => Promise;
/**
* Returns profile data for a given table.
*
* Parameters:
*
* - `tableName` - Name of the table
*
* Stability: *experimental*
*/
getTableProfileData: (tableName: string) => Promise;
/**
* Returns:
* * The list of tables in an app and the fields inside each table.
* * The list of derived fields.
* * The list of key fields.
*
* Parameters:
*
* - `windowSize` - Size of the window that is used to display the results.
* - `nullSize` -
* - `cellHeight` - Height of a cell in a table in pixels.
* - `syntheticMode` - One of:
* * _true_ for internal table viewer:
* Shows a more detailed view on how the Qlik engine defines the relations between fields and the quality of the keys.
* * _false_ for source table viewer:
* Shows the natural relation between fields without reference to synthetic keys and resultant linking synthetic tables. Instead synthetic keys are represented by multiple connectors between tables.
* - `includeSysVars` - If set to true, the system variables are included.
* - `includeProfiling` - If set to true, profiling information is included.
*
* Stability: *locked*
*/
getTablesAndKeys: (windowSize: Size, nullSize: Size, cellHeight: number, syntheticMode: boolean, includeSysVars: boolean, includeProfiling?: boolean) => Promise;
/**
* Fetches updated variables after a statement execution.
*
* If qRefSeqNo and qSetSeqNo are set to 0, it means that the variables were not updated.
*
* Stability: *locked*
*/
getTextMacros: () => Promise;
/**
* Returns a handle to a variable.
*
* Parameters:
*
* - `name` - Name of the variable.
*
* @deprecated: Use _Doc::GetVariableById_ method or _Doc::GetVariableByName_ method instead
*
* Stability: *locked*
*/
getVariable: (name: string) => Promise;
/**
* Gets the handle of a variable.
*
* Parameters:
*
* - `id` - Identifier of the variable.
*
* Stability: *locked*
*/
getVariableById: (id: string) => Promise;
/**
* Gets the handle of a variable.
*
* Parameters:
*
* - `name` - Name of the variable.
*
* Stability: *locked*
*/
getVariableByName: (name: string) => Promise;
getVariables: (listDef: VariableListDef) => Promise[]>;
/**
* Returns information about the position of the tables in the data model viewer.
* The position of the broom points and the position of the connection points cannot be retrieved in Qlik Sense.
*
* Stability: *locked*
*/
getViewDlgSaveInfo: () => Promise;
/**
* Guesses the data format for a given file.
* Recognized file formats are:
* * _CSV_ for Delimited
* * _FIX_ for Fixed Record
* * _DIF_ for Data Interchange Format
* * _EXCEL_BIFF_ for Microsoft Excel (XLS)
* * _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* * _HTML_ for HTML
* * _QVD_ for QVD file
* * _XML_ for XML
* * _QVX_ for QVX file
* * _JSON_ for JSON format
* * _KML_ for KML file
* * _PARQUET_ for PARQUET file
*
* ### FileType
* Recognized file formats are:
* * _CSV_ for Delimited
* * _FIX_ for Fixed Record
* * _DIF_ for Data Interchange Format
* * _EXCEL_BIFF_ for Microsoft Excel (XLS)
* * _EXCEL_OOXML_ for Microsoft Excel (XLSX)
* * _HTML_ for HTML
* * _QVD_ for QVD file
* * _XML_ for XML
* * _QVX_ for QVX file
* * _JSON_ for JSON format
* * _KML_ for KML file
* * _PARQUET_ for PARQUET file
*
* Parameters:
*
* - `connectionId` - Identifier of the connection file.
* - `relativePath` - Path of the connection file.
*
* Stability: *locked*
*/
guessFileType: (connectionId: string, relativePath?: string) => Promise;
/**
* Locks all selections in fields for current state.
*
* Parameters:
*
* - `stateName` - Alternate state name. When set, applies to alternate state instead of current.
*
* Stability: *locked*
*/
lockAll: (stateName?: string) => Promise;
/**
* Updates a connection.
* The identifier of a connection cannot be updated. qType cannot be modified with the ModifyConnection method.
*
* Parameters:
*
* - `connectionId` - Identifier of the connection.
* - `connection` - Information about the connection.
* Properties that can be updated.
* - `overrideCredentials` - Set this parameter to true to override the user name and password.
*
* Stability: *locked*
*/
modifyConnection: (connectionId: string, connection: Connection, overrideCredentials?: boolean) => Promise;
/**
* Publishes an app.
* All app objects are published. Generic objects, bookmarks, dimensions and measures inside the app are published.
* An app can only be published once and cannot be published to more than one stream.
*
* Parameters:
*
* - `streamId` - Identifier of the stream.
* - `name` - Name of the published app.
* If this parameter is not set, the engine automatically gives a new name to the published app.
*
* Stability: *locked*
*/
publish: (streamId: string, name?: string) => Promise;
/**
* Redoes the previous operation.
*
* The operation is successful if **qSuccess** is set to true.
*
* Stability: *locked*
*/
redo: () => Promise;
/**
* Removes an alternate state in the app.
*
* Parameters:
*
* - `stateName` - Name of the alternate state.
*
* Stability: *locked*
*/
removeAlternateState: (stateName: string) => Promise;
/**
* Removes an session alternate state in the app.
* The operation is successful if **qSuccess** is set to true.
*
* Parameters:
*
* - `stateName` - Name of the alternate state.
*
* Stability: *locked*
*/
removeSessionAlternateState: (stateName: string) => Promise;
/**
* Removes a variable.
*
* Parameters:
*
* - `name` - Name of the variable. Variable names are case sensitive.
*
* @deprecated: Use _Doc::DestroyVariableById_ method or _Doc::DestroyVariableByName_ method instead
*
* Stability: *locked*
*/
removeVariable: (name: string) => Promise;
/**
* Replace a bookmark. Optional inparams to change the original bookmarks properties, original are kept if left out.
*
* Parameters:
*
* - `id` - Identifier of the bookmark.
* - `ignorePatches` - Set to true to exclude patches from the bookmark. Default is false.
* - `objectIdsToPatch` - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true.
*
* Stability: *locked*
*/
replaceBookmark: (id: string, ignorePatches?: boolean, objectIdsToPatch?: string[]) => Promise;
/**
* Restore a temporary selection state identified by Id.
* RestoreTempSelectionState method is only supported in SaaS Editions of Qlik Sense.
*
* Parameters:
*
* - `id` - Identifier of the temporary selection state
*
* Stability: *locked*
*/
restoreTempSelectionState: (id: string) => Promise;
/**
* Resumes the app as the user left it.
*
* Stability: *locked*
*/
resume: () => Promise;
/**
* Save a copy of an app with a different name.
* Can be used to save a session app as an ordinary app.
*
* Parameters:
*
* - `newAppName` - <Name of the saved app>
*
* Stability: *locked*
*/
saveAs: (newAppName: string) => Promise;
/**
* Saves all objects that were modified in the app.
* Data from the data model are not saved.
This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
saveObjects: () => Promise;
/**
* Scrambles a field so the data is not recognizable. Some properties are retained to help debugging. For example, special characters are not changed, and small numbers are scrambled to another small number.
* Update access is required to use the function in Qlik Sense Enterprise.
*
* Parameters:
*
* - `fieldName` - Name of the field to scramble.
*
* Stability: *locked*
*/
scramble: (fieldName: string) => Promise;
/**
* Returns the search matches for one or more search terms.
* The search results depend on the search context.
* _SearchCombinationOptions_
*
* ### SearchMatchCombinations
*
*
* | Name |
* Description |
* Type |
*
*
* | qSearchMatchCombinations |
* Array of search combinations. |
* Array of SearchMatchCombination |
*
*
*
* Parameters:
*
* - `options` - Information about the search fields and the search context.
* - `terms` - List of terms to search for.
* - `page` - Array of pages to retrieve.
*
* @deprecated: Use _SearchResults_ method instead
*
* Stability: *locked*
*/
searchAssociations: (options: SearchCombinationOptions, terms: string[], page: SearchPage) => Promise;
/**
* Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: _slideitem_ , _sheet_ , _story_ , _slide_ , _masterobject_ , _snapshot_ , _LoadModel_ , _appprops_ and _searchhistory_ .
*
* Parameters:
*
* - `options` - Information about attributes.
* - `terms` - Terms to search for.
* - `page` - Array of pages to retrieve.
*
* Stability: *locked*
*/
searchObjects: (options: SearchObjectOptions, terms: string[], page: SearchPage) => Promise;
/**
* Returns the search matches for one or more search terms.
* Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).
* Each search group contains search results that correspond to a combination of search terms.
* For example, if the search terms are _organic_ , _pasta_ , and _America_ , the possible combination of search groups are:
* * organic
* * pasta
* * America
* * organic, pasta, America
* * organic, pasta
* * organic, America
* * pasta, America
*
* For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).
* For every search group item, there are one or several search matches. The position of the match in each search result is given.
*
* Parameters:
*
* - `options` - Information about the search combinations.
* - `terms` - Terms to search for.
* - `page` - Array of pages to retrieve.
*
* Stability: *locked*
*/
searchResults: (options: SearchCombinationOptions, terms: string[], page: SearchPage) => Promise;
/**
* Returns search terms suggestions.
*
* Parameters:
*
* - `options` - Information about the search combinations.
* - `terms` - Terms to search for.
*
* Stability: *locked*
*/
searchSuggest: (options: SearchCombinationOptions, terms: string[]) => Promise;
searchValues: (options: SearchValueOptions, terms: string[], page: SearchValuePage) => Promise;
/**
* Selects all search hits for a specified group.
* The results depend on the search context.
* _SearchCombinationOptions_.
*
* Parameters:
*
* - `options` - Information about the search fields and the search context.
* - `terms` - List of terms to search for.
* - `matchIx` - Index (value of _qId_ ) of the search result to select.
* - `softLock` - This parameter is deprecated and should not be set.
*
* Stability: *locked*
*/
selectAssociations: (options: SearchCombinationOptions, terms: string[], matchIx: number, softLock?: boolean) => Promise;
/**
* Sends a generic command to a custom connector.
* For more information on the commands that can be sent to a custom connector, see the QVX SDK help.
*
* Parameters:
*
* - `provider` - Connector file name.
* Command to be executed by the connector.
* - `command` - One of:
* * JsonRequest
* * GetCustomCaption
* * IsConnected
* * DisableQlikViewSelectButton
* * HaveStarField
* - `method` - Method name to be used within the command.
* The available methods depend on the chosen connector.
* - `parameters` - Parameters of the command.
* No parameters are required.
* - `appendConnection` - Name of the connection.
*
* Stability: *locked*
*/
sendGenericCommandToCustomConnector: (provider: string, command: string, method: string, parameters: string[], appendConnection: string) => Promise;
/**
* Sets properties to an app.
* The qLastReloadTime, qMigrationHash and qSavedInProductVersion properties does not need to be set but if they are, they should match the current values in the app layout.
*
* Parameters:
*
* - `prop` - Information about the properties of an app.
*
* Stability: *locked*
*/
setAppProperties: (prop: NxAppProperties) => Promise;
/**
* Set some variables as favorite.
*
* Parameters:
*
* - `names` - Variables to set as favorite.
*
* Stability: *locked*
*/
setFavoriteVariables: (names: string[]) => Promise;
/**
* Limits the number of rows of data to load from a data source.
* This method works when reloading in debug mode.
*
* Parameters:
*
* - `limit` - Fetch limit.
* Number of rows to load.
*
* Stability: *locked*
*/
setFetchLimit: (limit: number) => 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.
*
* Parameters:
*
* - `v` - The list of table states to set. A state will not be changed if already set to 2.
*
* Stability: *locked*
*/
setLooselyCoupledVector: (v: number[]) => Promise;
/**
* Prohibit binary load of this app.
* An app with prohibit binary load set cannot be loaded binary. For the setting to have effect a save is required.
*
* Parameters:
*
* - `prohibit` - True or false.
*
* Stability: *locked*
*/
setProhibitBinaryLoad: (prohibit: boolean) => Promise;
/**
* Sets values in script.
*
* Parameters:
*
* - `script` - Script content.
*
* Stability: *locked*
*/
setScript: (script: string) => Promise;
/**
* Set some breakpoints in the script of an app.
*
* Parameters:
*
* - `breakpoints` - Information about the breakpoints.
*
* Stability: *locked*
*/
setScriptBreakpoints: (breakpoints: EditorBreakpoint[]) => Promise;
/**
* Sets the positions of the tables in the data model viewer.
* The position of the broom points and the position of the connection points cannot be set in Qlik Sense.
*
* Parameters:
*
* - `info` - Information about the table.
*
* Stability: *locked*
*/
setViewDlgSaveInfo: (info: TableViewDlgSaveInfo) => Promise;
/**
* Store current selection state temporarily.
* The temporary selection state will be stored for 30min by default if TTL parameter is not present or positive.
* StoreTempSelectionState method is only supported in SaaS Editions of Qlik Sense.
*
* Parameters:
*
* - `tTLOfTempState` - Time to live in seconds for stored selection state
*
* Stability: *locked*
*/
storeTempSelectionState: (tTLOfTempState?: number) => Promise;
/**
* Transform current app into an instance of the targeted mode
*
* Parameters:
*
* - `dstParameters` - Attributes that should be set in the new app.
*
* Stability: *locked*
*/
transformApp: (dstParameters: TransformAppParameters) => Promise;
/**
* Undoes the previous operation.
*
* The operation is successful if **qSuccess** is set to true.
*
* Stability: *locked*
*/
undo: () => Promise;
/**
* Unlocks all selections in fields for current state.
*
* Parameters:
*
* - `stateName` - Alternate state name. When set, applies to alternate state instead of current.
*
* Stability: *locked*
*/
unlockAll: (stateName?: string) => Promise;
};
type NativeFieldFunctions = {
/**
* Clears the selections in a specific field.
*
* Stability: *locked*
*/
clear: () => Promise;
/**
* Maintains the selections in the current field while clearing the selections in the other fields.
*
* Parameters:
*
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
clearAllButThis: (softLock?: boolean) => Promise;
/**
* Returns the AND mode status of a field.
*
* Stability: *locked*
*/
getAndMode: () => Promise;
/**
* Retrieves the number of distinct values in a field.
*
* Stability: *locked*
*/
getCardinal: () => Promise;
/**
* Gets the properties of a field.
*
* The property _OneAndOnlyOne_ is set to true if one and only value has been selected in the field prior setting the property.
*
* Stability: *locked*
*/
getNxProperties: () => Promise;
/**
* Locks all selected values of a specific field.
*
* Stability: *locked*
*/
lock: () => Promise;
/**
* Selects some values in a field, by entering the element numbers related to the values to select.
*
* Parameters:
*
* - `values` - Indexes (or element numbers) of the values to select.
* - `toggleMode` - Set to true to keep any selections present in the list object.
* If this parameter is set to false, selections made before accepting the list object search become alternative.
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
lowLevelSelect: (values: number[], toggleMode: boolean, softLock?: boolean) => Promise;
/**
* Selects field values matching a search string.
*
* Parameters:
*
* - `match` - String to search for.
* Can contain wild cards or numeric search criteria.
* The characters <>"~()='[] have pre-defined meanings when used at the start of the string.
* To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character.
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
* - `excludedValuesMode` - Include excluded values in search.
*
* Stability: *locked*
*/
select: (match: string, softLock?: boolean, excludedValuesMode?: number) => Promise;
/**
* Selects all values of a field. Excluded values are also selected.
*
* Parameters:
*
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
selectAll: (softLock?: boolean) => Promise;
/**
* Selects all alternatives values in a specific field.
* In a field that contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
*
* Parameters:
*
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
selectAlternative: (softLock?: boolean) => Promise;
/**
* Inverts the current selections.
*
* Parameters:
*
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
selectExcluded: (softLock?: boolean) => Promise;
/**
* Selects all possible values in a specific field.
*
* Parameters:
*
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
selectPossible: (softLock?: boolean) => Promise;
/**
* Selects some values in a field, by entering the values to select.
*
* Parameters:
*
* - `fieldValues` - List of the values to select.
* - `toggleMode` - The default value is false.
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
selectValues: (fieldValues: FieldValue[], toggleMode?: boolean, softLock?: boolean) => Promise;
/**
* Sets a field in the AND mode.
*
* Parameters:
*
* - `andMode` - Specifies if the AND mode applies to the field.
* Set this parameter to true to enter the AND mode.
*
* Stability: *locked*
*/
setAndMode: (andMode: boolean) => Promise;
/**
* Sets some properties to a field.
*
* Parameters:
*
* - `properties` - Information about the properties of the field.
*
* Stability: *locked*
*/
setNxProperties: (properties: NxFieldProperties) => Promise;
/**
* Toggle selects field values matching a search string.
*
* Parameters:
*
* - `match` - String to search for.
* Can contain wild cards or numeric search criteria.
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
* - `excludedValuesMode` - Include excluded values in search.
*
* Stability: *locked*
*/
toggleSelect: (match: string, softLock?: boolean, excludedValuesMode?: number) => Promise;
/**
* Unlocks all selected values of a specific field if the target (or handle ) is a field.
*
* Stability: *locked*
*/
unlock: () => Promise;
};
type NativeGenericBookmarkFunctions = {
/**
* Applies a bookmark.
*
* The operation is successful if **qSuccess** is set to true.
*
* Stability: *locked*
*/
apply: () => Promise;
/**
* Applies a bookmark and verify result dataset against originally selected values.
*
* The operation is successful if **qApplySuccess** is set to true. **qWarnings** lists state and field with unmatching values
*
* Stability: *experimental*
*/
applyAndVerify: () => Promise;
/**
* Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
* and it will be forbidden in the near future.
* Applying a patch takes less time than resetting all the properties.
*
* Parameters:
*
* - `patches` - Array of patches.
*
* Stability: *locked*
*/
applyPatches: (patches: NxPatch[]) => Promise;
/**
* Adds the generic bookmark to the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
approve: () => Promise;
/**
* Retrieves the values of a field for the default state.
*
* ### Fieldvalue
*
*
*
* | Name |
* Description |
* Type |
*
*
* | qText |
* Text related to the field value. |
* String |
*
*
* | qIsNumeric |
* Is set to true if the value is a numeric. Default is false. |
* Boolean |
*
*
* | qNumber |
* Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. |
* Double |
*
*
*
*
* Parameters:
*
* - `field` - Name of the field.
* - `getExcludedValues` - If set to true, only NOT-selected values are returned.
* - `dataPage` - Range of returned values.
*
* Stability: *locked*
*/
getFieldValues: (field: string, getExcludedValues: boolean, dataPage: BookmarkFieldPage) => Promise;
/**
* Retrieves the values of a field per state.
*
* ### Fieldvalue
*
*
*
* | Name |
* Description |
* Type |
*
*
* | qText |
* Text related to the field value. |
* String |
*
*
* | qIsNumeric |
* Is set to true if the value is a numeric. Default is false. |
* Boolean |
*
*
* | qNumber |
* Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. |
* Double |
*
*
*
*
* Parameters:
*
* - `field` - Name of the field.
* - `getExcludedValues` - When to true, only NOT-selected values are returned.
* - `dataPages` - Range of returned values per state, an empty array will return the values of all states. Only one page without a state name returns the values for all states, using the start and end indices of the first page.
*
* Stability: *locked*
*/
getFieldValuesEx: (field: string, getExcludedValues: boolean, dataPages: BookmarkStateFieldPages) => Promise;
/**
* Returns:
* * The type of the object.
* * The identifier of the object.
*
* Stability: *locked*
*/
getInfo: () => Promise;
/**
* Evaluates an object and displays its properties including the dynamic properties.
* If the member _delta_ is set to true in the request object, only the delta is evaluated.
*
* Stability: *locked*
*/
getLayout: () => Promise;
/**
* Shows the properties of an object.
* If the member delta is set to true in the request object, only the delta is retrieved.
* The following is always returned in the output:
*
* Stability: *locked*
*/
getProperties: () => Promise;
/**
* Publishes a bookmark.
* This operation is not applicable for Qlik Sense Desktop.
*
* Stability: *locked*
*/
publish: () => Promise;
/**
* Sets some properties for a bookmark.
*
* Parameters:
*
* - `prop` - Information about the bookmark.
*
* Stability: *locked*
*/
setProperties: (prop: GenericBookmarkProperties) => Promise;
/**
* Removes the generic bookmark from the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
unApprove: () => Promise;
/**
* Unpublishes a bookmark.
* This operation is not applicable for Qlik Sense Desktop.
*
* Stability: *locked*
*/
unPublish: () => Promise;
};
type NativeGenericDimensionFunctions = {
/**
* Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
* and it will be forbidden in the near future.
* Applying a patch takes less time than resetting all the properties.
*
* Parameters:
*
* - `patches` - Array of patches.
*
* Stability: *locked*
*/
applyPatches: (patches: NxPatch[]) => Promise;
/**
* Adds the generic dimension to the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
approve: () => Promise;
/**
* Get a cyclic dimension's active field.
* This operation is only possible for cyclic dimensions.
*
* Stability: *experimental*
*/
getActiveField: () => Promise;
/**
* Returns the definition of a dimension.
*
* The definition of the dimension is returned.
*
* Stability: *locked*
*/
getDimension: () => Promise;
/**
* Returns the type and identifier of the object.
*
* Stability: *locked*
*/
getInfo: () => Promise;
/**
* Evaluates a dimension and displays its properties, including the dynamic properties.
*
* Stability: *locked*
*/
getLayout: () => Promise;
/**
* Lists the linked objects to a generic object, a dimension or a measure.
*
* Stability: *locked*
*/
getLinkedObjects: () => Promise;
/**
* Shows the properties of an object.
* Returns the identifier and the definition of the dimension.
* If the member delta is set to true in the request object, only the delta is retrieved.
*
* Stability: *locked*
*/
getProperties: () => Promise;
/**
* Publishes a dimension.
* This operation is not applicable for Qlik Sense Desktop.
*
* Stability: *locked*
*/
publish: () => Promise;
/**
* Set a cyclic dimension's active field directly.
* This operation is only possible for cyclic dimensions.
*
* Parameters:
*
* - `ix` - Index of the new active field.
*
* Stability: *experimental*
*/
setActiveField: (ix: number) => Promise;
/**
* Sets some properties for a dimension.
*
* Parameters:
*
* - `prop` - Information about the dimension.
*
* Stability: *locked*
*/
setProperties: (prop: GenericDimensionProperties) => Promise;
/**
* Step active field in a cyclic dimension.
* This operation is only possible for cyclic dimensions.
*
* Parameters:
*
* - `step` - The number of steps made through the dimension. Positive values step forward and negative values step backward.
*
* Stability: *experimental*
*/
stepCycle: (step: number) => Promise;
/**
* Removes the generic dimension from the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
unApprove: () => Promise;
/**
* Unpublishes a dimension.
* This operation is not applicable for Qlik Sense Desktop.
*
* Stability: *locked*
*/
unPublish: () => Promise;
};
type NativeGenericMeasureFunctions = {
/**
* Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId",
* and it will be forbidden in the near future.
* Applying a patch takes less time than resetting all the properties.
*
* Parameters:
*
* - `patches` - Array of patches.
*
* Stability: *locked*
*/
applyPatches: (patches: NxPatch[]) => Promise;
/**
* Adds the generic measure to the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
approve: () => Promise;
/**
* Returns the type and identifier of the object.
*
* Stability: *locked*
*/
getInfo: () => Promise;
/**
* Evaluates a measure and displays its properties, including the dynamic properties.
*
* Stability: *locked*
*/
getLayout: () => Promise;
/**
* Lists the linked objects to a generic object, a dimension or a measure.
*
* Stability: *locked*
*/
getLinkedObjects: () => Promise;
/**
* Returns the definition of a measure.
*
* Stability: *locked*
*/
getMeasure: () => Promise;
/**
* Shows the properties of an object.
* Returns the identifier and the definition of the measure.
* If the member delta is set to true in the request object, only the delta is retrieved.
* The following is always returned in the output:
*
* Stability: *locked*
*/
getProperties: () => Promise;
/**
* Publishes a measure.
* This operation is not applicable for Qlik Sense Desktop.
*
* Stability: *locked*
*/
publish: () => Promise;
/**
* Sets some properties for a measure.
*
* Parameters:
*
* - `prop` - Information about the measure.
*
* Stability: *locked*
*/
setProperties: (prop: GenericMeasureProperties) => Promise;
/**
* Removes the generic measure from the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
unApprove: () => Promise;
/**
* Unpublishes a measure.
* This operation is not applicable for Qlik Sense Desktop.
*
* Stability: *locked*
*/
unPublish: () => Promise;
};
type NativeGenericObjectFunctions = {
/**
* Aborts the results of a search in a list object.
* This method applies to list objects (objects with one dimension).
After an abort on a list object search, the _GetLayout Method_ does not return any more search results but it does return the values in the field.
*
* Parameters:
*
* - `path` - Path to the definition of the list object.
* For example, _/qListObjectDef_ .
*
* Stability: *locked*
*/
abortListObjectSearch: (path: string) => Promise;
/**
* Accept the results of a search in a list object. The search results become selected in the field.
* This method applies to list objects (objects with one dimension).
The search results are displayed using the _GetLayout Method_.
*
* Parameters:
*
* - `path` - Path to the definition of the list object.
* For example, _/qListObjectDef_ .
* - `toggleMode` - Set to true to keep any selections present in the list object.
* If this parameter is set to false, selections made before accepting the list object search become alternative.
* - `softLock` - Set to true to ignore locks; in that case, locked fields can be selected.
* The default value is false.
*
* Stability: *locked*
*/
acceptListObjectSearch: (path: string, toggleMode: boolean, softLock?: boolean) => Promise;
/**
* You can use the AddGroupMembers method with any object that contains an object grouping definition.
* This method allows you to add one or more members to an existing group of objects directly.
*
* Parameters:
*
* - `path` - Path to the definition of the object to be selected.
* For exampleb _/qNxGroupDef_ .
* - `members` - Array of IDs for the objects and/or subgroups to add to the group.
* - `targetGroupId` - Name of the group the Members will be added to (if not the called object).
* - `posId` - Id of the member whose position to insert into.
*
* Stability: *experimental*
*/
addGroupMembers: (path: string, members: NxGroupObjectId[], targetGroupId?: string, posId?: string) => Promise;
/**
* Applies a patch to the properties of an object. Allows an update to some of the properties.
* It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.
* In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing _GetProperties_ , and only a _GetLayout_ call shows the result of the operation.
* Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId",
* and it will be forbidden in the near future.
* Soft properties apply only to generic objects.
*
* Parameters:
*
* - `patches` - Array of patches.
* - `softPatch` - If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch.
* The default value is false.
*
* Stability: *locked*
*/
applyPatches: (patches: NxPatch[], softPatch?: boolean) => Promise;
/**
* Adds the generic object to the list of approved objects
* This operation is possible only in Qlik Sense Enterprise.
*
* Stability: *locked*
*/
approve: () => Promise;
/**
* Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time.
* When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about:
* * Ending the selection mode, see _EndSelections Method_.
* * The sort criteria, see _ListObjectDef_ or _HyperCubeDef_.
*
* ### Example
* A sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode.
*
* Parameters:
*
* - `paths` - List of the paths to the definition of the objects to enter selection mode.
* For example, _/qListObjectDef_ .
*
* Stability: *locked*
*/
beginSelections: (paths: string[]) => Promise;
/**
* Clears the selections in a dimension of a visualization.
*
* Parameters:
*
* - `path` - Path to the definition of the visualization.
* For example, _/qListObjectDef_ .
* - `colIndices` - Array of dimension numbers or indexes. The selections are cleared in the specified dimensions.
* Dimension numbers/indexes start from 0.
* If this parameter is not set, all dimensions are cleared.
*
* Stability: *locked*
*/
clearSelections: (path: string, colIndices?: number[]) => Promise;
/**
* Clears the soft properties of a generic object.
* For more information on how to add soft properties to a generic object, see _ApplyPatches Method_.
*
* Stability: *locked*
*/
clearSoftPatches: () => Promise;
/**
* Collapses the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.
* In the definition of the hypercube (in _HyperCubeDef_ ), the parameter _qAlwaysFullyExpanded_ must be set to false.
*
* Parameters:
*
* - `path` - Path to the definition of the object to be collapsed.
* For example, _/qHyperCubeDef_ .
* - `row` - Row index in the data matrix.
* Indexing starts from 0.
* - `col` - Column index. The index is based on the left dimension indexes.
* Indexing starts from 0.
* - `all` - If set to true, it collapses all cells.
* Parameters _qRow_ and _qCol_ are not used if _qAll_ is set to true, but they need to be set (for example to 0).
*
* Stability: *locked*
*/
collapseLeft: (path: string, row: number, col: number, all: boolean) => Promise;
/**
* Collapses the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.
* In the definition of the hypercube (in _HyperCubeDef_ ), the parameter _qAlwaysFullyExpanded_ must be set to false.
*
* Parameters:
*
* - `path` - Path to the definition of the object to be collapsed
* For example, _/qHyperCubeDef_ .
* - `row` - Row index. The index is based on the top dimension indexes.
* Indexing starts from 0.
* - `col` - Column index in the data matrix.
* Indexing starts from 0.
* - `all` - If set to true, it collapses all cells.
* Parameters _qRow_ and _qCol_ are not used if _qAll_ is set to true, but they need to be set (for example to 0).
*
* Stability: *locked*
*/
collapseTop: (path: string, row: number, col: number, all: boolean) => Promise;
/**
* Copies the properties of a generic object and its children.
* The source object is specified by the parameter _qFromId_ and the destination object is referenced by its handle.
* The identifier of the destination object is the same as before the copy takes place.
*
* Parameters:
*
* - `fromId` - Identifier of the object to copy.
*
* Stability: *locked*
*/
copyFrom: (fromId: string) => Promise;
/**
* Creates a generic object that is a child of another generic object.
* It is possible to update the properties of the child's parent at the same time that the child is created. Both operations are performed by the same call.
It is possible to create a child that is linked to another generic object. The two objects have the same properties.
*
* Parameters:
*
* - `prop` - Information about the child.
* It is possible to create a child that is linked to another object.
* - `propForThis` - Identifier of the parent's object.
* Should be set to update the properties of the parent's object at the same time the child is created.
*
* Stability: *locked*
*/
createChild: (prop: CustomChildProperties, propForThis?: CustomProperties) => Promise;
/**
* You can use the CreateGroup method with any object that contains an object grouping definition.
* This method allows you to create a new subgroup of objects directly and add it to a group's members.
* Returns the ID of the created subgroup.
*
* Parameters:
*
* - `path` - Path to the definition of the object to be selected.
* For example _/qNxGroupDef_ .
* - `groupDef` - Definition of the new group.
* - `targetGroupId` - Id of the group to create the new subgroup in (if not the called object).
*
* Stability: *experimental*
*/
createGroup: (path: string, groupDef: NxGroupDef, targetGroupId?: string) => Promise