@luzmo/dashboard-contents-types 1.0.3 → 1.0.4

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

@@ -0,0 +1,566 @@
+declare const _default: {
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "definitions": {
+        "ColumnSubtype": {
+            "enum": [
+                "coordinates",
+                "currency",
+                "duration",
+                "hierarchy_element_expression",
+                "topography"
+            ],
+            "type": "string"
+        },
+        "DateTimeSlotContent": {
+            "properties": {
+                "aggregationFunc": {
+                    "description": "Basic aggregation function. It can be used when a \"datetime\" column is used in a measure slot.",
+                    "enum": [
+                        "count",
+                        "distinctcount"
+                    ],
+                    "type": "string"
+                },
+                "color": {
+                    "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                    "type": [
+                        "null",
+                        "string"
+                    ]
+                },
+                "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": [
+                        "day_in_month",
+                        "day_in_year",
+                        "default",
+                        "hour_in_day",
+                        "minute_in_hour",
+                        "month_name",
+                        "month_number",
+                        "quarter_number",
+                        "second_in_minute",
+                        "week_number",
+                        "weekday_name",
+                        "weekday_number"
+                    ],
+                    "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"
+                },
+                "grandTotals": {
+                    "description": "Enable or disable grand totals, they're only used in Pivot table",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
+                "label": {
+                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "type": "object"
+                },
+                "level": {
+                    "description": "\"hierarchy\" or \"datetime\" level",
+                    "type": [
+                        "number",
+                        "null"
+                    ]
+                },
+                "lowestLevel": {
+                    "description": "Lowest \"hierarchy\" or \"datetime\" level",
+                    "type": [
+                        "null",
+                        "number"
+                    ]
+                },
+                "monthNameFormat": {
+                    "description": "Month name format for datetime column formatting",
+                    "enum": [
+                        "letter",
+                        "long",
+                        "short"
+                    ],
+                    "type": "string"
+                },
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
+                    "properties": {
+                        "level": {
+                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "Turn ON/OFF 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",
+                    "type": "null"
+                },
+                "type": {
+                    "const": "datetime",
+                    "description": "\"datetime\" column type",
+                    "type": "string"
+                },
+                "weekDayNameFormat": {
+                    "description": "Week day name format for datetime column formatting",
+                    "enum": [
+                        "letter",
+                        "long",
+                        "short"
+                    ],
+                    "type": "string"
+                },
+                "weekStart": {
+                    "description": "Week start day, 'sunday' or 'monday'. For datetime column formatting.",
+                    "enum": [
+                        "monday",
+                        "sunday"
+                    ],
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "GeoSlot": {
+            "description": "Geo slot definition of the Heat Map. This is the required slot. This slot can only accept a Geo content type column.",
+            "properties": {
+                "content": {
+                    "description": "Geo slot definition",
+                    "items": {
+                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/SpatialSlotContent"
+                    },
+                    "maxItems": 1,
+                    "type": "array"
+                },
+                "name": {
+                    "const": "geo",
+                    "description": "Name of the slot",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "HierarchySlotContent": {
+            "properties": {
+                "aggregationFunc": {
+                    "description": "Basic aggregation function. It can be used when a \"hierarchy\" column is used in a measure slot.",
+                    "enum": [
+                        "count",
+                        "distinctcount"
+                    ],
+                    "type": "string"
+                },
+                "color": {
+                    "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                    "type": [
+                        "null",
+                        "string"
+                    ]
+                },
+                "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"
+                },
+                "grandTotals": {
+                    "description": "Enable or disable grand totals, they're only used in Pivot table",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
+                "label": {
+                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "type": "object"
+                },
+                "level": {
+                    "description": "\"hierarchy\" or \"datetime\" level",
+                    "type": [
+                        "number",
+                        "null"
+                    ]
+                },
+                "lowestLevel": {
+                    "description": "Lowest \"hierarchy\" or \"datetime\" level",
+                    "type": [
+                        "null",
+                        "number"
+                    ]
+                },
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
+                    "properties": {
+                        "level": {
+                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "Turn ON/OFF 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": [
+                        {
+                            "enum": [
+                                "coordinates",
+                                "currency",
+                                "date",
+                                "datetime",
+                                "duration",
+                                "hierarchy_element_expression",
+                                "topography"
+                            ],
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Column subtype"
+                },
+                "type": {
+                    "const": "hierarchy",
+                    "description": "\"hierarchy\" column type",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "MeasureSlot": {
+            "description": "Measure slot definition of the Heat Map",
+            "properties": {
+                "content": {
+                    "description": "Measure slot definition",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/NumericSlotContent"
+                            },
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/HierarchySlotContent"
+                            },
+                            {
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/DateTimeSlotContent"
+                            }
+                        ]
+                    },
+                    "maxItems": 1,
+                    "type": "array"
+                },
+                "name": {
+                    "const": "measure",
+                    "description": "Name of the slot",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "NumericSlotContent": {
+            "properties": {
+                "aggregationFunc": {
+                    "description": "Aggregation function. It can be used with a \"numeric\" column type, and with some limitations with \"hierarchy\" and \"datetime\" column types.",
+                    "enum": [
+                        "average",
+                        "count",
+                        "cumulativesum",
+                        "distinctcount",
+                        "histogram",
+                        "max",
+                        "median",
+                        "min",
+                        "rate",
+                        "stddev",
+                        "sum",
+                        "weightedaverage"
+                    ],
+                    "type": "string"
+                },
+                "aggregationWeight": {
+                    "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
+                    "properties": {
+                        "columnId": {
+                            "description": "Column id",
+                            "format": "uuid",
+                            "type": "string"
+                        },
+                        "columnSubType": {
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/ColumnSubtype",
+                            "description": "Column subtype"
+                        },
+                        "datasetId": {
+                            "description": "Dataset id",
+                            "format": "uuid",
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
+                "bins": {
+                    "description": "Bin definition. It can be used when a \"numeric\" column is used as a category.",
+                    "properties": {
+                        "enabled": {
+                            "description": "Enable or disable binning",
+                            "type": "boolean"
+                        },
+                        "number": {
+                            "description": "Defines the range of the bins",
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
+                "color": {
+                    "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                    "type": [
+                        "null",
+                        "string"
+                    ]
+                },
+                "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": [
+                        "null",
+                        "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": {
+                        "format": {
+                            "description": "Duration format",
+                            "enum": [
+                                "long",
+                                "short",
+                                "time"
+                            ],
+                            "type": "string"
+                        },
+                        "levels": {
+                            "description": "Duration levels used",
+                            "items": {
+                                "type": "number"
+                            },
+                            "type": "array"
+                        }
+                    },
+                    "type": "object"
+                },
+                "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"
+                },
+                "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. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
+                    "type": "string"
+                },
+                "grandTotals": {
+                    "description": "Enable or disable grand totals, they're only used in Pivot table",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
+                "label": {
+                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "type": "object"
+                },
+                "periodOverPeriod": {
+                    "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
+                    "properties": {
+                        "level": {
+                            "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                            "type": "number"
+                        },
+                        "periodToDate": {
+                            "description": "Turn ON/OFF 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": [
+                        {
+                            "enum": [
+                                "coordinates",
+                                "currency",
+                                "date",
+                                "datetime",
+                                "duration",
+                                "hierarchy_element_expression",
+                                "topography"
+                            ],
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Column subtype"
+                },
+                "type": {
+                    "const": "numeric",
+                    "description": "\"numeric\" column / formula type",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "SpatialSlotContent": {
+            "properties": {
+                "color": {
+                    "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                    "type": [
+                        "null",
+                        "string"
+                    ]
+                },
+                "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"
+                },
+                "label": {
+                    "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "type": "object"
+                },
+                "subtype": {
+                    "anyOf": [
+                        {
+                            "enum": [
+                                "coordinates",
+                                "currency",
+                                "date",
+                                "datetime",
+                                "duration",
+                                "hierarchy_element_expression",
+                                "topography"
+                            ],
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Column subtype"
+                },
+                "type": {
+                    "const": "spatial",
+                    "description": "\"spatial\" column type",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        }
+    },
+    "description": "Data definition of the Heat Map",
+    "items": {
+        "anyOf": [
+            {
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/GeoSlot"
+            },
+            {
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/MeasureSlot"
+            }
+        ]
+    },
+    "maxItems": 2,
+    "type": "array"
+}
+
+;
+
+export default _default;

package/assets/json-schemas/heat-map.schema.json.d.ts

@@ -0,0 +1,23 @@
+declare const _default: {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map.schema.json",
+    "type": "object",
+    "description": "Heat Map item",
+    "properties": {
+        "type": {
+            "description": "Type of the item",
+            "type": "string",
+            "const": "heat-map"
+        },
+        "options": {
+            "description": "Options of the Heat Map item",
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-options.schema.json"
+        },
+        "slots": {
+            "description": "Data definition of the Heat Map item",
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json"
+        }
+    }
+};
+
+export default _default;