@astrato-io/visualizations 0.6.4 → 0.6.5

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 (149) hide show
  1. package/CHANGELOG.md +0 -0
  2. package/THIRD_PARTY_NOTICES.md +94 -4
  3. package/chunks/ClickAwayListener-BbeNMAvj.js +52 -0
  4. package/chunks/{LinearProgress-CUZ0D8_t.js → LinearProgress-B1FeWaen.js} +54 -54
  5. package/chunks/app-filter-bar.compiler-BGJ7HAbr.js +64 -0
  6. package/chunks/bar.compiler-CT0ZbQKc.js +374 -0
  7. package/chunks/{src-Cum_2NLV.js → builder-B6dWSIdD.js} +5779 -5635
  8. package/chunks/{coloring-C16AUZEi.js → coloring-B1XAfg6b.js} +234 -233
  9. package/chunks/{src-BC7cGcJ-.js → definitions-D3OVqmXl.js} +438 -360
  10. package/chunks/{escobar-BGqT1EsE.js → escobar-eDjtGpkC.js} +4645 -4619
  11. package/chunks/filter.compiler-DBsyRBJt.js +70 -0
  12. package/chunks/{filtering-Yq4DEa0t.js → filtering-tqjAyJH5.js} +432 -313
  13. package/chunks/{grouping-type-BX_9Ix5q.js → grouping-type-On4s9Thj.js} +1 -1
  14. package/chunks/handlers-VTBfIZYZ.js +13072 -0
  15. package/chunks/isEqual-BDxAhUo8.js +7514 -0
  16. package/chunks/line.compiler-CzdM5Ld0.js +198 -0
  17. package/chunks/{metadata-CPXdYoln.js → metadata-BGElBy5Z.js} +1 -1
  18. package/chunks/number.compiler-G-R7y16P.js +53 -0
  19. package/chunks/{src-C0LgoUWY.js → operations-CTNUX6Sy.js} +9576 -9432
  20. package/chunks/{range-DrzdfBX4.js → range-CiwTbMig.js} +2 -2
  21. package/chunks/{registry-CExpGJ1N.js → registry-CsQQzukD.js} +153 -153
  22. package/chunks/{requirements-DNhuShLS.js → requirements-DYjZCFyf.js} +1 -1
  23. package/chunks/{shared-CKDL4hx9.js → shared-CBvcC5YV.js} +460 -413
  24. package/chunks/{standalone-D5vnf-9y.js → standalone-0M4HlmDW2.js} +823 -822
  25. package/chunks/standalone-0ashe9w1.js +411 -0
  26. package/chunks/{standalone-C85u7U6I.js → standalone-B7jax8wa.js} +93 -94
  27. package/chunks/standalone-BK0VYU-l.js +463 -0
  28. package/chunks/{standalone-BDCwI6Hn.js → standalone-BMIbT1b2.js} +815 -815
  29. package/chunks/standalone-BZV5vOwA.js +6 -0
  30. package/chunks/standalone-BhDrWj4p.js +1980 -0
  31. package/chunks/{standalone-CNyNHKVx.js → standalone-BtSHCp2U2.js} +97 -98
  32. package/chunks/{standalone-CDQnr6qT.js → standalone-BvaKdky9.js} +95 -96
  33. package/chunks/standalone-BwtM31-f.js +2 -0
  34. package/chunks/{standalone-CY57qwZ-.js → standalone-C3gg736V.js} +153 -153
  35. package/chunks/{standalone-DFPva_ku.js → standalone-CC1VUjO32.js} +60 -60
  36. package/chunks/{standalone-CCNtaJ7s.js → standalone-C_rYnZ0N.js} +41 -41
  37. package/chunks/{standalone-CZynjFG7.js → standalone-CoLrAxRV.js} +3701 -3482
  38. package/chunks/{standalone-jiz0L2Dg.js → standalone-DC-aUgXC.js} +104 -104
  39. package/chunks/standalone-DCtRoTWg.js +675 -0
  40. package/chunks/standalone-DUDFTBqL.js +833 -0
  41. package/chunks/standalone-DhZkX9Td.js +2 -0
  42. package/chunks/{standalone-Dx3MLlrO.js → standalone-DtLElfuM.js} +141 -141
  43. package/chunks/{standalone-BmfMt74U.js → standalone-G9Q4Uczu.js} +192 -192
  44. package/chunks/{standalone-BH5NqDwp.js → standalone-JuLF-OoH.js} +390 -391
  45. package/chunks/standalone-_DeX21JJ.js +383 -0
  46. package/chunks/{standalone-lBm9hQ-q.js → standalone-gFhKZh8m.js} +34 -34
  47. package/chunks/standalone-tDNy-SFH.js +281 -0
  48. package/chunks/{standalone-rJ45Zfl1.js → standalone-v1oxfU20.js} +10 -10
  49. package/chunks/{standalone-BYm1UjLr.js → standalone-vzBY6q0I2.js} +18 -18
  50. package/chunks/table.compiler-tb914oj3.js +222 -0
  51. package/chunks/{ui-D1HQNIBy.js → ui-DQWtv2iM.js} +13485 -3973
  52. package/chunks/{useFieldName-oqQ3bvnO.js → useFieldName-BvdcoJRl.js} +1 -1
  53. package/chunks/{utils-Ba9T0TqC.js → utils-Bg7K-t6K.js} +7306 -6024
  54. package/chunks/{src-DvX5LU9T.js → view-Bn83C8d9.js} +2555 -4831
  55. package/definitions.js +3 -3
  56. package/docs/operations/astrato-app-filter-bar.md +17 -17
  57. package/docs/operations/bar.md +989 -1071
  58. package/docs/operations/combo.md +717 -738
  59. package/docs/operations/date-picker.md +25 -25
  60. package/docs/operations/distribution-gauge.md +471 -607
  61. package/docs/operations/dot.md +787 -879
  62. package/docs/operations/filter.md +139 -163
  63. package/docs/operations/gauge.md +491 -627
  64. package/docs/operations/heatMap.md +834 -916
  65. package/docs/operations/histogram.md +166 -180
  66. package/docs/operations/iframe.md +5 -5
  67. package/docs/operations/image.md +16 -16
  68. package/docs/operations/index.md +12 -12
  69. package/docs/operations/line.md +811 -888
  70. package/docs/operations/number.md +470 -536
  71. package/docs/operations/pie.md +825 -958
  72. package/docs/operations/radar.md +599 -679
  73. package/docs/operations/sankey.md +462 -584
  74. package/docs/operations/scatter.md +823 -929
  75. package/docs/operations/shape.md +34 -34
  76. package/docs/operations/simpleTextObject.md +18 -25
  77. package/docs/operations/slider.md +33 -43
  78. package/docs/operations/table.md +1160 -1150
  79. package/docs/operations/tree.md +354 -361
  80. package/docs/operations/treemap.md +545 -637
  81. package/docs/operations/waterfall.md +369 -379
  82. package/docs/operations/word-cloud.md +512 -583
  83. package/getters.js +3 -3
  84. package/index.js +51 -51
  85. package/metadata.js +3 -3
  86. package/operations.js +7 -7
  87. package/package.json +80 -86
  88. package/src/definitions/index.d.ts +2 -2
  89. package/src/definitions/{shared/lib → model/definitions}/available-fields.d.ts +0 -1
  90. package/src/definitions/{shared/lib/compilers/index.d.ts → model/definitions/compilers/compile.d.ts} +1 -1
  91. package/src/definitions/model/definitions/data-item-resolution.d.ts +19 -0
  92. package/src/definitions/model/definitions/descriptors/descriptor-metadata.d.ts +1341 -0
  93. package/src/definitions/model/definitions/descriptors/json-schema.d.ts +2 -0
  94. package/src/definitions/model/definitions/diagnostics.d.ts +5 -0
  95. package/src/definitions/model/definitions/field-suggestions.d.ts +2 -0
  96. package/src/definitions/model/definitions/index.d.ts +23 -0
  97. package/src/definitions/{shared/lib → model/definitions}/registry/compile.d.ts +1 -1
  98. package/src/definitions/model/definitions/registry/descriptor-registry.d.ts +3 -0
  99. package/src/definitions/model/definitions/schema-registry.d.ts +660 -0
  100. package/src/definitions/{shared/lib → model/definitions}/schemas/broad-chart.schema.d.ts +1 -1
  101. package/src/definitions/{shared/lib → model/definitions}/schemas/common.schema.d.ts +0 -1
  102. package/src/definitions/model/definitions/schemas/index.d.ts +9 -0
  103. package/src/definitions/{shared/lib → model/definitions}/schemas/object.schema.d.ts +6 -6
  104. package/src/definitions/{shared/lib → model/definitions}/types/definition.types.d.ts +1 -1
  105. package/src/definitions/model/definitions/types/index.d.ts +3 -0
  106. package/src/definitions/{shared/lib/registry → model/definitions}/validation.d.ts +1 -1
  107. package/chunks/Radio-Ciu-F4CU.js +0 -957
  108. package/chunks/ToggleButton-BCJc3Jlc.js +0 -153
  109. package/chunks/_baseFlatten-DPXPOrea.js +0 -7076
  110. package/chunks/app-filter-bar.compiler-j_CVoWTa.js +0 -55
  111. package/chunks/bar.compiler-oqaPzIut.js +0 -370
  112. package/chunks/data-item-resolution-1lvYB5ln.js +0 -53
  113. package/chunks/event-bus-KiSiCJrC.js +0 -2683
  114. package/chunks/filter.compiler-CuLtc_02.js +0 -60
  115. package/chunks/gauge-target-type-BkKXAqkX.js +0 -4
  116. package/chunks/interfaces-VUY4_yVO.js +0 -8742
  117. package/chunks/line-settings-DfYTUyPz.js +0 -4
  118. package/chunks/line.compiler-BpA_6Tc7.js +0 -188
  119. package/chunks/number.compiler-DbkWcG4S.js +0 -44
  120. package/chunks/pie-uv42Eqal.js +0 -10
  121. package/chunks/src-Dun_jXtz.js +0 -10295
  122. package/chunks/standalone-87YV_m9n.js +0 -687
  123. package/chunks/standalone-BLVAWLNJ.js +0 -385
  124. package/chunks/standalone-BPomtAVs.js +0 -2
  125. package/chunks/standalone-BXyBcUOQ.js +0 -2
  126. package/chunks/standalone-BllF4rDp.js +0 -383
  127. package/chunks/standalone-BqWyrnZI.js +0 -281
  128. package/chunks/standalone-DQxxNwF8.js +0 -675
  129. package/chunks/standalone-DS9T0FZ-.js +0 -830
  130. package/chunks/standalone-DzixzZAL.js +0 -411
  131. package/chunks/standalone-QJ1kKMnO.js +0 -6
  132. package/chunks/table.compiler-BrXkm4Fz.js +0 -213
  133. package/chunks/toInteger-DVZr-D1j.js +0 -11
  134. package/chunks/treemap-x_zmJoG7.js +0 -23
  135. package/chunks/types-dVVCsDWD.js +0 -4
  136. package/chunks/view-CLqWMV7Z.js +0 -156
  137. package/src/definitions/shared/index.d.ts +0 -5
  138. package/src/definitions/shared/lib/registry/descriptor-registry.d.ts +0 -587
  139. package/src/definitions/shared/lib/registry/index.d.ts +0 -3
  140. package/src/definitions/shared/lib/schemas/index.d.ts +0 -9
  141. package/src/definitions/shared/lib/types/index.d.ts +0 -3
  142. package/src/definitions/{shared/lib → model/definitions}/schemas/app-filter-bar.schema.d.ts +0 -0
  143. package/src/definitions/{shared/lib → model/definitions}/schemas/bar.schema.d.ts +0 -0
  144. package/src/definitions/{shared/lib → model/definitions}/schemas/filter.schema.d.ts +0 -0
  145. package/src/definitions/{shared/lib → model/definitions}/schemas/line.schema.d.ts +0 -0
  146. package/src/definitions/{shared/lib → model/definitions}/schemas/number.schema.d.ts +0 -0
  147. package/src/definitions/{shared/lib → model/definitions}/schemas/table.schema.d.ts +4 -4
  148. /package/src/definitions/{shared/lib → model/definitions}/types/compilation.types.d.ts +0 -0
  149. /package/src/definitions/{shared/lib → model/definitions}/types/descriptor.types.d.ts +0 -0
@@ -2,7 +2,7 @@
2
2
 
3
3
  # `word-cloud` operations
4
4
 
5
- Reference for `@astrato-io/visualizations@0.6.4`.
5
+ Reference for `@astrato-io/visualizations@0.6.5`.
6
6
 
7
7
  [All visualization types](./index.md)
8
8
 
@@ -28,6 +28,7 @@ Use each schema below for the request’s `payload`, not for the whole operation
28
28
  - [`resetChartPaletteToThemeDefault`](#resetchartpalettetothemedefault)
29
29
  - [`setChartPalette`](#setchartpalette)
30
30
  - [`setColoringColor`](#setcoloringcolor)
31
+ - [`setColoringGradientAuto`](#setcoloringgradientauto)
31
32
  - [`setColoringGradientMax`](#setcoloringgradientmax)
32
33
  - [`setColoringGradientMin`](#setcoloringgradientmin)
33
34
  - [`setColoringOverwrites`](#setcoloringoverwrites)
@@ -66,7 +67,6 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
66
67
  ```json
67
68
  {
68
69
  "$schema": "https://json-schema.org/draft/2020-12/schema",
69
- "title": "Add coloring overwrite schema",
70
70
  "anyOf": [
71
71
  {
72
72
  "type": "object",
@@ -76,21 +76,21 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
76
76
  "type": "object",
77
77
  "properties": {
78
78
  "dataItemInternalKey": {
79
- "description": "Internal key of the data item of the dimension to be updated",
80
- "type": "string"
79
+ "type": "string",
80
+ "description": "Internal key of the data item of the dimension to be updated"
81
81
  },
82
82
  "dataItemUniqueSignature": {
83
- "description": "Unique signature of the data item of the dimension to be updated",
84
- "type": "string"
83
+ "type": "string",
84
+ "description": "Unique signature of the data item of the dimension to be updated"
85
85
  }
86
86
  },
87
87
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
88
88
  "additionalProperties": false
89
89
  },
90
90
  "color": {
91
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
92
91
  "type": "string",
93
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
92
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
93
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
94
94
  },
95
95
  "operator": {
96
96
  "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
@@ -99,14 +99,7 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
99
99
  },
100
100
  "value": {
101
101
  "description": "Value to compare against",
102
- "anyOf": [
103
- {
104
- "type": "string"
105
- },
106
- {
107
- "type": "number"
108
- }
109
- ]
102
+ "type": ["string", "number"]
110
103
  }
111
104
  },
112
105
  "required": ["color", "value"],
@@ -120,48 +113,34 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
120
113
  "type": "object",
121
114
  "properties": {
122
115
  "dataItemInternalKey": {
123
- "description": "Internal key of the data item of the dimension to be updated",
124
- "type": "string"
116
+ "type": "string",
117
+ "description": "Internal key of the data item of the dimension to be updated"
125
118
  },
126
119
  "dataItemUniqueSignature": {
127
- "description": "Unique signature of the data item of the dimension to be updated",
128
- "type": "string"
120
+ "type": "string",
121
+ "description": "Unique signature of the data item of the dimension to be updated"
129
122
  }
130
123
  },
131
124
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
132
125
  "additionalProperties": false
133
126
  },
134
127
  "color": {
135
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
136
128
  "type": "string",
137
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
129
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
130
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
138
131
  },
139
132
  "operator": {
140
- "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)",
141
133
  "type": "string",
142
- "const": "between"
134
+ "const": "between",
135
+ "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)"
143
136
  },
144
137
  "value": {
145
138
  "description": "Lower bound of the range",
146
- "anyOf": [
147
- {
148
- "type": "string"
149
- },
150
- {
151
- "type": "number"
152
- }
153
- ]
139
+ "type": ["string", "number"]
154
140
  },
155
141
  "secondValue": {
156
142
  "description": "Upper bound of the range",
157
- "anyOf": [
158
- {
159
- "type": "string"
160
- },
161
- {
162
- "type": "number"
163
- }
164
- ]
143
+ "type": ["string", "number"]
165
144
  }
166
145
  },
167
146
  "required": ["color", "operator", "value", "secondValue"],
@@ -175,41 +154,34 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
175
154
  "type": "object",
176
155
  "properties": {
177
156
  "dataItemInternalKey": {
178
- "description": "Internal key of the data item of the dimension to be updated",
179
- "type": "string"
157
+ "type": "string",
158
+ "description": "Internal key of the data item of the dimension to be updated"
180
159
  },
181
160
  "dataItemUniqueSignature": {
182
- "description": "Unique signature of the data item of the dimension to be updated",
183
- "type": "string"
161
+ "type": "string",
162
+ "description": "Unique signature of the data item of the dimension to be updated"
184
163
  }
185
164
  },
186
165
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
187
166
  "additionalProperties": false
188
167
  },
189
168
  "color": {
190
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
191
169
  "type": "string",
192
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
170
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
171
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
193
172
  },
194
173
  "operator": {
195
- "description": "Match (inList) or exclude (notInList) every value in values",
196
174
  "type": "string",
197
- "enum": ["inList", "notInList"]
175
+ "enum": ["inList", "notInList"],
176
+ "description": "Match (inList) or exclude (notInList) every value in values"
198
177
  },
199
178
  "values": {
200
- "description": "Values to match",
201
179
  "minItems": 1,
202
180
  "type": "array",
203
181
  "items": {
204
- "anyOf": [
205
- {
206
- "type": "string"
207
- },
208
- {
209
- "type": "number"
210
- }
211
- ]
212
- }
182
+ "type": ["string", "number"]
183
+ },
184
+ "description": "Values to match"
213
185
  },
214
186
  "delimiter": {
215
187
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -220,7 +192,8 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
220
192
  "required": ["color", "operator", "values"],
221
193
  "additionalProperties": false
222
194
  }
223
- ]
195
+ ],
196
+ "title": "Add coloring overwrite schema"
224
197
  }
225
198
  ```
226
199
 
@@ -235,47 +208,39 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
235
208
  ```json
236
209
  {
237
210
  "$schema": "https://json-schema.org/draft/2020-12/schema",
238
- "title": "Add coloring rule schema",
239
211
  "anyOf": [
240
212
  {
241
213
  "type": "object",
242
214
  "properties": {
243
215
  "measure": {
244
- "description": "Measure whose value is compared",
245
216
  "type": "object",
246
217
  "properties": {
247
218
  "dataItemInternalKey": {
248
- "description": "Internal key of the data item of the measure to be updated",
249
- "type": "string"
219
+ "type": "string",
220
+ "description": "Internal key of the data item of the measure to be updated"
250
221
  },
251
222
  "dataItemUniqueSignature": {
252
- "description": "Unique signature of the data item of the measure to be updated",
253
- "type": "string"
223
+ "type": "string",
224
+ "description": "Unique signature of the data item of the measure to be updated"
254
225
  }
255
226
  },
256
227
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
257
- "additionalProperties": false
228
+ "additionalProperties": false,
229
+ "description": "Measure whose value is compared"
258
230
  },
259
231
  "color": {
260
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
261
232
  "type": "string",
262
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
233
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
234
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
263
235
  },
264
236
  "operator": {
265
- "description": "How the measure value is compared",
266
237
  "type": "string",
267
- "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"]
238
+ "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"],
239
+ "description": "How the measure value is compared"
268
240
  },
269
241
  "value": {
270
242
  "description": "Value to compare against",
271
- "anyOf": [
272
- {
273
- "type": "string"
274
- },
275
- {
276
- "type": "number"
277
- }
278
- ]
243
+ "type": ["string", "number"]
279
244
  }
280
245
  },
281
246
  "required": ["measure", "color", "operator", "value"],
@@ -285,52 +250,38 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
285
250
  "type": "object",
286
251
  "properties": {
287
252
  "measure": {
288
- "description": "Measure whose value is compared",
289
253
  "type": "object",
290
254
  "properties": {
291
255
  "dataItemInternalKey": {
292
- "description": "Internal key of the data item of the measure to be updated",
293
- "type": "string"
256
+ "type": "string",
257
+ "description": "Internal key of the data item of the measure to be updated"
294
258
  },
295
259
  "dataItemUniqueSignature": {
296
- "description": "Unique signature of the data item of the measure to be updated",
297
- "type": "string"
260
+ "type": "string",
261
+ "description": "Unique signature of the data item of the measure to be updated"
298
262
  }
299
263
  },
300
264
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
301
- "additionalProperties": false
265
+ "additionalProperties": false,
266
+ "description": "Measure whose value is compared"
302
267
  },
303
268
  "color": {
304
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
305
269
  "type": "string",
306
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
270
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
271
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
307
272
  },
308
273
  "operator": {
309
- "description": "Matches measure values from value to secondValue, both inclusive",
310
274
  "type": "string",
311
- "const": "between"
275
+ "const": "between",
276
+ "description": "Matches measure values from value to secondValue, both inclusive"
312
277
  },
313
278
  "value": {
314
279
  "description": "Lower bound of the range",
315
- "anyOf": [
316
- {
317
- "type": "string"
318
- },
319
- {
320
- "type": "number"
321
- }
322
- ]
280
+ "type": ["string", "number"]
323
281
  },
324
282
  "secondValue": {
325
283
  "description": "Upper bound of the range",
326
- "anyOf": [
327
- {
328
- "type": "string"
329
- },
330
- {
331
- "type": "number"
332
- }
333
- ]
284
+ "type": ["string", "number"]
334
285
  }
335
286
  },
336
287
  "required": ["measure", "color", "operator", "value", "secondValue"],
@@ -340,45 +291,38 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
340
291
  "type": "object",
341
292
  "properties": {
342
293
  "measure": {
343
- "description": "Measure whose value is compared",
344
294
  "type": "object",
345
295
  "properties": {
346
296
  "dataItemInternalKey": {
347
- "description": "Internal key of the data item of the measure to be updated",
348
- "type": "string"
297
+ "type": "string",
298
+ "description": "Internal key of the data item of the measure to be updated"
349
299
  },
350
300
  "dataItemUniqueSignature": {
351
- "description": "Unique signature of the data item of the measure to be updated",
352
- "type": "string"
301
+ "type": "string",
302
+ "description": "Unique signature of the data item of the measure to be updated"
353
303
  }
354
304
  },
355
305
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
356
- "additionalProperties": false
306
+ "additionalProperties": false,
307
+ "description": "Measure whose value is compared"
357
308
  },
358
309
  "color": {
359
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
360
310
  "type": "string",
361
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
311
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
312
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
362
313
  },
363
314
  "operator": {
364
- "description": "Match (inList) or exclude (notInList) every value in values",
365
315
  "type": "string",
366
- "enum": ["inList", "notInList"]
316
+ "enum": ["inList", "notInList"],
317
+ "description": "Match (inList) or exclude (notInList) every value in values"
367
318
  },
368
319
  "values": {
369
- "description": "Values to match",
370
320
  "minItems": 1,
371
321
  "type": "array",
372
322
  "items": {
373
- "anyOf": [
374
- {
375
- "type": "string"
376
- },
377
- {
378
- "type": "number"
379
- }
380
- ]
381
- }
323
+ "type": ["string", "number"]
324
+ },
325
+ "description": "Values to match"
382
326
  },
383
327
  "delimiter": {
384
328
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -389,7 +333,8 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
389
333
  "required": ["measure", "color", "operator", "values"],
390
334
  "additionalProperties": false
391
335
  }
392
- ]
336
+ ],
337
+ "title": "Add coloring rule schema"
393
338
  }
394
339
  ```
395
340
 
@@ -404,16 +349,16 @@ Add a new dimension to the chart
404
349
  ```json
405
350
  {
406
351
  "$schema": "https://json-schema.org/draft/2020-12/schema",
407
- "title": "Add dimension schema",
408
352
  "type": "object",
409
353
  "properties": {
410
354
  "key": {
411
- "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"",
412
- "type": "string"
355
+ "type": "string",
356
+ "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\""
413
357
  }
414
358
  },
415
359
  "required": ["key"],
416
- "additionalProperties": false
360
+ "additionalProperties": false,
361
+ "title": "Add dimension schema"
417
362
  }
418
363
  ```
419
364
 
@@ -428,23 +373,22 @@ Add a new measure to the chart
428
373
  ```json
429
374
  {
430
375
  "$schema": "https://json-schema.org/draft/2020-12/schema",
431
- "title": "Add measure schema",
432
- "anyOf": [
376
+ "oneOf": [
433
377
  {
434
378
  "type": "object",
435
379
  "properties": {
436
380
  "sourceKind": {
437
- "description": "Raw database field from available data `fields`.",
438
381
  "type": "string",
439
- "const": "field"
382
+ "const": "field",
383
+ "description": "Raw database field from available data `fields`."
440
384
  },
441
385
  "key": {
442
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
443
- "type": "string"
386
+ "type": "string",
387
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
444
388
  },
445
389
  "aggregation": {
446
- "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
447
- "type": "string"
390
+ "type": "string",
391
+ "description": "Required for raw database fields. Use one of the aggregation names returned for that field."
448
392
  }
449
393
  },
450
394
  "required": ["sourceKind", "key", "aggregation"],
@@ -454,13 +398,13 @@ Add a new measure to the chart
454
398
  "type": "object",
455
399
  "properties": {
456
400
  "sourceKind": {
457
- "description": "Predefined/user-defined measure from available data `measures`.",
458
401
  "type": "string",
459
- "const": "measure"
402
+ "const": "measure",
403
+ "description": "Predefined/user-defined measure from available data `measures`."
460
404
  },
461
405
  "key": {
462
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
463
- "type": "string"
406
+ "type": "string",
407
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
464
408
  }
465
409
  },
466
410
  "required": ["sourceKind", "key"],
@@ -470,19 +414,20 @@ Add a new measure to the chart
470
414
  "type": "object",
471
415
  "properties": {
472
416
  "sourceKind": {
473
- "description": "Predefined calculation from available data `measures`.",
474
417
  "type": "string",
475
- "const": "calculation"
418
+ "const": "calculation",
419
+ "description": "Predefined calculation from available data `measures`."
476
420
  },
477
421
  "key": {
478
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
479
- "type": "string"
422
+ "type": "string",
423
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
480
424
  }
481
425
  },
482
426
  "required": ["sourceKind", "key"],
483
427
  "additionalProperties": false
484
428
  }
485
- ]
429
+ ],
430
+ "title": "Add measure schema"
486
431
  }
487
432
  ```
488
433
 
@@ -497,22 +442,19 @@ Add another measure filter before aggregation. Keeps existing filters.
497
442
  ```json
498
443
  {
499
444
  "$schema": "https://json-schema.org/draft/2020-12/schema",
500
- "description": "Add another measure filter before aggregation. Keeps existing filters.",
501
- "title": "Add measure filter schema",
502
445
  "anyOf": [
503
446
  {
504
447
  "type": "object",
505
448
  "properties": {
506
449
  "measureName": {
507
- "description": "Visible measure name or label",
508
- "type": "string"
450
+ "type": "string",
451
+ "description": "Visible measure name or label"
509
452
  },
510
453
  "fieldKey": {
511
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
512
- "type": "string"
454
+ "type": "string",
455
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
513
456
  },
514
457
  "operator": {
515
- "description": "Filter operator that requires a value",
516
458
  "type": "string",
517
459
  "enum": [
518
460
  "equals",
@@ -527,10 +469,10 @@ Add another measure filter before aggregation. Keeps existing filters.
527
469
  "notLike",
528
470
  "startsWith",
529
471
  "endsWith"
530
- ]
472
+ ],
473
+ "description": "Filter operator that requires a value"
531
474
  },
532
475
  "value": {
533
- "description": "Filter value",
534
476
  "anyOf": [
535
477
  {
536
478
  "type": "string"
@@ -549,7 +491,8 @@ Add another measure filter before aggregation. Keeps existing filters.
549
491
  "required": ["type", "variableName"],
550
492
  "additionalProperties": false
551
493
  }
552
- ]
494
+ ],
495
+ "description": "Filter value"
553
496
  }
554
497
  },
555
498
  "required": ["measureName", "fieldKey", "operator", "value"],
@@ -559,20 +502,19 @@ Add another measure filter before aggregation. Keeps existing filters.
559
502
  "type": "object",
560
503
  "properties": {
561
504
  "measureName": {
562
- "description": "Visible measure name or label",
563
- "type": "string"
505
+ "type": "string",
506
+ "description": "Visible measure name or label"
564
507
  },
565
508
  "fieldKey": {
566
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
567
- "type": "string"
509
+ "type": "string",
510
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
568
511
  },
569
512
  "operator": {
570
- "description": "Filter operator that requires valueFrom and valueTo",
571
513
  "type": "string",
572
- "enum": ["isBetween", "isNotBetween"]
514
+ "enum": ["isBetween", "isNotBetween"],
515
+ "description": "Filter operator that requires valueFrom and valueTo"
573
516
  },
574
517
  "valueFrom": {
575
- "description": "Lower filter value",
576
518
  "anyOf": [
577
519
  {
578
520
  "type": "string"
@@ -591,10 +533,10 @@ Add another measure filter before aggregation. Keeps existing filters.
591
533
  "required": ["type", "variableName"],
592
534
  "additionalProperties": false
593
535
  }
594
- ]
536
+ ],
537
+ "description": "Lower filter value"
595
538
  },
596
539
  "valueTo": {
597
- "description": "Upper filter value",
598
540
  "anyOf": [
599
541
  {
600
542
  "type": "string"
@@ -613,7 +555,8 @@ Add another measure filter before aggregation. Keeps existing filters.
613
555
  "required": ["type", "variableName"],
614
556
  "additionalProperties": false
615
557
  }
616
- ]
558
+ ],
559
+ "description": "Upper filter value"
617
560
  }
618
561
  },
619
562
  "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
@@ -623,25 +566,25 @@ Add another measure filter before aggregation. Keeps existing filters.
623
566
  "type": "object",
624
567
  "properties": {
625
568
  "measureName": {
626
- "description": "Visible measure name or label",
627
- "type": "string"
569
+ "type": "string",
570
+ "description": "Visible measure name or label"
628
571
  },
629
572
  "fieldKey": {
630
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
631
- "type": "string"
573
+ "type": "string",
574
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
632
575
  },
633
576
  "operator": {
634
- "description": "Filter operator that requires a list of values",
635
577
  "type": "string",
636
- "enum": ["inList", "excludedFromList"]
578
+ "enum": ["inList", "excludedFromList"],
579
+ "description": "Filter operator that requires a list of values"
637
580
  },
638
581
  "values": {
639
- "description": "Filter values",
640
582
  "minItems": 1,
641
583
  "type": "array",
642
584
  "items": {
643
585
  "type": "string"
644
- }
586
+ },
587
+ "description": "Filter values"
645
588
  }
646
589
  },
647
590
  "required": ["measureName", "fieldKey", "operator", "values"],
@@ -651,23 +594,25 @@ Add another measure filter before aggregation. Keeps existing filters.
651
594
  "type": "object",
652
595
  "properties": {
653
596
  "measureName": {
654
- "description": "Visible measure name or label",
655
- "type": "string"
597
+ "type": "string",
598
+ "description": "Visible measure name or label"
656
599
  },
657
600
  "fieldKey": {
658
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
659
- "type": "string"
601
+ "type": "string",
602
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
660
603
  },
661
604
  "operator": {
662
- "description": "Filter operator that does not require values",
663
605
  "type": "string",
664
- "enum": ["isNull", "notNull"]
606
+ "enum": ["isNull", "notNull"],
607
+ "description": "Filter operator that does not require values"
665
608
  }
666
609
  },
667
610
  "required": ["measureName", "fieldKey", "operator"],
668
611
  "additionalProperties": false
669
612
  }
670
- ]
613
+ ],
614
+ "description": "Add another measure filter before aggregation. Keeps existing filters.",
615
+ "title": "Add measure filter schema"
671
616
  }
672
617
  ```
673
618
 
@@ -682,18 +627,15 @@ Add another result filter after aggregation. Keeps existing result filters.
682
627
  ```json
683
628
  {
684
629
  "$schema": "https://json-schema.org/draft/2020-12/schema",
685
- "description": "Add another result filter after aggregation. Keeps existing result filters.",
686
- "title": "Add result filter schema",
687
630
  "anyOf": [
688
631
  {
689
632
  "type": "object",
690
633
  "properties": {
691
634
  "measureName": {
692
- "description": "Visible measure name or label",
693
- "type": "string"
635
+ "type": "string",
636
+ "description": "Visible measure name or label"
694
637
  },
695
638
  "operator": {
696
- "description": "Filter operator that requires a value",
697
639
  "type": "string",
698
640
  "enum": [
699
641
  "equals",
@@ -708,10 +650,10 @@ Add another result filter after aggregation. Keeps existing result filters.
708
650
  "notLike",
709
651
  "startsWith",
710
652
  "endsWith"
711
- ]
653
+ ],
654
+ "description": "Filter operator that requires a value"
712
655
  },
713
656
  "value": {
714
- "description": "Filter value",
715
657
  "anyOf": [
716
658
  {
717
659
  "type": "string"
@@ -730,7 +672,8 @@ Add another result filter after aggregation. Keeps existing result filters.
730
672
  "required": ["type", "variableName"],
731
673
  "additionalProperties": false
732
674
  }
733
- ]
675
+ ],
676
+ "description": "Filter value"
734
677
  }
735
678
  },
736
679
  "required": ["measureName", "operator", "value"],
@@ -740,16 +683,15 @@ Add another result filter after aggregation. Keeps existing result filters.
740
683
  "type": "object",
741
684
  "properties": {
742
685
  "measureName": {
743
- "description": "Visible measure name or label",
744
- "type": "string"
686
+ "type": "string",
687
+ "description": "Visible measure name or label"
745
688
  },
746
689
  "operator": {
747
- "description": "Filter operator that requires valueFrom and valueTo",
748
690
  "type": "string",
749
- "enum": ["isBetween", "isNotBetween"]
691
+ "enum": ["isBetween", "isNotBetween"],
692
+ "description": "Filter operator that requires valueFrom and valueTo"
750
693
  },
751
694
  "valueFrom": {
752
- "description": "Lower filter value",
753
695
  "anyOf": [
754
696
  {
755
697
  "type": "string"
@@ -768,10 +710,10 @@ Add another result filter after aggregation. Keeps existing result filters.
768
710
  "required": ["type", "variableName"],
769
711
  "additionalProperties": false
770
712
  }
771
- ]
713
+ ],
714
+ "description": "Lower filter value"
772
715
  },
773
716
  "valueTo": {
774
- "description": "Upper filter value",
775
717
  "anyOf": [
776
718
  {
777
719
  "type": "string"
@@ -790,7 +732,8 @@ Add another result filter after aggregation. Keeps existing result filters.
790
732
  "required": ["type", "variableName"],
791
733
  "additionalProperties": false
792
734
  }
793
- ]
735
+ ],
736
+ "description": "Upper filter value"
794
737
  }
795
738
  },
796
739
  "required": ["measureName", "operator", "valueFrom", "valueTo"],
@@ -800,21 +743,21 @@ Add another result filter after aggregation. Keeps existing result filters.
800
743
  "type": "object",
801
744
  "properties": {
802
745
  "measureName": {
803
- "description": "Visible measure name or label",
804
- "type": "string"
746
+ "type": "string",
747
+ "description": "Visible measure name or label"
805
748
  },
806
749
  "operator": {
807
- "description": "Filter operator that requires a list of values",
808
750
  "type": "string",
809
- "enum": ["inList", "excludedFromList"]
751
+ "enum": ["inList", "excludedFromList"],
752
+ "description": "Filter operator that requires a list of values"
810
753
  },
811
754
  "values": {
812
- "description": "Filter values",
813
755
  "minItems": 1,
814
756
  "type": "array",
815
757
  "items": {
816
758
  "type": "string"
817
- }
759
+ },
760
+ "description": "Filter values"
818
761
  }
819
762
  },
820
763
  "required": ["measureName", "operator", "values"],
@@ -824,19 +767,21 @@ Add another result filter after aggregation. Keeps existing result filters.
824
767
  "type": "object",
825
768
  "properties": {
826
769
  "measureName": {
827
- "description": "Visible measure name or label",
828
- "type": "string"
770
+ "type": "string",
771
+ "description": "Visible measure name or label"
829
772
  },
830
773
  "operator": {
831
- "description": "Filter operator that does not require values",
832
774
  "type": "string",
833
- "enum": ["isNull", "notNull"]
775
+ "enum": ["isNull", "notNull"],
776
+ "description": "Filter operator that does not require values"
834
777
  }
835
778
  },
836
779
  "required": ["measureName", "operator"],
837
780
  "additionalProperties": false
838
781
  }
839
- ]
782
+ ],
783
+ "description": "Add another result filter after aggregation. Keeps existing result filters.",
784
+ "title": "Add result filter schema"
840
785
  }
841
786
  ```
842
787
 
@@ -851,25 +796,25 @@ Change how a measure is aggregated
851
796
  ```json
852
797
  {
853
798
  "$schema": "https://json-schema.org/draft/2020-12/schema",
854
- "title": "Change measure aggregation schema",
855
799
  "type": "object",
856
800
  "properties": {
857
801
  "dataItemInternalKey": {
858
- "description": "Internal key of the data item of the measure to be updated",
859
- "type": "string"
802
+ "type": "string",
803
+ "description": "Internal key of the data item of the measure to be updated"
860
804
  },
861
805
  "dataItemUniqueSignature": {
862
- "description": "Unique signature of the data item of the measure to be updated",
863
- "type": "string"
806
+ "type": "string",
807
+ "description": "Unique signature of the data item of the measure to be updated"
864
808
  },
865
809
  "aggregation": {
866
- "description": "Aggregation function to be used for the measure",
867
810
  "type": "string",
868
- "minLength": 1
811
+ "minLength": 1,
812
+ "description": "Aggregation function to be used for the measure"
869
813
  }
870
814
  },
871
815
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
872
- "additionalProperties": false
816
+ "additionalProperties": false,
817
+ "title": "Change measure aggregation schema"
873
818
  }
874
819
  ```
875
820
 
@@ -884,21 +829,21 @@ Clear measure filters before aggregation. Use fieldKey for one field; omit it fo
884
829
  ```json
885
830
  {
886
831
  "$schema": "https://json-schema.org/draft/2020-12/schema",
887
- "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
888
- "title": "Clear measure filter schema",
889
832
  "type": "object",
890
833
  "properties": {
891
834
  "measureName": {
892
- "description": "Visible measure name or label",
893
- "type": "string"
835
+ "type": "string",
836
+ "description": "Visible measure name or label"
894
837
  },
895
838
  "fieldKey": {
896
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label. Omit to clear all filters on the measure.",
897
- "type": "string"
839
+ "type": "string",
840
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label. Omit to clear all filters on the measure."
898
841
  }
899
842
  },
900
843
  "required": ["measureName"],
901
- "additionalProperties": false
844
+ "additionalProperties": false,
845
+ "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
846
+ "title": "Clear measure filter schema"
902
847
  }
903
848
  ```
904
849
 
@@ -913,17 +858,17 @@ Clear all result filters for one measure.
913
858
  ```json
914
859
  {
915
860
  "$schema": "https://json-schema.org/draft/2020-12/schema",
916
- "description": "Clear all result filters for one measure.",
917
- "title": "Clear result filter schema",
918
861
  "type": "object",
919
862
  "properties": {
920
863
  "measureName": {
921
- "description": "Visible measure name or label",
922
- "type": "string"
864
+ "type": "string",
865
+ "description": "Visible measure name or label"
923
866
  }
924
867
  },
925
868
  "required": ["measureName"],
926
- "additionalProperties": false
869
+ "additionalProperties": false,
870
+ "description": "Clear all result filters for one measure.",
871
+ "title": "Clear result filter schema"
927
872
  }
928
873
  ```
929
874
 
@@ -938,20 +883,20 @@ Create a copy of an existing dimension
938
883
  ```json
939
884
  {
940
885
  "$schema": "https://json-schema.org/draft/2020-12/schema",
941
- "title": "Duplicate dimension schema",
942
886
  "type": "object",
943
887
  "properties": {
944
888
  "dataItemInternalKey": {
945
- "description": "Internal key of the data item of the dimension to be duplicated",
946
- "type": "string"
889
+ "type": "string",
890
+ "description": "Internal key of the data item of the dimension to be duplicated"
947
891
  },
948
892
  "dataItemUniqueSignature": {
949
- "description": "Unique signature of the data item of the dimension to be duplicated",
950
- "type": "string"
893
+ "type": "string",
894
+ "description": "Unique signature of the data item of the dimension to be duplicated"
951
895
  }
952
896
  },
953
897
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
954
- "additionalProperties": false
898
+ "additionalProperties": false,
899
+ "title": "Duplicate dimension schema"
955
900
  }
956
901
  ```
957
902
 
@@ -966,20 +911,20 @@ Create a copy of an existing measure
966
911
  ```json
967
912
  {
968
913
  "$schema": "https://json-schema.org/draft/2020-12/schema",
969
- "title": "Duplicate measure schema",
970
914
  "type": "object",
971
915
  "properties": {
972
916
  "dataItemInternalKey": {
973
- "description": "Internal key of the data item of the measure to be duplicated",
974
- "type": "string"
917
+ "type": "string",
918
+ "description": "Internal key of the data item of the measure to be duplicated"
975
919
  },
976
920
  "dataItemUniqueSignature": {
977
- "description": "Unique signature of the data item of the measure to be duplicated",
978
- "type": "string"
921
+ "type": "string",
922
+ "description": "Unique signature of the data item of the measure to be duplicated"
979
923
  }
980
924
  },
981
925
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
982
- "additionalProperties": false
926
+ "additionalProperties": false,
927
+ "title": "Duplicate measure schema"
983
928
  }
984
929
  ```
985
930
 
@@ -994,18 +939,18 @@ Remove one value color by its position, as returned by getColoringOverwrites
994
939
  ```json
995
940
  {
996
941
  "$schema": "https://json-schema.org/draft/2020-12/schema",
997
- "title": "Remove coloring overwrite schema",
998
942
  "type": "object",
999
943
  "properties": {
1000
944
  "index": {
1001
- "description": "Zero-based position of the entry to remove",
1002
945
  "type": "integer",
1003
946
  "minimum": 0,
1004
- "maximum": 9007199254740991
947
+ "maximum": 9007199254740991,
948
+ "description": "Zero-based position of the entry to remove"
1005
949
  }
1006
950
  },
1007
951
  "required": ["index"],
1008
- "additionalProperties": false
952
+ "additionalProperties": false,
953
+ "title": "Remove coloring overwrite schema"
1009
954
  }
1010
955
  ```
1011
956
 
@@ -1020,18 +965,18 @@ Remove one measure color rule by its position, as returned by getColoringRules
1020
965
  ```json
1021
966
  {
1022
967
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1023
- "title": "Remove coloring rule schema",
1024
968
  "type": "object",
1025
969
  "properties": {
1026
970
  "index": {
1027
- "description": "Zero-based position of the entry to remove",
1028
971
  "type": "integer",
1029
972
  "minimum": 0,
1030
- "maximum": 9007199254740991
973
+ "maximum": 9007199254740991,
974
+ "description": "Zero-based position of the entry to remove"
1031
975
  }
1032
976
  },
1033
977
  "required": ["index"],
1034
- "additionalProperties": false
978
+ "additionalProperties": false,
979
+ "title": "Remove coloring rule schema"
1035
980
  }
1036
981
  ```
1037
982
 
@@ -1046,20 +991,20 @@ Remove a dimension from the chart
1046
991
  ```json
1047
992
  {
1048
993
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1049
- "title": "Remove dimension schema",
1050
994
  "type": "object",
1051
995
  "properties": {
1052
996
  "dataItemInternalKey": {
1053
- "description": "Internal key of the data item of the dimension to be removed",
1054
- "type": "string"
997
+ "type": "string",
998
+ "description": "Internal key of the data item of the dimension to be removed"
1055
999
  },
1056
1000
  "dataItemUniqueSignature": {
1057
- "description": "Unique signature of the data item of the dimension to be removed",
1058
- "type": "string"
1001
+ "type": "string",
1002
+ "description": "Unique signature of the data item of the dimension to be removed"
1059
1003
  }
1060
1004
  },
1061
1005
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1062
- "additionalProperties": false
1006
+ "additionalProperties": false,
1007
+ "title": "Remove dimension schema"
1063
1008
  }
1064
1009
  ```
1065
1010
 
@@ -1074,20 +1019,20 @@ Remove a measure from the chart
1074
1019
  ```json
1075
1020
  {
1076
1021
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1077
- "title": "Remove measure schema",
1078
1022
  "type": "object",
1079
1023
  "properties": {
1080
1024
  "dataItemInternalKey": {
1081
- "description": "Internal key of the data item of the measure to be removed",
1082
- "type": "string"
1025
+ "type": "string",
1026
+ "description": "Internal key of the data item of the measure to be removed"
1083
1027
  },
1084
1028
  "dataItemUniqueSignature": {
1085
- "description": "Unique signature of the data item of the measure to be removed",
1086
- "type": "string"
1029
+ "type": "string",
1030
+ "description": "Unique signature of the data item of the measure to be removed"
1087
1031
  }
1088
1032
  },
1089
1033
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1090
- "additionalProperties": false
1034
+ "additionalProperties": false,
1035
+ "title": "Remove measure schema"
1091
1036
  }
1092
1037
  ```
1093
1038
 
@@ -1102,10 +1047,10 @@ Reset the chart palette back to the workbook theme default
1102
1047
  ```json
1103
1048
  {
1104
1049
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1105
- "title": "Reset chart palette schema",
1106
1050
  "type": "object",
1107
1051
  "properties": {},
1108
- "additionalProperties": false
1052
+ "additionalProperties": false,
1053
+ "title": "Reset chart palette schema"
1109
1054
  }
1110
1055
  ```
1111
1056
 
@@ -1120,9 +1065,9 @@ Apply an existing palette using a built-in palette name or a theme palette label
1120
1065
  ```json
1121
1066
  {
1122
1067
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1123
- "title": "Chart palette schema",
1124
1068
  "type": "string",
1125
- "minLength": 1
1069
+ "minLength": 1,
1070
+ "title": "Chart palette schema"
1126
1071
  }
1127
1072
  ```
1128
1073
 
@@ -1137,9 +1082,25 @@ Set the single color used by the chart
1137
1082
  ```json
1138
1083
  {
1139
1084
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1140
- "title": "Coloring color schema",
1141
1085
  "type": "string",
1142
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1086
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1087
+ "title": "Coloring color schema"
1088
+ }
1089
+ ```
1090
+
1091
+ ## `setColoringGradientAuto`
1092
+
1093
+ Automatic gradient limits
1094
+
1095
+ Enable automatic gradient limits from the data, or disable Auto to use the stored limits. Preserves stored minimum and maximum values
1096
+
1097
+ **Payload schema**
1098
+
1099
+ ```json
1100
+ {
1101
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1102
+ "type": "boolean",
1103
+ "title": "Coloring gradient auto schema"
1143
1104
  }
1144
1105
  ```
1145
1106
 
@@ -1147,16 +1108,33 @@ Set the single color used by the chart
1147
1108
 
1148
1109
  Gradient maximum
1149
1110
 
1150
- Set the maximum value of the gradient domain
1111
+ Set the maximum value of the gradient domain using a number or variable. Applies when setColoringGradientAuto is false
1151
1112
 
1152
1113
  **Payload schema**
1153
1114
 
1154
1115
  ```json
1155
1116
  {
1156
1117
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1157
- "description": "Maximum value for gradient",
1158
- "title": "Coloring gradient maximum schema",
1159
- "type": "number"
1118
+ "anyOf": [
1119
+ {
1120
+ "type": "number"
1121
+ },
1122
+ {
1123
+ "type": "object",
1124
+ "properties": {
1125
+ "type": {
1126
+ "type": "string",
1127
+ "const": "variable"
1128
+ },
1129
+ "variableName": {
1130
+ "type": "string"
1131
+ }
1132
+ },
1133
+ "required": ["type", "variableName"],
1134
+ "additionalProperties": false
1135
+ }
1136
+ ],
1137
+ "title": "Coloring gradient maximum schema"
1160
1138
  }
1161
1139
  ```
1162
1140
 
@@ -1164,16 +1142,33 @@ Set the maximum value of the gradient domain
1164
1142
 
1165
1143
  Gradient minimum
1166
1144
 
1167
- Set the minimum value of the gradient domain
1145
+ Set the minimum value of the gradient domain using a number or variable. Applies when setColoringGradientAuto is false
1168
1146
 
1169
1147
  **Payload schema**
1170
1148
 
1171
1149
  ```json
1172
1150
  {
1173
1151
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1174
- "description": "Minimum value for gradient",
1175
- "title": "Coloring gradient minimum schema",
1176
- "type": "number"
1152
+ "anyOf": [
1153
+ {
1154
+ "type": "number"
1155
+ },
1156
+ {
1157
+ "type": "object",
1158
+ "properties": {
1159
+ "type": {
1160
+ "type": "string",
1161
+ "const": "variable"
1162
+ },
1163
+ "variableName": {
1164
+ "type": "string"
1165
+ }
1166
+ },
1167
+ "required": ["type", "variableName"],
1168
+ "additionalProperties": false
1169
+ }
1170
+ ],
1171
+ "title": "Coloring gradient minimum schema"
1177
1172
  }
1178
1173
  ```
1179
1174
 
@@ -1188,11 +1183,9 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1188
1183
  ```json
1189
1184
  {
1190
1185
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1191
- "title": "Set coloring overwrites schema",
1192
1186
  "type": "object",
1193
1187
  "properties": {
1194
1188
  "overwrites": {
1195
- "description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all",
1196
1189
  "type": "array",
1197
1190
  "items": {
1198
1191
  "anyOf": [
@@ -1204,21 +1197,21 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1204
1197
  "type": "object",
1205
1198
  "properties": {
1206
1199
  "dataItemInternalKey": {
1207
- "description": "Internal key of the data item of the dimension to be updated",
1208
- "type": "string"
1200
+ "type": "string",
1201
+ "description": "Internal key of the data item of the dimension to be updated"
1209
1202
  },
1210
1203
  "dataItemUniqueSignature": {
1211
- "description": "Unique signature of the data item of the dimension to be updated",
1212
- "type": "string"
1204
+ "type": "string",
1205
+ "description": "Unique signature of the data item of the dimension to be updated"
1213
1206
  }
1214
1207
  },
1215
1208
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1216
1209
  "additionalProperties": false
1217
1210
  },
1218
1211
  "color": {
1219
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1220
1212
  "type": "string",
1221
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1213
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1214
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1222
1215
  },
1223
1216
  "operator": {
1224
1217
  "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
@@ -1236,14 +1229,7 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1236
1229
  },
1237
1230
  "value": {
1238
1231
  "description": "Value to compare against",
1239
- "anyOf": [
1240
- {
1241
- "type": "string"
1242
- },
1243
- {
1244
- "type": "number"
1245
- }
1246
- ]
1232
+ "type": ["string", "number"]
1247
1233
  }
1248
1234
  },
1249
1235
  "required": ["color", "value"],
@@ -1257,48 +1243,34 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1257
1243
  "type": "object",
1258
1244
  "properties": {
1259
1245
  "dataItemInternalKey": {
1260
- "description": "Internal key of the data item of the dimension to be updated",
1261
- "type": "string"
1246
+ "type": "string",
1247
+ "description": "Internal key of the data item of the dimension to be updated"
1262
1248
  },
1263
1249
  "dataItemUniqueSignature": {
1264
- "description": "Unique signature of the data item of the dimension to be updated",
1265
- "type": "string"
1250
+ "type": "string",
1251
+ "description": "Unique signature of the data item of the dimension to be updated"
1266
1252
  }
1267
1253
  },
1268
1254
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1269
1255
  "additionalProperties": false
1270
1256
  },
1271
1257
  "color": {
1272
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1273
1258
  "type": "string",
1274
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1259
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1260
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1275
1261
  },
1276
1262
  "operator": {
1277
- "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)",
1278
1263
  "type": "string",
1279
- "const": "between"
1264
+ "const": "between",
1265
+ "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)"
1280
1266
  },
1281
1267
  "value": {
1282
1268
  "description": "Lower bound of the range",
1283
- "anyOf": [
1284
- {
1285
- "type": "string"
1286
- },
1287
- {
1288
- "type": "number"
1289
- }
1290
- ]
1269
+ "type": ["string", "number"]
1291
1270
  },
1292
1271
  "secondValue": {
1293
1272
  "description": "Upper bound of the range",
1294
- "anyOf": [
1295
- {
1296
- "type": "string"
1297
- },
1298
- {
1299
- "type": "number"
1300
- }
1301
- ]
1273
+ "type": ["string", "number"]
1302
1274
  }
1303
1275
  },
1304
1276
  "required": ["color", "operator", "value", "secondValue"],
@@ -1312,41 +1284,34 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1312
1284
  "type": "object",
1313
1285
  "properties": {
1314
1286
  "dataItemInternalKey": {
1315
- "description": "Internal key of the data item of the dimension to be updated",
1316
- "type": "string"
1287
+ "type": "string",
1288
+ "description": "Internal key of the data item of the dimension to be updated"
1317
1289
  },
1318
1290
  "dataItemUniqueSignature": {
1319
- "description": "Unique signature of the data item of the dimension to be updated",
1320
- "type": "string"
1291
+ "type": "string",
1292
+ "description": "Unique signature of the data item of the dimension to be updated"
1321
1293
  }
1322
1294
  },
1323
1295
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1324
1296
  "additionalProperties": false
1325
1297
  },
1326
1298
  "color": {
1327
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1328
1299
  "type": "string",
1329
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1300
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1301
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1330
1302
  },
1331
1303
  "operator": {
1332
- "description": "Match (inList) or exclude (notInList) every value in values",
1333
1304
  "type": "string",
1334
- "enum": ["inList", "notInList"]
1305
+ "enum": ["inList", "notInList"],
1306
+ "description": "Match (inList) or exclude (notInList) every value in values"
1335
1307
  },
1336
1308
  "values": {
1337
- "description": "Values to match",
1338
1309
  "minItems": 1,
1339
1310
  "type": "array",
1340
1311
  "items": {
1341
- "anyOf": [
1342
- {
1343
- "type": "string"
1344
- },
1345
- {
1346
- "type": "number"
1347
- }
1348
- ]
1349
- }
1312
+ "type": ["string", "number"]
1313
+ },
1314
+ "description": "Values to match"
1350
1315
  },
1351
1316
  "delimiter": {
1352
1317
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -1358,11 +1323,13 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1358
1323
  "additionalProperties": false
1359
1324
  }
1360
1325
  ]
1361
- }
1326
+ },
1327
+ "description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all"
1362
1328
  }
1363
1329
  },
1364
1330
  "required": ["overwrites"],
1365
- "additionalProperties": false
1331
+ "additionalProperties": false,
1332
+ "title": "Set coloring overwrites schema"
1366
1333
  }
1367
1334
  ```
1368
1335
 
@@ -1394,11 +1361,9 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1394
1361
  ```json
1395
1362
  {
1396
1363
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1397
- "title": "Set coloring rules schema",
1398
1364
  "type": "object",
1399
1365
  "properties": {
1400
1366
  "rules": {
1401
- "description": "Ordered list of measure color rules; the first matching rule wins. An empty list removes them all",
1402
1367
  "type": "array",
1403
1368
  "items": {
1404
1369
  "anyOf": [
@@ -1406,41 +1371,34 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1406
1371
  "type": "object",
1407
1372
  "properties": {
1408
1373
  "measure": {
1409
- "description": "Measure whose value is compared",
1410
1374
  "type": "object",
1411
1375
  "properties": {
1412
1376
  "dataItemInternalKey": {
1413
- "description": "Internal key of the data item of the measure to be updated",
1414
- "type": "string"
1377
+ "type": "string",
1378
+ "description": "Internal key of the data item of the measure to be updated"
1415
1379
  },
1416
1380
  "dataItemUniqueSignature": {
1417
- "description": "Unique signature of the data item of the measure to be updated",
1418
- "type": "string"
1381
+ "type": "string",
1382
+ "description": "Unique signature of the data item of the measure to be updated"
1419
1383
  }
1420
1384
  },
1421
1385
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1422
- "additionalProperties": false
1386
+ "additionalProperties": false,
1387
+ "description": "Measure whose value is compared"
1423
1388
  },
1424
1389
  "color": {
1425
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1426
1390
  "type": "string",
1427
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1391
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1392
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1428
1393
  },
1429
1394
  "operator": {
1430
- "description": "How the measure value is compared",
1431
1395
  "type": "string",
1432
- "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"]
1396
+ "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"],
1397
+ "description": "How the measure value is compared"
1433
1398
  },
1434
1399
  "value": {
1435
1400
  "description": "Value to compare against",
1436
- "anyOf": [
1437
- {
1438
- "type": "string"
1439
- },
1440
- {
1441
- "type": "number"
1442
- }
1443
- ]
1401
+ "type": ["string", "number"]
1444
1402
  }
1445
1403
  },
1446
1404
  "required": ["measure", "color", "operator", "value"],
@@ -1450,52 +1408,38 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1450
1408
  "type": "object",
1451
1409
  "properties": {
1452
1410
  "measure": {
1453
- "description": "Measure whose value is compared",
1454
1411
  "type": "object",
1455
1412
  "properties": {
1456
1413
  "dataItemInternalKey": {
1457
- "description": "Internal key of the data item of the measure to be updated",
1458
- "type": "string"
1414
+ "type": "string",
1415
+ "description": "Internal key of the data item of the measure to be updated"
1459
1416
  },
1460
1417
  "dataItemUniqueSignature": {
1461
- "description": "Unique signature of the data item of the measure to be updated",
1462
- "type": "string"
1418
+ "type": "string",
1419
+ "description": "Unique signature of the data item of the measure to be updated"
1463
1420
  }
1464
1421
  },
1465
1422
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1466
- "additionalProperties": false
1423
+ "additionalProperties": false,
1424
+ "description": "Measure whose value is compared"
1467
1425
  },
1468
1426
  "color": {
1469
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1470
1427
  "type": "string",
1471
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1428
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1429
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1472
1430
  },
1473
1431
  "operator": {
1474
- "description": "Matches measure values from value to secondValue, both inclusive",
1475
1432
  "type": "string",
1476
- "const": "between"
1433
+ "const": "between",
1434
+ "description": "Matches measure values from value to secondValue, both inclusive"
1477
1435
  },
1478
1436
  "value": {
1479
1437
  "description": "Lower bound of the range",
1480
- "anyOf": [
1481
- {
1482
- "type": "string"
1483
- },
1484
- {
1485
- "type": "number"
1486
- }
1487
- ]
1438
+ "type": ["string", "number"]
1488
1439
  },
1489
1440
  "secondValue": {
1490
1441
  "description": "Upper bound of the range",
1491
- "anyOf": [
1492
- {
1493
- "type": "string"
1494
- },
1495
- {
1496
- "type": "number"
1497
- }
1498
- ]
1442
+ "type": ["string", "number"]
1499
1443
  }
1500
1444
  },
1501
1445
  "required": ["measure", "color", "operator", "value", "secondValue"],
@@ -1505,45 +1449,38 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1505
1449
  "type": "object",
1506
1450
  "properties": {
1507
1451
  "measure": {
1508
- "description": "Measure whose value is compared",
1509
1452
  "type": "object",
1510
1453
  "properties": {
1511
1454
  "dataItemInternalKey": {
1512
- "description": "Internal key of the data item of the measure to be updated",
1513
- "type": "string"
1455
+ "type": "string",
1456
+ "description": "Internal key of the data item of the measure to be updated"
1514
1457
  },
1515
1458
  "dataItemUniqueSignature": {
1516
- "description": "Unique signature of the data item of the measure to be updated",
1517
- "type": "string"
1459
+ "type": "string",
1460
+ "description": "Unique signature of the data item of the measure to be updated"
1518
1461
  }
1519
1462
  },
1520
1463
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1521
- "additionalProperties": false
1464
+ "additionalProperties": false,
1465
+ "description": "Measure whose value is compared"
1522
1466
  },
1523
1467
  "color": {
1524
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1525
1468
  "type": "string",
1526
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1469
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1470
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1527
1471
  },
1528
1472
  "operator": {
1529
- "description": "Match (inList) or exclude (notInList) every value in values",
1530
1473
  "type": "string",
1531
- "enum": ["inList", "notInList"]
1474
+ "enum": ["inList", "notInList"],
1475
+ "description": "Match (inList) or exclude (notInList) every value in values"
1532
1476
  },
1533
1477
  "values": {
1534
- "description": "Values to match",
1535
1478
  "minItems": 1,
1536
1479
  "type": "array",
1537
1480
  "items": {
1538
- "anyOf": [
1539
- {
1540
- "type": "string"
1541
- },
1542
- {
1543
- "type": "number"
1544
- }
1545
- ]
1546
- }
1481
+ "type": ["string", "number"]
1482
+ },
1483
+ "description": "Values to match"
1547
1484
  },
1548
1485
  "delimiter": {
1549
1486
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -1555,11 +1492,13 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1555
1492
  "additionalProperties": false
1556
1493
  }
1557
1494
  ]
1558
- }
1495
+ },
1496
+ "description": "Ordered list of measure color rules; the first matching rule wins. An empty list removes them all"
1559
1497
  }
1560
1498
  },
1561
1499
  "required": ["rules"],
1562
- "additionalProperties": false
1500
+ "additionalProperties": false,
1501
+ "title": "Set coloring rules schema"
1563
1502
  }
1564
1503
  ```
1565
1504
 
@@ -1574,9 +1513,9 @@ Set how colors are applied to the chart
1574
1513
  ```json
1575
1514
  {
1576
1515
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1577
- "title": "Coloring type schema",
1578
1516
  "type": "string",
1579
- "enum": ["single", "categorical", "gradient"]
1517
+ "enum": ["single", "categorical", "gradient"],
1518
+ "title": "Coloring type schema"
1580
1519
  }
1581
1520
  ```
1582
1521
 
@@ -1591,7 +1530,6 @@ Replace the whole custom gradient with a provided list of colors
1591
1530
  ```json
1592
1531
  {
1593
1532
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1594
- "title": "Custom gradient colors schema",
1595
1533
  "type": "object",
1596
1534
  "properties": {
1597
1535
  "colors": {
@@ -1604,7 +1542,8 @@ Replace the whole custom gradient with a provided list of colors
1604
1542
  }
1605
1543
  },
1606
1544
  "required": ["colors"],
1607
- "additionalProperties": false
1545
+ "additionalProperties": false,
1546
+ "title": "Custom gradient colors schema"
1608
1547
  }
1609
1548
  ```
1610
1549
 
@@ -1619,7 +1558,6 @@ Replace the whole custom categorical palette with a provided list of colors and
1619
1558
  ```json
1620
1559
  {
1621
1560
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1622
- "title": "Custom palette colors schema",
1623
1561
  "type": "object",
1624
1562
  "properties": {
1625
1563
  "colors": {
@@ -1632,7 +1570,8 @@ Replace the whole custom categorical palette with a provided list of colors and
1632
1570
  }
1633
1571
  },
1634
1572
  "required": ["colors"],
1635
- "additionalProperties": false
1573
+ "additionalProperties": false,
1574
+ "title": "Custom palette colors schema"
1636
1575
  }
1637
1576
  ```
1638
1577
 
@@ -1647,16 +1586,15 @@ Set the custom display format string for a dimension. This changes label formatt
1647
1586
  ```json
1648
1587
  {
1649
1588
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1650
- "title": "Dimension format string schema",
1651
1589
  "type": "object",
1652
1590
  "properties": {
1653
1591
  "dataItemInternalKey": {
1654
- "description": "Internal key of the data item of the dimension to be updated",
1655
- "type": "string"
1592
+ "type": "string",
1593
+ "description": "Internal key of the data item of the dimension to be updated"
1656
1594
  },
1657
1595
  "dataItemUniqueSignature": {
1658
- "description": "Unique signature of the data item of the dimension to be updated",
1659
- "type": "string"
1596
+ "type": "string",
1597
+ "description": "Unique signature of the data item of the dimension to be updated"
1660
1598
  },
1661
1599
  "formatString": {
1662
1600
  "anyOf": [
@@ -1681,7 +1619,8 @@ Set the custom display format string for a dimension. This changes label formatt
1681
1619
  }
1682
1620
  },
1683
1621
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1684
- "additionalProperties": false
1622
+ "additionalProperties": false,
1623
+ "title": "Dimension format string schema"
1685
1624
  }
1686
1625
  ```
1687
1626
 
@@ -1696,16 +1635,15 @@ Set the display format type used by a dimension. This changes label formatting o
1696
1635
  ```json
1697
1636
  {
1698
1637
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1699
- "title": "Dimension format type schema",
1700
1638
  "type": "object",
1701
1639
  "properties": {
1702
1640
  "dataItemInternalKey": {
1703
- "description": "Internal key of the data item of the dimension to be updated",
1704
- "type": "string"
1641
+ "type": "string",
1642
+ "description": "Internal key of the data item of the dimension to be updated"
1705
1643
  },
1706
1644
  "dataItemUniqueSignature": {
1707
- "description": "Unique signature of the data item of the dimension to be updated",
1708
- "type": "string"
1645
+ "type": "string",
1646
+ "description": "Unique signature of the data item of the dimension to be updated"
1709
1647
  },
1710
1648
  "formatType": {
1711
1649
  "anyOf": [
@@ -1800,7 +1738,8 @@ Set the display format type used by a dimension. This changes label formatting o
1800
1738
  }
1801
1739
  },
1802
1740
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
1803
- "additionalProperties": false
1741
+ "additionalProperties": false,
1742
+ "title": "Dimension format type schema"
1804
1743
  }
1805
1744
  ```
1806
1745
 
@@ -1815,18 +1754,17 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
1815
1754
  ```json
1816
1755
  {
1817
1756
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1818
- "title": "Dimension temporal grouping schema",
1819
- "anyOf": [
1757
+ "oneOf": [
1820
1758
  {
1821
1759
  "type": "object",
1822
1760
  "properties": {
1823
1761
  "dataItemInternalKey": {
1824
- "description": "Internal key of the data item of the dimension to be updated",
1825
- "type": "string"
1762
+ "type": "string",
1763
+ "description": "Internal key of the data item of the dimension to be updated"
1826
1764
  },
1827
1765
  "dataItemUniqueSignature": {
1828
- "description": "Unique signature of the data item of the dimension to be updated",
1829
- "type": "string"
1766
+ "type": "string",
1767
+ "description": "Unique signature of the data item of the dimension to be updated"
1830
1768
  },
1831
1769
  "mode": {
1832
1770
  "type": "string",
@@ -1840,12 +1778,12 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
1840
1778
  "type": "object",
1841
1779
  "properties": {
1842
1780
  "dataItemInternalKey": {
1843
- "description": "Internal key of the data item of the dimension to be updated",
1844
- "type": "string"
1781
+ "type": "string",
1782
+ "description": "Internal key of the data item of the dimension to be updated"
1845
1783
  },
1846
1784
  "dataItemUniqueSignature": {
1847
- "description": "Unique signature of the data item of the dimension to be updated",
1848
- "type": "string"
1785
+ "type": "string",
1786
+ "description": "Unique signature of the data item of the dimension to be updated"
1849
1787
  },
1850
1788
  "mode": {
1851
1789
  "type": "string",
@@ -1876,12 +1814,12 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
1876
1814
  "type": "object",
1877
1815
  "properties": {
1878
1816
  "dataItemInternalKey": {
1879
- "description": "Internal key of the data item of the dimension to be updated",
1880
- "type": "string"
1817
+ "type": "string",
1818
+ "description": "Internal key of the data item of the dimension to be updated"
1881
1819
  },
1882
1820
  "dataItemUniqueSignature": {
1883
- "description": "Unique signature of the data item of the dimension to be updated",
1884
- "type": "string"
1821
+ "type": "string",
1822
+ "description": "Unique signature of the data item of the dimension to be updated"
1885
1823
  },
1886
1824
  "mode": {
1887
1825
  "type": "string",
@@ -1907,7 +1845,8 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
1907
1845
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
1908
1846
  "additionalProperties": false
1909
1847
  }
1910
- ]
1848
+ ],
1849
+ "title": "Dimension temporal grouping schema"
1911
1850
  }
1912
1851
  ```
1913
1852
 
@@ -1922,23 +1861,23 @@ Set the currency symbol used by a measure formatter
1922
1861
  ```json
1923
1862
  {
1924
1863
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1925
- "title": "Measure currency schema",
1926
1864
  "type": "object",
1927
1865
  "properties": {
1928
1866
  "dataItemInternalKey": {
1929
- "description": "Internal key of the data item of the measure to be updated",
1930
- "type": "string"
1867
+ "type": "string",
1868
+ "description": "Internal key of the data item of the measure to be updated"
1931
1869
  },
1932
1870
  "dataItemUniqueSignature": {
1933
- "description": "Unique signature of the data item of the measure to be updated",
1934
- "type": "string"
1871
+ "type": "string",
1872
+ "description": "Unique signature of the data item of the measure to be updated"
1935
1873
  },
1936
1874
  "currency": {
1937
1875
  "type": "string"
1938
1876
  }
1939
1877
  },
1940
1878
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1941
- "additionalProperties": false
1879
+ "additionalProperties": false,
1880
+ "title": "Measure currency schema"
1942
1881
  }
1943
1882
  ```
1944
1883
 
@@ -1953,23 +1892,23 @@ Set whether measure currency symbol is prefixed
1953
1892
  ```json
1954
1893
  {
1955
1894
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1956
- "title": "Measure currency is prefix schema",
1957
1895
  "type": "object",
1958
1896
  "properties": {
1959
1897
  "dataItemInternalKey": {
1960
- "description": "Internal key of the data item of the measure to be updated",
1961
- "type": "string"
1898
+ "type": "string",
1899
+ "description": "Internal key of the data item of the measure to be updated"
1962
1900
  },
1963
1901
  "dataItemUniqueSignature": {
1964
- "description": "Unique signature of the data item of the measure to be updated",
1965
- "type": "string"
1902
+ "type": "string",
1903
+ "description": "Unique signature of the data item of the measure to be updated"
1966
1904
  },
1967
1905
  "currencyIsPrefix": {
1968
1906
  "type": "boolean"
1969
1907
  }
1970
1908
  },
1971
1909
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1972
- "additionalProperties": false
1910
+ "additionalProperties": false,
1911
+ "title": "Measure currency is prefix schema"
1973
1912
  }
1974
1913
  ```
1975
1914
 
@@ -1984,16 +1923,15 @@ Configure a Defined parameter of a custom measure using its default, a static va
1984
1923
  ```json
1985
1924
  {
1986
1925
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1987
- "title": "Set measure defined parameter schema",
1988
1926
  "type": "object",
1989
1927
  "properties": {
1990
1928
  "dataItemInternalKey": {
1991
- "description": "Internal key of the data item of the measure to be updated",
1992
- "type": "string"
1929
+ "type": "string",
1930
+ "description": "Internal key of the data item of the measure to be updated"
1993
1931
  },
1994
1932
  "dataItemUniqueSignature": {
1995
- "description": "Unique signature of the data item of the measure to be updated",
1996
- "type": "string"
1933
+ "type": "string",
1934
+ "description": "Unique signature of the data item of the measure to be updated"
1997
1935
  },
1998
1936
  "collectionKey": {
1999
1937
  "description": "Measure collection to update. Defaults to primary measures.",
@@ -2001,13 +1939,12 @@ Configure a Defined parameter of a custom measure using its default, a static va
2001
1939
  "enum": ["measures", "supportingMeasures"]
2002
1940
  },
2003
1941
  "parameterName": {
2004
- "description": "Exact name of a Defined parameter exposed by the measure",
2005
1942
  "type": "string",
2006
- "minLength": 1
1943
+ "minLength": 1,
1944
+ "description": "Exact name of a Defined parameter exposed by the measure"
2007
1945
  },
2008
1946
  "value": {
2009
- "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
2010
- "anyOf": [
1947
+ "oneOf": [
2011
1948
  {
2012
1949
  "type": "object",
2013
1950
  "properties": {
@@ -2027,17 +1964,7 @@ Configure a Defined parameter of a custom measure using its default, a static va
2027
1964
  "const": "static"
2028
1965
  },
2029
1966
  "value": {
2030
- "anyOf": [
2031
- {
2032
- "type": "string"
2033
- },
2034
- {
2035
- "type": "number"
2036
- },
2037
- {
2038
- "type": "boolean"
2039
- }
2040
- ]
1967
+ "type": ["string", "number", "boolean"]
2041
1968
  }
2042
1969
  },
2043
1970
  "required": ["type", "value"],
@@ -2051,19 +1978,21 @@ Configure a Defined parameter of a custom measure using its default, a static va
2051
1978
  "const": "variable"
2052
1979
  },
2053
1980
  "variableName": {
2054
- "description": "Exact name of an existing compatible workbook variable",
2055
1981
  "type": "string",
2056
- "minLength": 1
1982
+ "minLength": 1,
1983
+ "description": "Exact name of an existing compatible workbook variable"
2057
1984
  }
2058
1985
  },
2059
1986
  "required": ["type", "variableName"],
2060
1987
  "additionalProperties": false
2061
1988
  }
2062
- ]
1989
+ ],
1990
+ "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable"
2063
1991
  }
2064
1992
  },
2065
1993
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
2066
- "additionalProperties": false
1994
+ "additionalProperties": false,
1995
+ "title": "Set measure defined parameter schema"
2067
1996
  }
2068
1997
  ```
2069
1998
 
@@ -2078,22 +2007,19 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2078
2007
  ```json
2079
2008
  {
2080
2009
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2081
- "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
2082
- "title": "Set measure filter schema",
2083
2010
  "anyOf": [
2084
2011
  {
2085
2012
  "type": "object",
2086
2013
  "properties": {
2087
2014
  "measureName": {
2088
- "description": "Visible measure name or label",
2089
- "type": "string"
2015
+ "type": "string",
2016
+ "description": "Visible measure name or label"
2090
2017
  },
2091
2018
  "fieldKey": {
2092
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2093
- "type": "string"
2019
+ "type": "string",
2020
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2094
2021
  },
2095
2022
  "operator": {
2096
- "description": "Filter operator that requires a value",
2097
2023
  "type": "string",
2098
2024
  "enum": [
2099
2025
  "equals",
@@ -2108,10 +2034,10 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2108
2034
  "notLike",
2109
2035
  "startsWith",
2110
2036
  "endsWith"
2111
- ]
2037
+ ],
2038
+ "description": "Filter operator that requires a value"
2112
2039
  },
2113
2040
  "value": {
2114
- "description": "Filter value",
2115
2041
  "anyOf": [
2116
2042
  {
2117
2043
  "type": "string"
@@ -2130,7 +2056,8 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2130
2056
  "required": ["type", "variableName"],
2131
2057
  "additionalProperties": false
2132
2058
  }
2133
- ]
2059
+ ],
2060
+ "description": "Filter value"
2134
2061
  }
2135
2062
  },
2136
2063
  "required": ["measureName", "fieldKey", "operator", "value"],
@@ -2140,20 +2067,19 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2140
2067
  "type": "object",
2141
2068
  "properties": {
2142
2069
  "measureName": {
2143
- "description": "Visible measure name or label",
2144
- "type": "string"
2070
+ "type": "string",
2071
+ "description": "Visible measure name or label"
2145
2072
  },
2146
2073
  "fieldKey": {
2147
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2148
- "type": "string"
2074
+ "type": "string",
2075
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2149
2076
  },
2150
2077
  "operator": {
2151
- "description": "Filter operator that requires valueFrom and valueTo",
2152
2078
  "type": "string",
2153
- "enum": ["isBetween", "isNotBetween"]
2079
+ "enum": ["isBetween", "isNotBetween"],
2080
+ "description": "Filter operator that requires valueFrom and valueTo"
2154
2081
  },
2155
2082
  "valueFrom": {
2156
- "description": "Lower filter value",
2157
2083
  "anyOf": [
2158
2084
  {
2159
2085
  "type": "string"
@@ -2172,10 +2098,10 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2172
2098
  "required": ["type", "variableName"],
2173
2099
  "additionalProperties": false
2174
2100
  }
2175
- ]
2101
+ ],
2102
+ "description": "Lower filter value"
2176
2103
  },
2177
2104
  "valueTo": {
2178
- "description": "Upper filter value",
2179
2105
  "anyOf": [
2180
2106
  {
2181
2107
  "type": "string"
@@ -2194,7 +2120,8 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2194
2120
  "required": ["type", "variableName"],
2195
2121
  "additionalProperties": false
2196
2122
  }
2197
- ]
2123
+ ],
2124
+ "description": "Upper filter value"
2198
2125
  }
2199
2126
  },
2200
2127
  "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
@@ -2204,25 +2131,25 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2204
2131
  "type": "object",
2205
2132
  "properties": {
2206
2133
  "measureName": {
2207
- "description": "Visible measure name or label",
2208
- "type": "string"
2134
+ "type": "string",
2135
+ "description": "Visible measure name or label"
2209
2136
  },
2210
2137
  "fieldKey": {
2211
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2212
- "type": "string"
2138
+ "type": "string",
2139
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2213
2140
  },
2214
2141
  "operator": {
2215
- "description": "Filter operator that requires a list of values",
2216
2142
  "type": "string",
2217
- "enum": ["inList", "excludedFromList"]
2143
+ "enum": ["inList", "excludedFromList"],
2144
+ "description": "Filter operator that requires a list of values"
2218
2145
  },
2219
2146
  "values": {
2220
- "description": "Filter values",
2221
2147
  "minItems": 1,
2222
2148
  "type": "array",
2223
2149
  "items": {
2224
2150
  "type": "string"
2225
- }
2151
+ },
2152
+ "description": "Filter values"
2226
2153
  }
2227
2154
  },
2228
2155
  "required": ["measureName", "fieldKey", "operator", "values"],
@@ -2232,23 +2159,25 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2232
2159
  "type": "object",
2233
2160
  "properties": {
2234
2161
  "measureName": {
2235
- "description": "Visible measure name or label",
2236
- "type": "string"
2162
+ "type": "string",
2163
+ "description": "Visible measure name or label"
2237
2164
  },
2238
2165
  "fieldKey": {
2239
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2240
- "type": "string"
2166
+ "type": "string",
2167
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2241
2168
  },
2242
2169
  "operator": {
2243
- "description": "Filter operator that does not require values",
2244
2170
  "type": "string",
2245
- "enum": ["isNull", "notNull"]
2171
+ "enum": ["isNull", "notNull"],
2172
+ "description": "Filter operator that does not require values"
2246
2173
  }
2247
2174
  },
2248
2175
  "required": ["measureName", "fieldKey", "operator"],
2249
2176
  "additionalProperties": false
2250
2177
  }
2251
- ]
2178
+ ],
2179
+ "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
2180
+ "title": "Set measure filter schema"
2252
2181
  }
2253
2182
  ```
2254
2183
 
@@ -2263,16 +2192,15 @@ Set the custom format string for a measure
2263
2192
  ```json
2264
2193
  {
2265
2194
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2266
- "title": "Measure format string schema",
2267
2195
  "type": "object",
2268
2196
  "properties": {
2269
2197
  "dataItemInternalKey": {
2270
- "description": "Internal key of the data item of the measure to be updated",
2271
- "type": "string"
2198
+ "type": "string",
2199
+ "description": "Internal key of the data item of the measure to be updated"
2272
2200
  },
2273
2201
  "dataItemUniqueSignature": {
2274
- "description": "Unique signature of the data item of the measure to be updated",
2275
- "type": "string"
2202
+ "type": "string",
2203
+ "description": "Unique signature of the data item of the measure to be updated"
2276
2204
  },
2277
2205
  "formatString": {
2278
2206
  "anyOf": [
@@ -2297,7 +2225,8 @@ Set the custom format string for a measure
2297
2225
  }
2298
2226
  },
2299
2227
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2300
- "additionalProperties": false
2228
+ "additionalProperties": false,
2229
+ "title": "Measure format string schema"
2301
2230
  }
2302
2231
  ```
2303
2232
 
@@ -2312,16 +2241,15 @@ Set the format type used by a measure
2312
2241
  ```json
2313
2242
  {
2314
2243
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2315
- "title": "Measure format type schema",
2316
2244
  "type": "object",
2317
2245
  "properties": {
2318
2246
  "dataItemInternalKey": {
2319
- "description": "Internal key of the data item of the measure to be updated",
2320
- "type": "string"
2247
+ "type": "string",
2248
+ "description": "Internal key of the data item of the measure to be updated"
2321
2249
  },
2322
2250
  "dataItemUniqueSignature": {
2323
- "description": "Unique signature of the data item of the measure to be updated",
2324
- "type": "string"
2251
+ "type": "string",
2252
+ "description": "Unique signature of the data item of the measure to be updated"
2325
2253
  },
2326
2254
  "formatType": {
2327
2255
  "anyOf": [
@@ -2416,7 +2344,8 @@ Set the format type used by a measure
2416
2344
  }
2417
2345
  },
2418
2346
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
2419
- "additionalProperties": false
2347
+ "additionalProperties": false,
2348
+ "title": "Measure format type schema"
2420
2349
  }
2421
2350
  ```
2422
2351
 
@@ -2431,16 +2360,15 @@ Set how negative values are displayed for a measure formatter
2431
2360
  ```json
2432
2361
  {
2433
2362
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2434
- "title": "Measure negative type schema",
2435
2363
  "type": "object",
2436
2364
  "properties": {
2437
2365
  "dataItemInternalKey": {
2438
- "description": "Internal key of the data item of the measure to be updated",
2439
- "type": "string"
2366
+ "type": "string",
2367
+ "description": "Internal key of the data item of the measure to be updated"
2440
2368
  },
2441
2369
  "dataItemUniqueSignature": {
2442
- "description": "Unique signature of the data item of the measure to be updated",
2443
- "type": "string"
2370
+ "type": "string",
2371
+ "description": "Unique signature of the data item of the measure to be updated"
2444
2372
  },
2445
2373
  "negativeType": {
2446
2374
  "type": "string",
@@ -2448,7 +2376,8 @@ Set how negative values are displayed for a measure formatter
2448
2376
  }
2449
2377
  },
2450
2378
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2451
- "additionalProperties": false
2379
+ "additionalProperties": false,
2380
+ "title": "Measure negative type schema"
2452
2381
  }
2453
2382
  ```
2454
2383
 
@@ -2463,18 +2392,15 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2463
2392
  ```json
2464
2393
  {
2465
2394
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2466
- "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
2467
- "title": "Set result filter schema",
2468
2395
  "anyOf": [
2469
2396
  {
2470
2397
  "type": "object",
2471
2398
  "properties": {
2472
2399
  "measureName": {
2473
- "description": "Visible measure name or label",
2474
- "type": "string"
2400
+ "type": "string",
2401
+ "description": "Visible measure name or label"
2475
2402
  },
2476
2403
  "operator": {
2477
- "description": "Filter operator that requires a value",
2478
2404
  "type": "string",
2479
2405
  "enum": [
2480
2406
  "equals",
@@ -2489,10 +2415,10 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2489
2415
  "notLike",
2490
2416
  "startsWith",
2491
2417
  "endsWith"
2492
- ]
2418
+ ],
2419
+ "description": "Filter operator that requires a value"
2493
2420
  },
2494
2421
  "value": {
2495
- "description": "Filter value",
2496
2422
  "anyOf": [
2497
2423
  {
2498
2424
  "type": "string"
@@ -2511,7 +2437,8 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2511
2437
  "required": ["type", "variableName"],
2512
2438
  "additionalProperties": false
2513
2439
  }
2514
- ]
2440
+ ],
2441
+ "description": "Filter value"
2515
2442
  }
2516
2443
  },
2517
2444
  "required": ["measureName", "operator", "value"],
@@ -2521,16 +2448,15 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2521
2448
  "type": "object",
2522
2449
  "properties": {
2523
2450
  "measureName": {
2524
- "description": "Visible measure name or label",
2525
- "type": "string"
2451
+ "type": "string",
2452
+ "description": "Visible measure name or label"
2526
2453
  },
2527
2454
  "operator": {
2528
- "description": "Filter operator that requires valueFrom and valueTo",
2529
2455
  "type": "string",
2530
- "enum": ["isBetween", "isNotBetween"]
2456
+ "enum": ["isBetween", "isNotBetween"],
2457
+ "description": "Filter operator that requires valueFrom and valueTo"
2531
2458
  },
2532
2459
  "valueFrom": {
2533
- "description": "Lower filter value",
2534
2460
  "anyOf": [
2535
2461
  {
2536
2462
  "type": "string"
@@ -2549,10 +2475,10 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2549
2475
  "required": ["type", "variableName"],
2550
2476
  "additionalProperties": false
2551
2477
  }
2552
- ]
2478
+ ],
2479
+ "description": "Lower filter value"
2553
2480
  },
2554
2481
  "valueTo": {
2555
- "description": "Upper filter value",
2556
2482
  "anyOf": [
2557
2483
  {
2558
2484
  "type": "string"
@@ -2571,7 +2497,8 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2571
2497
  "required": ["type", "variableName"],
2572
2498
  "additionalProperties": false
2573
2499
  }
2574
- ]
2500
+ ],
2501
+ "description": "Upper filter value"
2575
2502
  }
2576
2503
  },
2577
2504
  "required": ["measureName", "operator", "valueFrom", "valueTo"],
@@ -2581,21 +2508,21 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2581
2508
  "type": "object",
2582
2509
  "properties": {
2583
2510
  "measureName": {
2584
- "description": "Visible measure name or label",
2585
- "type": "string"
2511
+ "type": "string",
2512
+ "description": "Visible measure name or label"
2586
2513
  },
2587
2514
  "operator": {
2588
- "description": "Filter operator that requires a list of values",
2589
2515
  "type": "string",
2590
- "enum": ["inList", "excludedFromList"]
2516
+ "enum": ["inList", "excludedFromList"],
2517
+ "description": "Filter operator that requires a list of values"
2591
2518
  },
2592
2519
  "values": {
2593
- "description": "Filter values",
2594
2520
  "minItems": 1,
2595
2521
  "type": "array",
2596
2522
  "items": {
2597
2523
  "type": "string"
2598
- }
2524
+ },
2525
+ "description": "Filter values"
2599
2526
  }
2600
2527
  },
2601
2528
  "required": ["measureName", "operator", "values"],
@@ -2605,19 +2532,21 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2605
2532
  "type": "object",
2606
2533
  "properties": {
2607
2534
  "measureName": {
2608
- "description": "Visible measure name or label",
2609
- "type": "string"
2535
+ "type": "string",
2536
+ "description": "Visible measure name or label"
2610
2537
  },
2611
2538
  "operator": {
2612
- "description": "Filter operator that does not require values",
2613
2539
  "type": "string",
2614
- "enum": ["isNull", "notNull"]
2540
+ "enum": ["isNull", "notNull"],
2541
+ "description": "Filter operator that does not require values"
2615
2542
  }
2616
2543
  },
2617
2544
  "required": ["measureName", "operator"],
2618
2545
  "additionalProperties": false
2619
2546
  }
2620
- ]
2547
+ ],
2548
+ "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
2549
+ "title": "Set result filter schema"
2621
2550
  }
2622
2551
  ```
2623
2552
 
@@ -2651,8 +2580,8 @@ Replace all static filters with a nested AND/OR filter group.
2651
2580
  "type": "object",
2652
2581
  "properties": {
2653
2582
  "fieldKey": {
2654
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2655
- "type": "string"
2583
+ "type": "string",
2584
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2656
2585
  },
2657
2586
  "operator": {
2658
2587
  "anyOf": [
@@ -2869,7 +2798,6 @@ Enable or disable all matching supporting measures by name
2869
2798
  ```json
2870
2799
  {
2871
2800
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2872
- "title": "Supporting measure enabled by name schema",
2873
2801
  "type": "object",
2874
2802
  "properties": {
2875
2803
  "name": {
@@ -2881,7 +2809,8 @@ Enable or disable all matching supporting measures by name
2881
2809
  }
2882
2810
  },
2883
2811
  "required": ["name", "enabled"],
2884
- "additionalProperties": false
2812
+ "additionalProperties": false,
2813
+ "title": "Supporting measure enabled by name schema"
2885
2814
  }
2886
2815
  ```
2887
2816
 
@@ -2896,24 +2825,24 @@ Enable or disable a dimension in the chart
2896
2825
  ```json
2897
2826
  {
2898
2827
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2899
- "title": "Toggle dimension schema",
2900
2828
  "type": "object",
2901
2829
  "properties": {
2902
2830
  "dataItemInternalKey": {
2903
- "description": "Internal key of the data item of the dimension to be toggled",
2904
- "type": "string"
2831
+ "type": "string",
2832
+ "description": "Internal key of the data item of the dimension to be toggled"
2905
2833
  },
2906
2834
  "dataItemUniqueSignature": {
2907
- "description": "Unique signature of the data item of the dimension to be toggled",
2908
- "type": "string"
2835
+ "type": "string",
2836
+ "description": "Unique signature of the data item of the dimension to be toggled"
2909
2837
  },
2910
2838
  "enabled": {
2911
- "description": "Whether the dimension should be enabled or disabled",
2912
- "type": "boolean"
2839
+ "type": "boolean",
2840
+ "description": "Whether the dimension should be enabled or disabled"
2913
2841
  }
2914
2842
  },
2915
2843
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
2916
- "additionalProperties": false
2844
+ "additionalProperties": false,
2845
+ "title": "Toggle dimension schema"
2917
2846
  }
2918
2847
  ```
2919
2848
 
@@ -2928,7 +2857,6 @@ Enable, disable, or toggle a dimension or measure by its name
2928
2857
  ```json
2929
2858
  {
2930
2859
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2931
- "title": "Toggle dimension or measure by name schema",
2932
2860
  "type": "object",
2933
2861
  "properties": {
2934
2862
  "name": {
@@ -2940,7 +2868,8 @@ Enable, disable, or toggle a dimension or measure by its name
2940
2868
  }
2941
2869
  },
2942
2870
  "required": ["name", "operation"],
2943
- "additionalProperties": false
2871
+ "additionalProperties": false,
2872
+ "title": "Toggle dimension or measure by name schema"
2944
2873
  }
2945
2874
  ```
2946
2875
 
@@ -2955,20 +2884,20 @@ Enable or disable a measure in the chart
2955
2884
  ```json
2956
2885
  {
2957
2886
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2958
- "title": "Toggle measure schema",
2959
2887
  "type": "object",
2960
2888
  "properties": {
2961
2889
  "dataItemInternalKey": {
2962
- "description": "Internal key of the data item of the measure to be toggled",
2963
- "type": "string"
2890
+ "type": "string",
2891
+ "description": "Internal key of the data item of the measure to be toggled"
2964
2892
  },
2965
2893
  "dataItemUniqueSignature": {
2966
- "description": "Unique signature of the data item of the measure to be toggled",
2967
- "type": "string"
2894
+ "type": "string",
2895
+ "description": "Unique signature of the data item of the measure to be toggled"
2968
2896
  }
2969
2897
  },
2970
2898
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2971
- "additionalProperties": false
2899
+ "additionalProperties": false,
2900
+ "title": "Toggle measure schema"
2972
2901
  }
2973
2902
  ```
2974
2903
 
@@ -2983,16 +2912,15 @@ Modify properties of an existing dimension
2983
2912
  ```json
2984
2913
  {
2985
2914
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2986
- "title": "Update dimension schema",
2987
2915
  "type": "object",
2988
2916
  "properties": {
2989
2917
  "dataItemInternalKey": {
2990
- "description": "Internal key of the data item of the dimension to be updated",
2991
- "type": "string"
2918
+ "type": "string",
2919
+ "description": "Internal key of the data item of the dimension to be updated"
2992
2920
  },
2993
2921
  "dataItemUniqueSignature": {
2994
- "description": "Unique signature of the data item of the dimension to be updated",
2995
- "type": "string"
2922
+ "type": "string",
2923
+ "description": "Unique signature of the data item of the dimension to be updated"
2996
2924
  },
2997
2925
  "changes": {
2998
2926
  "type": "object",
@@ -3018,7 +2946,8 @@ Modify properties of an existing dimension
3018
2946
  }
3019
2947
  },
3020
2948
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
3021
- "additionalProperties": false
2949
+ "additionalProperties": false,
2950
+ "title": "Update dimension schema"
3022
2951
  }
3023
2952
  ```
3024
2953
 
@@ -3033,16 +2962,15 @@ Modify properties of an existing measure
3033
2962
  ```json
3034
2963
  {
3035
2964
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3036
- "title": "Update measure schema",
3037
2965
  "type": "object",
3038
2966
  "properties": {
3039
2967
  "dataItemInternalKey": {
3040
- "description": "Internal key of the data item of the measure to be updated",
3041
- "type": "string"
2968
+ "type": "string",
2969
+ "description": "Internal key of the data item of the measure to be updated"
3042
2970
  },
3043
2971
  "dataItemUniqueSignature": {
3044
- "description": "Unique signature of the data item of the measure to be updated",
3045
- "type": "string"
2972
+ "type": "string",
2973
+ "description": "Unique signature of the data item of the measure to be updated"
3046
2974
  },
3047
2975
  "changes": {
3048
2976
  "type": "object",
@@ -3066,6 +2994,7 @@ Modify properties of an existing measure
3066
2994
  }
3067
2995
  },
3068
2996
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
3069
- "additionalProperties": false
2997
+ "additionalProperties": false,
2998
+ "title": "Update measure schema"
3070
2999
  }
3071
3000
  ```