@luzmo/dashboard-contents-types 0.1.88 → 1.0.0

package/assets/json-schemas/scatter-plot-slots.schema.json.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
         "ColorSlot": {
@@ -10,13 +10,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-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/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -292,16 +346,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/scatter-plot-slots.schema.json#/definitions/ColumnSubtype",
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
-                        "set": {
+                        "datasetId": {
                             "description": "Dataset id",
                             "format": "uuid",
                             "type": "string"
@@ -330,7 +384,7 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
@@ -342,6 +396,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": {
@@ -369,8 +428,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": {
@@ -386,10 +444,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": [
@@ -427,13 +507,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -456,13 +536,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -485,13 +565,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -511,19 +591,19 @@ declare const _default: {
     "items": {
         "anyOf": [
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/YAxisSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/YAxisSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/NameSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/NameSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/SizeSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/SizeSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/XAxisSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/XAxisSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json#/definitions/ColorSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json#/definitions/ColorSlot"
             }
         ]
     },

package/assets/json-schemas/scatter-plot.schema.json.d.ts

@@ -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/scatter-plot.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot.schema.json",
     "type": "object",
     "description": "Scatter Plot item",
     "properties": {
@@ -11,11 +11,11 @@ declare const _default: {
         },
         "options": {
             "description": "Options of the Scatter Plot item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-options.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-options.schema.json"
         },
         "slots": {
             "description": "Data definition of the Scatter Plot item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/scatter-plot-slots.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/scatter-plot-slots.schema.json"
         }
     }
 };

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/slicer-filter-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/slicer-filter-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "applyFiltersWithButton": {
@@ -8,7 +8,13 @@ declare const _default: {
             "type": "boolean"
         },
         "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"
         },
         "display": {
@@ -439,7 +445,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"
@@ -455,7 +461,7 @@ declare const _default: {
                                                     ],
                                                     "type": "string"
                                                 },
-                                                "set": {
+                                                "datasetId": {
                                                     "description": "Dataset id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -484,11 +490,6 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
-                                        "column": {
-                                            "description": "Column id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "columnHierarchies": {
                                             "anyOf": [
                                                 {
@@ -519,6 +520,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": [
@@ -526,6 +532,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": [
@@ -571,8 +582,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": {
@@ -618,17 +628,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": [
                                                 {
@@ -991,6 +1023,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": {