@luzmo/dashboard-contents-types 1.0.6 → 1.0.8

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "blur": {
@@ -101,33 +101,13 @@ declare const _default: {
         "interactivity": {
             "description": "Interactivity options",
             "properties": {
-                "availableExportTypes": {
-                    "default": [
-                        "xlsx",
-                        "csv",
-                        "png"
-                    ],
-                    "description": "Available export types interactivity option",
-                    "items": {
-                        "description": "Export types",
-                        "enum": [
-                            "csv",
-                            "csv-raw",
-                            "png",
-                            "xlsx",
-                            "xlsx-raw"
-                        ],
-                        "type": "string"
-                    },
-                    "type": "array"
-                },
                 "exportTypes": {
                     "default": [
                         "xlsx",
                         "csv",
                         "png"
                     ],
-                    "description": "Export types interactivity option",
+                    "description": "Export types interactivity option. The export button appears when hovering the chart. If the empty array is provided, the export button is not shown.",
                     "items": {
                         "description": "Export types",
                         "enum": [
@@ -149,364 +129,25 @@ declare const _default: {
                     "items": {
                         "description": "Measure dimension picker configuration",
                         "properties": {
-                            "acceptFormula": {
-                                "type": "boolean"
-                            },
-                            "allAvailableColumns": {
-                                "items": {
-                                    "properties": {
-                                        "columns": {
-                                            "items": {
-                                                "properties": {
-                                                    "cardinality": {
-                                                        "type": "number"
-                                                    },
-                                                    "color": {
-                                                        "type": "string"
-                                                    },
-                                                    "columnHierarchies": {
-                                                        "anyOf": [
-                                                            {
-                                                                "items": {
-                                                                    "type": "string"
-                                                                },
-                                                                "type": "array"
-                                                            },
-                                                            {
-                                                                "items": {
-                                                                    "properties": {
-                                                                        "color": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "id": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "level": {
-                                                                            "type": "number"
-                                                                        },
-                                                                        "name": {
-                                                                            "type": "object"
-                                                                        }
-                                                                    },
-                                                                    "type": "object"
-                                                                },
-                                                                "type": "array"
-                                                            }
-                                                        ]
-                                                    },
-                                                    "currency": {
-                                                        "properties": {
-                                                            "id": {
-                                                                "type": "string"
-                                                            },
-                                                            "name": {
-                                                                "type": "string"
-                                                            },
-                                                            "symbol": {
-                                                                "type": "string"
-                                                            }
-                                                        },
-                                                        "type": "object"
-                                                    },
-                                                    "currency_id": {
-                                                        "type": "string"
-                                                    },
-                                                    "description": {
-                                                        "type": "object"
-                                                    },
-                                                    "duration_format": {
-                                                        "enum": [
-                                                            "long",
-                                                            "short",
-                                                            "time"
-                                                        ],
-                                                        "type": "string"
-                                                    },
-                                                    "duration_levels": {
-                                                        "items": {
-                                                            "type": "number"
-                                                        },
-                                                        "type": "array"
-                                                    },
-                                                    "expression": {
-                                                        "type": "string"
-                                                    },
-                                                    "format": {
-                                                        "type": "string"
-                                                    },
-                                                    "hierarchyLevels": {
-                                                        "items": {
-                                                            "properties": {
-                                                                "color": {
-                                                                    "type": "string"
-                                                                },
-                                                                "id": {
-                                                                    "type": "string"
-                                                                },
-                                                                "level": {
-                                                                    "type": "number"
-                                                                },
-                                                                "name": {
-                                                                    "type": "object"
-                                                                }
-                                                            },
-                                                            "type": "object"
-                                                        },
-                                                        "type": "array"
-                                                    },
-                                                    "hierarchy_enabled": {
-                                                        "type": "boolean"
-                                                    },
-                                                    "highestLevel": {
-                                                        "type": "number"
-                                                    },
-                                                    "id": {
-                                                        "type": "string"
-                                                    },
-                                                    "informat": {
-                                                        "type": "string"
-                                                    },
-                                                    "isFormula": {
-                                                        "type": "boolean"
-                                                    },
-                                                    "isLabel": {
-                                                        "type": "boolean"
-                                                    },
-                                                    "joins": {
-                                                        "items": {
-                                                            "properties": {
-                                                                "currency_id": {
-                                                                    "type": [
-                                                                        "null",
-                                                                        "string"
-                                                                    ]
-                                                                },
-                                                                "hierarchy_enabled": {
-                                                                    "type": "boolean"
-                                                                },
-                                                                "id": {
-                                                                    "type": "string"
-                                                                },
-                                                                "join": {
-                                                                    "properties": {
-                                                                        "column_id": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "created_at": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "joins_id": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "subtype": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "type": {
-                                                                            "enum": [
-                                                                                "exact",
-                                                                                "lookup"
-                                                                            ],
-                                                                            "type": "string"
-                                                                        },
-                                                                        "update_at": {
-                                                                            "type": "string"
-                                                                        },
-                                                                        "updated_at": {
-                                                                            "type": "string"
-                                                                        }
-                                                                    },
-                                                                    "type": "object"
-                                                                },
-                                                                "securable_id": {
-                                                                    "type": "string"
-                                                                }
-                                                            },
-                                                            "type": "object"
-                                                        },
-                                                        "type": "array"
-                                                    },
-                                                    "level": {
-                                                        "type": "number"
-                                                    },
-                                                    "lowestLevel": {
-                                                        "type": "number"
-                                                    },
-                                                    "name": {
-                                                        "type": "object"
-                                                    },
-                                                    "order": {
-                                                        "type": "number"
-                                                    },
-                                                    "securable_id": {
-                                                        "type": "string"
-                                                    },
-                                                    "source_name": {
-                                                        "type": "string"
-                                                    },
-                                                    "subtype": {
-                                                        "enum": [
-                                                            "coordinates",
-                                                            "currency",
-                                                            "duration",
-                                                            "hierarchy_element_expression",
-                                                            "topography"
-                                                        ],
-                                                        "type": "string"
-                                                    },
-                                                    "type": {
-                                                        "enum": [
-                                                            "datetime",
-                                                            "hierarchy",
-                                                            "numeric",
-                                                            "spatial"
-                                                        ],
-                                                        "type": "string"
-                                                    },
-                                                    "version": {
-                                                        "type": "number"
-                                                    },
-                                                    "width": {
-                                                        "type": "number"
-                                                    }
-                                                },
-                                                "type": "object"
-                                            },
-                                            "type": "array"
-                                        },
-                                        "datasetId": {
-                                            "format": "uuid",
-                                            "type": "string"
-                                        },
-                                        "datasetName": {
-                                            "type": "object"
-                                        },
-                                        "formulas": {
-                                            "items": {
-                                                "properties": {
-                                                    "color": {
-                                                        "type": "string"
-                                                    },
-                                                    "currency": {
-                                                        "properties": {
-                                                            "id": {
-                                                                "type": "string"
-                                                            },
-                                                            "name": {
-                                                                "type": "string"
-                                                            },
-                                                            "symbol": {
-                                                                "type": "string"
-                                                            }
-                                                        },
-                                                        "type": "object"
-                                                    },
-                                                    "currency_id": {
-                                                        "type": "string"
-                                                    },
-                                                    "duration_format": {
-                                                        "enum": [
-                                                            "long",
-                                                            "short",
-                                                            "time"
-                                                        ],
-                                                        "type": "string"
-                                                    },
-                                                    "duration_levels": {
-                                                        "items": {
-                                                            "type": "number"
-                                                        },
-                                                        "type": "array"
-                                                    },
-                                                    "expression": {
-                                                        "type": "string"
-                                                    },
-                                                    "format": {
-                                                        "type": "string"
-                                                    },
-                                                    "id": {
-                                                        "type": "string"
-                                                    },
-                                                    "informat": {
-                                                        "enum": [
-                                                            "DD-MM-YYYY HH:mm:ss.SSS",
-                                                            "DD-MM-YYYY HH:mm:ss.SSS ZZ",
-                                                            "MM-DD-YYYY HH:mm:ss.SSS",
-                                                            "MM-DD-YYYY HH:mm:ss.SSS ZZ",
-                                                            "X",
-                                                            "YYYY-MM-DD HH:mm:ss.SSS",
-                                                            "YYYY-MM-DD HH:mm:ss.SSS ZZ",
-                                                            "hierarchy",
-                                                            "numeric",
-                                                            "x"
-                                                        ],
-                                                        "type": "string"
-                                                    },
-                                                    "isFormula": {
-                                                        "type": "boolean"
-                                                    },
-                                                    "level": {
-                                                        "type": "number"
-                                                    },
-                                                    "lowestLevel": {
-                                                        "type": "number"
-                                                    },
-                                                    "name": {
-                                                        "type": "object"
-                                                    },
-                                                    "securableFormula": {
-                                                        "properties": {
-                                                            "formula_id": {
-                                                                "type": "string"
-                                                            },
-                                                            "securable_id": {
-                                                                "type": "string"
-                                                            }
-                                                        },
-                                                        "type": "object"
-                                                    },
-                                                    "securable_id": {
-                                                        "type": "string"
-                                                    },
-                                                    "subtype": {
-                                                        "enum": [
-                                                            "currency",
-                                                            "date",
-                                                            "datetime",
-                                                            "duration"
-                                                        ],
-                                                        "type": "string"
-                                                    },
-                                                    "type": {
-                                                        "enum": [
-                                                            "datetime",
-                                                            "hierarchy",
-                                                            "numeric"
-                                                        ],
-                                                        "type": "string"
-                                                    }
-                                                },
-                                                "type": "object"
-                                            },
-                                            "type": "array"
-                                        }
-                                    },
-                                    "type": "object"
-                                },
-                                "type": "array"
-                            },
-                            "allowMultiple": {
-                                "type": "boolean"
-                            },
-                            "description": {
-                                "type": "string"
-                            },
                             "order": {
+                                "description": "Order",
+                                "examples": [
+                                    0,
+                                    9999
+                                ],
                                 "type": "number"
                             },
                             "slot": {
+                                "description": "Slot name",
+                                "examples": [
+                                    "measure",
+                                    "dimension",
+                                    "legend"
+                                ],
                                 "type": "string"
                             },
                             "values": {
+                                "description": "An array of columns for the current picker",
                                 "items": {
                                     "properties": {
                                         "aggregationFunc": {
@@ -542,6 +183,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "ip_address",
                                                         "topography"
                                                     ],
                                                     "type": "string"
@@ -575,36 +217,6 @@ declare const _default: {
                                                 "string"
                                             ]
                                         },
-                                        "columnHierarchies": {
-                                            "anyOf": [
-                                                {
-                                                    "items": {
-                                                        "type": "string"
-                                                    },
-                                                    "type": "array"
-                                                },
-                                                {
-                                                    "items": {
-                                                        "properties": {
-                                                            "color": {
-                                                                "type": "string"
-                                                            },
-                                                            "id": {
-                                                                "type": "string"
-                                                            },
-                                                            "level": {
-                                                                "type": "number"
-                                                            },
-                                                            "name": {
-                                                                "type": "object"
-                                                            }
-                                                        },
-                                                        "type": "object"
-                                                    },
-                                                    "type": "array"
-                                                }
-                                            ]
-                                        },
                                         "columnId": {
                                             "description": "Column id",
                                             "format": "uuid",
@@ -679,13 +291,6 @@ declare const _default: {
                                             },
                                             "type": "object"
                                         },
-                                        "hidden": {
-                                            "type": "boolean"
-                                        },
-                                        "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"
@@ -733,6 +338,7 @@ declare const _default: {
                                                     "enum": [
                                                         "none",
                                                         "past",
+                                                        "absoluteChange",
                                                         "percentageChange"
                                                     ],
                                                     "type": "string"
@@ -740,10 +346,8 @@ declare const _default: {
                                             },
                                             "type": "object"
                                         },
-                                        "readonly": {
-                                            "type": "boolean"
-                                        },
                                         "selected": {
+                                            "description": "Selected item",
                                             "type": "boolean"
                                         },
                                         "subtype": {
@@ -756,6 +360,7 @@ declare const _default: {
                                                         "datetime",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "ip_address",
                                                         "topography"
                                                     ],
                                                     "type": "string"
@@ -807,7 +412,7 @@ declare const _default: {
             "type": "object"
         },
         "limit": {
-            "description": "Show number of observations",
+            "description": "The maximum number of data rows to query and display",
             "properties": {
                 "number": {
                     "default": 10000,

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
         "ColumnSubtype": {
@@ -8,6 +8,7 @@ declare const _default: {
                 "currency",
                 "duration",
                 "hierarchy_element_expression",
+                "ip_address",
                 "topography"
             ],
             "type": "string"
@@ -98,7 +99,7 @@ declare const _default: {
                     "type": "string"
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -136,7 +137,7 @@ declare const _default: {
                 "content": {
                     "description": "Geo slot definition",
                     "items": {
-                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/SpatialSlotContent"
+                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/SpatialSlotContent"
                     },
                     "maxItems": 1,
                     "type": "array"
@@ -208,7 +209,7 @@ declare const _default: {
                     ]
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -221,6 +222,7 @@ declare const _default: {
                                 "datetime",
                                 "duration",
                                 "hierarchy_element_expression",
+                                "ip_address",
                                 "topography"
                             ],
                             "type": "string"
@@ -247,13 +249,13 @@ declare const _default: {
                     "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.92/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.92/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"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -297,7 +299,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "columnSubType": {
-                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/ColumnSubtype",
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
                         "datasetId": {
@@ -390,7 +392,7 @@ declare const _default: {
                     "type": "object"
                 },
                 "periodOverPeriod": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/PeriodOverPeriod",
                     "description": "Settings to configure period over period comparison. It can be used only in a measure slot."
                 },
                 "subtype": {
@@ -403,6 +405,7 @@ declare const _default: {
                                 "datetime",
                                 "duration",
                                 "hierarchy_element_expression",
+                                "ip_address",
                                 "topography"
                             ],
                             "type": "string"
@@ -436,17 +439,18 @@ declare const _default: {
                     "type": "number"
                 },
                 "type": {
-                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/heat-map-slots.schema.json#/definitions/PeriodOverPeriodType",
+                    "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/PeriodOverPeriodType",
                     "description": "Period over period comparison type"
                 }
             },
             "type": "object"
         },
         "PeriodOverPeriodType": {
-            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'percentageChange' - percentage change comparison to the past",
+            "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'absoluteChange' - absolute change comparison to the past,\n'percentageChange' - percentage change comparison to the past",
             "enum": [
                 "none",
                 "past",
+                "absoluteChange",
                 "percentageChange"
             ],
             "type": "string"
@@ -488,6 +492,7 @@ declare const _default: {
                                 "datetime",
                                 "duration",
                                 "hierarchy_element_expression",
+                                "ip_address",
                                 "topography"
                             ],
                             "type": "string"
@@ -511,10 +516,10 @@ declare const _default: {
     "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.92/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"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.92/heat-map-slots.schema.json#/definitions/MeasureSlot"
             }
         ]
     },