qe-api-client 2.7.0__py3-none-any.whl → 2.9.0__py3-none-any.whl

qe_api_client/api_classes/engine_app_api.py

@@ -26,7 +26,7 @@ class EngineAppApi:
         """
         self.engine_socket = socket
 
-    def get_script(self, doc_handle):
+    def get_script(self, doc_handle: int):
         """
         Retrieves the script of the app identified by the document handle.
 
@@ -43,7 +43,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def set_script(self, doc_handle, script):
+    def set_script(self, doc_handle: int, script):
         """
         Sets the script of the app identified by the document handle.
 
@@ -61,7 +61,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def do_reload(self, doc_handle, param_list=[]):
+    def do_reload(self, doc_handle: int, param_list=[]):
         """
         Triggers a reload of the app identified by the document handle.
 
@@ -79,7 +79,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def do_reload_ex(self, doc_handle, param_list={}):
+    def do_reload_ex(self, doc_handle: int, param_list={}):
         """
         Triggers an extended reload of the app identified by the document handle.
 
@@ -98,7 +98,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_app_layout(self, doc_handle):
+    def get_app_layout(self, doc_handle: int):
         """
         Retrieves the layout structure of the app identified by the document handle.
 
@@ -115,7 +115,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_object(self, app_handle, object_id):
+    def get_object(self, app_handle: int, object_id: str):
         """
         Retrieves a specific object from the app identified by the document handle.
 
@@ -134,7 +134,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_field(self, doc_handle, field_name, state_name=""):
+    def get_field(self, doc_handle: int, field_name, state_name=""):
         """
         Retrieves a specific field from the app identified by the document handle.
 
@@ -154,7 +154,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def create_object(self, doc_handle, prop):
+    def create_object(self, doc_handle: int, prop):
         """
         Creates a new object in the app identified by the document handle.
 
@@ -177,7 +177,7 @@ class EngineAppApi:
     # You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app.  # NOQA
     # Objects in a given state are not affected by user selections in the other states.  # NOQA
     # Call GetAppLayout() afterwards to get the latest states
-    def add_alternate_state(self, doc_handle, state_name):
+    def add_alternate_state(self, doc_handle: int, state_name):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "AddAlternateState",
                           "params": [state_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -188,7 +188,7 @@ class EngineAppApi:
 
     # AddFieldFromExpression method: Adds a field on the fly. !! The expression of a field on the fly is persisted but  # NOQA
     # not its values. !!
-    def add_field_from_expression(self, doc_handle, field_name, expr_value):
+    def add_field_from_expression(self, doc_handle: int, field_name, expr_value):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "AddFieldFromExpression",
                           "params": [field_name, expr_value]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -199,7 +199,7 @@ class EngineAppApi:
 
     # CheckExpression method: Checks whether an expression is valid or not
     # qErrorMsg is empty if it's valid
-    def check_expression(self, doc_handle, expr_value):
+    def check_expression(self, doc_handle: int, expr_value):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CheckExpression",
                           "params": [expr_value]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -211,7 +211,7 @@ class EngineAppApi:
     # CheckScriptSyntax method: Checks whether a load script is valid or not
     # Used AFTER doing SetScript method
     # errors are displayed in an array discussing positions of characters in script where failing  # NOQA
-    def check_script(self, doc_handle):
+    def check_script(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CheckScriptSyntax", "params": {}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -219,7 +219,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def clear_all(self, doc_handle, locked_also=False, alt_state=""):
+    def clear_all(self, doc_handle: int, locked_also=False, alt_state=""):
         """
         Clear selections in fields for current state. Locked fields are not cleared by default.
 
@@ -239,7 +239,7 @@ class EngineAppApi:
     # CreateConnection method: Creates a connection. A connection indicates from which data source, the data should  # NOQA
     # be taken. The connection can be: an ODBC connection, OLEDB connection, a custom connection, a folder connection  # NOQA
     #  (lib connection), an internet connection, Single Sign-On
-    def create_connection(self, doc_handle, connect_name, connect_string, connect_type, user_name, password,
+    def create_connection(self, doc_handle: int, connect_name, connect_string, connect_type, user_name, password,
                           mod_date="", meta="", sso_passthrough="LOG_ON_SERVICE_USER"):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateConnection",
                           "params": [{"qName": connect_name, "qMeta": meta, "qConnectionString": connect_string,
@@ -255,7 +255,7 @@ class EngineAppApi:
     # can contain the same dimension.
     # Parameters:
     # qProp (MANDATORY: send dim_id, dim_title, dim_grouping, dim_field, dim_label, meta_def (optional)  # NOQA
-    def create_dimension(self, doc_handle, prop):
+    def create_dimension(self, doc_handle: int, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateDimension",
                           "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -265,7 +265,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroyDimension method: Removes a dimension
-    def destroy_dimension(self, doc_handle, dim_id):
+    def destroy_dimension(self, doc_handle: int, dim_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyDimension",
                           "params": {"qId": dim_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -275,7 +275,7 @@ class EngineAppApi:
             return response["error"]
 
     # DestroyMeasure method: Removes a measure
-    def destroy_measure(self, doc_handle, measure_id):
+    def destroy_measure(self, doc_handle: int, measure_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyDimension",
                           "params": [{measure_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -285,7 +285,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroyObject method: Removes an app object. The children of the object (if any) are removed as well.  # NOQA
-    def destroy_object(self, doc_handle, object_id):
+    def destroy_object(self, doc_handle: int, object_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyObject",
                           "params": [{object_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -295,7 +295,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroySessionObject method: Removes a session object. The children of the object (if any) are removed as well.  # NOQA
-    def destroy_session_object(self, doc_handle, object_id):
+    def destroy_session_object(self, doc_handle: int, object_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroySessionObject",
                           "params": [{object_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -305,7 +305,7 @@ class EngineAppApi:
             return response['error']
 
     # DestroySessionVariable method: Removes an transient variable.
-    def destroy_session_variable(self, doc_handle, var_id):
+    def destroy_session_variable(self, doc_handle: int, var_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroySessionVariable",
                           "params": [{var_id}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -317,7 +317,7 @@ class EngineAppApi:
     # DestroyVariableById method: Removes a varable..
     # Script-defined variables cannot be removed using the DestroyVariableById method or the  # NOQA
     # DestroyVariableByName method.
-    def destroy_variable_by_id(self, doc_handle, var_name):
+    def destroy_variable_by_id(self, doc_handle: int, var_name):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DestroyVariableById",
                           "params": [{var_name}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -331,7 +331,7 @@ class EngineAppApi:
     # can contain the same dimension.
     # Parameters:
     # qProp (MANDATORY: send dim_id, dim_title, dim_grouping, dim_field, dim_label, meta_def (optional)  # NOQA
-    def create_measure(self, doc_handle, prop):
+    def create_measure(self, doc_handle: int, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateMeasure",
                           "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -364,7 +364,7 @@ class EngineAppApi:
     # ### Example:  The variable x contains the text string Sum(Sales). In a chart, you define the expression $(x)/12.  # NOQA
     # 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),  # NOQA
     # the data in the chart are immediately recalculated with the expression interpreted as Sum(Budget)/12.  # NOQA
-    def create_session_variable(self, doc_handle, var_id="", var_name="", var_comment="", var_def=""):
+    def create_session_variable(self, doc_handle: int, var_id="", var_name="", var_comment="", var_def=""):
         msg = json.dumps(
             {"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
              "method": "CreateSessionVariable", "params": [{
@@ -393,7 +393,7 @@ class EngineAppApi:
     # The effect is exactly the same as having the chart expression Sum(Sales)/12.   # NOQA
     # 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.  # NOQA
-    def create_variable(self, doc_handle, var_id="", var_name="", var_comment="", var_def=""):
+    def create_variable(self, doc_handle: int, var_id="", var_name="", var_comment="", var_def=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
                           "method": "CreateVariable", "params": [{
                                 "qInfo": {
@@ -435,7 +435,7 @@ class EngineAppApi:
 
     # DoSave method: Saves an app - All objects and data in the data model are saved.  # NOQA
     # Desktop only - server auto saves
-    def do_save(self, doc_handle, file_name=""):
+    def do_save(self, doc_handle: int, file_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "DoSave",
                           "params": {"qFileName": file_name}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -446,7 +446,7 @@ class EngineAppApi:
 
     # Evaluate method: Evaluates an expression as a string. (Actually uses EvaluateEx, which is better for giving the data type back to python)  # NOQA
     # Parameters: qExpression
-    def expr_eval(self, doc_handle, expr):
+    def expr_eval(self, doc_handle: int, expr):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "EvaluateEx",
                           "params": {"qExpression": expr}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -456,7 +456,7 @@ class EngineAppApi:
             return response['error']
 
     # GetAllInfos method: Get the identifier and the type of any generic object in an app by using the GetAllInfos method.  # NOQA
-    def get_all_infos(self, doc_handle):
+    def get_all_infos(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetAllInfos", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -465,7 +465,7 @@ class EngineAppApi:
             return response['error']
 
     # GetAppProperties method: Gets the properties of an app.
-    def get_app_properties(self, doc_handle):
+    def get_app_properties(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetAppProperties", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -475,7 +475,7 @@ class EngineAppApi:
 
     # GetConnection method: Retrieves a connection and returns: The creation time of the connection, The identifier of  # NOQA
     # the connection, The type of the connection, The name of the connection, The connection string  # NOQA
-    def get_connection(self, doc_handle, connection_id):
+    def get_connection(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetConnection",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -485,7 +485,7 @@ class EngineAppApi:
             return response['error']
 
     # GetConnections method: Lists the connections in an app
-    def get_connections(self, doc_handle):
+    def get_connections(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetConnections", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -494,7 +494,7 @@ class EngineAppApi:
             return response['error']
 
     # GetDatabaseInfo: Get information about an ODBC, OLEDB or CUSTOM connection  # NOQA
-    def get_db_info(self, doc_handle, connection_id):
+    def get_db_info(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseInfo",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -504,7 +504,7 @@ class EngineAppApi:
             return response['error']
 
     # GetDatabaseOwners: List the owners of a database for a ODBC, OLEDB or CUSTOM connection  # NOQA
-    def get_db_owners(self, doc_handle, connection_id):
+    def get_db_owners(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseOwners",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -514,7 +514,7 @@ class EngineAppApi:
             return response['error']
 
     # GetDatabases: List the databases of a ODBC, OLEDB or CUSTOM connection
-    def get_databases(self, doc_handle, connection_id):
+    def get_databases(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabases",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -525,7 +525,7 @@ class EngineAppApi:
 
     # GetDatabaseTableFields: List the fields in a table for a ODBC, OLEDB or CUSTOM connection  # NOQA
     # Parameters taken are: connection_id (mandatory), db_name, db_owner, table_name (mandatory)  # NOQA
-    def get_db_table_fields(self, doc_handle, connection_id, db_name="", db_owner="", table_name=""):
+    def get_db_table_fields(self, doc_handle: int, connection_id, db_name="", db_owner="", table_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseTableFields",
                           "params": [connection_id, db_name, db_owner, table_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -536,7 +536,7 @@ class EngineAppApi:
 
     # GetDatabaseTablePreview: Preview the data in the fields in a table for a ODBC, OLEDB or CUSTOM connection  # NOQA
     # Parameters taken are: connection_id (mandatory), db_name, db_owner, table_name (mandatory)  # NOQA
-    def get_db_table_preview(self, doc_handle, connection_id, db_name="", db_owner="", table_name=""):
+    def get_db_table_preview(self, doc_handle: int, connection_id, db_name="", db_owner="", table_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseTablePreview",
                           "params": [connection_id, db_name, db_owner, table_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -547,7 +547,7 @@ class EngineAppApi:
 
     # GetDatabaseTables: List the tables in a database for a specific owner and for a ODBC, OLEDB or CUSTOM connection  # NOQA
     # Parameters taken are: connection_id (mandatory), db_name, db_owner
-    def get_db_tables(self, doc_handle, connection_id, db_name="", db_owner=""):
+    def get_db_tables(self, doc_handle: int, connection_id, db_name="", db_owner=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetDatabaseTables",
                           "params": [connection_id, db_name, db_owner]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -560,7 +560,7 @@ class EngineAppApi:
     # GetEmptyScript: Creates a script that contains one section. This section contains Set statements that give  # NOQA
     # localized information from the regional settings of the computer.
     # Parameter: none
-    def get_empty_script(self, doc_handle):
+    def get_empty_script(self, doc_handle: int):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetEmptyScript", "params": []})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
@@ -570,7 +570,7 @@ class EngineAppApi:
 
     # GetFieldDescription: Get the description of a field
     # Parameter: field name
-    def get_field_descr(self, doc_handle, field_name):
+    def get_field_descr(self, doc_handle: int, field_name):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFieldDescription",
                           "params": {"qFieldName": field_name}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -585,7 +585,7 @@ class EngineAppApi:
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file
         # qTable (MOSTLY MANDATORY): Name of the table ***This parameter must be set for XLS, XLSX, HTML and XML files.***  # NOQA
-    def get_file_table_fields(self, doc_handle, connection_id,
+    def get_file_table_fields(self, doc_handle: int, connection_id,
                               rel_path="", data_fmt="", table_name=""):
         msg = json.dumps(
             {"jsonrpc": "2.0", "id": 0, "handle": doc_handle,
@@ -605,7 +605,7 @@ class EngineAppApi:
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file
         # qTable (MOSTLY MANDATORY): Name of the table ***This parameter must be set for XLS, XLSX, HTML and XML files.***  # NOQA
-    def get_file_table_preview(self, doc_handle, connection_id, rel_path="", data_fmt="", table_name=""):
+    def get_file_table_preview(self, doc_handle: int, connection_id, rel_path="", data_fmt="", table_name=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFileTablePreview",
                           "params": [connection_id, rel_path, {"qType": data_fmt}, table_name]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -620,7 +620,7 @@ class EngineAppApi:
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file (XML, JSON)
         # qTable (MOSTLY MANDATORY): Name of the table ***This parameter must be set for XLS, XLSX, HTML and XML files.***  # NOQA
-    def get_file_table_ex(self, doc_handle, connection_id,
+    def get_file_table_ex(self, doc_handle: int, connection_id,
                           rel_path="", data_fmt=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFileTablesEx",
                           "params": [connection_id, rel_path, {"qType": data_fmt}]})
@@ -635,7 +635,7 @@ class EngineAppApi:
         # qConnectionId (MANDATORY): Identifier of the connection.
         # qRelativePath: Path of the connection file
         # qDataFormat: Type of the file (XML, JSON)
-    def get_file_tables(self, doc_handle, connection_id, rel_path="", data_fmt=""):
+    def get_file_tables(self, doc_handle: int, connection_id, rel_path="", data_fmt=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFileTables",
                           "params": [connection_id, rel_path, {"qType": data_fmt}]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -646,7 +646,7 @@ class EngineAppApi:
 
     # GetFolderItemsForConnection method: List the items for a folder connection  # NOQA
     # Parameter: connection_id
-    def get_folder_items_for_connection(self, doc_handle, connection_id):
+    def get_folder_items_for_connection(self, doc_handle: int, connection_id):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetFolderItemsForConnection",
                           "params": [connection_id]})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -656,7 +656,7 @@ class EngineAppApi:
             return response['error']
 
     # GetAllInfos method: Get the identifier and the type of any generic object in an app by using the GetAllInfos method.  # NOQA
-    def get_lineage(self, doc_handle):
+    def get_lineage(self, doc_handle: int):
         """
         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.
@@ -674,7 +674,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def create_session_object(self, doc_handle, prop):
+    def create_session_object(self, doc_handle: int, prop):
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateSessionObject",
                           "params": {"qProp": prop}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -683,7 +683,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_set_analysis(self, doc_handle, state_name="", bookmark_id=""):
+    def get_set_analysis(self, doc_handle: int, state_name="", bookmark_id=""):
         msg = json.dumps({"jsonrpc": "2.0", "id": 3, "handle": doc_handle, "method": "GetSetAnalysis",
                           "params": {"qStateName": state_name, "qBookmarkId": bookmark_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
@@ -701,7 +701,7 @@ class EngineAppApi:
         except KeyError:
             return response['error']
 
-    def get_variable_by_id(self, doc_handle, variable_id):
+    def get_variable_by_id(self, doc_handle: int, variable_id):
         """
         Gets the handle of a variable.
 
@@ -715,6 +715,66 @@ class EngineAppApi:
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetVariableById",
                           "params": {"qId": variable_id}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']['qReturn']
+        except KeyError:
+            return response['error']
+
+
+    def create_bookmark(self, doc_handle: int, prop: dict):
+        """
+        Creates a bookmark.
+
+        Parameters:
+            doc_handle (int): The handle identifying the document.
+            prop (dict): Bookmark properties.
+
+        Returns:
+            dict: The handle of the generic bookmark.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "CreateBookmark",
+                          "params": {"qProp": prop}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']['qReturn']
+        except KeyError:
+            return response['error']
+
+
+    def get_bookmarks(self, doc_handle: int, options: dict):
+        """
+        Returns all bookmarks compatible with options.
+
+        Parameters:
+            doc_handle (int): The handle identifying the document.
+            qOptions (dict): Bookmark type filter and requested properties.
+
+        Returns:
+            list: The resulting list.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": doc_handle, "method": "GetBookmarks",
+                          "params": {"qOptions": options}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response['result']
+        except KeyError:
+            return response['error']
+
+
+    def get_bookmark(self, app_handle: int, bookmark_id: str):
+        """
+        Retrieves a specific bookmark from the app identified by the document handle.
+
+        Parameters:
+            app_handle (int): The handle identifying the app document.
+            bookmark_id (str): The ID of the bookmark to retrieve.
+
+        Returns:
+            dict: The retrieved object (qReturn). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": app_handle, "method": "GetBookmark",
+                          "params": {"qId": bookmark_id}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response['result']['qReturn']
         except KeyError:

qe_api_client/api_classes/engine_generic_object_api.py

@@ -124,7 +124,7 @@ class EngineGenericObjectApi:
         except KeyError:
             return response["error"]
 
-    def get_hypercube_data(self, handle, path="/qHyperCubeDef", pages={}):
+    def get_hypercube_data(self, handle: int, path: str, pages: list):
         """
         Retrieves the data from a specific hypercube in a generic object.
 
@@ -137,14 +137,14 @@ class EngineGenericObjectApi:
             dict: The data from the hypercube. In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetHyperCubeData",
-                          "params": {"qPath": path, "qPages": [pages]}})
+                          "params": {"qPath": path, "qPages": pages}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
         except KeyError:
             return response["error"]
 
-    def get_hypercube_pivot_data(self, handle, path="/qHyperCubeDef", pages={}):
+    def get_hypercube_pivot_data(self, handle: int, path: str, pages: list):
         """
         Retrieves the pivot data from a specific hypercube in a generic object.
 
@@ -157,14 +157,14 @@ class EngineGenericObjectApi:
             dict: The pivot data from the hypercube. In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetHyperCubePivotData",
-                          "params": {"qPath": path, "qPages": [pages]}})
+                          "params": {"qPath": path, "qPages": pages}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
         except KeyError:
             return response["error"]
 
-    def get_hypercube_stack_data(self, handle, path="/qHyperCubeDef", pages={}, max_no_cells=10000):
+    def get_hypercube_stack_data(self, handle: int, path: str, pages: list, max_no_cells: int = 10000):
         """
         Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
 
@@ -179,7 +179,7 @@ class EngineGenericObjectApi:
             dict: The pivot data from the hypercube. In case of an error, returns the error information.
         """
         msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetHyperCubeStackData",
-                          "params": {"qPath": path, "qPages": [pages], "qMaxNbrCells": max_no_cells}})
+                          "params": {"qPath": path, "qPages": pages, "qMaxNbrCells": max_no_cells}})
         response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
         try:
             return response["result"]
@@ -208,3 +208,60 @@ class EngineGenericObjectApi:
             return response["result"]
         except KeyError:
             return response["error"]
+
+
+    def get_properties(self, handle: int):
+        """
+        Retrieves the properties of a specific generic object.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+
+        Returns:
+            dict: The properties of the generic object (qLayout). In case of an error, returns the error information.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetProperties", "params": {}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qProp"]
+        except KeyError:
+            return response["error"]
+
+
+    def embed_snapshot_object(self, handle: int, snapshot_id: str):
+        """
+        Adds a snapshot to a generic object. Only one snapshot can be embedded in a generic object. If you embed a
+        snapshot in an object that already contains a snapshot, the new snapshot overwrites the previous one.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+            snapshot_id (str): The id of the snapshot to be embeded.
+
+        Returns:
+            update
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "EmbedSnapshotObject",
+                          "params": {"qId": snapshot_id}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]
+
+
+    def get_parent(self, handle: int):
+        """
+        Returns the type of the object and the corresponding handle to the parent object in the hiearchy.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+
+        Returns:
+            { "qType": "GenericObject", "qHandle": <handle of the object> }
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "GetParent", "params": {}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]["qReturn"]
+        except KeyError:
+            return response["error"]

qe_api_client/engine.py

@@ -12,6 +12,8 @@ import qe_api_client.structs as structs
 import math
 import pandas as pd
 import numpy as np
+from datetime import datetime, timezone
+import time
 
 
 class QixEngine:
@@ -135,9 +137,9 @@ class QixEngine:
         # Define of the single dimension properties
         nx_info = self.structs.nx_info(obj_type="dimension")
         if dim_color is None:
-            coloring = self.structs.coloring()
+            coloring = self.structs.dim_coloring()
         else:
-            coloring = self.structs.coloring(base_color={"color": dim_color, "index": dim_color_index})
+            coloring = self.structs.dim_coloring(base_color={"color": dim_color, "index": dim_color_index})
 
         nx_library_dimension_def = self.structs.nx_library_dimension_def(grouping="N", field_definitions=[dim_def],
                                                                          field_labels=[dim_title],
@@ -213,7 +215,8 @@ class QixEngine:
 
 
     def create_master_measure(self, app_handle: int, mes_title: str, mes_def: str, mes_label: str = "",
-                              mes_desc: str = "", mes_tags: list = None):
+                              mes_desc: str = "", mes_tags: list = None, mes_color: str = None,
+                              mes_color_index: int = -1, gradient: dict = None):
         """
         Creates a master measure.
 
@@ -224,6 +227,8 @@ class QixEngine:
             mes_label (str, optional): The label of the measure.
             mes_desc (str, optional): The description of the measure.
             mes_tags (list, optional): The tags of the measure.
+            mes_color (str, optional): The color of the measure.
+            mes_color_index (int, optional): The index of the color of the measure.
 
         Returns:
             dict: The handle and Id of the measure.
@@ -233,8 +238,17 @@ class QixEngine:
 
         # Define of the measure properties
         nx_info = self.structs.nx_info(obj_type="measure")
+
+        if mes_color is None:
+            coloring = self.structs.mes_coloring()
+        else:
+            coloring = self.structs.mes_coloring(base_color={"color": mes_color, "index": mes_color_index})
+
+        if gradient is not None:
+            coloring.update({"gradient": gradient})
+
         nx_library_measure_def = self.structs.nx_library_measure_def(label=mes_title, mes_def=mes_def,
-                                                                     label_expression=mes_label)
+                                                                     label_expression=mes_label, coloring=coloring)
         gen_mes_props = self.structs.generic_measure_properties(nx_info=nx_info,
                                                                 nx_library_measure_def=nx_library_measure_def,
                                                                 title=mes_title, description=mes_desc, tags=mes_tags)
@@ -439,6 +453,203 @@ class QixEngine:
         return chart
 
 
+    def create_snapshot(self, app_handle: int, object_id: str, snapshot_title: str = "", snapshot_description: str = "",
+        object_width: float = 1280, object_height: float = 720, bounding_client_width: float = 1280,
+        bounding_client_height: float = 720, rtl: bool = False, parent_width: float = 1280, parent_height: float = 720,
+        content_width: float = 1280, content_height: float = 720, chart_data_scroll_offset_start: int = 0,
+        chart_data_scroll_offset_end: int = 53, chart_data_legend_scroll_offset: int = 0, chart_data_zoom_min = 0,
+        chart_data_zoom_max = 0):
+        """
+        Creates a snapshot object.
+
+        Parameters:
+            app_handle (int): The handle of the app.
+            object_id (str): The id of the object.
+            snapshot_title (str): The title of the snapshot.
+            snapshot_description (str): The description of the snapshot.
+            object_width (float): The width of the snapshot object.
+            object_height (float): The height of the snapshot object.
+            bounding_client_width (float): The width of the bounding client.
+            bounding_client_height (float): The height of the bounding client.
+            rtl (bool): Controls the rendering of content with right-to-left (RTL) language support.
+            parent_width (float): The width of the parent object.
+            parent_height (float): The height of the parent object.
+            content_width (float): The width of the content object.
+            content_height (float): The height of the content object.
+            chart_data_scroll_offset_start (int): Scroll offset start.
+            chart_data_scroll_offset_end (int): Scroll offset end.
+            chart_data_legend_scroll_offset (int): Legend scroll offset.
+            chart_data_zoom_min: Minimum chart data zoom.
+            chart_data_zoom_max: Maximum chart data zoom.
+
+        Returns:
+            dict: The handle and Id of the created snapshot.
+        """
+        # Get chart object
+        chart_obj = self.eaa.get_object(app_handle=app_handle, object_id=object_id)
+        chart_obj_handle = self.get_handle(chart_obj)
+
+        # Get sheet object
+        sheet_obj = self.get_object_sheet(app_handle=app_handle, obj_id=object_id)
+        sheet_id = self.get_id(sheet_obj)
+
+        # Get the visualization type
+        chart_obj_layout = self.egoa.get_layout(handle=chart_obj_handle)
+        visualization = chart_obj_layout["visualization"]
+
+        # Attribut "qInfo" changed
+        chart_obj_layout["qInfo"] = {"qType": "snapshot"}
+
+        # Attribut "qMetaDef" added
+        chart_obj_layout["qMetaDef"] = {"title": snapshot_title, "description": snapshot_description}
+
+        # Attribut "creationDate" added
+        chart_obj_layout["creationDate"] = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+
+        # Attribut "permissions" added
+        chart_obj_layout["permissions"] = {"update": True, "publish": False, "export": False, "exportData": True,
+                                           "changeOwner": False, "remove": True}
+
+        # Attribut "visualizationType" added
+        chart_obj_layout["visualizationType"] = visualization
+
+        # Attribut "sourceObjectId" added
+        chart_obj_layout["sourceObjectId"] = object_id
+
+        # Attribut "sheetId" added
+        chart_obj_layout["sheetId"] = sheet_id
+
+        # Attribut "timestamp" added
+        chart_obj_layout["timestamp"] = int(time.time() * 1000)
+
+        # Attribut "isClone" added
+        chart_obj_layout["isClone"] = False
+
+        # Attribut "supportExport" added
+        chart_obj_layout["supportExport"] = True
+
+        # Attribut "qIncludeVariables" added
+        chart_obj_layout["qIncludeVariables"] = True
+
+        # Build the special snapshot parameters for the different chart types.
+        if visualization in ["sn-table", "pivot-table"]:
+            # Attribut "snapshotData" added
+            chart_obj_layout["snapshotData"] = {
+                "object": {
+                    "size": {
+                        "w": object_width,
+                        "h": object_height,
+                        "boundingClientWidth": bounding_client_width,
+                        "boundingClientHeight": bounding_client_height
+                    }
+                },
+                "rtl": rtl,
+                "parent": {
+                    "h": parent_height,
+                    "w": parent_width
+                }
+            }
+
+        elif visualization in ["combochart", "barchart"]:
+            # Attribut "snapshotData" added
+            chart_obj_layout["snapshotData"] = {
+                "object": {
+                    "size": {
+                        "w": object_width,
+                        "h": object_height,
+                        "boundingClientWidth": bounding_client_width,
+                        "boundingClientHeight": bounding_client_height
+                    }
+                },
+                "rtl": rtl,
+                "content": {
+                    "size": {
+                        "w": content_width,
+                        "h": content_height
+                    },
+                    "chartData": {
+                        "scrollOffset": {
+                            "start": chart_data_scroll_offset_start,
+                            "end": chart_data_scroll_offset_end
+                        },
+                        "legendScrollOffset": chart_data_legend_scroll_offset
+                    }
+                },
+                "parent": {
+                    "h": parent_height,
+                    "w": parent_width
+                }
+            }
+
+        elif visualization in ["linechart"]:
+            # Attribut "snapshotData" added
+            chart_obj_layout["snapshotData"] = {
+                "object": {
+                    "size": {
+                        "w": object_width,
+                        "h": object_height,
+                        "boundingClientWidth": bounding_client_width,
+                        "boundingClientHeight": bounding_client_height
+                    }
+                },
+                "rtl": rtl,
+                "content": {
+                    "size": {
+                        "w": content_width,
+                        "h": content_height
+                    },
+                    "chartData": {
+                        "zoom": {
+                            "min": chart_data_zoom_min,
+                            "max": chart_data_zoom_max
+                        }
+                    }
+                },
+                "parent": {
+                    "h": parent_height,
+                    "w": parent_width
+                }
+            }
+
+        else:
+            print("Chart type not supported.")
+
+        # Create snapshot
+        snapshot = self.eaa.create_bookmark(doc_handle=app_handle, prop=chart_obj_layout)
+        snapshot.update({"visualization": visualization})
+
+        return snapshot
+
+
+    def embed_snapshot(self, app_handle: int, snapshot_id: str, slide_id: str):
+        """
+        Embeds a created snapshot object on a slide.
+
+        Parameters:
+            app_handle (int): The handle of the app.
+            snapshot_id (str): The id of the snapshot.
+            slide_id (str): The id of the slide to embed.
+        """
+        # Get the slide, where the snapshot should be embeded.
+        slide = self.eaa.get_object(app_handle=app_handle, object_id=slide_id)
+        slide_handle = self.get_handle(slide)
+
+        # Get the visualization type of the snapshot
+        snapshot = self.eaa.get_bookmark(app_handle=app_handle, bookmark_id=snapshot_id)
+        snapshot_handle = self.get_handle(snapshot)
+        snapshot_layout = self.egoa.get_layout(handle=snapshot_handle)
+        visualization_type = snapshot_layout["visualizationType"]
+
+        # create the snapshot
+        slideitem_snapshot_properties = self.structs.slideitem_snapshot_properties(snapshot_id=snapshot_id,
+                                                                                   visualization_type=visualization_type)
+        slideitem_snapshot = self.egoa.create_child(handle=slide_handle, prop=slideitem_snapshot_properties)
+        slideitem_snapshot_handle = self.get_handle(slideitem_snapshot)
+
+        slideitem_snapshot_embeded = self.egoa.embed_snapshot_object(handle=slideitem_snapshot_handle,
+                                                                     snapshot_id=snapshot_id)
+
+
     def get_app_lineage_info(self, app_handle):
         """
         Gets the lineage information of the app. The lineage information includes the LOAD and STORE statements from
@@ -488,19 +699,60 @@ class QixEngine:
 
         Parameters:
         obj : dict
-            The object containing the handle.
+            The object containing the id.
 
         Returns:
-        int: The handle value.
+        int: The id value.
 
         Raises:
-        ValueError: If the handle value is invalid.
+        ValueError: If the id value is invalid.
         """
         try:
             return obj["qGenericId"]
         except ValueError:
             return "Bad id value in " + obj
 
+    @staticmethod
+    def get_type(obj):
+        """
+        Retrieves the type from a given object.
+
+        Parameters:
+        obj : dict
+            The object containing the type.
+
+        Returns:
+        int: The type value.
+
+        Raises:
+        ValueError: If the type value is invalid.
+        """
+        try:
+            return obj["qGenericType"]
+        except ValueError:
+            return "Bad type value in " + obj
+
+
+    def get_object_sheet(self, app_handle: int, obj_id: str):
+        """
+        Retrieves the sheet from a given chart object.
+
+        Parameters:
+            app_handle (int): The handle of the app.
+            obj_id (str): The ID of the object.
+
+        Returns:
+            dict: The sheet object with handle and id.
+        """
+        parent_obj = self.eaa.get_object(app_handle=app_handle, object_id=obj_id)
+        while self.get_type(parent_obj) != "sheet":
+            obj = parent_obj
+            obj_handle = self.get_handle(obj)
+            parent_obj = self.egoa.get_parent(handle=obj_handle)
+
+        return parent_obj
+
+
     def get_chart_data(self, app_handle, obj_id):
         """
         Retrieves the data from a given chart object.
@@ -526,14 +778,25 @@ class QixEngine:
         # Determine the number of the columns and the rows the table has and splits in certain circumstances the table
         # calls
         no_of_columns = obj_layout['qHyperCube']['qSize']['qcx']
+
+        if no_of_columns == 0:
+            return 'The chart either contains no columns or has a calculation condition!'
+
         width = no_of_columns
         no_of_rows = obj_layout['qHyperCube']['qSize']['qcy']
         height = int(math.floor(10000 / no_of_columns))
 
         # Extract the dimension and measure titles and concat them to column names.
-        dimension_titles = [dim['qFallbackTitle'] for dim in obj_layout['qHyperCube']['qDimensionInfo']]
-        measure_titles = [measure['qFallbackTitle'] for measure in obj_layout['qHyperCube']['qMeasureInfo']]
-        column_names = dimension_titles + measure_titles
+        dimension_info = obj_layout['qHyperCube'].get('qDimensionInfo', [])
+        measure_info = obj_layout['qHyperCube'].get('qMeasureInfo', [])
+        column_info = dimension_info + measure_info
+
+        # Build the column mapping using qEffectiveInterColumnSortOrder
+        sort_order = sorted(obj_layout['qHyperCube']['qEffectiveInterColumnSortOrder'])
+        sort_order_positive = [x for x in sort_order if x >= 0]
+        column_names = []
+        for i in sort_order_positive:
+            column_names.append(column_info[i]["qFallbackTitle"])
 
         # if the type of the charts has a straight data structure
         if (obj_layout['qInfo']['qType'] in ['table', 'sn-table', 'piechart', 'scatterplot', 'combochart', 'barchart']
@@ -546,7 +809,7 @@ class QixEngine:
             # Retrieves the hypercube data in a loop (because of limitation from 10.000 cells per call)
             while no_of_rows > page * height:
                 nx_page = self.structs.nx_page(left=0, top=page * height, width=width, height=height)
-                hc_data = self.egoa.get_hypercube_data(obj_handle, '/qHyperCubeDef', nx_page)[
+                hc_data = self.egoa.get_hypercube_data(handle=obj_handle, path='/qHyperCubeDef', pages=[nx_page])[
                     'qDataPages'][0]['qMatrix']
                 data_values.extend(hc_data)
                 page += 1
@@ -563,9 +826,10 @@ class QixEngine:
 
             # Supporting function to traverse all subnodes to get all dimensions
             def get_all_dimensions(node):
-                dimensions = [node['qText']]
-                # if 'qSubNodes' in node and node['qSubNodes']:
-                if node['qSubNodes']:
+                label = node.get('qText', '')  # Leerer String, falls nicht vorhanden
+                dimensions = [label]
+
+                if 'qSubNodes' in node and node['qSubNodes']:
                     sub_dimensions = []
                     for sub_node in node['qSubNodes']:
                         sub_dimensions.extend([dimensions + d for d in get_all_dimensions(sub_node)])
@@ -573,13 +837,25 @@ class QixEngine:
                 else:
                     return [dimensions]
 
-            # Gets the column headers for the pivot table
+            # Supporting function to get all column headers for the pivot table
+            def get_column_paths(node):
+                label = node.get('qText', '')
+                current_path = [label]
+
+                if 'qSubNodes' in node and node['qSubNodes']:
+                    paths = []
+                    for sub in node['qSubNodes']:
+                        for path in get_column_paths(sub):
+                            paths.append(current_path + path)
+                    return paths
+                else:
+                    return [current_path]
+
             col_headers = []
             nx_page_top = self.structs.nx_page(left=0, top=0, width=width, height=1)
-            hc_top = self.egoa.get_hypercube_pivot_data(obj_handle, '/qHyperCubeDef', nx_page_top)[
-                'qDataPages'][0]['qTop']
+            hc_top = self.egoa.get_hypercube_pivot_data(handle=obj_handle, path='/qHyperCubeDef', pages=[nx_page_top])['qDataPages'][0]['qTop']
             for top_node in hc_top:
-                col_headers.extend(get_all_dimensions(top_node))
+                col_headers.extend(get_column_paths(top_node))
 
             # Paging variables
             page = 0
@@ -591,13 +867,13 @@ class QixEngine:
                 nx_page = self.structs.nx_page(left=0, top=page * height, width=width, height=height)
 
                 # Retrieves the row headers for the pivot table
-                hc_left = self.egoa.get_hypercube_pivot_data(obj_handle, '/qHyperCubeDef', nx_page)[
+                hc_left = self.egoa.get_hypercube_pivot_data(handle=obj_handle, path='/qHyperCubeDef', pages=[nx_page])[
                     'qDataPages'][0]['qLeft']
                 for left_node in hc_left:
                     row_headers.extend(get_all_dimensions(left_node))
 
                 # Retrieves the data for the pivot table
-                hc_data = self.egoa.get_hypercube_pivot_data(obj_handle, '/qHyperCubeDef', nx_page)[
+                hc_data = self.egoa.get_hypercube_pivot_data(handle=obj_handle, path='/qHyperCubeDef', pages=[nx_page])[
                     'qDataPages'][0]['qData']
                 for row in hc_data:
                     data_values.append([cell['qText'] for cell in row])
@@ -610,12 +886,15 @@ class QixEngine:
 
             # Creates the Dataframe
             df = pd.DataFrame(data_values, index=row_index, columns=col_index)
+            index_levels = df.index.nlevels
+            df.index.names = column_names[:index_levels]
+            df = df.reset_index()
 
         # if the type of the charts has a stacked data structure
         elif obj_layout['qInfo']['qType'] in ['barchart'] and obj_layout['qHyperCube']['qStackedDataPages'] != []:
             max_no_cells = no_of_columns * no_of_rows
             nx_page = self.structs.nx_page(left=0, top=0, width=no_of_columns, height=no_of_rows)
-            hc_data = self.egoa.get_hypercube_stack_data(obj_handle, '/qHyperCubeDef', nx_page, max_no_cells)[
+            hc_data = self.egoa.get_hypercube_stack_data(handle=obj_handle, path='/qHyperCubeDef', pages=[nx_page], max_no_cells=max_no_cells)[
                 'qDataPages'][0]['qData'][0]['qSubNodes']
 
             # Transform the nested structure into a flat DataFrame
@@ -701,7 +980,7 @@ class QixEngine:
         # Retrieves the hypercube data in a loop (because of limitation from 10.000 cells per call)
         while no_of_rows > page * height:
             nx_page = self.structs.nx_page(left=0, top=page * height, width=width, height=height)
-            hc_data = self.egoa.get_hypercube_data(hc_obj_handle, '/qHyperCubeDef', nx_page)['qDataPages'][0]['qMatrix']
+            hc_data = self.egoa.get_hypercube_data(handle=hc_obj_handle, path='/qHyperCubeDef', pages=[nx_page])['qDataPages'][0]['qMatrix']
             data_values.extend(hc_data)
             page += 1
 

qe_api_client/structs.py

@@ -277,14 +277,18 @@ def nx_library_dimension_def(grouping: str = "N", field_definitions: list = None
 
 
 def nx_library_measure_def(label: str, mes_def: str, grouping: str = "N", expressions: list = None,
-                           active_expression: int = 0, label_expression:str = "", num_format: dict = None):
+                           active_expression: int = 0, label_expression:str = "", num_format: dict = None,
+                           coloring: dict = None):
+    if coloring is None:
+        coloring = {}
     if num_format is None:
         num_format = {}
     if expressions is None:
         expressions = []
     return {
         "qLabel": label, "qDef": mes_def,"qGrouping": grouping, "qExpressions": expressions,
-        "qActiveExpression": active_expression, "qLabelExpression": label_expression, "qNumFormat": num_format
+        "qActiveExpression": active_expression, "qLabelExpression": label_expression, "qNumFormat": num_format,
+        "coloring": coloring
     }
 
 
@@ -509,7 +513,7 @@ def color_map(colors: list = None, nul: dict = None, oth: dict = None, pal: str
     }
 
 
-def coloring(change_hash: str = None, color_map_ref: str = "", has_value_colors: bool = False, base_color: dict = None):
+def dim_coloring(change_hash: str = None, color_map_ref: str = "", has_value_colors: bool = False, base_color: dict = None):
     if base_color is None:
         base_color = {"color": "none", "index": 0}
     return {
@@ -520,6 +524,15 @@ def coloring(change_hash: str = None, color_map_ref: str = "", has_value_colors:
     }
 
 
+def mes_coloring(base_color: dict = None, _gradient: dict = None):
+    coloring = {}
+    if base_color is not None:
+        coloring.update({"baseColor": base_color})
+    if _gradient is not None:
+        coloring.update({"gradient": _gradient})
+    return coloring
+
+
 def color_map_properties(dim_id: str, prop_def:dict = None, extends_id: str = "", state_name: str = "",
                          _color_map: dict = None):
 
@@ -539,3 +552,115 @@ def value_color(value: str, color: str, index: int = -1):
         "value": value,
         "baseColor": {"color": color, "index": index}
     }
+
+
+def color(_color: str, index: int = -1):
+    return {"color": _color, "index": index}
+
+
+def gradient(colors: list = None, break_types: list = None, limits: list = None, limit_type: str = "percent"):
+    if colors is None:
+        colors = [color(_color="#332288"), color(_color="#117733")]
+    if break_types is None:
+        break_types = [False]
+    if limits is None:
+        limits = [0.5]
+    return {"colors": colors, "breakTypes": break_types, "limits": limits, "limitType": limit_type}
+
+
+def static_content_url_def(url: str = None):
+    if url is None:
+        return {}
+    else:
+        return {"qUrl": url}
+
+
+def story_properties(title: str = "", description: str = "", extends_id: str = "", state_name: str = "", rank: int = 0,
+                     thumbnail_url: str = None):
+
+    info = nx_info(obj_type="story")
+    prop_def = {"title": title, "description": description}
+    if thumbnail_url is None:
+        thumbnail = {"qStaticContentUrlDef": static_content_url_def()}
+    else:
+        thumbnail = {"qStaticContentUrlDef": static_content_url_def(url=thumbnail_url)}
+    child_list_def = {"qData": {"title": "/title", "rank": "/rank"}}
+
+    return {
+        "qInfo": info, "qExtendsId": extends_id, "qMetaDef": prop_def, "qStateName": state_name, "rank": rank,
+        "thumbnail": thumbnail, "qChildListDef": child_list_def
+    }
+
+
+def slide_properties(extends_id: str = "", prop_def: dict = None, state_name: str = ""):
+
+    if prop_def is None:
+        prop_def = {}
+    info = nx_info(obj_type="slide")
+    child_list_def = {"qData": {"title": "/title", "sheetId": "/sheetId", "ratio": "/ratio", "position": "/position",
+                                "dataPath": "/dataPath", "srcPath": "/srcPath",	"visualization": "/visualization",
+                                "visualizationType": "/visualizationType", "style": "/style"}}
+
+    return {
+        "qInfo": info, "qExtendsId": extends_id, "qMetaDef": prop_def, "qStateName": state_name, "qChildListDef": child_list_def
+    }
+
+
+def slideitem_text_properties(ratio: bool = True, position_top: str = "3.69985%", position_left: str = "31.25000%",
+                              position_width: str = "39.57903%", position_height: str = "11.28086%",
+                              position_z_index: int = 1, position_right: str = "auto",
+                              visualization_type: str = "", style_color: str = "#6E6E6E",
+                              style_text: str = ""):
+
+    position = {"top": position_top, "left": position_left, "width": position_width, "height": position_height,
+                "z-index": position_z_index, "right": position_right}
+    info = nx_info(obj_type="slideitem")
+
+    return {
+        "qInfo": info, "qExtendsId": "", "qMetaDef": {}, "qStateName": "",
+        "qEmbeddedSnapshotDef": {}, "title": "", "sheetId": "", "ratio": ratio,
+		"position": position, "visualization": "text", "visualizationType": visualization_type,
+		"style": {"color": style_color, "text": style_text}
+    }
+
+
+def slideitem_shape_properties(ratio: bool = True, position_top: str = "3.69985%", position_left: str = "31.25000%",
+                              position_width: str = "39.57903%", position_height: str = "11.28086%",
+                              position_z_index: int = 1, position_right: str = "auto",
+                              visualization_type: str = "", style_color: str = "#000000"):
+
+    position = {"top": position_top, "left": position_left, "width": position_width, "height": position_height,
+                "z-index": position_z_index, "right": position_right}
+    info = nx_info(obj_type="slideitem")
+
+    return {
+        "qInfo": info, "qExtendsId": "", "qMetaDef": {}, "qStateName": "",
+        "qEmbeddedSnapshotDef": {}, "title": "", "sheetId": "", "ratio": ratio,
+		"position": position, "dataPath": "../resources/img/storytelling/shapes/" + visualization_type + ".svg",
+        "visualization": "shape", "visualizationType": visualization_type,
+		"style": {"color": style_color, "colorPaletteIndex": -1}
+    }
+
+
+def slideitem_snapshot_properties(snapshot_id: str, visualization_type: str, ratio: bool = True,
+                                  position_top: str = "14.81481%", position_left: str = "2.08333%",
+                                  position_width: str = "95.83334%", position_height: str = "81.4814875%",
+                                  position_z_index: int = 1):
+
+    position = {"top": position_top, "left": position_left, "width": position_width, "height": position_height,
+                "z-index": position_z_index}
+    info = nx_info(obj_type="slideitem")
+
+    return {
+        "qInfo": info, "qExtendsId": "", "qMetaDef": {}, "qStateName": "", "qEmbeddedSnapshotDef": {}, "title": "",
+        "sheetId": "", "ratio": ratio, "position": position, "visualization": "snapshot",
+        "visualizationType": visualization_type, "style": {"id": snapshot_id}
+    }
+
+
+def nx_get_bookmark_options(types: list, data: dict = None):
+    if data is None:
+        data = {}
+    return {
+			"qTypes": types, "qData": data
+	}

{qe_api_client-2.7.0.dist-info → qe_api_client-2.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.7.0
+Version: 2.9.0
 Summary: Python client for the Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev
@@ -11,8 +11,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: websocket-client>=0.47.0
+Requires-Dist: websocket-client>=1.0.0
 Requires-Dist: pandas>=2.2.0
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: uuid>=1.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{qe_api_client-2.7.0.dist-info → qe_api_client-2.9.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 qe_api_client/__init__.py,sha256=bypB4CIjpHtf5Pu_NwtJajC69zqQD7qB9jo8cCX0B54,23
-qe_api_client/engine.py,sha256=4pll0uoFPph5WgRufpP4OsYlypWKQhMfJQAaaWPWWUU,56738
+qe_api_client/engine.py,sha256=ErLb7KXpnH6UC7jNvZWdkW2_aeW7GCmvH8IzTcCDj0Q,68103
 qe_api_client/engine_communicator.py,sha256=q6x7ix2Ev8yGmTTm7cf1vHcidOihKM0HjDXeJ-dZYjk,1133
-qe_api_client/structs.py,sha256=Gh7aGNLN58kYeBY-6Nb7yagQpHnd1f-IlfaE8aEF9ns,22621
+qe_api_client/structs.py,sha256=iZRy54jDyAk8ZD4rtrKxefnBcXcB1aRE0oxpOxoYcDM,28078
 qe_api_client/api_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qe_api_client/api_classes/engine_app_api.py,sha256=qobuSdLV5I-DOXto0Qi5ckMG3q5Dll0Lto3TyjZSbso,37493
+qe_api_client/api_classes/engine_app_api.py,sha256=umVY3jtNyk4am_9XH1yAbng2BRGAF-sg_JSssbXcF5M,39962
 qe_api_client/api_classes/engine_field_api.py,sha256=zCLIR7rmxqwIrJYK_-uHVEhMvBcEP2qofuX8ZPygqCA,5479
 qe_api_client/api_classes/engine_generic_dimension_api.py,sha256=oSZoRT-j4hsCVnUm1OSg7XZPWXhUzFLY_53kM0KwPHs,2122
 qe_api_client/api_classes/engine_generic_measure_api.py,sha256=uj4i_ykX9F9Dtk78fOidMBhzSP8vEucEfrB6MrLwgPI,1340
-qe_api_client/api_classes/engine_generic_object_api.py,sha256=iasoNYSSsBTr_S3ExoorfCip9fhy7sCQ_J-ru2JYal8,10130
+qe_api_client/api_classes/engine_generic_object_api.py,sha256=_69Pf-Tp5vRB_LX76uQr8x03DstS_OOBVVw8h-9nwlA,12345
 qe_api_client/api_classes/engine_generic_variable_api.py,sha256=sWXZpE-GLfcMijmfORnDNrJ6lmXX3x5TRHlkEu_i0BQ,2027
 qe_api_client/api_classes/engine_global_api.py,sha256=G6QQHI36WOo7W25zg4Uz__gMSLC2ptNTvbBdElPzgZI,27535
-qe_api_client-2.7.0.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
-qe_api_client-2.7.0.dist-info/METADATA,sha256=5-VkSmGbK-92mrMlEqFgozK8FtbUfmpW1o5_zQZrLlA,2385
-qe_api_client-2.7.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-qe_api_client-2.7.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
-qe_api_client-2.7.0.dist-info/RECORD,,
+qe_api_client-2.9.0.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
+qe_api_client-2.9.0.dist-info/METADATA,sha256=g4aMmiMpkgRMvNe60MHsywPsl1dT8FLmmvH-VorJ9Wk,2437
+qe_api_client-2.9.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+qe_api_client-2.9.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
+qe_api_client-2.9.0.dist-info/RECORD,,

{qe_api_client-2.7.0.dist-info → qe_api_client-2.9.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any