@luzmo/dashboard-contents-types 1.0.18 → 1.0.19

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.97/combination-chart-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/combination-chart-options.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "annotate": {
@@ -12,7 +12,12 @@ declare const _default: {
                             "type": "boolean"
                         },
                         "content": {
-                            "description": "Information tooltip content in format {locale: \"content\"}, for example, {en: \"Content\"}",
+                            "description": "Information tooltip content in format {<locale>: \"content\"}",
+                            "examples": [
+                                {
+                                    "en": "Content"
+                                }
+                            ],
                             "type": "object"
                         },
                         "position": {
@@ -46,7 +51,7 @@ declare const _default: {
                         },
                         "ticksMode": {
                             "default": "ticks",
-                            "description": "Ticks mode of the X-axis",
+                            "description": "Ticks mode of the X-axis: hide, ticks, or gridlines",
                             "enum": [
                                 "gridlines",
                                 "hide",
@@ -55,7 +60,7 @@ declare const _default: {
                             "type": "string"
                         },
                         "ticksStyle": {
-                            "description": "Axis ticks style",
+                            "description": "Ticks style of the X-axis: auto or user defined",
                             "enum": [
                                 "auto",
                                 "userDefined"
@@ -78,7 +83,13 @@ declare const _default: {
                             "type": "string"
                         },
                         "manualAxesRange": {
-                            "description": "Manual axes range",
+                            "description": "Set manual axes range",
+                            "examples": [
+                                [
+                                    0,
+                                    100
+                                ]
+                            ],
                             "items": [
                                 {
                                     "type": "number"
@@ -93,7 +104,7 @@ declare const _default: {
                         },
                         "scale": {
                             "default": "linear",
-                            "description": "Y-axis scale",
+                            "description": "Y-axis scale type: linear or logarithmic",
                             "enum": [
                                 "linear",
                                 "logarithmic"
@@ -101,11 +112,15 @@ declare const _default: {
                             "type": "string"
                         },
                         "scaleLogBase": {
-                            "description": "Logarithmic base of the Y-axis. Only applies if the scale is logarithmic.",
+                            "description": "Base of the logarithmic scale. Only applies if the scale is logarithmic.",
+                            "examples": [
+                                2,
+                                10
+                            ],
                             "type": "number"
                         },
                         "ticksDensity": {
-                            "description": "Ticks density of the Y-axis",
+                            "description": "Density of the ticks on the Y-axis",
                             "enum": [
                                 "compact",
                                 "normal",
@@ -114,7 +129,8 @@ declare const _default: {
                             "type": "string"
                         },
                         "ticksMode": {
-                            "description": "Ticks mode of the Y-axis",
+                            "default": "ticks",
+                            "description": "Ticks mode of the Y-axis: hide, ticks, or gridlines",
                             "enum": [
                                 "gridlines",
                                 "hide",
@@ -124,7 +140,7 @@ declare const _default: {
                         },
                         "type": {
                             "default": "default",
-                            "description": "Combination chart measure axis type",
+                            "description": "Y-axis type: default, manual or variable",
                             "enum": [
                                 "default",
                                 "manual",
@@ -140,11 +156,11 @@ declare const _default: {
                     "properties": {
                         "active": {
                             "default": false,
-                            "description": "Show or hide the Y2-axis",
+                            "description": "Toggle whether the Y2-axis is active",
                             "type": "boolean"
                         },
                         "color": {
-                            "description": "Y-axis color",
+                            "description": "Y2-axis color",
                             "examples": [
                                 "#000000",
                                 "black",
@@ -153,7 +169,13 @@ declare const _default: {
                             "type": "string"
                         },
                         "manualAxesRange": {
-                            "description": "Manual axis range options. Minimum and maximum value of the axis range.",
+                            "description": "Set manual axes range",
+                            "examples": [
+                                [
+                                    0,
+                                    100
+                                ]
+                            ],
                             "items": [
                                 {
                                     "type": "number"
@@ -170,11 +192,11 @@ declare const _default: {
                             "default": [
                                 1
                             ],
-                            "description": "Measure indexes",
+                            "description": "Array of measure indexes to be displayed on the Y2-axis",
                             "examples": [
                                 [
-                                    0,
-                                    1
+                                    1,
+                                    2
                                 ]
                             ],
                             "items": {
@@ -183,8 +205,7 @@ declare const _default: {
                             "type": "array"
                         },
                         "scale": {
-                            "default": "linear",
-                            "description": "Axis scale type",
+                            "description": "Y2-axis scale type: linear or logarithmic",
                             "enum": [
                                 "linear",
                                 "logarithmic"
@@ -192,11 +213,15 @@ declare const _default: {
                             "type": "string"
                         },
                         "scaleLogBase": {
-                            "description": "Logarithmic base of the Y2-axis",
+                            "description": "Base of the logarithmic scale. Only applies if the scale is logarithmic.",
+                            "examples": [
+                                2,
+                                10
+                            ],
                             "type": "number"
                         },
                         "ticksDensity": {
-                            "description": "Axis ticks density",
+                            "description": "Density of the ticks on the Y2-axis",
                             "enum": [
                                 "compact",
                                 "normal",
@@ -206,7 +231,7 @@ declare const _default: {
                         },
                         "ticksMode": {
                             "default": "ticks",
-                            "description": "Axis ticks mode",
+                            "description": "Ticks mode of the Y2-axis: hide, ticks, or gridlines",
                             "enum": [
                                 "gridlines",
                                 "hide",
@@ -216,7 +241,7 @@ declare const _default: {
                         },
                         "type": {
                             "default": "default",
-                            "description": "Combination chart measure axis type",
+                            "description": "Y2-axis type: default, manual or variable",
                             "enum": [
                                 "default",
                                 "manual",
@@ -274,27 +299,6 @@ declare const _default: {
                         }
                     },
                     "type": "object"
-                },
-                "y2": {
-                    "description": "Y2-axis label options",
-                    "properties": {
-                        "enabled": {
-                            "default": false,
-                            "description": "Show or hide the Y2-axis labels",
-                            "type": "boolean"
-                        },
-                        "position": {
-                            "default": "middle",
-                            "description": "Position of the Y-axis labels",
-                            "enum": [
-                                "bottom",
-                                "middle",
-                                "top"
-                            ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
                 }
             },
             "type": "object"
@@ -356,15 +360,20 @@ declare const _default: {
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Show or hide the X-axis grid",
+                            "description": "Show or hide the axis grid",
                             "type": "boolean"
                         },
                         "opacity": {
-                            "description": "Opacity of the X-axis grid",
+                            "description": "Opacity of the axis grid",
+                            "examples": [
+                                1,
+                                0.5,
+                                0.1
+                            ],
                             "type": "number"
                         },
                         "style": {
-                            "description": "Axis grid lines style",
+                            "description": "Style of the axis grid",
                             "enum": [
                                 "dashed",
                                 "dotted",
@@ -380,39 +389,20 @@ declare const _default: {
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Show or hide the Y-axis grid",
+                            "description": "Show or hide the axis grid",
                             "type": "boolean"
                         },
                         "opacity": {
-                            "description": "Opacity of the Y-axis grid",
-                            "type": "number"
-                        },
-                        "style": {
-                            "description": "Axis grid lines style",
-                            "enum": [
-                                "dashed",
-                                "dotted",
-                                "solid"
+                            "description": "Opacity of the axis grid",
+                            "examples": [
+                                1,
+                                0.5,
+                                0.1
                             ],
-                            "type": "string"
-                        }
-                    },
-                    "type": "object"
-                },
-                "y2": {
-                    "description": "Y2-axis grid options",
-                    "properties": {
-                        "enabled": {
-                            "default": false,
-                            "description": "Show or hide the Y2-axis grid",
-                            "type": "boolean"
-                        },
-                        "opacity": {
-                            "description": "Opacity of the Y2-axis grid",
                             "type": "number"
                         },
                         "style": {
-                            "description": "Axis grid lines style",
+                            "description": "Style of the axis grid",
                             "enum": [
                                 "dashed",
                                 "dotted",
@@ -506,94 +496,97 @@ declare const _default: {
                     "type": "boolean"
                 },
                 "customEvents": {
-                    "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"
+                    "default": null,
+                    "description": "Custom events interactivity option",
+                    "properties": {
+                        "events": {
+                            "items": {
+                                "description": "Custom event configuration",
+                                "properties": {
+                                    "label": {
+                                        "description": "Label in format {<locale>: \"label\"}, for example",
+                                        "examples": [
+                                            {
+                                                "en": "Total Revenue"
                                             }
-                                        },
+                                        ],
                                         "type": "object"
                                     },
-                                    "type": "array"
+                                    "name": {
+                                        "description": "Custom event name",
+                                        "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"
-                                    },
-                                    "type": "array"
-                                }
+                                "type": "object"
                             },
-                            "type": "object"
+                            "type": "array"
                         },
-                        {
-                            "type": "null"
+                        "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"
+                            },
+                            "type": "array"
                         }
-                    ],
-                    "default": null,
-                    "description": "Custom events interactivity option"
+                    },
+                    "type": "object"
                 },
                 "customTooltip": {
                     "default": null,
-                    "description": "Custom tooltip interactivity option, in format {locale: \"tooltip\"}, for example, {en: \"Total Revenue\"}",
+                    "description": "Custom tooltip interactivity option, in format {<locale>: \"tooltip text\"}",
+                    "examples": [
+                        {
+                            "en": "Total Revenue"
+                        }
+                    ],
                     "type": [
                         "null",
                         "object"
@@ -690,6 +683,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -730,7 +724,11 @@ declare const _default: {
                                             "type": "string"
                                         },
                                         "currency": {
-                                            "description": "Currency code, for example \"€\" or \"$\". It is only used when the column type is \"numeric\" and subtype is \"currency\".",
+                                            "description": "Currency code. It is only used when the column type is \"numeric\" and subtype is \"currency\".",
+                                            "examples": [
+                                                "€",
+                                                "$"
+                                            ],
                                             "type": [
                                                 "null",
                                                 "string"
@@ -799,7 +797,13 @@ declare const _default: {
                                             "type": "object"
                                         },
                                         "label": {
-                                            "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                                            "description": "Label in format {<locale>: \"label\"}",
+                                            "examples": [
+                                                {
+                                                    "de": "Gesamtumsatz",
+                                                    "en": "Total Revenue"
+                                                }
+                                            ],
                                             "type": "object"
                                         },
                                         "level": {
@@ -832,6 +836,207 @@ declare const _default: {
                                                     "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
                                                     "type": "number"
                                                 },
+                                                "offsetDateColumn": {
+                                                    "allOf": [
+                                                        {
+                                                            "properties": {
+                                                                "cardinality": {
+                                                                    "type": "number"
+                                                                },
+                                                                "color": {
+                                                                    "type": "string"
+                                                                },
+                                                                "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"
+                                                                },
+                                                                "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",
+                                                                        "interval",
+                                                                        "ip_address",
+                                                                        "topography"
+                                                                    ],
+                                                                    "type": "string"
+                                                                },
+                                                                "type": {
+                                                                    "enum": [
+                                                                        "array[datetime]",
+                                                                        "array[hierarchy]",
+                                                                        "array[numeric]",
+                                                                        "array[spatial]",
+                                                                        "datetime",
+                                                                        "hierarchy",
+                                                                        "numeric",
+                                                                        "spatial"
+                                                                    ],
+                                                                    "type": "string"
+                                                                },
+                                                                "version": {
+                                                                    "type": "number"
+                                                                },
+                                                                "width": {
+                                                                    "type": "number"
+                                                                }
+                                                            },
+                                                            "type": "object"
+                                                        },
+                                                        {
+                                                            "properties": {
+                                                                "datasetId": {
+                                                                    "type": "string"
+                                                                }
+                                                            },
+                                                            "type": "object"
+                                                        }
+                                                    ],
+                                                    "description": "Offset date column"
+                                                },
                                                 "periodToDate": {
                                                     "description": "Turn ON/OFF period to date comparison",
                                                     "type": "boolean"
@@ -840,6 +1045,14 @@ declare const _default: {
                                                     "description": "Number of periods",
                                                     "type": "number"
                                                 },
+                                                "rangeType": {
+                                                    "description": "Range type",
+                                                    "enum": [
+                                                        "relative",
+                                                        "user-defined"
+                                                    ],
+                                                    "type": "string"
+                                                },
                                                 "type": {
                                                     "description": "Period over period comparison type",
                                                     "enum": [
@@ -865,6 +1078,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -934,7 +1148,12 @@ declare const _default: {
                             "type": "string"
                         },
                         "url": {
-                            "description": "URL in format {locale: \"url\"}, for example, {en: \"...\"}",
+                            "description": "URL in format {<locale>: \"url\"}",
+                            "examples": [
+                                {
+                                    "en": "https://example.com"
+                                }
+                            ],
                             "type": "object"
                         }
                     },
@@ -1117,7 +1336,7 @@ declare const _default: {
                         "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",
@@ -1126,7 +1345,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"
                             }
                         },
@@ -1539,7 +1759,7 @@ declare const _default: {
             "type": "string"
         },
         "title": {
-            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
+            "description": "Title in format { <locale>: \"title\"}. It's applied if the title is displayed.",
             "examples": [
                 {
                     "en": "Title"