@luzmo/dashboard-contents-types 1.0.0 → 1.0.2

package/assets/json-schemas/date-filter-options.schema.json.d.ts

@@ -204,6 +204,9 @@ declare const _default: {
                                                     "currency_id": {
                                                         "type": "string"
                                                     },
+                                                    "description": {
+                                                        "type": "object"
+                                                    },
                                                     "duration_format": {
                                                         "enum": [
                                                             "long",
@@ -657,7 +660,7 @@ declare const _default: {
                                             "type": "string"
                                         },
                                         "formula": {
-                                            "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas.",
+                                            "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
                                             "type": "string"
                                         },
                                         "grandTotals": {
@@ -704,18 +707,18 @@ declare const _default: {
                                             "type": "string"
                                         },
                                         "periodOverPeriod": {
-                                            "description": "Settings to configure period over period comparison",
+                                            "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
                                             "properties": {
                                                 "level": {
-                                                    "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                                                    "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
                                                     "type": "number"
                                                 },
                                                 "periodToDate": {
-                                                    "description": "period to date comparison",
+                                                    "description": "Turn ON/OFF period to date comparison",
                                                     "type": "boolean"
                                                 },
                                                 "quantity": {
-                                                    "description": "number of periods",
+                                                    "description": "Number of periods",
                                                     "type": "number"
                                                 },
                                                 "type": {
@@ -796,6 +799,67 @@ declare const _default: {
             },
             "type": "object"
         },
+        "loader": {
+            "description": "The loader configuration",
+            "properties": {
+                "background": {
+                    "default": "#f9f9f9",
+                    "description": "Background color of the chart loader element",
+                    "type": "string"
+                },
+                "fontColor": {
+                    "default": "#5a5a5a",
+                    "description": "Font color of the text of the chart loaders",
+                    "type": "string"
+                },
+                "locale": {
+                    "default": "en",
+                    "description": "Locale to be used if \"msg\" is set",
+                    "examples": [
+                        "en",
+                        "fr"
+                    ],
+                    "type": "string"
+                },
+                "mode": {
+                    "default": "light",
+                    "description": "Light or dark loader",
+                    "type": "string"
+                },
+                "msg": {
+                    "description": "Loading message",
+                    "examples": [
+                        "Loading dashboard..."
+                    ],
+                    "type": "string"
+                },
+                "showBranded": {
+                    "default": false,
+                    "description": "Shows the branded \"powered by\" information",
+                    "type": "boolean"
+                },
+                "spinnerBackground": {
+                    "default": "rgba(169, 169, 169, 0.14)",
+                    "description": "Background color of the spinner",
+                    "type": "string"
+                },
+                "spinnerColor": {
+                    "default": "rgba(255, 165, 0, 0.7)",
+                    "description": "Spinner color of the loader",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "locale": {
+            "default": "en",
+            "description": "Locale to be used",
+            "examples": [
+                "en",
+                "fr"
+            ],
+            "type": "string"
+        },
         "padding": {
             "description": "Padding of the date filter",
             "properties": {
@@ -815,37 +879,8 @@ declare const _default: {
         "theme": {
             "description": "Theme configuration",
             "properties": {
-                "axis": {
-                    "description": "Axis styling",
-                    "examples": [
-                        {
-                            "fontSize": 12
-                        },
-                        {
-                            "fontSize": 10
-                        }
-                    ],
-                    "type": "object"
-                },
-                "background": {
-                    "description": "Background color",
-                    "examples": [
-                        "rgb(245, 245, 245)",
-                        "rgb(61, 61, 61)"
-                    ],
-                    "type": "string"
-                },
-                "baseFontSize": {
-                    "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
-                    "examples": [
-                        13,
-                        16,
-                        20
-                    ],
-                    "type": "number"
-                },
                 "borders": {
-                    "description": "Border styling",
+                    "description": "Custom border styling",
                     "properties": {
                         "border-bottom-width": {
                             "description": "Border bottom width",
@@ -914,7 +949,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "boxShadow": {
-                    "description": "Shadow styling",
+                    "description": "Custom shadow styling",
                     "properties": {
                         "color": {
                             "description": "Shadow color",
@@ -943,55 +978,8 @@ declare const _default: {
                     },
                     "type": "object"
                 },
-                "colors": {
-                    "description": "A list of theme colors",
-                    "examples": [
-                        [
-                            "rgb(122, 112, 112)",
-                            "rgb(175, 169, 169)",
-                            "rgb(228, 226, 226)"
-                        ],
-                        [
-                            "rgb(48, 36, 179)",
-                            "rgb(105, 93, 255)",
-                            "rgb(199, 194, 255)",
-                            "rgb(134, 4, 129)",
-                            "rgb(204, 55, 198)",
-                            "rgb(236, 180, 234)",
-                            "rgb(220, 141, 0)",
-                            "rgb(249, 206, 61)",
-                            "rgb(253, 237, 182)",
-                            "rgb(6, 142, 84)",
-                            "rgb(58, 213, 147)",
-                            "rgb(181, 239, 215)",
-                            "rgb(85, 78, 78)",
-                            "rgb(149, 141, 141)",
-                            "rgb(215, 212, 212)"
-                        ]
-                    ],
-                    "items": {
-                        "type": "string"
-                    },
-                    "type": "array"
-                },
-                "editBackground": {
-                    "description": "Edit background",
-                    "examples": [
-                        "rgb(228, 228, 228)",
-                        "rgb(245, 245, 245)",
-                        "rgb(61, 61, 61)"
-                    ],
-                    "type": "string"
-                },
-                "editModeBackground": {
-                    "description": "Edit mode background",
-                    "examples": [
-                        "rgb(245, 245, 245)"
-                    ],
-                    "type": "string"
-                },
                 "font": {
-                    "description": "Font styling",
+                    "description": "Custom font styling",
                     "properties": {
                         "font-style": {
                             "const": "normal",
@@ -1035,40 +1023,15 @@ declare const _default: {
                     "type": "object"
                 },
                 "id": {
-                    "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
+                    "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
                     "examples": [
                         "seasonal",
                         "urban"
                     ],
                     "type": "string"
                 },
-                "itemSpecific": {
-                    "description": "Item specific styling",
-                    "properties": {
-                        "padding": {
-                            "description": "Padding of the item",
-                            "examples": [
-                                0,
-                                4,
-                                8,
-                                10
-                            ],
-                            "type": "number"
-                        },
-                        "rounding": {
-                            "description": "Rounding of the item",
-                            "examples": [
-                                0,
-                                8,
-                                12
-                            ],
-                            "type": "number"
-                        }
-                    },
-                    "type": "object"
-                },
                 "itemsBackground": {
-                    "description": "Item background color",
+                    "description": "Custom item background color",
                     "examples": [
                         "rgb(255, 255, 255)",
                         "rgb(71, 69, 69)",
@@ -1076,85 +1039,8 @@ declare const _default: {
                     ],
                     "type": "string"
                 },
-                "legend": {
-                    "description": "Legend styling",
-                    "properties": {
-                        "fontSize": {
-                            "description": "Legend font size in px",
-                            "examples": [
-                                12,
-                                16
-                            ],
-                            "type": "number"
-                        },
-                        "lineHeight": {
-                            "description": "Legend line height in px",
-                            "examples": [
-                                12,
-                                16,
-                                20
-                            ],
-                            "type": "number"
-                        },
-                        "type": {
-                            "description": "Legend type",
-                            "enum": [
-                                "circle",
-                                "line",
-                                "normal"
-                            ],
-                            "examples": [
-                                "normal",
-                                "line",
-                                "circle"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
-                },
-                "mainColor": {
-                    "description": "Theme main color",
-                    "examples": [
-                        "rgb(123, 144, 255)",
-                        "rgb(255, 174, 52)",
-                        "rgb(123, 144, 255)"
-                    ],
-                    "type": "string"
-                },
-                "margins": {
-                    "description": "Dashboard vertical and horizontal margins",
-                    "examples": [
-                        [
-                            16,
-                            16
-                        ],
-                        [
-                            20,
-                            20
-                        ]
-                    ],
-                    "items": [
-                        {
-                            "type": "number"
-                        },
-                        {
-                            "type": "number"
-                        }
-                    ],
-                    "maxItems": 2,
-                    "minItems": 2,
-                    "type": "array"
-                },
-                "name": {
-                    "description": "Theme name",
-                    "examples": [
-                        "manual"
-                    ],
-                    "type": "string"
-                },
                 "title": {
-                    "description": "Title styling",
+                    "description": "Custom title styling",
                     "properties": {
                         "align": {
                             "description": "Title align",
@@ -1222,51 +1108,8 @@ declare const _default: {
                     },
                     "type": "object"
                 },
-                "tooltip": {
-                    "description": "Tooltip styling",
-                    "properties": {
-                        "background": {
-                            "description": "Tooltip's background",
-                            "examples": [
-                                "rgb(248, 248, 248)",
-                                "rgb(248, 248, 248)",
-                                "rgb(130, 128, 128)",
-                                "rgb(61, 61, 61)"
-                            ],
-                            "type": "string"
-                        },
-                        "fontSize": {
-                            "description": "Tooltip's font size in px",
-                            "examples": [
-                                12,
-                                16,
-                                20
-                            ],
-                            "type": "number"
-                        },
-                        "lineHeight": {
-                            "description": "Tooltip's line height in px",
-                            "examples": [
-                                12,
-                                16,
-                                20
-                            ],
-                            "type": "number"
-                        },
-                        "opacity": {
-                            "description": "Tooltip's opacity",
-                            "examples": [
-                                0.5,
-                                0.8,
-                                1
-                            ],
-                            "type": "number"
-                        }
-                    },
-                    "type": "object"
-                },
                 "type": {
-                    "description": "Theme type",
+                    "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
                     "examples": [
                         "custom"
                     ],
@@ -1275,6 +1118,14 @@ declare const _default: {
             },
             "type": "object"
         },
+        "timezoneId": {
+            "description": "The timezone that will be used in the dashboard. This timezone id needs to be a valid id that is available in the IANA timezone database",
+            "examples": [
+                "Europe/Brussels",
+                "America/New_York"
+            ],
+            "type": "string"
+        },
         "title": {
             "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
             "examples": [

package/assets/json-schemas/date-filter-slots.schema.json.d.ts

@@ -88,18 +88,18 @@ declare const _default: {
                     "type": "string"
                 },
                 "periodOverPeriod": {
-                    "description": "Settings to configure period over period comparison",
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
                     "properties": {
                         "level": {
-                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
                             "type": "number"
                         },
                         "periodToDate": {
-                            "description": "period to date comparison",
+                            "description": "Turn ON/OFF period to date comparison",
                             "type": "boolean"
                         },
                         "quantity": {
-                            "description": "number of periods",
+                            "description": "Number of periods",
                             "type": "number"
                         },
                         "type": {