@luzmo/dashboard-contents-types 1.0.6 → 1.0.8

package/assets/json-schemas/area-chart-options.schema.json.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/area-chart-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.92/area-chart-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "axis": {
@@ -172,7 +172,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": "A color which is used as a default color in certain cases. For example, if the legend slot is not set, the chart will be drawn in this color.",
             "examples": [
                 "#FF5733",
                 "#33FF57",
@@ -339,114 +339,104 @@ 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"
-                },
                 "brush": {
                     "default": true,
                     "description": "Filter on brush interactivity option",
                     "type": "boolean"
                 },
                 "customEvents": {
-                    "default": null,
-                    "description": "Custom events interactivity option",
-                    "properties": {
-                        "events": {
-                            "items": {
-                                "description": "Custom event configuration",
-                                "properties": {
-                                    "label": {
-                                        "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                    "anyOf": [
+                        {
+                            "properties": {
+                                "events": {
+                                    "items": {
+                                        "description": "Custom event configuration",
+                                        "properties": {
+                                            "label": {
+                                                "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                                                "type": "object"
+                                            },
+                                            "name": {
+                                                "description": "Custom event name",
+                                                "type": "string"
+                                            }
+                                        },
                                         "type": "object"
                                     },
-                                    "name": {
-                                        "description": "Custom event name",
-                                        "type": "string"
-                                    }
+                                    "type": "array"
                                 },
-                                "type": "object"
-                            },
-                            "type": "array"
-                        },
-                        "extraData": {
-                            "items": {
-                                "properties": {
-                                    "aggregation": {
-                                        "description": "Aggregation query type",
-                                        "enum": [
-                                            "average",
-                                            "count",
-                                            "cumulativesum",
-                                            "distinctcount",
-                                            "histogram",
-                                            "max",
-                                            "median",
-                                            "min",
-                                            "rate",
-                                            "stddev",
-                                            "sum",
-                                            "weightedaverage"
-                                        ],
-                                        "type": "string"
-                                    },
-                                    "columnId": {
-                                        "description": "Column id",
-                                        "format": "uuid",
-                                        "type": "string"
-                                    },
-                                    "datasetId": {
-                                        "description": "Dataset id",
-                                        "format": "uuid",
-                                        "type": "string"
-                                    },
-                                    "formulaId": {
-                                        "description": "Formula id",
-                                        "format": "uuid",
-                                        "type": "string"
-                                    },
-                                    "label": {
-                                        "description": "Label",
-                                        "type": "string"
-                                    },
-                                    "weightedColumnId": {
-                                        "description": "Weighted column id",
-                                        "format": "uuid",
-                                        "type": "string"
+                                "extraData": {
+                                    "items": {
+                                        "properties": {
+                                            "aggregation": {
+                                                "description": "Aggregation query type",
+                                                "enum": [
+                                                    "average",
+                                                    "count",
+                                                    "cumulativesum",
+                                                    "distinctcount",
+                                                    "histogram",
+                                                    "max",
+                                                    "median",
+                                                    "min",
+                                                    "rate",
+                                                    "stddev",
+                                                    "sum",
+                                                    "weightedaverage"
+                                                ],
+                                                "type": "string"
+                                            },
+                                            "columnId": {
+                                                "description": "Column id",
+                                                "format": "uuid",
+                                                "type": "string"
+                                            },
+                                            "datasetId": {
+                                                "description": "Dataset id",
+                                                "format": "uuid",
+                                                "type": "string"
+                                            },
+                                            "formulaId": {
+                                                "description": "Formula id",
+                                                "format": "uuid",
+                                                "type": "string"
+                                            },
+                                            "label": {
+                                                "description": "Label",
+                                                "type": "string"
+                                            },
+                                            "weightedColumnId": {
+                                                "description": "Weighted column id",
+                                                "format": "uuid",
+                                                "type": "string"
+                                            },
+                                            "weightedDatasetId": {
+                                                "description": "Weighted dataset id",
+                                                "format": "uuid",
+                                                "type": "string"
+                                            }
+                                        },
+                                        "type": "object"
                                     },
-                                    "weightedDatasetId": {
-                                        "description": "Weighted dataset id",
-                                        "format": "uuid",
-                                        "type": "string"
-                                    }
-                                },
-                                "type": "object"
+                                    "type": "array"
+                                }
                             },
-                            "type": "array"
+                            "type": "object"
+                        },
+                        {
+                            "type": "null"
                         }
-                    },
-                    "type": "object"
+                    ],
+                    "default": null,
+                    "description": "Custom events interactivity option"
                 },
                 "customTooltip": {
                     "default": null,
                     "description": "Custom tooltip interactivity option, in format {locale: \"tooltip\"}, for example, {en: \"Total Revenue\"}",
-                    "type": "object"
+                    "type": [
+                        "null",
+                        "object"
+                    ]
                 },
                 "exportTypes": {
                     "default": [
@@ -454,7 +444,7 @@ declare const _default: {
                         "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": [
@@ -476,364 +466,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": {
@@ -869,6 +520,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "ip_address",
                                                         "topography"
                                                     ],
                                                     "type": "string"
@@ -902,36 +554,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",
@@ -1006,13 +628,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"
@@ -1060,6 +675,7 @@ declare const _default: {
                                                     "enum": [
                                                         "none",
                                                         "past",
+                                                        "absoluteChange",
                                                         "percentageChange"
                                                     ],
                                                     "type": "string"
@@ -1067,10 +683,8 @@ declare const _default: {
                                             },
                                             "type": "object"
                                         },
-                                        "readonly": {
-                                            "type": "boolean"
-                                        },
                                         "selected": {
+                                            "description": "Selected item",
                                             "type": "boolean"
                                         },
                                         "subtype": {
@@ -1083,6 +697,7 @@ declare const _default: {
                                                         "datetime",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "ip_address",
                                                         "topography"
                                                     ],
                                                     "type": "string"
@@ -1206,7 +821,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": 100000,
@@ -1283,11 +898,11 @@ declare const _default: {
             "type": "boolean"
         },
         "missingValue": {
-            "description": "Missing value configuration",
+            "description": "Fill missing days. Describes how missing date periods in the data are handled in the chart.",
             "properties": {
                 "type": {
                     "default": "no",
-                    "description": "Type of the missing value",
+                    "description": "Type of the missing value. The possible values are \"No\" (don't fill missing date periods), \"Break area when null values\" (area is interrupted between two date periods with a missing period in between) or a manual value (area is drawn as a manual value between two date periods with a missing period in between, default: 0).",
                     "enum": [
                         "break",
                         "manual",
@@ -1296,7 +911,8 @@ declare const _default: {
                     "type": "string"
                 },
                 "value": {
-                    "description": "Value of the missing value",
+                    "default": 0,
+                    "description": "The manual value of the missing value, it's applied when the type is \"manual\"",
                     "type": "number"
                 }
             },