@luzmo/dashboard-contents-types 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/README.md +154 -0
- package/assets/json-schemas/area-chart-options.schema.json.d.ts +75 -157
- package/assets/json-schemas/area-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/bar-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/bar-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/box-plot-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/box-plot-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/bubble-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/bubble-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/bullet-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/bullet-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/choropleth-map-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/choropleth-map-slots.schema.json.d.ts +13 -40
- package/assets/json-schemas/circular-gauge-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/circular-gauge-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/column-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/column-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/combination-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/combination-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/date-filter-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/date-filter-slots.schema.json.d.ts +4 -4
- package/assets/json-schemas/donut-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/donut-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/dropdown-filter-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/evolution-number-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/evolution-number-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/funnel-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/funnel-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/image-options.schema.json.d.ts +69 -0
- package/assets/json-schemas/line-chart-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/line-chart-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/options.schema.json.d.ts +3 -0
- package/assets/json-schemas/pivot-table-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/pivot-table-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/regular-table-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/regular-table-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/sankey-diagram-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/scatter-plot-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/scatter-plot-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/slicer-filter-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/slicer-filter-slots.schema.json.d.ts +13 -13
- package/assets/json-schemas/slider-filter-options.schema.json.d.ts +74 -5
- package/assets/json-schemas/slider-filter-slots.schema.json.d.ts +9 -9
- package/assets/json-schemas/slots.schema.json.d.ts +3 -0
- package/assets/json-schemas/text-options.schema.json.d.ts +69 -0
- package/index.js +220 -142
- package/index.mjs +2194 -701
- package/json-schemas.d.ts +1334 -123
- package/json-schemas.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/lib/area-chart/area-chart-options.d.ts +7 -4
- package/src/lib/area-chart/area-chart-options.d.ts.map +1 -1
- package/src/lib/date-filter/date-filter-options.d.ts +1 -2
- package/src/lib/date-filter/date-filter-options.d.ts.map +1 -1
- package/src/lib/dropdown-filter/dropdown-filter-options.d.ts +1 -2
- package/src/lib/dropdown-filter/dropdown-filter-options.d.ts.map +1 -1
- package/src/lib/shared/index.d.ts +1 -0
- package/src/lib/shared/index.d.ts.map +1 -1
- package/src/lib/shared/object-view-options.d.ts +2 -1
- package/src/lib/shared/object-view-options.d.ts.map +1 -1
- package/src/lib/shared/slots.d.ts +7 -6
- package/src/lib/shared/slots.d.ts.map +1 -1
- package/src/lib/shared/viz-item.d.ts +60 -0
- package/src/lib/shared/viz-item.d.ts.map +1 -0
- package/src/lib/slicer-filter/slicer-filter-options.d.ts +1 -1
- package/src/lib/slicer-filter/slicer-filter-options.d.ts.map +1 -1
- package/src/lib/slider-filter/slider-filter-options.d.ts +1 -1
- package/src/lib/slider-filter/slider-filter-options.d.ts.map +1 -1
- package/src/options.d.ts +1 -1
- package/src/options.d.ts.map +1 -1
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# Types and JSON schemas for Luzmo dashboard contents
|
|
2
|
+
|
|
3
|
+
This packages contains different dashboard contents' types and JSON schemas for Luzmo dashboard contents.
|
|
4
|
+
|
|
5
|
+
## Content Item Types
|
|
6
|
+
|
|
7
|
+
Here is the list of some types for content items. There are more types available in the package.
|
|
8
|
+
|
|
9
|
+
| Type | Description |
|
|
10
|
+
|--------------------------------|-------------------------------------------------------|
|
|
11
|
+
| `AreaChart` | An Area Chart type. |
|
|
12
|
+
| `AreaChartViewOptions` | An Area Chart options type. |
|
|
13
|
+
| `AreaChartSlots` | An Area Chart slots type. |
|
|
14
|
+
| `BarChart` | A Bar Chart type. |
|
|
15
|
+
| `BarChartViewOptions` | A Bar Chart options type. |
|
|
16
|
+
| `BarChartSlots` | A Bar Chart slots type. |
|
|
17
|
+
| `BoxPlot` | A Box Plot type. |
|
|
18
|
+
| `BoxPlotViewOptions` | A Box Plot options type. |
|
|
19
|
+
| `BoxPlotSlots` | A Box Plot slots type. |
|
|
20
|
+
| `BubbleChart` | A Bubble Chart type. |
|
|
21
|
+
| `BubbleChartViewOptions` | A Bubble Chart options type. |
|
|
22
|
+
| `BubbleChartSlots` | A Bubble Chart slots type. |
|
|
23
|
+
| `BulletChart` | A Bullet Chart type. |
|
|
24
|
+
| `BulletChartViewOptions` | A Bullet Chart options type. |
|
|
25
|
+
| `BulletChartSlots` | A Bullet Chart slots type. |
|
|
26
|
+
| `ChoroplethMap` | A Choropleth Map type. |
|
|
27
|
+
| `ChoroplethMapViewOptions` | A Choropleth Map options type. |
|
|
28
|
+
| `ChoroplethMapSlots` | A Choropleth Map slots type. |
|
|
29
|
+
| `CircularGauge` | A Circular Gauge type. |
|
|
30
|
+
| `CircularGaugeViewOptions` | A Circular Gauge options type. |
|
|
31
|
+
| `CircularGaugeSlots` | A Circular Gauge slots type. |
|
|
32
|
+
| `ColumnChart` | A Column Chart type. |
|
|
33
|
+
| `ColumnChartViewOptions` | A Column Chart options type. |
|
|
34
|
+
| `ColumnChartSlots` | A Column Chart slots type. |
|
|
35
|
+
| `CombinationChart` | A Combination Chart type. |
|
|
36
|
+
| `CombinationChartViewOptions` | A Combination Chart options type. |
|
|
37
|
+
| `CombinationChartSlots` | A Combination Chart slots type. |
|
|
38
|
+
| `ConditionalNumber` | A Conditional Number type. |
|
|
39
|
+
| `ConditionalNumberViewOptions` | A Conditional Number options type. |
|
|
40
|
+
| `ConditionalNumberSlots` | A Conditional Number slots type. |
|
|
41
|
+
| `DateFilter` | A Date Filter type. |
|
|
42
|
+
| `DateFilterViewOptions` | A Date Filter options type. |
|
|
43
|
+
| `DateFilterSlots` | A Date Filter slots type. |
|
|
44
|
+
| `DonutChart` | A Donut Chart type. |
|
|
45
|
+
| `DonutChartViewOptions` | A Donut Chart options type. |
|
|
46
|
+
| `DonutChartSlots` | A Donut Chart slots type. |
|
|
47
|
+
| `DropdownFilter` | A Dropdown Filter type. |
|
|
48
|
+
| `DropdownFilterViewOptions` | A Dropdown Filter options type. |
|
|
49
|
+
| `DropdownFilterSlots` | A Dropdown Filter slots type. |
|
|
50
|
+
| `EvolutionNumber` | An Evolution Number type. |
|
|
51
|
+
| `EvolutionNumberViewOptions` | An Evolution Number options type. |
|
|
52
|
+
| `EvolutionNumberSlots` | An Evolution Number slots type. |
|
|
53
|
+
| `FunnelChart` | A Funnel Chart type. |
|
|
54
|
+
| `FunnelChartViewOptions` | A Funnel Chart options type. |
|
|
55
|
+
| `FunnelChartSlots` | A Funnel Chart slots type. |
|
|
56
|
+
| `Image` | An Image type. |
|
|
57
|
+
| `ImageViewOptions` | An Image options type. |
|
|
58
|
+
| `LineChart` | A Line Chart type. |
|
|
59
|
+
| `LineChartViewOptions` | A Line Chart options type. |
|
|
60
|
+
| `LineChartSlots` | A Line Chart slots type. |
|
|
61
|
+
| `PivotTable` | A Pivot Table type. |
|
|
62
|
+
| `PivotTableViewOptions` | A Pivot Table options type. |
|
|
63
|
+
| `PivotTableSlots` | A Pivot Table slots type. |
|
|
64
|
+
| `RegularTable` | A Regular Table type. |
|
|
65
|
+
| `RegularTableViewOptions` | A Regular Table options type. |
|
|
66
|
+
| `RegularTableSlots` | A Regular Table slots type. |
|
|
67
|
+
| `SankeyDiagram` | A ScatterPlot type. |
|
|
68
|
+
| `SankeyDiagramViewOptions` | A Sankey Diagram options type. |
|
|
69
|
+
| `SankeyDiagramSlots` | A Sankey Diagram slots type. |
|
|
70
|
+
| `ScatterPlot` | A Scatter Plot type. |
|
|
71
|
+
| `ScatterPlotViewOptions` | A Scatter Plot options type. |
|
|
72
|
+
| `ScatterPlotSlots` | A Scatter Plot slots type. |
|
|
73
|
+
| `SlicerFilter` | A Slicer Filter type. |
|
|
74
|
+
| `SlicerFilterViewOptions` | A Slicer Filter options type. |
|
|
75
|
+
| `SlicerFilterSlots` | A Slicer Filter slots type. |
|
|
76
|
+
| `SliderFilter` | A Slider Filter type. |
|
|
77
|
+
| `SliderFilterViewOptions` | A Slider Filter options type. |
|
|
78
|
+
| `SliderFilterSlots` | A Slider Filter slots type. |
|
|
79
|
+
| `Text` | A Text type. |
|
|
80
|
+
| `TextViewOptions` | A Text options type. |
|
|
81
|
+
| `VizItemType` | A union type for content item types. |
|
|
82
|
+
| `Options` | A union type for all the options from all the charts. |
|
|
83
|
+
| `Slots` | A union type for all the slots from all the charts. |
|
|
84
|
+
|
|
85
|
+
## JSON Schemas
|
|
86
|
+
|
|
87
|
+
The library also provides JSON schemas for the content items. The schemas are provided as an object with the schema name as the key and the schema as the value.
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';
|
|
91
|
+
|
|
92
|
+
console.log(JSON_SCHEMAS);
|
|
93
|
+
console.log(JSON_SCHEMAS['text-options.schema.json']);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
The JSON schemas are not dereferenced. You can use a library like [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser) to dereference the schemas. `json-schema-ref-parser` is a Node library so to use it in a browser environment you should add a [configuration](https://github.com/APIDevTools/json-schema-ref-parser?tab=readme-ov-file#browser-support) for that.
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import * as refParser from '@apidevtools/json-schema-ref-parser';
|
|
100
|
+
import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';
|
|
101
|
+
|
|
102
|
+
const refParserResolver = {
|
|
103
|
+
order: 101,
|
|
104
|
+
canRead: /^https:\/\/developer\.luzmo\.com/,
|
|
105
|
+
read: (file, callback) => {
|
|
106
|
+
const name = file.url.split('/').pop();
|
|
107
|
+
const schema = JSON_SCHEMAS[name];
|
|
108
|
+
|
|
109
|
+
if (schema) {
|
|
110
|
+
callback(null, JSON.stringify(schema));
|
|
111
|
+
} else {
|
|
112
|
+
callback(new Error('Schema not found'));
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
const refParserOptions = {
|
|
118
|
+
mutateInputSchema: false,
|
|
119
|
+
resolve: {
|
|
120
|
+
http: refParserResolver,
|
|
121
|
+
external: true
|
|
122
|
+
}
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
refParser.dereference(JSON_SCHEMAS['area-chart-slots.schema.json'], refParserOptions)
|
|
126
|
+
.then((dereferencedSchema) => {
|
|
127
|
+
console.log(dereferencedSchema);
|
|
128
|
+
})
|
|
129
|
+
.catch((err) => {
|
|
130
|
+
console.error(err);
|
|
131
|
+
});
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
To validate a content item against a schema, you can use a library like [ajv](https://github.com/ajv-validator/ajv).
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import Ajv from "ajv";
|
|
138
|
+
import ajvAddFormats from 'ajv-formats';
|
|
139
|
+
import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';
|
|
140
|
+
|
|
141
|
+
const ajv = new Ajv({
|
|
142
|
+
schemas: Object.keys(JSON_SCHEMAS).map(key => JSON_SCHEMAS[key]),
|
|
143
|
+
allowUnionTypes: true,
|
|
144
|
+
strictTuples: false
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
ajvAddFormats(ajv);
|
|
148
|
+
|
|
149
|
+
const schemaId = 'https://developer.luzmo.com/assets/json-schemas/0.1.89/text-options.schema.json';
|
|
150
|
+
const validate = ajv.getSchema(schemaId);
|
|
151
|
+
const isValid = validate('VALUE TO VALIDATE');
|
|
152
|
+
|
|
153
|
+
console.log(isValid);
|
|
154
|
+
```
|
|
@@ -39,7 +39,7 @@ declare const _default: {
|
|
|
39
39
|
"type": "object"
|
|
40
40
|
},
|
|
41
41
|
"y": {
|
|
42
|
-
"description": "
|
|
42
|
+
"description": "Y-axis options",
|
|
43
43
|
"properties": {
|
|
44
44
|
"color": {
|
|
45
45
|
"description": "Y-axis color",
|
|
@@ -118,107 +118,6 @@ declare const _default: {
|
|
|
118
118
|
}
|
|
119
119
|
},
|
|
120
120
|
"type": "object"
|
|
121
|
-
},
|
|
122
|
-
"y2": {
|
|
123
|
-
"description": "Y2-axis options",
|
|
124
|
-
"properties": {
|
|
125
|
-
"active": {
|
|
126
|
-
"default": false,
|
|
127
|
-
"description": "Toggle whether the Y2-axis is active",
|
|
128
|
-
"type": "boolean"
|
|
129
|
-
},
|
|
130
|
-
"color": {
|
|
131
|
-
"description": "Y2-axis color",
|
|
132
|
-
"examples": [
|
|
133
|
-
"#000000",
|
|
134
|
-
"black",
|
|
135
|
-
"rgba(0,0,0,1)"
|
|
136
|
-
],
|
|
137
|
-
"type": "string"
|
|
138
|
-
},
|
|
139
|
-
"manualAxesRange": {
|
|
140
|
-
"description": "Set manual axes range",
|
|
141
|
-
"examples": [
|
|
142
|
-
[
|
|
143
|
-
0,
|
|
144
|
-
100
|
|
145
|
-
]
|
|
146
|
-
],
|
|
147
|
-
"items": [
|
|
148
|
-
{
|
|
149
|
-
"type": "number"
|
|
150
|
-
},
|
|
151
|
-
{
|
|
152
|
-
"type": "number"
|
|
153
|
-
}
|
|
154
|
-
],
|
|
155
|
-
"maxItems": 2,
|
|
156
|
-
"minItems": 2,
|
|
157
|
-
"type": "array"
|
|
158
|
-
},
|
|
159
|
-
"measureIndexes": {
|
|
160
|
-
"default": [
|
|
161
|
-
1
|
|
162
|
-
],
|
|
163
|
-
"description": "Array of measure indexes to be displayed on the Y2-axis",
|
|
164
|
-
"examples": [
|
|
165
|
-
[
|
|
166
|
-
1,
|
|
167
|
-
2
|
|
168
|
-
]
|
|
169
|
-
],
|
|
170
|
-
"items": {
|
|
171
|
-
"type": "number"
|
|
172
|
-
},
|
|
173
|
-
"type": "array"
|
|
174
|
-
},
|
|
175
|
-
"scale": {
|
|
176
|
-
"description": "Y-axis scale type: linear or logarithmic",
|
|
177
|
-
"enum": [
|
|
178
|
-
"linear",
|
|
179
|
-
"logarithmic"
|
|
180
|
-
],
|
|
181
|
-
"type": "string"
|
|
182
|
-
},
|
|
183
|
-
"scaleLogBase": {
|
|
184
|
-
"description": "Base of the logarithmic scale. Only applies if the scale is logarithmic.",
|
|
185
|
-
"examples": [
|
|
186
|
-
2,
|
|
187
|
-
10
|
|
188
|
-
],
|
|
189
|
-
"type": "number"
|
|
190
|
-
},
|
|
191
|
-
"ticksDensity": {
|
|
192
|
-
"description": "Density of the ticks on the Y2-axis",
|
|
193
|
-
"enum": [
|
|
194
|
-
"compact",
|
|
195
|
-
"normal",
|
|
196
|
-
"sparse"
|
|
197
|
-
],
|
|
198
|
-
"type": "string"
|
|
199
|
-
},
|
|
200
|
-
"ticksMode": {
|
|
201
|
-
"default": "ticks",
|
|
202
|
-
"description": "Ticks mode of the Y2-axis: hide, ticks, or gridlines",
|
|
203
|
-
"enum": [
|
|
204
|
-
"gridlines",
|
|
205
|
-
"hide",
|
|
206
|
-
"ticks"
|
|
207
|
-
],
|
|
208
|
-
"type": "string"
|
|
209
|
-
},
|
|
210
|
-
"type": {
|
|
211
|
-
"default": "default",
|
|
212
|
-
"description": "Y-axis type: default, manual or variable",
|
|
213
|
-
"enum": [
|
|
214
|
-
"default",
|
|
215
|
-
"manual",
|
|
216
|
-
"variable"
|
|
217
|
-
],
|
|
218
|
-
"type": "string"
|
|
219
|
-
}
|
|
220
|
-
},
|
|
221
|
-
"type": "object"
|
|
222
121
|
}
|
|
223
122
|
},
|
|
224
123
|
"type": "object"
|
|
@@ -267,27 +166,6 @@ declare const _default: {
|
|
|
267
166
|
}
|
|
268
167
|
},
|
|
269
168
|
"type": "object"
|
|
270
|
-
},
|
|
271
|
-
"y2": {
|
|
272
|
-
"description": "Another Y-axis label options",
|
|
273
|
-
"properties": {
|
|
274
|
-
"enabled": {
|
|
275
|
-
"default": false,
|
|
276
|
-
"description": "Show or hide the Y2-axis labels",
|
|
277
|
-
"type": "boolean"
|
|
278
|
-
},
|
|
279
|
-
"position": {
|
|
280
|
-
"default": "middle",
|
|
281
|
-
"description": "Position of the Y2-axis labels",
|
|
282
|
-
"enum": [
|
|
283
|
-
"bottom",
|
|
284
|
-
"middle",
|
|
285
|
-
"top"
|
|
286
|
-
],
|
|
287
|
-
"type": "string"
|
|
288
|
-
}
|
|
289
|
-
},
|
|
290
|
-
"type": "object"
|
|
291
169
|
}
|
|
292
170
|
},
|
|
293
171
|
"type": "object"
|
|
@@ -383,35 +261,6 @@ declare const _default: {
|
|
|
383
261
|
}
|
|
384
262
|
},
|
|
385
263
|
"type": "object"
|
|
386
|
-
},
|
|
387
|
-
"y2": {
|
|
388
|
-
"description": "Y-axis grid options",
|
|
389
|
-
"properties": {
|
|
390
|
-
"enabled": {
|
|
391
|
-
"default": false,
|
|
392
|
-
"description": "Show or hide the Y2-axis grid",
|
|
393
|
-
"type": "boolean"
|
|
394
|
-
},
|
|
395
|
-
"opacity": {
|
|
396
|
-
"description": "Opacity of the Y2-axis grid",
|
|
397
|
-
"examples": [
|
|
398
|
-
1,
|
|
399
|
-
0.5,
|
|
400
|
-
0.1
|
|
401
|
-
],
|
|
402
|
-
"type": "number"
|
|
403
|
-
},
|
|
404
|
-
"style": {
|
|
405
|
-
"description": "Style of the Y2-axis grid",
|
|
406
|
-
"enum": [
|
|
407
|
-
"dashed",
|
|
408
|
-
"dotted",
|
|
409
|
-
"solid"
|
|
410
|
-
],
|
|
411
|
-
"type": "string"
|
|
412
|
-
}
|
|
413
|
-
},
|
|
414
|
-
"type": "object"
|
|
415
264
|
}
|
|
416
265
|
},
|
|
417
266
|
"type": "object"
|
|
@@ -1142,7 +991,7 @@ declare const _default: {
|
|
|
1142
991
|
"type": "string"
|
|
1143
992
|
},
|
|
1144
993
|
"formula": {
|
|
1145
|
-
"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.",
|
|
994
|
+
"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",
|
|
1146
995
|
"type": "string"
|
|
1147
996
|
},
|
|
1148
997
|
"grandTotals": {
|
|
@@ -1189,18 +1038,18 @@ declare const _default: {
|
|
|
1189
1038
|
"type": "string"
|
|
1190
1039
|
},
|
|
1191
1040
|
"periodOverPeriod": {
|
|
1192
|
-
"description": "Settings to configure period over period comparison",
|
|
1041
|
+
"description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
|
|
1193
1042
|
"properties": {
|
|
1194
1043
|
"level": {
|
|
1195
|
-
"description": "
|
|
1044
|
+
"description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
|
|
1196
1045
|
"type": "number"
|
|
1197
1046
|
},
|
|
1198
1047
|
"periodToDate": {
|
|
1199
|
-
"description": "period to date comparison",
|
|
1048
|
+
"description": "Turn ON/OFF period to date comparison",
|
|
1200
1049
|
"type": "boolean"
|
|
1201
1050
|
},
|
|
1202
1051
|
"quantity": {
|
|
1203
|
-
"description": "
|
|
1052
|
+
"description": "Number of periods",
|
|
1204
1053
|
"type": "number"
|
|
1205
1054
|
},
|
|
1206
1055
|
"type": {
|
|
@@ -1364,6 +1213,67 @@ declare const _default: {
|
|
|
1364
1213
|
},
|
|
1365
1214
|
"type": "object"
|
|
1366
1215
|
},
|
|
1216
|
+
"loader": {
|
|
1217
|
+
"description": "The loader configuration",
|
|
1218
|
+
"properties": {
|
|
1219
|
+
"background": {
|
|
1220
|
+
"default": "#f9f9f9",
|
|
1221
|
+
"description": "Background color of the chart loader element",
|
|
1222
|
+
"type": "string"
|
|
1223
|
+
},
|
|
1224
|
+
"fontColor": {
|
|
1225
|
+
"default": "#5a5a5a",
|
|
1226
|
+
"description": "Font color of the text of the chart loaders",
|
|
1227
|
+
"type": "string"
|
|
1228
|
+
},
|
|
1229
|
+
"locale": {
|
|
1230
|
+
"default": "en",
|
|
1231
|
+
"description": "Locale to be used if \"msg\" is set",
|
|
1232
|
+
"examples": [
|
|
1233
|
+
"en",
|
|
1234
|
+
"fr"
|
|
1235
|
+
],
|
|
1236
|
+
"type": "string"
|
|
1237
|
+
},
|
|
1238
|
+
"mode": {
|
|
1239
|
+
"default": "light",
|
|
1240
|
+
"description": "Light or dark loader",
|
|
1241
|
+
"type": "string"
|
|
1242
|
+
},
|
|
1243
|
+
"msg": {
|
|
1244
|
+
"description": "Loading message",
|
|
1245
|
+
"examples": [
|
|
1246
|
+
"Loading dashboard..."
|
|
1247
|
+
],
|
|
1248
|
+
"type": "string"
|
|
1249
|
+
},
|
|
1250
|
+
"showBranded": {
|
|
1251
|
+
"default": false,
|
|
1252
|
+
"description": "Shows the branded \"powered by\" information",
|
|
1253
|
+
"type": "boolean"
|
|
1254
|
+
},
|
|
1255
|
+
"spinnerBackground": {
|
|
1256
|
+
"default": "rgba(169, 169, 169, 0.14)",
|
|
1257
|
+
"description": "Background color of the spinner",
|
|
1258
|
+
"type": "string"
|
|
1259
|
+
},
|
|
1260
|
+
"spinnerColor": {
|
|
1261
|
+
"default": "rgba(255, 165, 0, 0.7)",
|
|
1262
|
+
"description": "Spinner color of the loader",
|
|
1263
|
+
"type": "string"
|
|
1264
|
+
}
|
|
1265
|
+
},
|
|
1266
|
+
"type": "object"
|
|
1267
|
+
},
|
|
1268
|
+
"locale": {
|
|
1269
|
+
"default": "en",
|
|
1270
|
+
"description": "Locale to be used",
|
|
1271
|
+
"examples": [
|
|
1272
|
+
"en",
|
|
1273
|
+
"fr"
|
|
1274
|
+
],
|
|
1275
|
+
"type": "string"
|
|
1276
|
+
},
|
|
1367
1277
|
"missingValue": {
|
|
1368
1278
|
"description": "Missing value configuration",
|
|
1369
1279
|
"properties": {
|
|
@@ -1863,6 +1773,14 @@ declare const _default: {
|
|
|
1863
1773
|
},
|
|
1864
1774
|
"type": "object"
|
|
1865
1775
|
},
|
|
1776
|
+
"timezoneId": {
|
|
1777
|
+
"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",
|
|
1778
|
+
"examples": [
|
|
1779
|
+
"Europe/Brussels",
|
|
1780
|
+
"America/New_York"
|
|
1781
|
+
],
|
|
1782
|
+
"type": "string"
|
|
1783
|
+
},
|
|
1866
1784
|
"title": {
|
|
1867
1785
|
"description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
|
|
1868
1786
|
"examples": [
|
|
@@ -98,18 +98,18 @@ declare const _default: {
|
|
|
98
98
|
"type": "string"
|
|
99
99
|
},
|
|
100
100
|
"periodOverPeriod": {
|
|
101
|
-
"description": "Settings to configure period over period comparison",
|
|
101
|
+
"description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
|
|
102
102
|
"properties": {
|
|
103
103
|
"level": {
|
|
104
|
-
"description": "
|
|
104
|
+
"description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
|
|
105
105
|
"type": "number"
|
|
106
106
|
},
|
|
107
107
|
"periodToDate": {
|
|
108
|
-
"description": "period to date comparison",
|
|
108
|
+
"description": "Turn ON/OFF period to date comparison",
|
|
109
109
|
"type": "boolean"
|
|
110
110
|
},
|
|
111
111
|
"quantity": {
|
|
112
|
-
"description": "
|
|
112
|
+
"description": "Number of periods",
|
|
113
113
|
"type": "number"
|
|
114
114
|
},
|
|
115
115
|
"type": {
|
|
@@ -212,18 +212,18 @@ declare const _default: {
|
|
|
212
212
|
]
|
|
213
213
|
},
|
|
214
214
|
"periodOverPeriod": {
|
|
215
|
-
"description": "Settings to configure period over period comparison",
|
|
215
|
+
"description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
|
|
216
216
|
"properties": {
|
|
217
217
|
"level": {
|
|
218
|
-
"description": "
|
|
218
|
+
"description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
|
|
219
219
|
"type": "number"
|
|
220
220
|
},
|
|
221
221
|
"periodToDate": {
|
|
222
|
-
"description": "period to date comparison",
|
|
222
|
+
"description": "Turn ON/OFF period to date comparison",
|
|
223
223
|
"type": "boolean"
|
|
224
224
|
},
|
|
225
225
|
"quantity": {
|
|
226
|
-
"description": "
|
|
226
|
+
"description": "Number of periods",
|
|
227
227
|
"type": "number"
|
|
228
228
|
},
|
|
229
229
|
"type": {
|
|
@@ -428,7 +428,7 @@ declare const _default: {
|
|
|
428
428
|
"type": "string"
|
|
429
429
|
},
|
|
430
430
|
"formula": {
|
|
431
|
-
"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.",
|
|
431
|
+
"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",
|
|
432
432
|
"type": "string"
|
|
433
433
|
},
|
|
434
434
|
"grandTotals": {
|
|
@@ -445,18 +445,18 @@ declare const _default: {
|
|
|
445
445
|
"type": "object"
|
|
446
446
|
},
|
|
447
447
|
"periodOverPeriod": {
|
|
448
|
-
"description": "Settings to configure period over period comparison",
|
|
448
|
+
"description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
|
|
449
449
|
"properties": {
|
|
450
450
|
"level": {
|
|
451
|
-
"description": "
|
|
451
|
+
"description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
|
|
452
452
|
"type": "number"
|
|
453
453
|
},
|
|
454
454
|
"periodToDate": {
|
|
455
|
-
"description": "period to date comparison",
|
|
455
|
+
"description": "Turn ON/OFF period to date comparison",
|
|
456
456
|
"type": "boolean"
|
|
457
457
|
},
|
|
458
458
|
"quantity": {
|
|
459
|
-
"description": "
|
|
459
|
+
"description": "Number of periods",
|
|
460
460
|
"type": "number"
|
|
461
461
|
},
|
|
462
462
|
"type": {
|
|
@@ -3051,7 +3051,7 @@ declare const _default: {
|
|
|
3051
3051
|
"type": "string"
|
|
3052
3052
|
},
|
|
3053
3053
|
"formula": {
|
|
3054
|
-
"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.",
|
|
3054
|
+
"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",
|
|
3055
3055
|
"type": "string"
|
|
3056
3056
|
},
|
|
3057
3057
|
"grandTotals": {
|
|
@@ -3098,18 +3098,18 @@ declare const _default: {
|
|
|
3098
3098
|
"type": "string"
|
|
3099
3099
|
},
|
|
3100
3100
|
"periodOverPeriod": {
|
|
3101
|
-
"description": "Settings to configure period over period comparison",
|
|
3101
|
+
"description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
|
|
3102
3102
|
"properties": {
|
|
3103
3103
|
"level": {
|
|
3104
|
-
"description": "
|
|
3104
|
+
"description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
|
|
3105
3105
|
"type": "number"
|
|
3106
3106
|
},
|
|
3107
3107
|
"periodToDate": {
|
|
3108
|
-
"description": "period to date comparison",
|
|
3108
|
+
"description": "Turn ON/OFF period to date comparison",
|
|
3109
3109
|
"type": "boolean"
|
|
3110
3110
|
},
|
|
3111
3111
|
"quantity": {
|
|
3112
|
-
"description": "
|
|
3112
|
+
"description": "Number of periods",
|
|
3113
3113
|
"type": "number"
|
|
3114
3114
|
},
|
|
3115
3115
|
"type": {
|
|
@@ -3267,6 +3267,67 @@ declare const _default: {
|
|
|
3267
3267
|
},
|
|
3268
3268
|
"type": "object"
|
|
3269
3269
|
},
|
|
3270
|
+
"loader": {
|
|
3271
|
+
"description": "The loader configuration",
|
|
3272
|
+
"properties": {
|
|
3273
|
+
"background": {
|
|
3274
|
+
"default": "#f9f9f9",
|
|
3275
|
+
"description": "Background color of the chart loader element",
|
|
3276
|
+
"type": "string"
|
|
3277
|
+
},
|
|
3278
|
+
"fontColor": {
|
|
3279
|
+
"default": "#5a5a5a",
|
|
3280
|
+
"description": "Font color of the text of the chart loaders",
|
|
3281
|
+
"type": "string"
|
|
3282
|
+
},
|
|
3283
|
+
"locale": {
|
|
3284
|
+
"default": "en",
|
|
3285
|
+
"description": "Locale to be used if \"msg\" is set",
|
|
3286
|
+
"examples": [
|
|
3287
|
+
"en",
|
|
3288
|
+
"fr"
|
|
3289
|
+
],
|
|
3290
|
+
"type": "string"
|
|
3291
|
+
},
|
|
3292
|
+
"mode": {
|
|
3293
|
+
"default": "light",
|
|
3294
|
+
"description": "Light or dark loader",
|
|
3295
|
+
"type": "string"
|
|
3296
|
+
},
|
|
3297
|
+
"msg": {
|
|
3298
|
+
"description": "Loading message",
|
|
3299
|
+
"examples": [
|
|
3300
|
+
"Loading dashboard..."
|
|
3301
|
+
],
|
|
3302
|
+
"type": "string"
|
|
3303
|
+
},
|
|
3304
|
+
"showBranded": {
|
|
3305
|
+
"default": false,
|
|
3306
|
+
"description": "Shows the branded \"powered by\" information",
|
|
3307
|
+
"type": "boolean"
|
|
3308
|
+
},
|
|
3309
|
+
"spinnerBackground": {
|
|
3310
|
+
"default": "rgba(169, 169, 169, 0.14)",
|
|
3311
|
+
"description": "Background color of the spinner",
|
|
3312
|
+
"type": "string"
|
|
3313
|
+
},
|
|
3314
|
+
"spinnerColor": {
|
|
3315
|
+
"default": "rgba(255, 165, 0, 0.7)",
|
|
3316
|
+
"description": "Spinner color of the loader",
|
|
3317
|
+
"type": "string"
|
|
3318
|
+
}
|
|
3319
|
+
},
|
|
3320
|
+
"type": "object"
|
|
3321
|
+
},
|
|
3322
|
+
"locale": {
|
|
3323
|
+
"default": "en",
|
|
3324
|
+
"description": "Locale to be used",
|
|
3325
|
+
"examples": [
|
|
3326
|
+
"en",
|
|
3327
|
+
"fr"
|
|
3328
|
+
],
|
|
3329
|
+
"type": "string"
|
|
3330
|
+
},
|
|
3270
3331
|
"manualAxesRange": {
|
|
3271
3332
|
"description": "Manual axis range options. Minimum and maximum value of the axis range.",
|
|
3272
3333
|
"items": [
|
|
@@ -3856,6 +3917,14 @@ declare const _default: {
|
|
|
3856
3917
|
},
|
|
3857
3918
|
"type": "object"
|
|
3858
3919
|
},
|
|
3920
|
+
"timezoneId": {
|
|
3921
|
+
"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",
|
|
3922
|
+
"examples": [
|
|
3923
|
+
"Europe/Brussels",
|
|
3924
|
+
"America/New_York"
|
|
3925
|
+
],
|
|
3926
|
+
"type": "string"
|
|
3927
|
+
},
|
|
3859
3928
|
"title": {
|
|
3860
3929
|
"description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
|
|
3861
3930
|
"examples": [
|