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

qe_api_client/api_classes/engine_generic_dimension_api.py

@@ -36,3 +36,22 @@ class EngineGenericDimensionApi:
             return response["result"]["qReturn"]
         except KeyError:
             return response["error"]
+
+    def apply_patches(self, handle: int, patches: list):
+        """
+        Applies a patch to the properties of an object. Allows an update to some of the properties.
+
+        Parameters:
+            handle (int): The handle identifying the generic object.
+            patches (list): List of patches.
+
+        Returns:
+            dict: Operation succeeded.
+        """
+        msg = json.dumps({"jsonrpc": "2.0", "id": 0, "handle": handle, "method": "ApplyPatches",
+                          "params": {"qPatches": patches}})
+        response = json.loads(self.engine_socket.send_call(self.engine_socket, msg))
+        try:
+            return response["result"]
+        except KeyError:
+            return response["error"]

qe_api_client/engine.py

@@ -1,3 +1,5 @@
+import json
+
 import qe_api_client.api_classes.engine_app_api as engine_app_api
 import qe_api_client.engine_communicator as engine_communicator
 import qe_api_client.api_classes.engine_field_api as engine_field_api
@@ -93,8 +95,14 @@ class QixEngine:
         fld_handle = self.get_handle(lb_field)
         return self.efa.clear(fld_handle)
 
+
     def create_single_master_dimension(self, app_handle: int, dim_title: str, dim_def: str, dim_label: str = "",
-                                       dim_desc: str = "", dim_tags: list = None):
+                                       dim_desc: str = "", dim_tags: list = None, dim_color: str = None,
+                                       dim_color_index: int = -1, value_colors: list = None,
+                                       null_value_color: str = None, null_value_color_index: int = -1,
+                                       other_value_color: str = None, other_value_color_index: int = -1,
+                                       single_color: str = None, single_color_index: int = -1, palette: str = None
+                                       ):
         """
         Creates a single master dimension.
 
@@ -105,26 +113,105 @@ class QixEngine:
             dim_label (str, optional): The label of the dimension.
             dim_desc (str, optional): The description of the dimension.
             dim_tags (list, optional): The tags of the dimension.
+            dim_color (str, optional): The master dimension color.
+            dim_color_index (int, optional): The index of the master dimension color in the theme color picker.
+            value_colors (list, optional): The value colors of the master dimension.
+            null_value_color (str, optional): The NULL value color of the master dimension.
+            null_value_color_index (int, optional): The index of the NULL value color of the master dimension in the theme color picker.
+            other_value_color (str, optional): The OTHER value color of the master dimension.
+            other_value_color_index (int, optional): The index of the OTHER value color of the master dimension in the theme color picker.
+            single_color (str, optional): Single color of the values of the master dimension.
+            single_color_index (int, optional): The index of single color of the values of the master dimension in the theme color picker.
+            palette (str, optional): Choose a color palette, if there are more than one.
 
         Returns:
             dict: The handle and Id of the dimension.
         """
+        if value_colors is None:
+            value_colors = []
         if dim_tags is None:
             dim_tags = []
 
         # Define of the single dimension properties
         nx_info = self.structs.nx_info(obj_type="dimension")
+        if dim_color is None:
+            coloring = self.structs.coloring()
+        else:
+            coloring = self.structs.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],
-                                                                         label_expression=dim_label)
+                                                                         label_expression=dim_label, alias=dim_title,
+                                                                         title=dim_title, coloring=coloring)
         gen_dim_props = self.structs.generic_dimension_properties(nx_info=nx_info,
                                                                   nx_library_dimension_def=nx_library_dimension_def,
                                                                   title=dim_title, description=dim_desc, tags=dim_tags)
 
         # Create the single dimension
         master_dim = self.eaa.create_dimension(app_handle, gen_dim_props)
+
+        # Get id and handle of the master dimension
+        master_dim_id = self.get_id(master_dim)
+        master_dim_handle = self.get_handle(master_dim)
+
+        # Update "colorMapRef" property with the master dimension id.
+        patch_value = json.dumps(master_dim_id)
+        patch_color_map_ref = self.structs.nx_patch(op="replace", path="/qDim/coloring/colorMapRef", value=patch_value)
+        self.egda.apply_patches(handle=master_dim_handle, patches=[patch_color_map_ref])
+
+        # Define the color properties
+        if null_value_color is None:
+            null_value = None
+        else:
+            null_value = {"color": null_value_color, "index": null_value_color_index}
+
+        if other_value_color is None:
+            other_value = None
+        else:
+            other_value = {"color": other_value_color, "index": other_value_color_index}
+
+        if single_color is None:
+            single = None
+        else:
+            single = {"color": single_color, "index": single_color_index}
+
+        colors = value_colors
+        color_map = self.structs.color_map(colors=colors, nul=null_value, oth=other_value, single=single, pal=palette)
+        color_map_props = self.structs.color_map_properties(dim_id=master_dim_id, _color_map=color_map)
+
+        # Create color map object, if colors are passed.
+        if value_colors or null_value_color is not None or other_value_color is not None or single_color is not None or palette is not None:
+            color_map_model = self.eaa.create_object(app_handle, color_map_props)
+            color_map_model_handle = self.get_handle(color_map_model)
+
+            # Set "autoFill" and "usePal" to "False", if a single color is passed.
+            if bool(single):
+                patch_value_use_pal_auto_fill = json.dumps(False)
+                patch_use_pal = self.structs.nx_patch(op="replace", path="/colorMap/usePal",
+                                                      value=patch_value_use_pal_auto_fill)
+                self.egda.apply_patches(handle=color_map_model_handle, patches=[patch_use_pal])
+
+                patch_auto_fill = self.structs.nx_patch(op="replace", path="/colorMap/autoFill",
+                                                      value=patch_value_use_pal_auto_fill)
+                self.egda.apply_patches(handle=color_map_model_handle, patches=[patch_auto_fill])
+
+            # Set "autoFill" to "False", if a color palette is passed.
+            if palette is not None:
+                patch_value_auto_fill = json.dumps(False)
+                patch_auto_fill = self.structs.nx_patch(op="replace", path="/colorMap/autoFill",
+                                                        value=patch_value_auto_fill)
+                self.egda.apply_patches(handle=color_map_model_handle, patches=[patch_auto_fill])
+
+        # Update "hasValueColors" property, if value colors are passed.
+        if value_colors:
+            patch_value_has_value_colors = json.dumps(True)
+            patch_has_value_colors = self.structs.nx_patch(op="replace", path="/qDim/coloring/hasValueColors",
+                                                        value=patch_value_has_value_colors)
+            self.egda.apply_patches(handle=master_dim_handle, patches=[patch_has_value_colors])
+
         return master_dim
 
+
     def create_master_measure(self, app_handle: int, mes_title: str, mes_def: str, mes_label: str = "",
                               mes_desc: str = "", mes_tags: list = None):
         """
@@ -310,8 +397,12 @@ class QixEngine:
         nx_info = self.structs.nx_info(obj_type=obj_type)
         if obj_type == "table":
             chart_props = self.structs.table_properties(info=nx_info, hypercube_def=hypercube_def)
+        elif obj_type == "sn-table":
+            chart_props = self.structs.sn_table_properties(info=nx_info, hypercube_def=hypercube_def)
         elif obj_type == "pivot-table":
             chart_props = self.structs.pivot_table_properties(info=nx_info, hypercube_def=hypercube_def)
+        elif obj_type == "sn-pivot-table":
+            chart_props = self.structs.pivot_table_properties(info=nx_info, hypercube_def=hypercube_def)
         else:
             print("Not valid object type.")
 

qe_api_client/structs.py

@@ -263,14 +263,16 @@ def generic_dimension_properties(nx_info: dict, nx_library_dimension_def: dict,
 
 
 def nx_library_dimension_def(grouping: str = "N", field_definitions: list = None, field_labels: list = None,
-                             label_expression: str = ""):
+                             label_expression: str = "", alias: str = "", title: str = "", coloring: dict = None):
+    if coloring is None:
+        coloring = {}
     if field_labels is None:
         field_labels = []
     if field_definitions is None:
         field_definitions = []
     return {
         "qGrouping": grouping, "qFieldDefs": field_definitions, "qFieldLabels": field_labels,
-        "qLabelExpression": label_expression
+        "qLabelExpression": label_expression, "qAlias": alias, "title": title, "coloring": coloring
     }
 
 
@@ -380,16 +382,18 @@ def nx_attr_expr_def(expression: str = "", library_id: str = "", attribute: bool
         "qLabelExpression": label_expression
     }
 
+
 def table_properties(
         info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = "", state_name: str = "",
         script: str = "", _search: dict = None, show_titles: bool = True, title: str = "", subtitle: str = "",
         footnote: str = "", disable_nav_menu: bool = False, show_details: bool = False,
-        show_details_expression: bool = False, totals_show: bool = True, totals_position: str = "noTotals",
-        totals_label: str = "Totals", scrolling_horizontal: bool = True, scrolling_keep_first_column_in_view: bool = False,
+        show_details_expression: bool = False, _totals: dict = None, scrolling_horizontal: bool = True, scrolling_keep_first_column_in_view: bool = False,
         scrolling_keep_first_column_in_view_touch: bool = False, multiline_wrap_text_in_headers: bool = True,
         multiline_wrap_text_in_cells: bool = True
 ):
 
+    if _totals is None:
+        _totals = totals()
     if prop_def is None:
         prop_def = {}
     if _search is None:
@@ -399,14 +403,39 @@ def table_properties(
         "qInfo": info, "qExtendsId": extends_id, "qMetaDef": prop_def, "qStateName": state_name,
         "qHyperCubeDef": hypercube_def, "script": script, "search": _search, "showTitles": show_titles, "title": title,
         "subtitle": subtitle, "footnote": footnote, "disableNavMenu": disable_nav_menu, "showDetails": show_details,
-        "showDetailsExpression": show_details_expression,
-        "totals": {"show": totals_show, "position": totals_position, "label": totals_label},
+        "showDetailsExpression": show_details_expression, "totals": _totals,
         "scrolling": {"horizontal": scrolling_horizontal, "keepFirstColumnInView": scrolling_keep_first_column_in_view, "keepFirstColumnInViewTouch": scrolling_keep_first_column_in_view_touch},
         "multiline": {"wrapTextInHeaders": multiline_wrap_text_in_headers, "wrapTextInCells": multiline_wrap_text_in_cells},
         "visualization": "table"
     }
 
 
+def sn_table_properties(
+        info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = "", state_name: str = "",
+        show_titles: bool = True, title: str = "", subtitle: str = "", footnote: str = "", disable_nav_menu: bool = False,
+        show_details: bool = False, show_details_expression: bool = False, components: list = None, _totals: dict = None,
+        use_pagination: bool = False, enable_chart_exploration: bool = False, chart_exploration: dict = None
+):
+
+    if chart_exploration is None:
+        chart_exploration = {"menuVisibility": "auto"}
+    if components is None:
+        components = []
+    if _totals is None:
+        _totals = totals()
+    if prop_def is None:
+        prop_def = {}
+
+    return {
+        "qInfo": info, "qExtendsId": extends_id, "qMetaDef": prop_def, "qStateName": state_name,
+        "qHyperCubeDef": hypercube_def, "showTitles": show_titles, "title": title, "subtitle": subtitle,
+        "footnote": footnote, "disableNavMenu": disable_nav_menu, "showDetails": show_details,
+        "showDetailsExpression": show_details_expression, "components": components, "totals": _totals,
+        "usePagination": use_pagination, "enableChartExploration": enable_chart_exploration,
+        "chartExploration": chart_exploration, "visualization": "sn-table"
+    }
+
+
 def pivot_table_properties(
         info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = "", state_name: str = "",
         _search: dict = None, show_titles: bool = True, title: str = "", subtitle: str = "",
@@ -427,9 +456,86 @@ def pivot_table_properties(
     }
 
 
+def sn_pivot_table_properties(
+        info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = "", state_name: str = "",
+        _search: dict = None, show_titles: bool = True, title: str = "", subtitle: str = "",
+        footnote: str = "", disable_nav_menu: bool = False, show_details: bool = True,
+        show_details_expression: bool = False, components: list = None, null_value_representation: dict = None
+):
+    if null_value_representation is None:
+        null_value_representation = {"text": "-"}
+    if components is None:
+        components = []
+    if prop_def is None:
+        prop_def = {}
+    if _search is None:
+        _search = search()
+
+    return {
+        "qInfo": info, "qExtendsId": extends_id, "qMetaDef": prop_def, "qStateName": state_name,
+        "qHyperCubeDef": hypercube_def, "search": _search, "showTitles": show_titles, "title": title,
+        "subtitle": subtitle, "footnote": footnote, "disableNavMenu": disable_nav_menu, "showDetails": show_details,
+        "showDetailsExpression": show_details_expression, "components": components,
+        "nullValueRepresentation": null_value_representation, "visualization": "sn-pivot-table"
+    }
+
+
 def search(sorting: str = "auto"):
     return {"sorting": sorting}
 
 
 def text_align(auto: bool = True, align: str = "left"):
-    return {"auto": auto, "align": align}
+    return {"auto": auto, "align": align}
+
+
+def totals(totals_show: bool = True, totals_position: str = "noTotals", totals_label: str = "Totals"):
+    return {"show": totals_show, "position": totals_position, "label": totals_label}
+
+
+def color_map(colors: list = None, nul: dict = None, oth: dict = None, pal: str = None, single: dict = None,
+              use_pal: bool = True, auto_fill: bool = True):
+
+    if colors is None:
+        colors = []
+
+    return {
+        "colors": colors,
+        "nul": nul,
+        "oth": oth,
+        "pal": pal,
+        "single": single,
+        "usePal": use_pal,
+        "autoFill": auto_fill
+    }
+
+
+def 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 {
+        "changeHash": change_hash,
+        "colorMapRef": color_map_ref,
+        "hasValueColors": has_value_colors,
+        "baseColor": base_color
+    }
+
+
+def color_map_properties(dim_id: str, prop_def:dict = None, extends_id: str = "", state_name: str = "",
+                         _color_map: dict = None):
+
+    if _color_map is None:
+        _color_map = color_map()
+    if prop_def is None:
+        prop_def = {}
+    info = nx_info(obj_type="ColorMap", obj_id="ColorMapModel_" + dim_id)
+
+    return {
+        "qInfo": info, "qExtendsId": extends_id, "qMetaDef": prop_def, "qStateName": state_name, "colorMap": _color_map
+    }
+
+
+def value_color(value: str, color: str, index: int = -1):
+    return {
+        "value": value,
+        "baseColor": {"color": color, "index": index}
+    }

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.6.0
+Version: 2.7.0
 Summary: Python client for the Qlik Engine JSON API
 Home-page: https://github.com/lr-bicc/qe-api-client
 Author: Rumen Vasilev

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

@@ -1,17 +1,17 @@
 qe_api_client/__init__.py,sha256=bypB4CIjpHtf5Pu_NwtJajC69zqQD7qB9jo8cCX0B54,23
-qe_api_client/engine.py,sha256=clHXYefPVXQfqD2_sGFKXJalEFXBTR-I_9Dm0sDBA10,51256
+qe_api_client/engine.py,sha256=4pll0uoFPph5WgRufpP4OsYlypWKQhMfJQAaaWPWWUU,56738
 qe_api_client/engine_communicator.py,sha256=q6x7ix2Ev8yGmTTm7cf1vHcidOihKM0HjDXeJ-dZYjk,1133
-qe_api_client/structs.py,sha256=jBrwGtQU8K0rlP1l040JHYEhBXx5AJqw0jLztli0p3A,18449
+qe_api_client/structs.py,sha256=Gh7aGNLN58kYeBY-6Nb7yagQpHnd1f-IlfaE8aEF9ns,22621
 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_field_api.py,sha256=zCLIR7rmxqwIrJYK_-uHVEhMvBcEP2qofuX8ZPygqCA,5479
-qe_api_client/api_classes/engine_generic_dimension_api.py,sha256=OdYnL54jTaNgfICDj5czJcFB1QZ4Y0s_YslqomQY26I,1394
+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_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.6.0.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
-qe_api_client-2.6.0.dist-info/METADATA,sha256=lXZV-zsy0eEBiI6AaENlEpVPFqFdjpzQPpoiV9Zs__U,2385
-qe_api_client-2.6.0.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-qe_api_client-2.6.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
-qe_api_client-2.6.0.dist-info/RECORD,,
+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.6.0.dist-info → qe_api_client-2.7.0.dist-info}/WHEEL

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