@luzmo/dashboard-contents-types 0.1.88-beta.7 → 0.1.89

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.
Files changed (207) hide show
  1. package/README.md +154 -0
  2. package/assets/json-schemas/area-chart-options.schema.json.d.ts +32 -5
  3. package/assets/json-schemas/area-chart-slots.schema.json.d.ts +14 -14
  4. package/assets/json-schemas/area-chart.schema.json.d.ts +3 -3
  5. package/assets/json-schemas/bar-chart-options.schema.json.d.ts +32 -11
  6. package/assets/json-schemas/bar-chart-slots.schema.json.d.ts +14 -14
  7. package/assets/json-schemas/bar-chart.schema.json.d.ts +3 -3
  8. package/assets/json-schemas/box-plot-options.schema.json.d.ts +27 -6
  9. package/assets/json-schemas/box-plot-slots.schema.json.d.ts +8 -8
  10. package/assets/json-schemas/box-plot.schema.json.d.ts +3 -3
  11. package/assets/json-schemas/bubble-chart-options.schema.json.d.ts +27 -6
  12. package/assets/json-schemas/bubble-chart-slots.schema.json.d.ts +14 -14
  13. package/assets/json-schemas/bubble-chart.schema.json.d.ts +3 -3
  14. package/assets/json-schemas/bullet-chart-options.schema.json.d.ts +37 -6
  15. package/assets/json-schemas/bullet-chart-slots.schema.json.d.ts +14 -14
  16. package/assets/json-schemas/bullet-chart.schema.json.d.ts +3 -3
  17. package/assets/json-schemas/choropleth-map-options.schema.json.d.ts +37 -10
  18. package/assets/json-schemas/choropleth-map-slots.schema.json.d.ts +11 -11
  19. package/assets/json-schemas/choropleth-map.schema.json.d.ts +3 -3
  20. package/assets/json-schemas/circular-gauge-options.schema.json.d.ts +30 -9
  21. package/assets/json-schemas/circular-gauge-slots.schema.json.d.ts +10 -10
  22. package/assets/json-schemas/circular-gauge.schema.json.d.ts +3 -3
  23. package/assets/json-schemas/column-chart-options.schema.json.d.ts +32 -11
  24. package/assets/json-schemas/column-chart-slots.schema.json.d.ts +14 -14
  25. package/assets/json-schemas/column-chart.schema.json.d.ts +3 -3
  26. package/assets/json-schemas/combination-chart-options.schema.json.d.ts +34 -7
  27. package/assets/json-schemas/combination-chart-slots.schema.json.d.ts +10 -10
  28. package/assets/json-schemas/combination-chart.schema.json.d.ts +3 -3
  29. package/assets/json-schemas/date-filter-options.schema.json.d.ts +13 -3
  30. package/assets/json-schemas/date-filter-slots.schema.json.d.ts +3 -3
  31. package/assets/json-schemas/date-filter.schema.json.d.ts +3 -3
  32. package/assets/json-schemas/donut-chart-options.schema.json.d.ts +28 -7
  33. package/assets/json-schemas/donut-chart-slots.schema.json.d.ts +10 -10
  34. package/assets/json-schemas/donut-chart.schema.json.d.ts +3 -3
  35. package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts +13 -3
  36. package/assets/json-schemas/dropdown-filter-slots.schema.json.d.ts +6 -6
  37. package/assets/json-schemas/dropdown-filter.schema.json.d.ts +3 -3
  38. package/assets/json-schemas/evolution-number-options.schema.json.d.ts +51 -28
  39. package/assets/json-schemas/evolution-number-slots.schema.json.d.ts +8 -8
  40. package/assets/json-schemas/evolution-number.schema.json.d.ts +3 -3
  41. package/assets/json-schemas/funnel-chart-options.schema.json.d.ts +28 -7
  42. package/assets/json-schemas/funnel-chart-slots.schema.json.d.ts +9 -9
  43. package/assets/json-schemas/funnel-chart.schema.json.d.ts +3 -3
  44. package/assets/json-schemas/image-options.schema.json.d.ts +7 -3
  45. package/assets/json-schemas/image.schema.json.d.ts +2 -2
  46. package/assets/json-schemas/line-chart-options.schema.json.d.ts +29 -6
  47. package/assets/json-schemas/line-chart-slots.schema.json.d.ts +14 -14
  48. package/assets/json-schemas/line-chart.schema.json.d.ts +3 -3
  49. package/assets/json-schemas/options.schema.json.d.ts +24 -24
  50. package/assets/json-schemas/pivot-table-options.schema.json.d.ts +37 -12
  51. package/assets/json-schemas/pivot-table-slots.schema.json.d.ts +14 -14
  52. package/assets/json-schemas/pivot-table.schema.json.d.ts +3 -3
  53. package/assets/json-schemas/regular-table-options.schema.json.d.ts +33 -8
  54. package/assets/json-schemas/regular-table-slots.schema.json.d.ts +6 -6
  55. package/assets/json-schemas/regular-table.schema.json.d.ts +3 -3
  56. package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts +32 -8
  57. package/assets/json-schemas/sankey-diagram-slots.schema.json.d.ts +18 -18
  58. package/assets/json-schemas/sankey-diagram.schema.json.d.ts +3 -3
  59. package/assets/json-schemas/scatter-plot-options.schema.json.d.ts +39 -6
  60. package/assets/json-schemas/scatter-plot-slots.schema.json.d.ts +22 -22
  61. package/assets/json-schemas/scatter-plot.schema.json.d.ts +3 -3
  62. package/assets/json-schemas/slicer-filter-options.schema.json.d.ts +18 -8
  63. package/assets/json-schemas/slicer-filter-slots.schema.json.d.ts +10 -10
  64. package/assets/json-schemas/slicer-filter.schema.json.d.ts +3 -3
  65. package/assets/json-schemas/slider-filter-options.schema.json.d.ts +13 -3
  66. package/assets/json-schemas/slider-filter-slots.schema.json.d.ts +5 -5
  67. package/assets/json-schemas/slider-filter.schema.json.d.ts +3 -3
  68. package/assets/json-schemas/slots.schema.json.d.ts +22 -22
  69. package/assets/json-schemas/text-options.schema.json.d.ts +7 -3
  70. package/assets/json-schemas/text.schema.json.d.ts +2 -2
  71. package/assets/json-schemas/viz-item-type.schema.json.d.ts +1 -1
  72. package/index.d.ts +1 -0
  73. package/index.js +71 -71
  74. package/index.mjs +1038 -578
  75. package/json-schemas.d.ts +278 -122
  76. package/json-schemas.d.ts.map +1 -1
  77. package/package.json +1 -1
  78. package/src/index.d.ts +1 -0
  79. package/src/lib/area-chart/area-chart-options.d.ts +18 -16
  80. package/src/lib/area-chart/area-chart-slots.d.ts +2 -0
  81. package/src/lib/area-chart/area-chart.d.ts +4 -2
  82. package/src/lib/area-chart/index.d.ts +1 -0
  83. package/src/lib/bar-chart/bar-chart-options.d.ts +23 -21
  84. package/src/lib/bar-chart/bar-chart.d.ts +4 -2
  85. package/src/lib/bar-chart/bar-chart.slots.d.ts +2 -0
  86. package/src/lib/bar-chart/index.d.ts +1 -0
  87. package/src/lib/box-plot/box-plot-options.d.ts +17 -15
  88. package/src/lib/box-plot/box-plot-slots.d.ts +2 -0
  89. package/src/lib/box-plot/box-plot.d.ts +4 -2
  90. package/src/lib/box-plot/index.d.ts +1 -0
  91. package/src/lib/bubble-chart/bubble-chart-options.d.ts +16 -14
  92. package/src/lib/bubble-chart/bubble-chart-slots.d.ts +2 -0
  93. package/src/lib/bubble-chart/bubble-chart.d.ts +4 -2
  94. package/src/lib/bubble-chart/index.d.ts +1 -0
  95. package/src/lib/bullet-chart/bullet-chart-options.d.ts +17 -15
  96. package/src/lib/bullet-chart/bullet-chart-slots.d.ts +2 -0
  97. package/src/lib/bullet-chart/bullet-chart.d.ts +4 -2
  98. package/src/lib/bullet-chart/index.d.ts +1 -0
  99. package/src/lib/choropleth-map/choropleth-map-options.d.ts +22 -20
  100. package/src/lib/choropleth-map/choropleth-map-slots.d.ts +2 -0
  101. package/src/lib/choropleth-map/choropleth-map.d.ts +4 -2
  102. package/src/lib/choropleth-map/index.d.ts +1 -0
  103. package/src/lib/circular-gauge/circular-gauge-options.d.ts +15 -13
  104. package/src/lib/circular-gauge/circular-gauge-slots.d.ts +2 -0
  105. package/src/lib/circular-gauge/circular-gauge.d.ts +4 -2
  106. package/src/lib/circular-gauge/index.d.ts +1 -0
  107. package/src/lib/column-chart/column-chart-options.d.ts +23 -21
  108. package/src/lib/column-chart/column-chart-slots.d.ts +2 -0
  109. package/src/lib/column-chart/column-chart.d.ts +4 -2
  110. package/src/lib/column-chart/index.d.ts +1 -0
  111. package/src/lib/combination-chart/combination-chart-options.d.ts +19 -17
  112. package/src/lib/combination-chart/combination-chart-slots.d.ts +2 -0
  113. package/src/lib/combination-chart/combination-chart.d.ts +4 -2
  114. package/src/lib/combination-chart/index.d.ts +1 -0
  115. package/src/lib/conditional-number/conditional-number-options.d.ts +16 -14
  116. package/src/lib/conditional-number/conditional-number-slots.d.ts +2 -0
  117. package/src/lib/conditional-number/conditional-number.d.ts +4 -2
  118. package/src/lib/conditional-number/index.d.ts +1 -0
  119. package/src/lib/date-filter/date-filter-options.d.ts +6 -4
  120. package/src/lib/date-filter/date-filter-slots.d.ts +2 -0
  121. package/src/lib/date-filter/date-filter.d.ts +4 -2
  122. package/src/lib/date-filter/index.d.ts +1 -0
  123. package/src/lib/donut-chart/donut-chart-options.d.ts +18 -16
  124. package/src/lib/donut-chart/donut-chart-slots.d.ts +2 -0
  125. package/src/lib/donut-chart/donut-chart.d.ts +4 -2
  126. package/src/lib/donut-chart/index.d.ts +1 -0
  127. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts +8 -6
  128. package/src/lib/dropdown-filter/dropdown-filter-slots.d.ts +2 -0
  129. package/src/lib/dropdown-filter/dropdown-filter.d.ts +4 -2
  130. package/src/lib/dropdown-filter/index.d.ts +1 -0
  131. package/src/lib/evolution-number/evolution-number-options.d.ts +31 -14
  132. package/src/lib/evolution-number/evolution-number-options.d.ts.map +1 -1
  133. package/src/lib/evolution-number/evolution-number-slots.d.ts +2 -0
  134. package/src/lib/evolution-number/evolution-number.d.ts +4 -2
  135. package/src/lib/evolution-number/index.d.ts +1 -0
  136. package/src/lib/funnel-chart/funnel-chart-options.d.ts +18 -16
  137. package/src/lib/funnel-chart/funnel-chart-slots.d.ts +2 -0
  138. package/src/lib/funnel-chart/funnel-chart.d.ts +4 -2
  139. package/src/lib/funnel-chart/index.d.ts +1 -0
  140. package/src/lib/image/image-options.d.ts +5 -3
  141. package/src/lib/image/image.d.ts +3 -1
  142. package/src/lib/image/index.d.ts +1 -0
  143. package/src/lib/line-chart/index.d.ts +1 -0
  144. package/src/lib/line-chart/line-chart-options.d.ts +17 -15
  145. package/src/lib/line-chart/line-chart-slots.d.ts +2 -0
  146. package/src/lib/line-chart/line-chart.d.ts +4 -2
  147. package/src/lib/pivot-table/index.d.ts +1 -0
  148. package/src/lib/pivot-table/pivot-table-options.d.ts +21 -19
  149. package/src/lib/pivot-table/pivot-table-slots.d.ts +2 -0
  150. package/src/lib/pivot-table/pivot-table.d.ts +4 -2
  151. package/src/lib/regular-table/index.d.ts +1 -0
  152. package/src/lib/regular-table/regular-table-options.d.ts +16 -14
  153. package/src/lib/regular-table/regular-table-slots.d.ts +2 -0
  154. package/src/lib/regular-table/regular-table.d.ts +4 -2
  155. package/src/lib/sankey-diagram/index.d.ts +1 -0
  156. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts +17 -15
  157. package/src/lib/sankey-diagram/sankey-diagram-slots.d.ts +2 -0
  158. package/src/lib/sankey-diagram/sankey-diagram.d.ts +4 -2
  159. package/src/lib/scatter-plot/index.d.ts +1 -0
  160. package/src/lib/scatter-plot/scatter-plot-options.d.ts +18 -16
  161. package/src/lib/scatter-plot/scatter-plot-slots.d.ts +2 -0
  162. package/src/lib/scatter-plot/scatter-plot.d.ts +4 -2
  163. package/src/lib/shared/axes.d.ts +1 -0
  164. package/src/lib/shared/axis-view-options.d.ts +2 -0
  165. package/src/lib/shared/common.d.ts +7 -5
  166. package/src/lib/shared/common.d.ts.map +1 -1
  167. package/src/lib/shared/drop-object-view-options.d.ts +4 -0
  168. package/src/lib/shared/drop-object-view-options.d.ts.map +1 -1
  169. package/src/lib/shared/filters.d.ts +1 -0
  170. package/src/lib/shared/formula.d.ts +2 -0
  171. package/src/lib/shared/index.d.ts +1 -0
  172. package/src/lib/shared/info-tooltip-options.d.ts +1 -0
  173. package/src/lib/shared/interactivity-brush.d.ts +1 -0
  174. package/src/lib/shared/interactivity-custom-events.d.ts +2 -0
  175. package/src/lib/shared/interactivity-custom-tooltip.d.ts +1 -0
  176. package/src/lib/shared/interactivity-drilldown.d.ts +2 -0
  177. package/src/lib/shared/interactivity-export.d.ts +3 -2
  178. package/src/lib/shared/interactivity-filter.d.ts +1 -0
  179. package/src/lib/shared/interactivity-go-to-url.d.ts +1 -0
  180. package/src/lib/shared/interactivity-measure-dimension-picker.d.ts +3 -1
  181. package/src/lib/shared/interactivity-target.d.ts +1 -0
  182. package/src/lib/shared/interpolation.d.ts +1 -0
  183. package/src/lib/shared/item-filter-group.d.ts +1 -0
  184. package/src/lib/shared/legend.d.ts +2 -0
  185. package/src/lib/shared/map-object-view-options.d.ts +4 -2
  186. package/src/lib/shared/object-view-options.d.ts +4 -2
  187. package/src/lib/shared/placeholder.d.ts +1 -0
  188. package/src/lib/shared/query.d.ts +1 -0
  189. package/src/lib/shared/ranges.d.ts +1 -0
  190. package/src/lib/shared/slots.d.ts +4 -2
  191. package/src/lib/shared/sort.d.ts +2 -0
  192. package/src/lib/shared/theme.d.ts +6 -1
  193. package/src/lib/shared/theme.d.ts.map +1 -1
  194. package/src/lib/shared/title.d.ts +1 -0
  195. package/src/lib/slicer-filter/index.d.ts +1 -0
  196. package/src/lib/slicer-filter/slicer-filter-options.d.ts +15 -13
  197. package/src/lib/slicer-filter/slicer-filter-slots.d.ts +2 -0
  198. package/src/lib/slicer-filter/slicer-filter.d.ts +4 -2
  199. package/src/lib/slider-filter/index.d.ts +1 -0
  200. package/src/lib/slider-filter/slider-filter-options.d.ts +7 -5
  201. package/src/lib/slider-filter/slider-filter-slots.d.ts +2 -0
  202. package/src/lib/slider-filter/slider-filter.d.ts +4 -2
  203. package/src/lib/text/index.d.ts +1 -0
  204. package/src/lib/text/text-options.d.ts +3 -1
  205. package/src/lib/text/text.d.ts +3 -1
  206. package/src/options.d.ts +25 -23
  207. package/src/slots.d.ts +23 -21
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
+ ```
@@ -1,5 +1,5 @@
1
1
  declare const _default: {
2
- "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-options.schema.json",
2
+ "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-options.schema.json",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "properties": {
5
5
  "axis": {
@@ -52,6 +52,12 @@ declare const _default: {
52
52
  },
53
53
  "manualAxesRange": {
54
54
  "description": "Set manual axes range",
55
+ "examples": [
56
+ [
57
+ 0,
58
+ 100
59
+ ]
60
+ ],
55
61
  "items": [
56
62
  {
57
63
  "type": "number"
@@ -132,6 +138,12 @@ declare const _default: {
132
138
  },
133
139
  "manualAxesRange": {
134
140
  "description": "Set manual axes range",
141
+ "examples": [
142
+ [
143
+ 0,
144
+ 100
145
+ ]
146
+ ],
135
147
  "items": [
136
148
  {
137
149
  "type": "number"
@@ -281,7 +293,13 @@ declare const _default: {
281
293
  "type": "object"
282
294
  },
283
295
  "color": {
296
+ "default": "",
284
297
  "description": "The main color for the item, if omitted the default color from the theme will be used.",
298
+ "examples": [
299
+ "#FF5733",
300
+ "#33FF57",
301
+ "#5733FF"
302
+ ],
285
303
  "type": "string"
286
304
  },
287
305
  "display": {
@@ -1235,7 +1253,10 @@ declare const _default: {
1235
1253
  "type": "array"
1236
1254
  },
1237
1255
  "urlConfig": {
1238
- "default": "{ target: '_blank', url: null }",
1256
+ "default": {
1257
+ "target": "_blank",
1258
+ "url": null
1259
+ },
1239
1260
  "description": "Go to URL interactivity option",
1240
1261
  "properties": {
1241
1262
  "target": {
@@ -1258,7 +1279,7 @@ declare const _default: {
1258
1279
  "type": "object"
1259
1280
  },
1260
1281
  "interpolation": {
1261
- "default": "'linear'",
1282
+ "default": "linear",
1262
1283
  "description": "This option set the interpolation for the area drawn: \"linear\" or \"step-before\" or \"step-after\" or \"monotone\"",
1263
1284
  "enum": [
1264
1285
  "linear",
@@ -1349,6 +1370,8 @@ declare const _default: {
1349
1370
  "type": "string"
1350
1371
  },
1351
1372
  "nullBreak": {
1373
+ "default": false,
1374
+ "description": "Null break options",
1352
1375
  "type": "boolean"
1353
1376
  },
1354
1377
  "theme": {
@@ -1369,14 +1392,18 @@ declare const _default: {
1369
1392
  "background": {
1370
1393
  "description": "Background color",
1371
1394
  "examples": [
1372
- "dark",
1373
- "light",
1374
1395
  "rgb(245, 245, 245)",
1375
1396
  "rgb(61, 61, 61)"
1376
1397
  ],
1377
1398
  "type": "string"
1378
1399
  },
1379
1400
  "baseFontSize": {
1401
+ "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1402
+ "examples": [
1403
+ 13,
1404
+ 16,
1405
+ 20
1406
+ ],
1380
1407
  "type": "number"
1381
1408
  },
1382
1409
  "borders": {
@@ -1,5 +1,5 @@
1
1
  declare const _default: {
2
- "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json",
2
+ "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "definitions": {
5
5
  "ColumnSubtype": {
@@ -220,13 +220,13 @@ declare const _default: {
220
220
  "items": {
221
221
  "anyOf": [
222
222
  {
223
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/NumericSlotContent"
223
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/NumericSlotContent"
224
224
  },
225
225
  {
226
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/HierarchySlotContent"
226
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/HierarchySlotContent"
227
227
  },
228
228
  {
229
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/DateTimeSlotContent"
229
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/DateTimeSlotContent"
230
230
  }
231
231
  ]
232
232
  },
@@ -249,13 +249,13 @@ declare const _default: {
249
249
  "items": {
250
250
  "anyOf": [
251
251
  {
252
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/NumericSlotContent"
252
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/NumericSlotContent"
253
253
  },
254
254
  {
255
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/HierarchySlotContent"
255
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/HierarchySlotContent"
256
256
  },
257
257
  {
258
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/DateTimeSlotContent"
258
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/DateTimeSlotContent"
259
259
  }
260
260
  ]
261
261
  },
@@ -298,7 +298,7 @@ declare const _default: {
298
298
  "type": "string"
299
299
  },
300
300
  "columnSubType": {
301
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/ColumnSubtype",
301
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/ColumnSubtype",
302
302
  "description": "Column subtype"
303
303
  },
304
304
  "set": {
@@ -427,13 +427,13 @@ declare const _default: {
427
427
  "items": {
428
428
  "anyOf": [
429
429
  {
430
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/NumericSlotContent"
430
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/NumericSlotContent"
431
431
  },
432
432
  {
433
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/HierarchySlotContent"
433
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/HierarchySlotContent"
434
434
  },
435
435
  {
436
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/DateTimeSlotContent"
436
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/DateTimeSlotContent"
437
437
  }
438
438
  ]
439
439
  },
@@ -453,13 +453,13 @@ declare const _default: {
453
453
  "items": {
454
454
  "anyOf": [
455
455
  {
456
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/XAxisSlot"
456
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/XAxisSlot"
457
457
  },
458
458
  {
459
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/MeasureSlot"
459
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/MeasureSlot"
460
460
  },
461
461
  {
462
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json#/definitions/LegendSlot"
462
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json#/definitions/LegendSlot"
463
463
  }
464
464
  ]
465
465
  },
@@ -1,6 +1,6 @@
1
1
  declare const _default: {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart.schema.json",
3
+ "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart.schema.json",
4
4
  "type": "object",
5
5
  "description": "Area Chart item",
6
6
  "properties": {
@@ -11,11 +11,11 @@ declare const _default: {
11
11
  },
12
12
  "options": {
13
13
  "description": "Options of the Area Chart item",
14
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-options.schema.json"
14
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-options.schema.json"
15
15
  },
16
16
  "slots": {
17
17
  "description": "Data definition of the Area Chart item",
18
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/area-chart-slots.schema.json"
18
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/area-chart-slots.schema.json"
19
19
  }
20
20
  }
21
21
  };
@@ -1,5 +1,5 @@
1
1
  declare const _default: {
2
- "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-options.schema.json",
2
+ "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-options.schema.json",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "properties": {
5
5
  "axis": {
@@ -18,7 +18,7 @@ declare const _default: {
18
18
  "type": "string"
19
19
  },
20
20
  "scale": {
21
- "default": "'linear'",
21
+ "default": "linear",
22
22
  "description": "X-axis scale type",
23
23
  "enum": [
24
24
  "linear",
@@ -44,7 +44,7 @@ declare const _default: {
44
44
  "type": "string"
45
45
  },
46
46
  "ticksMode": {
47
- "default": "'ticks'",
47
+ "default": "ticks",
48
48
  "description": "Ticks mode of the X-axis",
49
49
  "enum": [
50
50
  "gridlines",
@@ -69,7 +69,7 @@ declare const _default: {
69
69
  "type": "string"
70
70
  },
71
71
  "ticksMode": {
72
- "default": "'ticks'",
72
+ "default": "ticks",
73
73
  "description": "Ticks mode of the Y-axis",
74
74
  "enum": [
75
75
  "gridlines",
@@ -136,7 +136,7 @@ declare const _default: {
136
136
  "description": "Bars options",
137
137
  "properties": {
138
138
  "label": {
139
- "default": "'none'",
139
+ "default": "none",
140
140
  "description": "Bar label options",
141
141
  "enum": [
142
142
  "none",
@@ -171,7 +171,13 @@ declare const _default: {
171
171
  "type": "object"
172
172
  },
173
173
  "color": {
174
+ "default": "",
174
175
  "description": "The main color for the item, if omitted the default color from the theme will be used.",
176
+ "examples": [
177
+ "#FF5733",
178
+ "#33FF57",
179
+ "#5733FF"
180
+ ],
175
181
  "type": "string"
176
182
  },
177
183
  "display": {
@@ -334,7 +340,11 @@ declare const _default: {
334
340
  "description": "Interactivity options",
335
341
  "properties": {
336
342
  "availableExportTypes": {
337
- "default": "['xlsx', 'csv', 'png']",
343
+ "default": [
344
+ "xlsx",
345
+ "csv",
346
+ "png"
347
+ ],
338
348
  "description": "Available export types interactivity option",
339
349
  "items": {
340
350
  "description": "Export types",
@@ -2499,7 +2509,11 @@ declare const _default: {
2499
2509
  "type": "object"
2500
2510
  },
2501
2511
  "exportTypes": {
2502
- "default": "['xlsx', 'csv', 'png']",
2512
+ "default": [
2513
+ "xlsx",
2514
+ "csv",
2515
+ "png"
2516
+ ],
2503
2517
  "description": "Export types interactivity option",
2504
2518
  "items": {
2505
2519
  "description": "Export types",
@@ -3153,7 +3167,10 @@ declare const _default: {
3153
3167
  "type": "boolean"
3154
3168
  },
3155
3169
  "urlConfig": {
3156
- "default": "{ target: '_blank', url: null }",
3170
+ "default": {
3171
+ "target": "_blank",
3172
+ "url": null
3173
+ },
3157
3174
  "description": "Go to URL interactivity option",
3158
3175
  "properties": {
3159
3176
  "target": {
@@ -3239,7 +3256,7 @@ declare const _default: {
3239
3256
  "type": "array"
3240
3257
  },
3241
3258
  "mode": {
3242
- "default": "'grouped'",
3259
+ "default": "grouped",
3243
3260
  "description": "Mode of the Bar chart: grouped, stacked or 100% stacked",
3244
3261
  "enum": [
3245
3262
  "100",
@@ -3368,14 +3385,18 @@ declare const _default: {
3368
3385
  "background": {
3369
3386
  "description": "Background color",
3370
3387
  "examples": [
3371
- "dark",
3372
- "light",
3373
3388
  "rgb(245, 245, 245)",
3374
3389
  "rgb(61, 61, 61)"
3375
3390
  ],
3376
3391
  "type": "string"
3377
3392
  },
3378
3393
  "baseFontSize": {
3394
+ "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
3395
+ "examples": [
3396
+ 13,
3397
+ 16,
3398
+ 20
3399
+ ],
3379
3400
  "type": "number"
3380
3401
  },
3381
3402
  "borders": {
@@ -1,5 +1,5 @@
1
1
  declare const _default: {
2
- "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json",
2
+ "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "definitions": {
5
5
  "ColumnSubtype": {
@@ -220,13 +220,13 @@ declare const _default: {
220
220
  "items": {
221
221
  "anyOf": [
222
222
  {
223
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/NumericSlotContent"
223
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/NumericSlotContent"
224
224
  },
225
225
  {
226
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/HierarchySlotContent"
226
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/HierarchySlotContent"
227
227
  },
228
228
  {
229
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/DateTimeSlotContent"
229
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/DateTimeSlotContent"
230
230
  }
231
231
  ]
232
232
  },
@@ -249,13 +249,13 @@ declare const _default: {
249
249
  "items": {
250
250
  "anyOf": [
251
251
  {
252
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/NumericSlotContent"
252
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/NumericSlotContent"
253
253
  },
254
254
  {
255
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/HierarchySlotContent"
255
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/HierarchySlotContent"
256
256
  },
257
257
  {
258
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/DateTimeSlotContent"
258
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/DateTimeSlotContent"
259
259
  }
260
260
  ]
261
261
  },
@@ -298,7 +298,7 @@ declare const _default: {
298
298
  "type": "string"
299
299
  },
300
300
  "columnSubType": {
301
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/ColumnSubtype",
301
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/ColumnSubtype",
302
302
  "description": "Column subtype"
303
303
  },
304
304
  "set": {
@@ -427,13 +427,13 @@ declare const _default: {
427
427
  "items": {
428
428
  "anyOf": [
429
429
  {
430
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/NumericSlotContent"
430
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/NumericSlotContent"
431
431
  },
432
432
  {
433
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/HierarchySlotContent"
433
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/HierarchySlotContent"
434
434
  },
435
435
  {
436
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/DateTimeSlotContent"
436
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/DateTimeSlotContent"
437
437
  }
438
438
  ]
439
439
  },
@@ -453,13 +453,13 @@ declare const _default: {
453
453
  "items": {
454
454
  "anyOf": [
455
455
  {
456
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/MeasureSlot"
456
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/MeasureSlot"
457
457
  },
458
458
  {
459
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/YAxisSlot"
459
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/YAxisSlot"
460
460
  },
461
461
  {
462
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json#/definitions/LegendSlot"
462
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json#/definitions/LegendSlot"
463
463
  }
464
464
  ]
465
465
  },
@@ -1,6 +1,6 @@
1
1
  declare const _default: {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart.schema.json",
3
+ "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart.schema.json",
4
4
  "type": "object",
5
5
  "description": "Bar Chart item",
6
6
  "properties": {
@@ -11,11 +11,11 @@ declare const _default: {
11
11
  },
12
12
  "options": {
13
13
  "description": "Options of the Bar Chart item",
14
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-options.schema.json"
14
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-options.schema.json"
15
15
  },
16
16
  "slots": {
17
17
  "description": "Data definition of the Bar Chart item",
18
- "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.88/bar-chart-slots.schema.json"
18
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/bar-chart-slots.schema.json"
19
19
  }
20
20
  }
21
21
  };