@luzmo/dashboard-contents-types 1.0.18 → 1.0.19

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

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.97/ohlc-chart-options.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.98/ohlc-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": {
@@ -30,60 +35,56 @@ declare const _default: {
             "type": "object"
         },
         "axis": {
+            "description": "Axes options",
             "properties": {
                 "x": {
+                    "description": "X-axis options",
                     "properties": {
                         "color": {
-                            "description": "Color of x-axis",
+                            "description": "X-axis color",
                             "examples": [
                                 "#000000",
-                                "#ff0000"
+                                "black",
+                                "rgba(0,0,0,1)"
                             ],
                             "type": "string"
                         },
                         "ticksMode": {
                             "default": "ticks",
-                            "description": "Tick mode of x-axis",
+                            "description": "Ticks mode of the X-axis: hide, ticks, or gridlines",
                             "enum": [
                                 "gridlines",
                                 "hide",
                                 "ticks"
                             ],
-                            "examples": [
-                                "hide",
-                                "ticks",
-                                "gridlines"
-                            ],
                             "type": "string"
                         }
                     },
                     "type": "object"
                 },
                 "y": {
+                    "description": "Y-axis options",
                     "properties": {
                         "color": {
-                            "description": "Color of y-axis",
+                            "description": "Y-axis color",
                             "examples": [
                                 "#000000",
-                                "#ff0000"
+                                "black",
+                                "rgba(0,0,0,1)"
                             ],
                             "type": "string"
                         },
                         "scale": {
                             "default": "linear",
-                            "description": "Scale on y-axis",
+                            "description": "Y-axis scale type: linear or logarithmic",
                             "enum": [
                                 "linear",
                                 "logarithmic"
                             ],
-                            "examples": [
-                                "linear",
-                                "logarithmic"
-                            ],
                             "type": "string"
                         },
                         "scaleLogBase": {
-                            "description": "When scale is logarithmic, this is the base of the logarithm.",
+                            "description": "Base of the logarithmic scale. Only applies if the scale is logarithmic.",
                             "examples": [
                                 2,
                                 10
@@ -91,32 +92,22 @@ declare const _default: {
                             "type": "number"
                         },
                         "ticksDensity": {
-                            "description": "Density of tick",
+                            "description": "Density of the ticks on the Y-axis",
                             "enum": [
                                 "compact",
                                 "normal",
                                 "sparse"
                             ],
-                            "examples": [
-                                "compact",
-                                "normal",
-                                "sparse"
-                            ],
                             "type": "string"
                         },
                         "ticksMode": {
                             "default": "ticks",
-                            "description": "Tick mode of y-axis",
+                            "description": "Ticks mode of the Y-axis: hide, ticks, or gridlines",
                             "enum": [
                                 "gridlines",
                                 "hide",
                                 "ticks"
                             ],
-                            "examples": [
-                                "hide",
-                                "ticks",
-                                "gridlines"
-                            ],
                             "type": "string"
                         }
                     },
@@ -126,17 +117,19 @@ declare const _default: {
             "type": "object"
         },
         "axislabels": {
+            "description": "Axes labels options",
             "properties": {
                 "x": {
+                    "description": "X-axis label options",
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Enable or disable x-axis labels",
+                            "description": "Show or hide the X-axis labels",
                             "type": "boolean"
                         },
                         "position": {
                             "default": "center",
-                            "description": "Position of labels on x-axis",
+                            "description": "Position of the X-axis labels",
                             "enum": [
                                 "center",
                                 "left",
@@ -148,15 +141,16 @@ declare const _default: {
                     "type": "object"
                 },
                 "y": {
+                    "description": "Y-axis label options",
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Enable or disable y-axis labels",
+                            "description": "Show or hide the Y-axis labels",
                             "type": "boolean"
                         },
                         "position": {
                             "default": "middle",
-                            "description": "Position of labels on y-axis",
+                            "description": "Position of the Y-axis labels",
                             "enum": [
                                 "bottom",
                                 "middle",
@@ -191,67 +185,61 @@ declare const _default: {
             "type": "object"
         },
         "grid": {
-            "description": "Grid config",
+            "description": "Chart grid options",
             "properties": {
                 "x": {
+                    "description": "X-axis grid options",
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Enable or disable x-axis gridlines",
+                            "description": "Show or hide the axis grid",
                             "type": "boolean"
                         },
                         "opacity": {
-                            "description": "Opacity of x-axis grid lines.",
+                            "description": "Opacity of the axis grid",
                             "examples": [
+                                1,
                                 0.5,
-                                1
+                                0.1
                             ],
                             "type": "number"
                         },
                         "style": {
-                            "description": "Style of x-axis gridlines",
+                            "description": "Style of the axis grid",
                             "enum": [
                                 "dashed",
                                 "dotted",
                                 "solid"
                             ],
-                            "examples": [
-                                "solid",
-                                "dashed",
-                                "dotted"
-                            ],
                             "type": "string"
                         }
                     },
                     "type": "object"
                 },
                 "y": {
+                    "description": "Y-axis grid options",
                     "properties": {
                         "enabled": {
                             "default": false,
-                            "description": "Enable or disable y-axis gridlines",
+                            "description": "Show or hide the axis grid",
                             "type": "boolean"
                         },
                         "opacity": {
-                            "description": "Opacity of y-axis grid lines.",
+                            "description": "Opacity of the axis grid",
                             "examples": [
+                                1,
                                 0.5,
-                                1
+                                0.1
                             ],
                             "type": "number"
                         },
                         "style": {
-                            "description": "Style of y-axis gridlines",
+                            "description": "Style of the axis grid",
                             "enum": [
                                 "dashed",
                                 "dotted",
                                 "solid"
                             ],
-                            "examples": [
-                                "solid",
-                                "dashed",
-                                "dotted"
-                            ],
                             "type": "string"
                         }
                     },
@@ -340,94 +328,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"
@@ -524,6 +515,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -564,7 +556,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"
@@ -633,7 +629,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": {
@@ -666,6 +668,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"
@@ -674,6 +877,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": [
@@ -699,6 +910,7 @@ declare const _default: {
                                                         "currency",
                                                         "duration",
                                                         "hierarchy_element_expression",
+                                                        "interval",
                                                         "ip_address",
                                                         "topography"
                                                     ],
@@ -768,7 +980,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"
                         }
                     },
@@ -1194,7 +1411,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"