qe-api-client 2.8.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

qe_api_client/structs.py

@@ -565,4 +565,112 @@ def gradient(colors: list = None, break_types: list = None, limits: list = None,
         break_types = [False]
     if limits is None:
         limits = [0.5]
-    return {"colors": colors, "breakTypes": break_types, "limits": limits, "limitType": limit_type}
+    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
+	}
+
+
+def options(types: list, include_session_objects: bool = False, data: dict = None):
+    if data is None:
+        data = {}
+    return {
+        "qTypes": types,
+        "qIncludeSessionObjects": include_session_objects,
+        "qData": data
+    }

{qe_api_client-2.8.0.dist-info → qe_api_client-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qe-api-client
-Version: 2.8.0
+Version: 3.0.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.8.0.dist-info → qe_api_client-3.0.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 qe_api_client/__init__.py,sha256=bypB4CIjpHtf5Pu_NwtJajC69zqQD7qB9jo8cCX0B54,23
-qe_api_client/engine.py,sha256=P98pUEbR86e-UDuI38lzIpRlpT1s93pAs5wNhJtxr5c,58380
+qe_api_client/engine.py,sha256=fgiJfVtCqHi1ui-AQRaXxLd9RYkCK0rJmsHaXy4PoPE,120634
 qe_api_client/engine_communicator.py,sha256=q6x7ix2Ev8yGmTTm7cf1vHcidOihKM0HjDXeJ-dZYjk,1133
-qe_api_client/structs.py,sha256=HuXUCPpHWrQgqilplRID213VAfhO7sefh3FCWfTguvA,23515
+qe_api_client/structs.py,sha256=uk82M1neq9svTw-XVEJzwGxDxeALueGAcp1fG-LjTTA,28327
 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=brTmeUs2o2J8QP2BmGdI4kLP_MVGUZVoB4PPkwAJyec,40773
 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=WTxRusRt2PGxmXsQQyGZ2M2JRyKTSSrV5TqpiykxDbA,10807
+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.8.0.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
-qe_api_client-2.8.0.dist-info/METADATA,sha256=94Fddh_umm8FPjkp7Scj3VGheOLvjGPEiyzx_V3UGjI,2437
-qe_api_client-2.8.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-qe_api_client-2.8.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
-qe_api_client-2.8.0.dist-info/RECORD,,
+qe_api_client-3.0.0.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
+qe_api_client-3.0.0.dist-info/METADATA,sha256=_r4JQhzHNd-VmHfuc-wFziIySkZ9Rez7qsoA16KvsZo,2437
+qe_api_client-3.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+qe_api_client-3.0.0.dist-info/top_level.txt,sha256=m_43YagP8UtZgJHmZEfu0vlBNwt36M01-Qby2jByMnk,14
+qe_api_client-3.0.0.dist-info/RECORD,,