@luzmo/dashboard-contents-types 0.1.89 → 1.0.0

package/assets/json-schemas/choropleth-map-slots.schema.json.d.ts

@@ -55,11 +55,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": [
@@ -118,10 +123,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",
@@ -188,11 +215,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"
@@ -224,10 +256,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": [
@@ -309,7 +363,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"
@@ -318,7 +372,7 @@ declare const _default: {
                             "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
-                        "set": {
+                        "datasetId": {
                             "description": "Dataset id",
                             "format": "uuid",
                             "type": "string"
@@ -347,7 +401,7 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
@@ -359,6 +413,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": {
@@ -386,8 +445,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": {
@@ -403,10 +461,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": [
@@ -445,11 +525,16 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
                 },
+                "datasetId": {
+                    "description": "Dataset id",
+                    "format": "uuid",
+                    "type": "string"
+                },
                 "include_nonoccurring": {
                     "description": "Shows empty areas for geo slots (with the name \"geo\" and content type 'spacial).\nAlso, it can be set in the options' advanced settings of the Choropleth map.",
                     "type": "boolean"
@@ -458,10 +543,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": [

package/assets/json-schemas/circular-gauge-options.schema.json.d.ts

@@ -593,7 +593,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"
@@ -609,7 +609,7 @@ declare const _default: {
                                                     ],
                                                     "type": "string"
                                                 },
-                                                "set": {
+                                                "datasetId": {
                                                     "description": "Dataset id",
                                                     "format": "uuid",
                                                     "type": "string"
@@ -638,11 +638,6 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
-                                        "column": {
-                                            "description": "Column id",
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
                                         "columnHierarchies": {
                                             "anyOf": [
                                                 {
@@ -673,6 +668,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": [
@@ -680,6 +680,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": [
@@ -725,8 +730,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": {
@@ -772,17 +776,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": [
                                                 {

package/assets/json-schemas/circular-gauge-slots.schema.json.d.ts

@@ -29,11 +29,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": [
@@ -92,10 +97,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",
@@ -143,11 +170,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"
@@ -179,10 +211,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": [
@@ -264,7 +318,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"
@@ -273,7 +327,7 @@ declare const _default: {
                             "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/circular-gauge-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
-                        "set": {
+                        "datasetId": {
                             "description": "Dataset id",
                             "format": "uuid",
                             "type": "string"
@@ -302,7 +356,7 @@ declare const _default: {
                         "string"
                     ]
                 },
-                "column": {
+                "columnId": {
                     "description": "Column id",
                     "format": "uuid",
                     "type": "string"
@@ -314,6 +368,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": {
@@ -341,8 +400,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": {
@@ -358,10 +416,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": [