@luzmo/dashboard-contents-types 1.0.2 → 1.0.4-beta.0

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

@@ -1,10 +1,10 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "classification": {
             "default": "quantile",
-            "description": "Classification options: quantile, interval, continuous or manual",
+            "description": "Classification method",
             "enum": [
                 "continuous",
                 "interval",
@@ -15,7 +15,7 @@ declare const _default: {
         },
         "color": {
             "default": "",
-            "description": "The main color for the item, if omitted the default color from the theme will be used.",
+            "description": "The main color for the item, if omitted the default color from the theme will be used",
             "examples": [
                 "#FF5733",
                 "#33FF57",
@@ -25,10 +25,54 @@ declare const _default: {
         },
         "colorsClass": {
             "default": "PuBu",
-            "description": "Set classes on the colors",
+            "description": "A color class, use \"manual\" to specify custom colors in the manualValues option",
+            "examples": [
+                "manual",
+                "Spectral",
+                "RdYlBu",
+                "PdBu",
+                "PiYG",
+                "PRGn",
+                "RdYlGn",
+                "BrBG",
+                "RdGy",
+                "PuOr",
+                "Paired",
+                "Set1",
+                "Set3",
+                "OrRd",
+                "PuBu",
+                "BuPu",
+                "Oranges",
+                "BuGn",
+                "YlOrBr",
+                "YlGn",
+                "Reds",
+                "RdPu",
+                "Greens",
+                "YlGnBu",
+                "Purples",
+                "GnBu",
+                "Greys",
+                "YlOrRd",
+                "PuRd",
+                "Blues",
+                "PuBuGn",
+                "Spectrum",
+                "BlueRed",
+                "Plasma",
+                "Viris",
+                "Incan",
+                "Fire",
+                "Inferno",
+                "Ocean",
+                "Sunrise"
+            ],
             "type": "string"
         },
         "disableWebgl": {
+            "default": false,
+            "description": "Disable or enable WebGL rendering",
             "type": "boolean"
         },
         "display": {
@@ -48,35 +92,45 @@ declare const _default: {
             "type": "object"
         },
         "enabled": {
+            "description": "Options to enable or disable different map features",
             "properties": {
                 "pan": {
+                    "default": true,
+                    "description": "Enable or disable pan",
                     "type": "boolean"
                 },
                 "pitchBearing": {
+                    "default": false,
+                    "description": "Enable or disable \"Pitch & Rotate\" (allows using Ctrl + drag)",
                     "type": "boolean"
                 },
                 "repositionOnRefresh": {
+                    "default": true,
+                    "description": "Enable or disable reposition on Data Refresh",
                     "type": "boolean"
                 },
                 "zoom": {
+                    "default": true,
+                    "description": "Enable or disable zoom",
                     "type": "boolean"
                 }
             },
             "type": "object"
         },
         "highlights": {
-            "description": "Highlight options",
+            "description": "Highlight dominance options, it's applied only when a category is set",
             "properties": {
                 "active": {
                     "default": true,
-                    "description": "enable or disable highlight",
+                    "description": "Enable or disable highlight",
                     "type": "boolean"
                 },
                 "color": {
                     "default": "rgb(255,255,255)",
                     "description": "If enabled, color of the highlight",
                     "examples": [
-                        "#000000"
+                        "rgb(0,0,0)",
+                        "rgb(255,255,255)"
                     ],
                     "type": "string"
                 }
@@ -1013,18 +1067,24 @@ declare const _default: {
             ],
             "type": "string"
         },
+        "lookupFiltering": {
+            "default": false,
+            "description": "Allow interactive filtering of charts with linked datasets",
+            "type": "boolean"
+        },
         "manualValues": {
-            "default": [
-                []
-            ],
-            "description": "Manual values configuration",
+            "default": {
+                "manualValues": []
+            },
+            "description": "Manually specified classification and colors",
             "properties": {
                 "ranges": {
+                    "description": "Ranges of values and colors",
                     "items": {
                         "description": "Values range options that are configured manually",
                         "properties": {
                             "color": {
-                                "description": "Color of the range",
+                                "description": "Color of the range, it can be a hex or rgb(a) color",
                                 "type": "string"
                             },
                             "isNegativeInfinityRange": {
@@ -1045,7 +1105,16 @@ declare const _default: {
         },
         "numberClasses": {
             "default": 5,
-            "description": "Number of classes",
+            "description": "Number of classes for classification",
+            "examples": [
+                3,
+                4,
+                5,
+                6,
+                7,
+                8,
+                9
+            ],
             "type": "number"
         },
         "opacity": {
@@ -1053,19 +1122,35 @@ declare const _default: {
             "description": "Opacity of the map",
             "type": "number"
         },
-        "overlays": {
-            "items": {},
-            "type": "array"
-        },
         "pin": {
+            "description": "Pin options",
             "properties": {
                 "auto": {
+                    "default": true,
+                    "description": "Automatically pin the map",
                     "type": "boolean"
                 },
                 "bearing": {
+                    "default": 0,
+                    "description": "The map's initial bearing (rotation), measured in degrees counter-clockwise from north. If unspecified in options or style, it defaults to `0`.",
                     "type": "number"
                 },
                 "center": {
+                    "default": [
+                        0,
+                        0
+                    ],
+                    "description": "The map's initial centerpoint. If unspecified in options or style, it defaults to [0, 0]. Note: MapLibre GL JS uses longitude-latitude order to match GeoJSON.",
+                    "examples": [
+                        [
+                            0,
+                            0
+                        ],
+                        [
+                            50.870978137947134,
+                            4.344406127929688
+                        ]
+                    ],
                     "items": [
                         {
                             "type": "number"
@@ -1079,9 +1164,18 @@ declare const _default: {
                     "type": "array"
                 },
                 "pitch": {
+                    "default": 0,
+                    "description": "The map's initial pitch (tilt), measured in degrees from the screen plane (0-85). If unspecified in options or the style, it defaults to 0.",
                     "type": "number"
                 },
                 "zoom": {
+                    "default": 2,
+                    "description": "The map's initial zoom level. If unspecified in options or style, it defaults to 0.",
+                    "examples": [
+                        2,
+                        5,
+                        11
+                    ],
                     "type": "number"
                 }
             },
@@ -1089,9 +1183,10 @@ declare const _default: {
         },
         "strokeColor": {
             "default": "rgba(0,0,0,.3)",
-            "description": "Stroke color of the map",
+            "description": "Border color, it's applied only when a category is set",
             "examples": [
-                "#000000"
+                "#000000",
+                "rgb(227,150,150)"
             ],
             "type": "string"
         },
@@ -1202,12 +1297,7 @@ declare const _default: {
                     "properties": {
                         "font-style": {
                             "const": "normal",
-                            "description": "Font style",
-                            "examples": [
-                                "normal",
-                                "italic",
-                                "oblique"
-                            ],
+                            "description": "Use it to reset the font style to \"normal\"",
                             "type": "string"
                         },
                         "font-weight": {
@@ -1418,8 +1508,23 @@ declare const _default: {
             "type": "object"
         },
         "tileProvider": {
+            "default": {
+                "attribution": "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a>",
+                "name": "OpenStreetMap",
+                "url": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
+            },
+            "description": "Map style when WebGL rendering is disabled",
             "properties": {
                 "attribution": {
+                    "description": "Attribution",
+                    "examples": [
+                        "",
+                        "&copy; <a href=\"http://www.openstreetmap.org/copyright\">OpenStreetMap</a>",
+                        "&copy; Openstreetmap France | &copy; <a href=\"http://www.openstreetmap.org/copyright\">OpenStreetMap</a>",
+                        "&copy; <a href=\"http://www.openstreetmap.org/copyright\">OpenStreetMap</a>, Tiles courtesy of <a href=\"http://hot.openstreetmap.org/\" target=\"_blank\">Humanitarian OpenStreetMap Team</a>",
+                        "<a id=\"home-link\" target=\"_top\" href=\"../\">Map tiles</a> by <a target=\"_top\" href=\"http://stamen.com\">Stamen Design</a>, under <a target=\"_top\" href=\"http://creativecommons.org/licenses/by/3.0\">CC BY 3.0</a>, &copy; <a href=\"http://www.openstreetmap.org/copyright\">OpenStreetMap</a>",
+                        "&copy; <a href=\"http://www.antwerpen.be\">Stad Antwerpen</a>"
+                    ],
                     "type": "string"
                 },
                 "bounds": {
@@ -1446,15 +1551,57 @@ declare const _default: {
                         {
                             "type": "object"
                         }
+                    ],
+                    "description": "Bounds",
+                    "examples": [
+                        [
+                            [
+                                51.1,
+                                4.1
+                            ],
+                            [
+                                51.45,
+                                4.5
+                            ]
+                        ]
                     ]
                 },
                 "name": {
+                    "description": "Name",
+                    "examples": [
+                        "No Tiles",
+                        "OpenStreetMap",
+                        "OpenStreetMap France",
+                        "OpenStreetMap Hot",
+                        "Stamen Toner",
+                        "Stamen Watercolor",
+                        "Stamen Terrain",
+                        "Cityplan Antwerp"
+                    ],
                     "type": "string"
                 },
                 "url": {
+                    "description": "URL",
+                    "examples": [
+                        "",
+                        "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
+                        "https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png",
+                        "https://tile-{s}.openstreetmap.fr/hot/{z}/{x}/{y}.png",
+                        "https://stamen-tiles-{s}.a.ssl.fastly.net/toner/{z}/{x}/{y}.png",
+                        "https://stamen-tiles-{s}.a.ssl.fastly.net/watercolor/{z}/{x}/{y}.png",
+                        "https://stamen-tiles-{s}.a.ssl.fastly.net/terrain/{z}/{x}/{y}.png",
+                        "https://tiles.arcgis.com/tiles/1KSVSmnHT2Lw9ea6/arcgis/rest/services/basemap_stadsplan_v5/MapServer/tile/{z}/{y}/{x}"
+                    ],
                     "type": "string"
                 },
                 "vectorId": {
+                    "description": "Vector ID",
+                    "examples": [
+                        "no-tiles",
+                        "osm-bright",
+                        "toner",
+                        "osm-liberty"
+                    ],
                     "type": "string"
                 }
             },
@@ -1469,7 +1616,7 @@ declare const _default: {
             "type": "string"
         },
         "title": {
-            "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
+            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
             "examples": [
                 {
                     "en": "Title"
@@ -1494,26 +1641,79 @@ declare const _default: {
             "type": "object"
         },
         "vectorTileProvider": {
+            "default": {
+                "attribution": "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a>",
+                "id": "klokantech-basic",
+                "name": "Basic"
+            },
+            "description": "Map style when WebGL rendering is enabled",
             "properties": {
                 "attribution": {
+                    "description": "Attribution",
+                    "examples": [
+                        "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a>"
+                    ],
                     "type": "string"
                 },
                 "id": {
+                    "description": "ID",
+                    "examples": [
+                        "no-tiles",
+                        "klokantech-basic",
+                        "osm-bright",
+                        "dark-matter",
+                        "fiord-color",
+                        "osm-liberty",
+                        "pastel",
+                        "positron"
+                    ],
                     "type": "string"
                 },
                 "name": {
+                    "description": "Name",
+                    "examples": [
+                        "No Tiles",
+                        "Basic",
+                        "Bright",
+                        "Dark",
+                        "Fiord",
+                        "Liberty",
+                        "Pastel",
+                        "Positron",
+                        "Streets"
+                    ],
                     "type": "string"
                 },
                 "rasterName": {
+                    "description": "Raster name",
+                    "examples": [
+                        "No Tiles",
+                        "OpenStreetMap"
+                    ],
                     "type": "string"
                 },
                 "url": {
+                    "description": "URL",
+                    "examples": [
+                        "https://openmaptiles.github.io/klokantech-basic-gl-style/style-cdn.json",
+                        "https://openmaptiles.github.io/osm-bright-gl-style/style-cdn.json",
+                        "https://openmaptiles.github.io/dark-matter-gl-style/style-cdn.json",
+                        "https://openmaptiles.github.io/fiord-color-gl-style/style-cdn.json",
+                        "https://rawgit.com/lukasmartinelli/osm-liberty/gh-pages/style.json",
+                        "https://api.maptiler.com/maps/pastel/style.json",
+                        "https://openmaptiles.github.io/positron-gl-style/style-cdn.json"
+                    ],
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "zoomRange": {
+            "default": [
+                0,
+                25
+            ],
+            "description": "Zoom range",
             "items": [
                 {
                     "type": "number"
@@ -1529,7 +1729,6 @@ declare const _default: {
     },
     "type": "object"
 }
-
 ;
 
 export default _default;

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
         "CategorySlot": {
@@ -10,10 +10,10 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -185,7 +185,7 @@ declare const _default: {
                 "content": {
                     "description": "Geo slot definition",
                     "items": {
-                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/SpatialSlotContent"
+                        "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/SpatialSlotContent"
                     },
                     "maxItems": 1,
                     "type": "array"
@@ -319,13 +319,13 @@ declare const _default: {
                     "items": {
                         "anyOf": [
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/NumericSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/NumericSlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/HierarchySlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/HierarchySlotContent"
                             },
                             {
-                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/DateTimeSlotContent"
+                                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/DateTimeSlotContent"
                             }
                         ]
                     },
@@ -369,7 +369,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "columnSubType": {
-                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/ColumnSubtype",
+                            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/ColumnSubtype",
                             "description": "Column subtype"
                         },
                         "datasetId": {
@@ -576,13 +576,13 @@ declare const _default: {
     "items": {
         "anyOf": [
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/GeoSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/GeoSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/MeasureSlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/MeasureSlot"
             },
             {
-                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/choropleth-map-slots.schema.json#/definitions/CategorySlot"
+                "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/choropleth-map-slots.schema.json#/definitions/CategorySlot"
             }
         ]
     },

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

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

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/circular-gauge-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/circular-gauge-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "circle": {
@@ -46,7 +46,7 @@ declare const _default: {
         },
         "color": {
             "default": "",
-            "description": "The main color for the item, if omitted the default color from the theme will be used.",
+            "description": "The main color for the item, if omitted the default color from the theme will be used",
             "examples": [
                 "#FF5733",
                 "#33FF57",
@@ -956,6 +956,11 @@ declare const _default: {
             ],
             "type": "string"
         },
+        "lookupFiltering": {
+            "default": false,
+            "description": "Allow interactive filtering of charts with linked datasets",
+            "type": "boolean"
+        },
         "manualValues": {
             "default": {},
             "description": "Manual values configuration of the Circular Gauge",
@@ -965,7 +970,7 @@ declare const _default: {
                         "description": "Values range options that are configured manually",
                         "properties": {
                             "color": {
-                                "description": "Color of the range",
+                                "description": "Color of the range, it can be a hex or rgb(a) color",
                                 "type": "string"
                             },
                             "isNegativeInfinityRange": {
@@ -1118,12 +1123,7 @@ declare const _default: {
                     "properties": {
                         "font-style": {
                             "const": "normal",
-                            "description": "Font style",
-                            "examples": [
-                                "normal",
-                                "italic",
-                                "oblique"
-                            ],
+                            "description": "Use it to reset the font style to \"normal\"",
                             "type": "string"
                         },
                         "font-weight": {
@@ -1305,7 +1305,7 @@ declare const _default: {
             "type": "string"
         },
         "title": {
-            "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
+            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
             "examples": [
                 {
                     "en": "Title"
@@ -1316,7 +1316,6 @@ declare const _default: {
     },
     "type": "object"
 }
-
 ;
 
 export default _default;