@luzmo/dashboard-contents-types 1.0.6 → 1.0.8

package/assets/json-schemas/strip-plot-options.schema.json.d.ts

@@ -0,0 +1,723 @@
+declare const _default: {
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.92/strip-plot-options.schema.json",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "properties": {
+        "color": {
+            "default": "",
+            "description": "The main color for the item, if omitted the default color from the theme will be used",
+            "examples": [
+                "#FF5733",
+                "#33FF57",
+                "#5733FF"
+            ],
+            "type": "string"
+        },
+        "display": {
+            "properties": {
+                "percentile": {
+                    "default": ": true",
+                    "description": "Show percentile in label values (P32, P99 etc.) along with absolute values.",
+                    "type": "boolean"
+                },
+                "searchOption": {
+                    "default": true,
+                    "description": "Show or hide a search bar at the top right",
+                    "type": "boolean"
+                },
+                "title": {
+                    "default": false,
+                    "description": "Show or hide the title",
+                    "type": "boolean"
+                }
+            },
+            "type": "object"
+        },
+        "interactivity": {
+            "description": "Interactivity options",
+            "properties": {
+                "exportTypes": {
+                    "default": [
+                        "xlsx",
+                        "csv",
+                        "png"
+                    ],
+                    "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": [
+                            "csv",
+                            "csv-raw",
+                            "png",
+                            "xlsx",
+                            "xlsx-raw"
+                        ],
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "measureDimensionPicker": {
+                    "default": [
+                        []
+                    ],
+                    "description": "An array of measure dimension picker configurations",
+                    "items": {
+                        "description": "Measure dimension picker configuration",
+                        "properties": {
+                            "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": {
+                                            "description": "Aggregation function. It can be used with a \"numeric\" column type, and with some limitations with \"hierarchy\" and \"datetime\" column types.",
+                                            "enum": [
+                                                "average",
+                                                "count",
+                                                "cumulativesum",
+                                                "distinctcount",
+                                                "histogram",
+                                                "max",
+                                                "median",
+                                                "min",
+                                                "rate",
+                                                "stddev",
+                                                "sum",
+                                                "weightedaverage"
+                                            ],
+                                            "type": "string"
+                                        },
+                                        "aggregationWeight": {
+                                            "description": "Aggregation weight. It can be used with a \"numeric\" column type.",
+                                            "properties": {
+                                                "columnId": {
+                                                    "description": "Column id",
+                                                    "format": "uuid",
+                                                    "type": "string"
+                                                },
+                                                "columnSubType": {
+                                                    "description": "Column subtype",
+                                                    "enum": [
+                                                        "coordinates",
+                                                        "currency",
+                                                        "duration",
+                                                        "hierarchy_element_expression",
+                                                        "ip_address",
+                                                        "topography"
+                                                    ],
+                                                    "type": "string"
+                                                },
+                                                "datasetId": {
+                                                    "description": "Dataset id",
+                                                    "format": "uuid",
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "bins": {
+                                            "description": "Bin definition. It can be used when a \"numeric\" column is used as a category.",
+                                            "properties": {
+                                                "enabled": {
+                                                    "description": "Enable or disable binning",
+                                                    "type": "boolean"
+                                                },
+                                                "number": {
+                                                    "description": "Defines the range of the bins",
+                                                    "type": "number"
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "color": {
+                                            "description": "Color of the column. Any column type can have it, but it's applied when a column is set as a measure and when multiple measures are defined.",
+                                            "type": [
+                                                "null",
+                                                "string"
+                                            ]
+                                        },
+                                        "columnId": {
+                                            "description": "Column id",
+                                            "format": "uuid",
+                                            "type": "string"
+                                        },
+                                        "currency": {
+                                            "description": "Currency code, for example \"€\" or \"$\". It is only used when the column type is \"numeric\" and subtype is \"currency\".",
+                                            "type": [
+                                                "null",
+                                                "string"
+                                            ]
+                                        },
+                                        "datasetId": {
+                                            "description": "Dataset id",
+                                            "format": "uuid",
+                                            "type": "string"
+                                        },
+                                        "datetimeDisplayMode": {
+                                            "description": "If it's set it will be used for datetime formatting together with weekStart, weekDayNameFormat, monthNameFormat",
+                                            "enum": [
+                                                "day_in_month",
+                                                "day_in_year",
+                                                "default",
+                                                "hour_in_day",
+                                                "minute_in_hour",
+                                                "month_name",
+                                                "month_number",
+                                                "quarter_number",
+                                                "second_in_minute",
+                                                "week_number",
+                                                "weekday_name",
+                                                "weekday_number"
+                                            ],
+                                            "type": "string"
+                                        },
+                                        "duration": {
+                                            "description": "Duration definition. It's only used when the column type is \"numeric\" and subtype is \"duration\".",
+                                            "properties": {
+                                                "format": {
+                                                    "description": "Duration format",
+                                                    "enum": [
+                                                        "long",
+                                                        "short",
+                                                        "time"
+                                                    ],
+                                                    "type": "string"
+                                                },
+                                                "levels": {
+                                                    "description": "Duration levels used",
+                                                    "items": {
+                                                        "type": "number"
+                                                    },
+                                                    "type": "array"
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "format": {
+                                            "description": "D3 format, it is used for \"numeric\" formatting (https://observablehq.com/@d3/d3-format), for \"datetime\" formatting (https://d3js.org/d3-time-format).\nIt can also be used for \"hierarchy\" formatting but when it's used in the measure slot.",
+                                            "type": "string"
+                                        },
+                                        "formula": {
+                                            "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
+                                            "type": "string"
+                                        },
+                                        "grandTotals": {
+                                            "description": "Enable or disable grand totals, they're only used in Pivot table",
+                                            "properties": {
+                                                "enabled": {
+                                                    "type": "boolean"
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "label": {
+                                            "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
+                                            "type": "object"
+                                        },
+                                        "level": {
+                                            "description": "\"hierarchy\" or \"datetime\" level",
+                                            "type": [
+                                                "number",
+                                                "null"
+                                            ]
+                                        },
+                                        "lowestLevel": {
+                                            "description": "Lowest \"hierarchy\" or \"datetime\" level",
+                                            "type": [
+                                                "null",
+                                                "number"
+                                            ]
+                                        },
+                                        "monthNameFormat": {
+                                            "description": "Month name format for datetime column formatting",
+                                            "enum": [
+                                                "letter",
+                                                "long",
+                                                "short"
+                                            ],
+                                            "type": "string"
+                                        },
+                                        "periodOverPeriod": {
+                                            "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
+                                            "properties": {
+                                                "level": {
+                                                    "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
+                                                    "type": "number"
+                                                },
+                                                "periodToDate": {
+                                                    "description": "Turn ON/OFF period to date comparison",
+                                                    "type": "boolean"
+                                                },
+                                                "quantity": {
+                                                    "description": "Number of periods",
+                                                    "type": "number"
+                                                },
+                                                "type": {
+                                                    "description": "Period over period comparison type",
+                                                    "enum": [
+                                                        "none",
+                                                        "past",
+                                                        "absoluteChange",
+                                                        "percentageChange"
+                                                    ],
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "selected": {
+                                            "description": "Selected item",
+                                            "type": "boolean"
+                                        },
+                                        "subtype": {
+                                            "anyOf": [
+                                                {
+                                                    "enum": [
+                                                        "coordinates",
+                                                        "currency",
+                                                        "date",
+                                                        "datetime",
+                                                        "duration",
+                                                        "hierarchy_element_expression",
+                                                        "ip_address",
+                                                        "topography"
+                                                    ],
+                                                    "type": "string"
+                                                },
+                                                {
+                                                    "type": "null"
+                                                }
+                                            ],
+                                            "description": "Column subtype"
+                                        },
+                                        "type": {
+                                            "description": "Column / Formula type",
+                                            "enum": [
+                                                "datetime",
+                                                "hierarchy",
+                                                "numeric",
+                                                "spatial"
+                                            ],
+                                            "type": "string"
+                                        },
+                                        "weekDayNameFormat": {
+                                            "description": "Week day name format for datetime column formatting",
+                                            "enum": [
+                                                "letter",
+                                                "long",
+                                                "short"
+                                            ],
+                                            "type": "string"
+                                        },
+                                        "weekStart": {
+                                            "description": "Week start day, 'sunday' or 'monday'. For datetime column formatting.",
+                                            "enum": [
+                                                "monday",
+                                                "sunday"
+                                            ],
+                                            "type": "string"
+                                        }
+                                    },
+                                    "type": "object"
+                                },
+                                "type": "array"
+                            }
+                        },
+                        "type": "object"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "limit": {
+            "description": "The maximum number of data rows to query and display",
+            "properties": {
+                "number": {
+                    "default": 100000,
+                    "description": "Number of observations value",
+                    "type": "number"
+                }
+            },
+            "type": "object"
+        },
+        "loader": {
+            "description": "The loader configuration",
+            "properties": {
+                "background": {
+                    "default": "#f9f9f9",
+                    "description": "Background color of the chart loader element",
+                    "type": "string"
+                },
+                "fontColor": {
+                    "default": "#5a5a5a",
+                    "description": "Font color of the text of the chart loaders",
+                    "type": "string"
+                },
+                "locale": {
+                    "default": "en",
+                    "description": "Locale to be used if \"msg\" is set",
+                    "examples": [
+                        "en",
+                        "fr"
+                    ],
+                    "type": "string"
+                },
+                "mode": {
+                    "default": "light",
+                    "description": "Light or dark loader",
+                    "type": "string"
+                },
+                "msg": {
+                    "description": "Loading message",
+                    "examples": [
+                        "Loading dashboard..."
+                    ],
+                    "type": "string"
+                },
+                "showBranded": {
+                    "default": false,
+                    "description": "Shows the branded \"powered by\" information",
+                    "type": "boolean"
+                },
+                "spinnerBackground": {
+                    "default": "rgba(169, 169, 169, 0.14)",
+                    "description": "Background color of the spinner",
+                    "type": "string"
+                },
+                "spinnerColor": {
+                    "default": "rgba(255, 165, 0, 0.7)",
+                    "description": "Spinner color of the loader",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "locale": {
+            "default": "en",
+            "description": "Locale to be used",
+            "examples": [
+                "en",
+                "fr"
+            ],
+            "type": "string"
+        },
+        "lookupFiltering": {
+            "default": false,
+            "description": "Allow interactive filtering of charts with linked datasets",
+            "type": "boolean"
+        },
+        "theme": {
+            "description": "Theme configuration",
+            "properties": {
+                "borders": {
+                    "description": "Custom border styling",
+                    "properties": {
+                        "border-bottom-width": {
+                            "description": "Border bottom width, it is visible when a border style and color are set",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-color": {
+                            "description": "Border color, it is visible when a border style and width are set",
+                            "examples": [
+                                "rgba(216, 216, 216, 1)",
+                                "rgb(147, 146, 148)"
+                            ],
+                            "type": "string"
+                        },
+                        "border-left-width": {
+                            "description": "Border left width, it is visible when a border style and color are set",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-radius": {
+                            "description": "Border radius",
+                            "examples": [
+                                "0",
+                                "12px",
+                                "20px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-right-width": {
+                            "description": "Border right width, it is visible when a border style and color are set",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-style": {
+                            "description": "Border style, it is visible when a border color and width are set",
+                            "examples": [
+                                "none",
+                                "solid",
+                                "dotted",
+                                "dashed"
+                            ],
+                            "type": "string"
+                        },
+                        "border-top-width": {
+                            "description": "Border top width, it is visible when a border style and color are set",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
+                "boxShadow": {
+                    "description": "Custom shadow styling",
+                    "properties": {
+                        "color": {
+                            "description": "Shadow color",
+                            "examples": [
+                                "rgb(0, 0, 0)",
+                                "rgb(100, 100, 103)"
+                            ],
+                            "type": "string"
+                        },
+                        "size": {
+                            "description": "Shadow size",
+                            "enum": [
+                                "L",
+                                "M",
+                                "S",
+                                "none"
+                            ],
+                            "examples": [
+                                "none",
+                                "S",
+                                "M",
+                                "L"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
+                "colors": {
+                    "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
+                    "examples": [
+                        [
+                            "red",
+                            "green",
+                            "blue",
+                            "yellow",
+                            "orange",
+                            "purple"
+                        ]
+                    ],
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "font": {
+                    "description": "Custom font styling",
+                    "properties": {
+                        "fontFamily": {
+                            "description": "Font family",
+                            "examples": [
+                                "Lato",
+                                "Montserrat",
+                                "Roboto Mono",
+                                "Arial",
+                                "Times New Roman"
+                            ],
+                            "type": "string"
+                        },
+                        "fontSize": {
+                            "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
+                            "examples": [
+                                10,
+                                15,
+                                18
+                            ],
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
+                "id": {
+                    "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
+                    "examples": [
+                        "seasonal",
+                        "urban"
+                    ],
+                    "type": "string"
+                },
+                "itemsBackground": {
+                    "description": "Custom item background color",
+                    "examples": [
+                        "rgb(255, 255, 255)",
+                        "rgb(71, 69, 69)",
+                        "rgb(195, 191, 191)"
+                    ],
+                    "type": "string"
+                },
+                "title": {
+                    "description": "Custom title styling, it's applied if the title is displayed",
+                    "properties": {
+                        "align": {
+                            "description": "Title align",
+                            "enum": [
+                                "center",
+                                "left",
+                                "right"
+                            ],
+                            "examples": [
+                                "left",
+                                "center",
+                                "right"
+                            ],
+                            "type": "string"
+                        },
+                        "bold": {
+                            "description": "Is title bold",
+                            "examples": [
+                                true,
+                                false
+                            ],
+                            "type": "boolean"
+                        },
+                        "border": {
+                            "description": "Is title a border",
+                            "examples": [
+                                true,
+                                false
+                            ],
+                            "type": "boolean"
+                        },
+                        "fontSize": {
+                            "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
+                            "examples": [
+                                16,
+                                20
+                            ],
+                            "type": "number"
+                        },
+                        "italic": {
+                            "description": "Is title italic",
+                            "examples": [
+                                true,
+                                false
+                            ],
+                            "type": "boolean"
+                        },
+                        "lineHeight": {
+                            "description": "Title's line height in px",
+                            "examples": [
+                                30,
+                                42,
+                                50
+                            ],
+                            "type": "number"
+                        },
+                        "underline": {
+                            "description": "Is title underline",
+                            "examples": [
+                                true,
+                                false
+                            ],
+                            "type": "boolean"
+                        }
+                    },
+                    "type": "object"
+                },
+                "tooltip": {
+                    "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
+                    "properties": {
+                        "background": {
+                            "description": "Tooltip's background",
+                            "examples": [
+                                "rgb(248, 248, 248)",
+                                "rgb(248, 248, 248)",
+                                "rgb(130, 128, 128)",
+                                "rgb(61, 61, 61)"
+                            ],
+                            "type": "string"
+                        },
+                        "fontSize": {
+                            "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
+                            "examples": [
+                                12,
+                                16,
+                                20
+                            ],
+                            "type": "number"
+                        },
+                        "opacity": {
+                            "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
+                            "examples": [
+                                0.5,
+                                0.8,
+                                1
+                            ],
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
+                "type": {
+                    "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
+                    "examples": [
+                        "custom"
+                    ],
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "timezoneId": {
+            "description": "The timezone that will be used in the dashboard. This timezone id needs to be a valid id that is available in the IANA timezone database",
+            "examples": [
+                "Europe/Brussels",
+                "America/New_York"
+            ],
+            "type": "string"
+        },
+        "title": {
+            "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
+            "examples": [
+                {
+                    "en": "Title"
+                }
+            ],
+            "type": "object"
+        }
+    },
+    "type": "object"
+}
+
+;
+
+export default _default;