npm - @luzmo/dashboard-contents-types - Versions diffs - 0.1.88 → 1.0.0 - Mend

@luzmo/dashboard-contents-types 0.1.88 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (229) hide show

package/assets/json-schemas/bullet-chart-slots.schema.json.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
         "CategorySlot": {
@@ -10,13 +10,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -58,11 +58,16 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "datetimeDisplayMode": {
                     "description": "If it's set it will be used for datetime formatting together with weekStart, weekDayNameFormat, monthNameFormat",
                     "enum": [
@@ -121,10 +126,32 @@ declare const _default: {
                     ],
                     "type": "string"
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "type": "string"
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison",
+                    "properties": {
+                        "level": {
+                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "period to date comparison",
+                            "type": "boolean"
+                        },
+                        "quantity": {
+                            "description": "number of periods",
+                            "type": "number"
+                        },
+                        "type": {
+                            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
+                            "enum": [
+                                "change",
+                                "none",
+                                "past"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
                 },
                 "subtype": {
                     "description": "There's no subtype for \"datetime\", it can be null or omitted",
@@ -172,11 +199,16 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "format": {
                     "description": "D3 format, it is used for \"numeric\" formatting (https://observablehq.com/@d3/d3-format), for \"datetime\" formatting (https://d3js.org/d3-time-format).\nIt can also be used for \"hierarchy\" formatting but when it's used in the measure slot.",
                     "type": "string"
@@ -208,10 +240,32 @@ declare const _default: {
                         "number"
                     ]
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "type": "string"
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison",
+                    "properties": {
+                        "level": {
+                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "period to date comparison",
+                            "type": "boolean"
+                        },
+                        "quantity": {
+                            "description": "number of periods",
+                            "type": "number"
+                        },
+                        "type": {
+                            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
+                            "enum": [
+                                "change",
+                                "none",
+                                "past"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
                 },
                 "subtype": {
                     "anyOf": [
@@ -249,13 +303,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -293,16 +347,16 @@ declare const _default: {
                 "aggregationWeight": {
                     "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
                     "properties": {
-                        "column": {
+                        "columnId": {
                             "description": "Column id",
                             "format": "uuid",
                             "type": "string"
                         },
                         "columnSubType": {
-                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/ColumnSubtype",
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
-                        "set": {
+                        "datasetId": {
                             "description": "Dataset id",
                             "format": "uuid",
                             "type": "string"
@@ -331,7 +385,7 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
@@ -343,6 +397,11 @@ declare const _default: {
                         "string"
                     ]
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "duration": {
                     "description": "Duration definition. It's only used when the column type is \"numeric\" and subtype is \"duration\".",
                     "properties": {
@@ -370,8 +429,7 @@ declare const _default: {
                     "type": "string"
                 },
                 "formula": {
-                    "description": "Dataset formula id. Formula is an entity similar to a column. Formula can be added on the dataset details page.",
-                    "format": "uuid",
+                    "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.",
                     "type": "string"
                 },
                 "grandTotals": {
@@ -387,10 +445,32 @@ declare const _default: {
                     "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
                     "type": "object"
                 },
-                "set": {
-                    "description": "Dataset id",
-                    "format": "uuid",
-                    "type": "string"
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison",
+                    "properties": {
+                        "level": {
+                            "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "period to date comparison",
+                            "type": "boolean"
+                        },
+                        "quantity": {
+                            "description": "number of periods",
+                            "type": "number"
+                        },
+                        "type": {
+                            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
+                            "enum": [
+                                "change",
+                                "none",
+                                "past"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
                 },
                 "subtype": {
                     "anyOf": [
@@ -428,13 +508,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -454,13 +534,13 @@ declare const _default: {
     "items": {
         "anyOf": [
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/MeasureSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/MeasureSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/CategorySlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/CategorySlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json#/definitions/TargetSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json#/definitions/TargetSlot"
             }
         ]
     },

package/assets/json-schemas/bullet-chart.schema.json.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 declare const _default: {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart.schema.json",
     "type": "object",
     "description": "Bullet Chart item",
     "properties": {
@@ -11,11 +11,11 @@ declare const _default: {
         },
         "options": {
             "description": "Options of the Bullet Chart item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-options.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-options.schema.json"
         },
         "slots": {
             "description": "Data definition of the Bullet Chart item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bullet-chart-slots.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bullet-chart-slots.schema.json"
         }
     }
 };

package/assets/json-schemas/choropleth-map-options.schema.json.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/choropleth-map-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "classification": {
@@ -14,7 +14,13 @@ declare const _default: {
             "type": "string"
         },
         "color": {
+            "default": "",
             "description": "The main color for the item, if omitted the default color from the theme will be used.",
+            "examples": [
+                "#FF5733",
+                "#33FF57",
+                "#5733FF"
+            ],
             "type": "string"
         },
         "colorsClass": {
@@ -590,7 +596,7 @@ declare const _default: {
                                         "aggregationWeight": {
                                             "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
                                             "properties": {
-                                                "column": {
+                                                "columnId": {
                                                     "description": "Column id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -606,7 +612,7 @@ declare const _default: {
                                                     ],
                                                     "type": "string"
                                                 },
-                                                "set": {
+                                                "datasetId": {
                                                     "description": "Dataset id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -635,11 +641,6 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
-                                        "column": {
-                                            "description": "Column id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "columnHierarchies": {
                                             "anyOf": [
                                                 {
@@ -670,6 +671,11 @@ declare const _default: {
                                                 }
                                             ]
                                         },
+                                        "columnId": {
+                                            "description": "Column id",
+                                            "format": "uuid",
+                                            "type": "string"
+                                        },
                                         "currency": {
                                             "description": "Currency code, for example \"€\" or \"$\". It is only used when the column type is \"numeric\" and subtype is \"currency\".",
                                             "type": [
@@ -677,6 +683,11 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
+                                        "datasetId": {
+                                            "description": "Dataset id",
+                                            "format": "uuid",
+                                            "type": "string"
+                                        },
                                         "datetimeDisplayMode": {
                                             "description": "If it's set it will be used for datetime formatting together with weekStart, weekDayNameFormat, monthNameFormat",
                                             "enum": [
@@ -722,8 +733,7 @@ declare const _default: {
                                             "type": "string"
                                         },
                                         "formula": {
-                                            "description": "Dataset formula id. Formula is an entity similar to a column. Formula can be added on the dataset details page.",
-                                            "format": "uuid",
+                                            "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.",
                                             "type": "string"
                                         },
                                         "grandTotals": {
@@ -769,17 +779,39 @@ declare const _default: {
                                             ],
                                             "type": "string"
                                         },
+                                        "periodOverPeriod": {
+                                            "description": "Settings to configure period over period comparison",
+                                            "properties": {
+                                                "level": {
+                                                    "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                                                    "type": "number"
+                                                },
+                                                "periodToDate": {
+                                                    "description": "period to date comparison",
+                                                    "type": "boolean"
+                                                },
+                                                "quantity": {
+                                                    "description": "number of periods",
+                                                    "type": "number"
+                                                },
+                                                "type": {
+                                                    "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
+                                                    "enum": [
+                                                        "change",
+                                                        "none",
+                                                        "past"
+                                                    ],
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
                                         "readonly": {
                                             "type": "boolean"
                                         },
                                         "selected": {
                                             "type": "boolean"
                                         },
-                                        "set": {
-                                            "description": "Dataset id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "subtype": {
                                             "anyOf": [
                                                 {
@@ -1023,6 +1055,12 @@ declare const _default: {
                     "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": {