@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
  # `treemap` 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
 
@@ -30,6 +30,7 @@ Use each schema below for the request’s `payload`, not for the whole operation
30
30
  - [`setAnimationEnabled`](#setanimationenabled)
31
31
  - [`setChartPalette`](#setchartpalette)
32
32
  - [`setColoringColor`](#setcoloringcolor)
33
+ - [`setColoringGradientAuto`](#setcoloringgradientauto)
33
34
  - [`setColoringGradientField`](#setcoloringgradientfield)
34
35
  - [`setColoringGradientMax`](#setcoloringgradientmax)
35
36
  - [`setColoringGradientMin`](#setcoloringgradientmin)
@@ -90,7 +91,6 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
90
91
  ```json
91
92
  {
92
93
  "$schema": "https://json-schema.org/draft/2020-12/schema",
93
- "title": "Add coloring overwrite schema",
94
94
  "anyOf": [
95
95
  {
96
96
  "type": "object",
@@ -100,21 +100,21 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
100
100
  "type": "object",
101
101
  "properties": {
102
102
  "dataItemInternalKey": {
103
- "description": "Internal key of the data item of the dimension to be updated",
104
- "type": "string"
103
+ "type": "string",
104
+ "description": "Internal key of the data item of the dimension to be updated"
105
105
  },
106
106
  "dataItemUniqueSignature": {
107
- "description": "Unique signature of the data item of the dimension to be updated",
108
- "type": "string"
107
+ "type": "string",
108
+ "description": "Unique signature of the data item of the dimension to be updated"
109
109
  }
110
110
  },
111
111
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
112
112
  "additionalProperties": false
113
113
  },
114
114
  "color": {
115
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
116
115
  "type": "string",
117
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
116
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
117
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
118
118
  },
119
119
  "operator": {
120
120
  "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
@@ -123,14 +123,7 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
123
123
  },
124
124
  "value": {
125
125
  "description": "Value to compare against",
126
- "anyOf": [
127
- {
128
- "type": "string"
129
- },
130
- {
131
- "type": "number"
132
- }
133
- ]
126
+ "type": ["string", "number"]
134
127
  }
135
128
  },
136
129
  "required": ["color", "value"],
@@ -144,48 +137,34 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
144
137
  "type": "object",
145
138
  "properties": {
146
139
  "dataItemInternalKey": {
147
- "description": "Internal key of the data item of the dimension to be updated",
148
- "type": "string"
140
+ "type": "string",
141
+ "description": "Internal key of the data item of the dimension to be updated"
149
142
  },
150
143
  "dataItemUniqueSignature": {
151
- "description": "Unique signature of the data item of the dimension to be updated",
152
- "type": "string"
144
+ "type": "string",
145
+ "description": "Unique signature of the data item of the dimension to be updated"
153
146
  }
154
147
  },
155
148
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
156
149
  "additionalProperties": false
157
150
  },
158
151
  "color": {
159
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
160
152
  "type": "string",
161
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
153
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
154
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
162
155
  },
163
156
  "operator": {
164
- "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)",
165
157
  "type": "string",
166
- "const": "between"
158
+ "const": "between",
159
+ "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)"
167
160
  },
168
161
  "value": {
169
162
  "description": "Lower bound of the range",
170
- "anyOf": [
171
- {
172
- "type": "string"
173
- },
174
- {
175
- "type": "number"
176
- }
177
- ]
163
+ "type": ["string", "number"]
178
164
  },
179
165
  "secondValue": {
180
166
  "description": "Upper bound of the range",
181
- "anyOf": [
182
- {
183
- "type": "string"
184
- },
185
- {
186
- "type": "number"
187
- }
188
- ]
167
+ "type": ["string", "number"]
189
168
  }
190
169
  },
191
170
  "required": ["color", "operator", "value", "secondValue"],
@@ -199,41 +178,34 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
199
178
  "type": "object",
200
179
  "properties": {
201
180
  "dataItemInternalKey": {
202
- "description": "Internal key of the data item of the dimension to be updated",
203
- "type": "string"
181
+ "type": "string",
182
+ "description": "Internal key of the data item of the dimension to be updated"
204
183
  },
205
184
  "dataItemUniqueSignature": {
206
- "description": "Unique signature of the data item of the dimension to be updated",
207
- "type": "string"
185
+ "type": "string",
186
+ "description": "Unique signature of the data item of the dimension to be updated"
208
187
  }
209
188
  },
210
189
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
211
190
  "additionalProperties": false
212
191
  },
213
192
  "color": {
214
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
215
193
  "type": "string",
216
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
194
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
195
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
217
196
  },
218
197
  "operator": {
219
- "description": "Match (inList) or exclude (notInList) every value in values",
220
198
  "type": "string",
221
- "enum": ["inList", "notInList"]
199
+ "enum": ["inList", "notInList"],
200
+ "description": "Match (inList) or exclude (notInList) every value in values"
222
201
  },
223
202
  "values": {
224
- "description": "Values to match",
225
203
  "minItems": 1,
226
204
  "type": "array",
227
205
  "items": {
228
- "anyOf": [
229
- {
230
- "type": "string"
231
- },
232
- {
233
- "type": "number"
234
- }
235
- ]
236
- }
206
+ "type": ["string", "number"]
207
+ },
208
+ "description": "Values to match"
237
209
  },
238
210
  "delimiter": {
239
211
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -244,7 +216,8 @@ Append one value color, eg. color the dimension value "Happy" dark teal. Value c
244
216
  "required": ["color", "operator", "values"],
245
217
  "additionalProperties": false
246
218
  }
247
- ]
219
+ ],
220
+ "title": "Add coloring overwrite schema"
248
221
  }
249
222
  ```
250
223
 
@@ -259,47 +232,39 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
259
232
  ```json
260
233
  {
261
234
  "$schema": "https://json-schema.org/draft/2020-12/schema",
262
- "title": "Add coloring rule schema",
263
235
  "anyOf": [
264
236
  {
265
237
  "type": "object",
266
238
  "properties": {
267
239
  "measure": {
268
- "description": "Measure whose value is compared",
269
240
  "type": "object",
270
241
  "properties": {
271
242
  "dataItemInternalKey": {
272
- "description": "Internal key of the data item of the measure to be updated",
273
- "type": "string"
243
+ "type": "string",
244
+ "description": "Internal key of the data item of the measure to be updated"
274
245
  },
275
246
  "dataItemUniqueSignature": {
276
- "description": "Unique signature of the data item of the measure to be updated",
277
- "type": "string"
247
+ "type": "string",
248
+ "description": "Unique signature of the data item of the measure to be updated"
278
249
  }
279
250
  },
280
251
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
281
- "additionalProperties": false
252
+ "additionalProperties": false,
253
+ "description": "Measure whose value is compared"
282
254
  },
283
255
  "color": {
284
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
285
256
  "type": "string",
286
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
257
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
258
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
287
259
  },
288
260
  "operator": {
289
- "description": "How the measure value is compared",
290
261
  "type": "string",
291
- "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"]
262
+ "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"],
263
+ "description": "How the measure value is compared"
292
264
  },
293
265
  "value": {
294
266
  "description": "Value to compare against",
295
- "anyOf": [
296
- {
297
- "type": "string"
298
- },
299
- {
300
- "type": "number"
301
- }
302
- ]
267
+ "type": ["string", "number"]
303
268
  }
304
269
  },
305
270
  "required": ["measure", "color", "operator", "value"],
@@ -309,52 +274,38 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
309
274
  "type": "object",
310
275
  "properties": {
311
276
  "measure": {
312
- "description": "Measure whose value is compared",
313
277
  "type": "object",
314
278
  "properties": {
315
279
  "dataItemInternalKey": {
316
- "description": "Internal key of the data item of the measure to be updated",
317
- "type": "string"
280
+ "type": "string",
281
+ "description": "Internal key of the data item of the measure to be updated"
318
282
  },
319
283
  "dataItemUniqueSignature": {
320
- "description": "Unique signature of the data item of the measure to be updated",
321
- "type": "string"
284
+ "type": "string",
285
+ "description": "Unique signature of the data item of the measure to be updated"
322
286
  }
323
287
  },
324
288
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
325
- "additionalProperties": false
289
+ "additionalProperties": false,
290
+ "description": "Measure whose value is compared"
326
291
  },
327
292
  "color": {
328
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
329
293
  "type": "string",
330
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
294
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
295
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
331
296
  },
332
297
  "operator": {
333
- "description": "Matches measure values from value to secondValue, both inclusive",
334
298
  "type": "string",
335
- "const": "between"
299
+ "const": "between",
300
+ "description": "Matches measure values from value to secondValue, both inclusive"
336
301
  },
337
302
  "value": {
338
303
  "description": "Lower bound of the range",
339
- "anyOf": [
340
- {
341
- "type": "string"
342
- },
343
- {
344
- "type": "number"
345
- }
346
- ]
304
+ "type": ["string", "number"]
347
305
  },
348
306
  "secondValue": {
349
307
  "description": "Upper bound of the range",
350
- "anyOf": [
351
- {
352
- "type": "string"
353
- },
354
- {
355
- "type": "number"
356
- }
357
- ]
308
+ "type": ["string", "number"]
358
309
  }
359
310
  },
360
311
  "required": ["measure", "color", "operator", "value", "secondValue"],
@@ -364,45 +315,38 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
364
315
  "type": "object",
365
316
  "properties": {
366
317
  "measure": {
367
- "description": "Measure whose value is compared",
368
318
  "type": "object",
369
319
  "properties": {
370
320
  "dataItemInternalKey": {
371
- "description": "Internal key of the data item of the measure to be updated",
372
- "type": "string"
321
+ "type": "string",
322
+ "description": "Internal key of the data item of the measure to be updated"
373
323
  },
374
324
  "dataItemUniqueSignature": {
375
- "description": "Unique signature of the data item of the measure to be updated",
376
- "type": "string"
325
+ "type": "string",
326
+ "description": "Unique signature of the data item of the measure to be updated"
377
327
  }
378
328
  },
379
329
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
380
- "additionalProperties": false
330
+ "additionalProperties": false,
331
+ "description": "Measure whose value is compared"
381
332
  },
382
333
  "color": {
383
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
384
334
  "type": "string",
385
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
335
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
336
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
386
337
  },
387
338
  "operator": {
388
- "description": "Match (inList) or exclude (notInList) every value in values",
389
339
  "type": "string",
390
- "enum": ["inList", "notInList"]
340
+ "enum": ["inList", "notInList"],
341
+ "description": "Match (inList) or exclude (notInList) every value in values"
391
342
  },
392
343
  "values": {
393
- "description": "Values to match",
394
344
  "minItems": 1,
395
345
  "type": "array",
396
346
  "items": {
397
- "anyOf": [
398
- {
399
- "type": "string"
400
- },
401
- {
402
- "type": "number"
403
- }
404
- ]
405
- }
347
+ "type": ["string", "number"]
348
+ },
349
+ "description": "Values to match"
406
350
  },
407
351
  "delimiter": {
408
352
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -413,7 +357,8 @@ Append one measure color rule, eg. color marks red when Sales is below 100. Earl
413
357
  "required": ["measure", "color", "operator", "values"],
414
358
  "additionalProperties": false
415
359
  }
416
- ]
360
+ ],
361
+ "title": "Add coloring rule schema"
417
362
  }
418
363
  ```
419
364
 
@@ -428,16 +373,16 @@ Add a new dimension to the chart
428
373
  ```json
429
374
  {
430
375
  "$schema": "https://json-schema.org/draft/2020-12/schema",
431
- "title": "Add dimension schema",
432
376
  "type": "object",
433
377
  "properties": {
434
378
  "key": {
435
- "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"",
436
- "type": "string"
379
+ "type": "string",
380
+ "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\""
437
381
  }
438
382
  },
439
383
  "required": ["key"],
440
- "additionalProperties": false
384
+ "additionalProperties": false,
385
+ "title": "Add dimension schema"
441
386
  }
442
387
  ```
443
388
 
@@ -452,23 +397,22 @@ Add a new measure to the chart
452
397
  ```json
453
398
  {
454
399
  "$schema": "https://json-schema.org/draft/2020-12/schema",
455
- "title": "Add measure schema",
456
- "anyOf": [
400
+ "oneOf": [
457
401
  {
458
402
  "type": "object",
459
403
  "properties": {
460
404
  "sourceKind": {
461
- "description": "Raw database field from available data `fields`.",
462
405
  "type": "string",
463
- "const": "field"
406
+ "const": "field",
407
+ "description": "Raw database field from available data `fields`."
464
408
  },
465
409
  "key": {
466
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
467
- "type": "string"
410
+ "type": "string",
411
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
468
412
  },
469
413
  "aggregation": {
470
- "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
471
- "type": "string"
414
+ "type": "string",
415
+ "description": "Required for raw database fields. Use one of the aggregation names returned for that field."
472
416
  }
473
417
  },
474
418
  "required": ["sourceKind", "key", "aggregation"],
@@ -478,13 +422,13 @@ Add a new measure to the chart
478
422
  "type": "object",
479
423
  "properties": {
480
424
  "sourceKind": {
481
- "description": "Predefined/user-defined measure from available data `measures`.",
482
425
  "type": "string",
483
- "const": "measure"
426
+ "const": "measure",
427
+ "description": "Predefined/user-defined measure from available data `measures`."
484
428
  },
485
429
  "key": {
486
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
487
- "type": "string"
430
+ "type": "string",
431
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
488
432
  }
489
433
  },
490
434
  "required": ["sourceKind", "key"],
@@ -494,19 +438,20 @@ Add a new measure to the chart
494
438
  "type": "object",
495
439
  "properties": {
496
440
  "sourceKind": {
497
- "description": "Predefined calculation from available data `measures`.",
498
441
  "type": "string",
499
- "const": "calculation"
442
+ "const": "calculation",
443
+ "description": "Predefined calculation from available data `measures`."
500
444
  },
501
445
  "key": {
502
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
503
- "type": "string"
446
+ "type": "string",
447
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
504
448
  }
505
449
  },
506
450
  "required": ["sourceKind", "key"],
507
451
  "additionalProperties": false
508
452
  }
509
- ]
453
+ ],
454
+ "title": "Add measure schema"
510
455
  }
511
456
  ```
512
457
 
@@ -521,22 +466,19 @@ Add another measure filter before aggregation. Keeps existing filters.
521
466
  ```json
522
467
  {
523
468
  "$schema": "https://json-schema.org/draft/2020-12/schema",
524
- "description": "Add another measure filter before aggregation. Keeps existing filters.",
525
- "title": "Add measure filter schema",
526
469
  "anyOf": [
527
470
  {
528
471
  "type": "object",
529
472
  "properties": {
530
473
  "measureName": {
531
- "description": "Visible measure name or label",
532
- "type": "string"
474
+ "type": "string",
475
+ "description": "Visible measure name or label"
533
476
  },
534
477
  "fieldKey": {
535
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
536
- "type": "string"
478
+ "type": "string",
479
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
537
480
  },
538
481
  "operator": {
539
- "description": "Filter operator that requires a value",
540
482
  "type": "string",
541
483
  "enum": [
542
484
  "equals",
@@ -551,10 +493,10 @@ Add another measure filter before aggregation. Keeps existing filters.
551
493
  "notLike",
552
494
  "startsWith",
553
495
  "endsWith"
554
- ]
496
+ ],
497
+ "description": "Filter operator that requires a value"
555
498
  },
556
499
  "value": {
557
- "description": "Filter value",
558
500
  "anyOf": [
559
501
  {
560
502
  "type": "string"
@@ -573,7 +515,8 @@ Add another measure filter before aggregation. Keeps existing filters.
573
515
  "required": ["type", "variableName"],
574
516
  "additionalProperties": false
575
517
  }
576
- ]
518
+ ],
519
+ "description": "Filter value"
577
520
  }
578
521
  },
579
522
  "required": ["measureName", "fieldKey", "operator", "value"],
@@ -583,20 +526,19 @@ Add another measure filter before aggregation. Keeps existing filters.
583
526
  "type": "object",
584
527
  "properties": {
585
528
  "measureName": {
586
- "description": "Visible measure name or label",
587
- "type": "string"
529
+ "type": "string",
530
+ "description": "Visible measure name or label"
588
531
  },
589
532
  "fieldKey": {
590
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
591
- "type": "string"
533
+ "type": "string",
534
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
592
535
  },
593
536
  "operator": {
594
- "description": "Filter operator that requires valueFrom and valueTo",
595
537
  "type": "string",
596
- "enum": ["isBetween", "isNotBetween"]
538
+ "enum": ["isBetween", "isNotBetween"],
539
+ "description": "Filter operator that requires valueFrom and valueTo"
597
540
  },
598
541
  "valueFrom": {
599
- "description": "Lower filter value",
600
542
  "anyOf": [
601
543
  {
602
544
  "type": "string"
@@ -615,10 +557,10 @@ Add another measure filter before aggregation. Keeps existing filters.
615
557
  "required": ["type", "variableName"],
616
558
  "additionalProperties": false
617
559
  }
618
- ]
560
+ ],
561
+ "description": "Lower filter value"
619
562
  },
620
563
  "valueTo": {
621
- "description": "Upper filter value",
622
564
  "anyOf": [
623
565
  {
624
566
  "type": "string"
@@ -637,7 +579,8 @@ Add another measure filter before aggregation. Keeps existing filters.
637
579
  "required": ["type", "variableName"],
638
580
  "additionalProperties": false
639
581
  }
640
- ]
582
+ ],
583
+ "description": "Upper filter value"
641
584
  }
642
585
  },
643
586
  "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
@@ -647,25 +590,25 @@ Add another measure filter before aggregation. Keeps existing filters.
647
590
  "type": "object",
648
591
  "properties": {
649
592
  "measureName": {
650
- "description": "Visible measure name or label",
651
- "type": "string"
593
+ "type": "string",
594
+ "description": "Visible measure name or label"
652
595
  },
653
596
  "fieldKey": {
654
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
655
- "type": "string"
597
+ "type": "string",
598
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
656
599
  },
657
600
  "operator": {
658
- "description": "Filter operator that requires a list of values",
659
601
  "type": "string",
660
- "enum": ["inList", "excludedFromList"]
602
+ "enum": ["inList", "excludedFromList"],
603
+ "description": "Filter operator that requires a list of values"
661
604
  },
662
605
  "values": {
663
- "description": "Filter values",
664
606
  "minItems": 1,
665
607
  "type": "array",
666
608
  "items": {
667
609
  "type": "string"
668
- }
610
+ },
611
+ "description": "Filter values"
669
612
  }
670
613
  },
671
614
  "required": ["measureName", "fieldKey", "operator", "values"],
@@ -675,23 +618,25 @@ Add another measure filter before aggregation. Keeps existing filters.
675
618
  "type": "object",
676
619
  "properties": {
677
620
  "measureName": {
678
- "description": "Visible measure name or label",
679
- "type": "string"
621
+ "type": "string",
622
+ "description": "Visible measure name or label"
680
623
  },
681
624
  "fieldKey": {
682
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
683
- "type": "string"
625
+ "type": "string",
626
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
684
627
  },
685
628
  "operator": {
686
- "description": "Filter operator that does not require values",
687
629
  "type": "string",
688
- "enum": ["isNull", "notNull"]
630
+ "enum": ["isNull", "notNull"],
631
+ "description": "Filter operator that does not require values"
689
632
  }
690
633
  },
691
634
  "required": ["measureName", "fieldKey", "operator"],
692
635
  "additionalProperties": false
693
636
  }
694
- ]
637
+ ],
638
+ "description": "Add another measure filter before aggregation. Keeps existing filters.",
639
+ "title": "Add measure filter schema"
695
640
  }
696
641
  ```
697
642
 
@@ -706,18 +651,15 @@ Add another result filter after aggregation. Keeps existing result filters.
706
651
  ```json
707
652
  {
708
653
  "$schema": "https://json-schema.org/draft/2020-12/schema",
709
- "description": "Add another result filter after aggregation. Keeps existing result filters.",
710
- "title": "Add result filter schema",
711
654
  "anyOf": [
712
655
  {
713
656
  "type": "object",
714
657
  "properties": {
715
658
  "measureName": {
716
- "description": "Visible measure name or label",
717
- "type": "string"
659
+ "type": "string",
660
+ "description": "Visible measure name or label"
718
661
  },
719
662
  "operator": {
720
- "description": "Filter operator that requires a value",
721
663
  "type": "string",
722
664
  "enum": [
723
665
  "equals",
@@ -732,10 +674,10 @@ Add another result filter after aggregation. Keeps existing result filters.
732
674
  "notLike",
733
675
  "startsWith",
734
676
  "endsWith"
735
- ]
677
+ ],
678
+ "description": "Filter operator that requires a value"
736
679
  },
737
680
  "value": {
738
- "description": "Filter value",
739
681
  "anyOf": [
740
682
  {
741
683
  "type": "string"
@@ -754,7 +696,8 @@ Add another result filter after aggregation. Keeps existing result filters.
754
696
  "required": ["type", "variableName"],
755
697
  "additionalProperties": false
756
698
  }
757
- ]
699
+ ],
700
+ "description": "Filter value"
758
701
  }
759
702
  },
760
703
  "required": ["measureName", "operator", "value"],
@@ -764,16 +707,15 @@ Add another result filter after aggregation. Keeps existing result filters.
764
707
  "type": "object",
765
708
  "properties": {
766
709
  "measureName": {
767
- "description": "Visible measure name or label",
768
- "type": "string"
710
+ "type": "string",
711
+ "description": "Visible measure name or label"
769
712
  },
770
713
  "operator": {
771
- "description": "Filter operator that requires valueFrom and valueTo",
772
714
  "type": "string",
773
- "enum": ["isBetween", "isNotBetween"]
715
+ "enum": ["isBetween", "isNotBetween"],
716
+ "description": "Filter operator that requires valueFrom and valueTo"
774
717
  },
775
718
  "valueFrom": {
776
- "description": "Lower filter value",
777
719
  "anyOf": [
778
720
  {
779
721
  "type": "string"
@@ -792,10 +734,10 @@ Add another result filter after aggregation. Keeps existing result filters.
792
734
  "required": ["type", "variableName"],
793
735
  "additionalProperties": false
794
736
  }
795
- ]
737
+ ],
738
+ "description": "Lower filter value"
796
739
  },
797
740
  "valueTo": {
798
- "description": "Upper filter value",
799
741
  "anyOf": [
800
742
  {
801
743
  "type": "string"
@@ -814,7 +756,8 @@ Add another result filter after aggregation. Keeps existing result filters.
814
756
  "required": ["type", "variableName"],
815
757
  "additionalProperties": false
816
758
  }
817
- ]
759
+ ],
760
+ "description": "Upper filter value"
818
761
  }
819
762
  },
820
763
  "required": ["measureName", "operator", "valueFrom", "valueTo"],
@@ -824,21 +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 requires a list of values",
832
774
  "type": "string",
833
- "enum": ["inList", "excludedFromList"]
775
+ "enum": ["inList", "excludedFromList"],
776
+ "description": "Filter operator that requires a list of values"
834
777
  },
835
778
  "values": {
836
- "description": "Filter values",
837
779
  "minItems": 1,
838
780
  "type": "array",
839
781
  "items": {
840
782
  "type": "string"
841
- }
783
+ },
784
+ "description": "Filter values"
842
785
  }
843
786
  },
844
787
  "required": ["measureName", "operator", "values"],
@@ -848,19 +791,21 @@ Add another result filter after aggregation. Keeps existing result filters.
848
791
  "type": "object",
849
792
  "properties": {
850
793
  "measureName": {
851
- "description": "Visible measure name or label",
852
- "type": "string"
794
+ "type": "string",
795
+ "description": "Visible measure name or label"
853
796
  },
854
797
  "operator": {
855
- "description": "Filter operator that does not require values",
856
798
  "type": "string",
857
- "enum": ["isNull", "notNull"]
799
+ "enum": ["isNull", "notNull"],
800
+ "description": "Filter operator that does not require values"
858
801
  }
859
802
  },
860
803
  "required": ["measureName", "operator"],
861
804
  "additionalProperties": false
862
805
  }
863
- ]
806
+ ],
807
+ "description": "Add another result filter after aggregation. Keeps existing result filters.",
808
+ "title": "Add result filter schema"
864
809
  }
865
810
  ```
866
811
 
@@ -875,25 +820,25 @@ Change how a measure is aggregated
875
820
  ```json
876
821
  {
877
822
  "$schema": "https://json-schema.org/draft/2020-12/schema",
878
- "title": "Change measure aggregation schema",
879
823
  "type": "object",
880
824
  "properties": {
881
825
  "dataItemInternalKey": {
882
- "description": "Internal key of the data item of the measure to be updated",
883
- "type": "string"
826
+ "type": "string",
827
+ "description": "Internal key of the data item of the measure to be updated"
884
828
  },
885
829
  "dataItemUniqueSignature": {
886
- "description": "Unique signature of the data item of the measure to be updated",
887
- "type": "string"
830
+ "type": "string",
831
+ "description": "Unique signature of the data item of the measure to be updated"
888
832
  },
889
833
  "aggregation": {
890
- "description": "Aggregation function to be used for the measure",
891
834
  "type": "string",
892
- "minLength": 1
835
+ "minLength": 1,
836
+ "description": "Aggregation function to be used for the measure"
893
837
  }
894
838
  },
895
839
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
896
- "additionalProperties": false
840
+ "additionalProperties": false,
841
+ "title": "Change measure aggregation schema"
897
842
  }
898
843
  ```
899
844
 
@@ -908,21 +853,21 @@ Clear measure filters before aggregation. Use fieldKey for one field; omit it fo
908
853
  ```json
909
854
  {
910
855
  "$schema": "https://json-schema.org/draft/2020-12/schema",
911
- "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
912
- "title": "Clear measure filter schema",
913
856
  "type": "object",
914
857
  "properties": {
915
858
  "measureName": {
916
- "description": "Visible measure name or label",
917
- "type": "string"
859
+ "type": "string",
860
+ "description": "Visible measure name or label"
918
861
  },
919
862
  "fieldKey": {
920
- "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.",
921
- "type": "string"
863
+ "type": "string",
864
+ "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."
922
865
  }
923
866
  },
924
867
  "required": ["measureName"],
925
- "additionalProperties": false
868
+ "additionalProperties": false,
869
+ "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
870
+ "title": "Clear measure filter schema"
926
871
  }
927
872
  ```
928
873
 
@@ -937,17 +882,17 @@ Clear all result filters for one measure.
937
882
  ```json
938
883
  {
939
884
  "$schema": "https://json-schema.org/draft/2020-12/schema",
940
- "description": "Clear all result filters for one measure.",
941
- "title": "Clear result filter schema",
942
885
  "type": "object",
943
886
  "properties": {
944
887
  "measureName": {
945
- "description": "Visible measure name or label",
946
- "type": "string"
888
+ "type": "string",
889
+ "description": "Visible measure name or label"
947
890
  }
948
891
  },
949
892
  "required": ["measureName"],
950
- "additionalProperties": false
893
+ "additionalProperties": false,
894
+ "description": "Clear all result filters for one measure.",
895
+ "title": "Clear result filter schema"
951
896
  }
952
897
  ```
953
898
 
@@ -962,20 +907,20 @@ Create a copy of an existing dimension
962
907
  ```json
963
908
  {
964
909
  "$schema": "https://json-schema.org/draft/2020-12/schema",
965
- "title": "Duplicate dimension schema",
966
910
  "type": "object",
967
911
  "properties": {
968
912
  "dataItemInternalKey": {
969
- "description": "Internal key of the data item of the dimension to be duplicated",
970
- "type": "string"
913
+ "type": "string",
914
+ "description": "Internal key of the data item of the dimension to be duplicated"
971
915
  },
972
916
  "dataItemUniqueSignature": {
973
- "description": "Unique signature of the data item of the dimension to be duplicated",
974
- "type": "string"
917
+ "type": "string",
918
+ "description": "Unique signature of the data item of the dimension to be duplicated"
975
919
  }
976
920
  },
977
921
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
978
- "additionalProperties": false
922
+ "additionalProperties": false,
923
+ "title": "Duplicate dimension schema"
979
924
  }
980
925
  ```
981
926
 
@@ -990,20 +935,20 @@ Create a copy of an existing measure
990
935
  ```json
991
936
  {
992
937
  "$schema": "https://json-schema.org/draft/2020-12/schema",
993
- "title": "Duplicate measure schema",
994
938
  "type": "object",
995
939
  "properties": {
996
940
  "dataItemInternalKey": {
997
- "description": "Internal key of the data item of the measure to be duplicated",
998
- "type": "string"
941
+ "type": "string",
942
+ "description": "Internal key of the data item of the measure to be duplicated"
999
943
  },
1000
944
  "dataItemUniqueSignature": {
1001
- "description": "Unique signature of the data item of the measure to be duplicated",
1002
- "type": "string"
945
+ "type": "string",
946
+ "description": "Unique signature of the data item of the measure to be duplicated"
1003
947
  }
1004
948
  },
1005
949
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1006
- "additionalProperties": false
950
+ "additionalProperties": false,
951
+ "title": "Duplicate measure schema"
1007
952
  }
1008
953
  ```
1009
954
 
@@ -1018,10 +963,10 @@ Clear the selected gradient field
1018
963
  ```json
1019
964
  {
1020
965
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1021
- "title": "Remove coloring gradient field schema",
1022
966
  "type": "object",
1023
967
  "properties": {},
1024
- "additionalProperties": false
968
+ "additionalProperties": false,
969
+ "title": "Remove coloring gradient field schema"
1025
970
  }
1026
971
  ```
1027
972
 
@@ -1036,18 +981,18 @@ Remove one value color by its position, as returned by getColoringOverwrites
1036
981
  ```json
1037
982
  {
1038
983
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1039
- "title": "Remove coloring overwrite schema",
1040
984
  "type": "object",
1041
985
  "properties": {
1042
986
  "index": {
1043
- "description": "Zero-based position of the entry to remove",
1044
987
  "type": "integer",
1045
988
  "minimum": 0,
1046
- "maximum": 9007199254740991
989
+ "maximum": 9007199254740991,
990
+ "description": "Zero-based position of the entry to remove"
1047
991
  }
1048
992
  },
1049
993
  "required": ["index"],
1050
- "additionalProperties": false
994
+ "additionalProperties": false,
995
+ "title": "Remove coloring overwrite schema"
1051
996
  }
1052
997
  ```
1053
998
 
@@ -1062,18 +1007,18 @@ Remove one measure color rule by its position, as returned by getColoringRules
1062
1007
  ```json
1063
1008
  {
1064
1009
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1065
- "title": "Remove coloring rule schema",
1066
1010
  "type": "object",
1067
1011
  "properties": {
1068
1012
  "index": {
1069
- "description": "Zero-based position of the entry to remove",
1070
1013
  "type": "integer",
1071
1014
  "minimum": 0,
1072
- "maximum": 9007199254740991
1015
+ "maximum": 9007199254740991,
1016
+ "description": "Zero-based position of the entry to remove"
1073
1017
  }
1074
1018
  },
1075
1019
  "required": ["index"],
1076
- "additionalProperties": false
1020
+ "additionalProperties": false,
1021
+ "title": "Remove coloring rule schema"
1077
1022
  }
1078
1023
  ```
1079
1024
 
@@ -1088,20 +1033,20 @@ Remove a dimension from the chart
1088
1033
  ```json
1089
1034
  {
1090
1035
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1091
- "title": "Remove dimension schema",
1092
1036
  "type": "object",
1093
1037
  "properties": {
1094
1038
  "dataItemInternalKey": {
1095
- "description": "Internal key of the data item of the dimension to be removed",
1096
- "type": "string"
1039
+ "type": "string",
1040
+ "description": "Internal key of the data item of the dimension to be removed"
1097
1041
  },
1098
1042
  "dataItemUniqueSignature": {
1099
- "description": "Unique signature of the data item of the dimension to be removed",
1100
- "type": "string"
1043
+ "type": "string",
1044
+ "description": "Unique signature of the data item of the dimension to be removed"
1101
1045
  }
1102
1046
  },
1103
1047
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1104
- "additionalProperties": false
1048
+ "additionalProperties": false,
1049
+ "title": "Remove dimension schema"
1105
1050
  }
1106
1051
  ```
1107
1052
 
@@ -1116,20 +1061,20 @@ Remove a measure from the chart
1116
1061
  ```json
1117
1062
  {
1118
1063
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1119
- "title": "Remove measure schema",
1120
1064
  "type": "object",
1121
1065
  "properties": {
1122
1066
  "dataItemInternalKey": {
1123
- "description": "Internal key of the data item of the measure to be removed",
1124
- "type": "string"
1067
+ "type": "string",
1068
+ "description": "Internal key of the data item of the measure to be removed"
1125
1069
  },
1126
1070
  "dataItemUniqueSignature": {
1127
- "description": "Unique signature of the data item of the measure to be removed",
1128
- "type": "string"
1071
+ "type": "string",
1072
+ "description": "Unique signature of the data item of the measure to be removed"
1129
1073
  }
1130
1074
  },
1131
1075
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1132
- "additionalProperties": false
1076
+ "additionalProperties": false,
1077
+ "title": "Remove measure schema"
1133
1078
  }
1134
1079
  ```
1135
1080
 
@@ -1144,10 +1089,10 @@ Reset the chart palette back to the workbook theme default
1144
1089
  ```json
1145
1090
  {
1146
1091
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1147
- "title": "Reset chart palette schema",
1148
1092
  "type": "object",
1149
1093
  "properties": {},
1150
- "additionalProperties": false
1094
+ "additionalProperties": false,
1095
+ "title": "Reset chart palette schema"
1151
1096
  }
1152
1097
  ```
1153
1098
 
@@ -1162,16 +1107,16 @@ Turn the chart animations on or off. They are on by default; the host can still
1162
1107
  ```json
1163
1108
  {
1164
1109
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1165
- "title": "Set animation enabled schema",
1166
1110
  "type": "object",
1167
1111
  "properties": {
1168
1112
  "enabled": {
1169
- "description": "Whether the chart animates when it first renders and when its data changes",
1170
- "type": "boolean"
1113
+ "type": "boolean",
1114
+ "description": "Whether the chart animates when it first renders and when its data changes"
1171
1115
  }
1172
1116
  },
1173
1117
  "required": ["enabled"],
1174
- "additionalProperties": false
1118
+ "additionalProperties": false,
1119
+ "title": "Set animation enabled schema"
1175
1120
  }
1176
1121
  ```
1177
1122
 
@@ -1186,9 +1131,9 @@ Apply an existing palette using a built-in palette name or a theme palette label
1186
1131
  ```json
1187
1132
  {
1188
1133
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1189
- "title": "Chart palette schema",
1190
1134
  "type": "string",
1191
- "minLength": 1
1135
+ "minLength": 1,
1136
+ "title": "Chart palette schema"
1192
1137
  }
1193
1138
  ```
1194
1139
 
@@ -1203,9 +1148,25 @@ Set the single color used by the chart
1203
1148
  ```json
1204
1149
  {
1205
1150
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1206
- "title": "Coloring color schema",
1207
1151
  "type": "string",
1208
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1152
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1153
+ "title": "Coloring color schema"
1154
+ }
1155
+ ```
1156
+
1157
+ ## `setColoringGradientAuto`
1158
+
1159
+ Automatic gradient limits
1160
+
1161
+ Enable automatic gradient limits from the data, or disable Auto to use the stored limits. Preserves stored minimum and maximum values
1162
+
1163
+ **Payload schema**
1164
+
1165
+ ```json
1166
+ {
1167
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1168
+ "type": "boolean",
1169
+ "title": "Coloring gradient auto schema"
1209
1170
  }
1210
1171
  ```
1211
1172
 
@@ -1220,25 +1181,25 @@ Select the field used for gradient coloring
1220
1181
  ```json
1221
1182
  {
1222
1183
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1223
- "title": "Coloring gradient field schema",
1224
1184
  "type": "object",
1225
1185
  "properties": {
1226
1186
  "key": {
1227
- "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
1228
- "type": "string"
1187
+ "type": "string",
1188
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
1229
1189
  },
1230
1190
  "sourceKind": {
1231
- "description": "Gradient field selection always uses a raw database field.",
1232
1191
  "type": "string",
1233
- "const": "field"
1192
+ "const": "field",
1193
+ "description": "Gradient field selection always uses a raw database field."
1234
1194
  },
1235
1195
  "aggregation": {
1236
- "description": "Aggregation function to use for the selected field.",
1237
- "type": "string"
1196
+ "type": "string",
1197
+ "description": "Aggregation function to use for the selected field."
1238
1198
  }
1239
1199
  },
1240
1200
  "required": ["key", "sourceKind", "aggregation"],
1241
- "additionalProperties": false
1201
+ "additionalProperties": false,
1202
+ "title": "Coloring gradient field schema"
1242
1203
  }
1243
1204
  ```
1244
1205
 
@@ -1246,16 +1207,33 @@ Select the field used for gradient coloring
1246
1207
 
1247
1208
  Gradient maximum
1248
1209
 
1249
- Set the maximum value of the gradient domain
1210
+ Set the maximum value of the gradient domain using a number or variable. Applies when setColoringGradientAuto is false
1250
1211
 
1251
1212
  **Payload schema**
1252
1213
 
1253
1214
  ```json
1254
1215
  {
1255
1216
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1256
- "description": "Maximum value for gradient",
1257
- "title": "Coloring gradient maximum schema",
1258
- "type": "number"
1217
+ "anyOf": [
1218
+ {
1219
+ "type": "number"
1220
+ },
1221
+ {
1222
+ "type": "object",
1223
+ "properties": {
1224
+ "type": {
1225
+ "type": "string",
1226
+ "const": "variable"
1227
+ },
1228
+ "variableName": {
1229
+ "type": "string"
1230
+ }
1231
+ },
1232
+ "required": ["type", "variableName"],
1233
+ "additionalProperties": false
1234
+ }
1235
+ ],
1236
+ "title": "Coloring gradient maximum schema"
1259
1237
  }
1260
1238
  ```
1261
1239
 
@@ -1263,16 +1241,33 @@ Set the maximum value of the gradient domain
1263
1241
 
1264
1242
  Gradient minimum
1265
1243
 
1266
- Set the minimum value of the gradient domain
1244
+ Set the minimum value of the gradient domain using a number or variable. Applies when setColoringGradientAuto is false
1267
1245
 
1268
1246
  **Payload schema**
1269
1247
 
1270
1248
  ```json
1271
1249
  {
1272
1250
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1273
- "description": "Minimum value for gradient",
1274
- "title": "Coloring gradient minimum schema",
1275
- "type": "number"
1251
+ "anyOf": [
1252
+ {
1253
+ "type": "number"
1254
+ },
1255
+ {
1256
+ "type": "object",
1257
+ "properties": {
1258
+ "type": {
1259
+ "type": "string",
1260
+ "const": "variable"
1261
+ },
1262
+ "variableName": {
1263
+ "type": "string"
1264
+ }
1265
+ },
1266
+ "required": ["type", "variableName"],
1267
+ "additionalProperties": false
1268
+ }
1269
+ ],
1270
+ "title": "Coloring gradient minimum schema"
1276
1271
  }
1277
1272
  ```
1278
1273
 
@@ -1289,14 +1284,7 @@ Set the aggregation used by the gradient field
1289
1284
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1290
1285
  "description": "Measure aggregation for coloring",
1291
1286
  "title": "Coloring measure aggregation schema",
1292
- "anyOf": [
1293
- {
1294
- "type": "string"
1295
- },
1296
- {
1297
- "type": "null"
1298
- }
1299
- ]
1287
+ "type": ["string", "null"]
1300
1288
  }
1301
1289
  ```
1302
1290
 
@@ -1311,11 +1299,9 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1311
1299
  ```json
1312
1300
  {
1313
1301
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1314
- "title": "Set coloring overwrites schema",
1315
1302
  "type": "object",
1316
1303
  "properties": {
1317
1304
  "overwrites": {
1318
- "description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all",
1319
1305
  "type": "array",
1320
1306
  "items": {
1321
1307
  "anyOf": [
@@ -1327,21 +1313,21 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1327
1313
  "type": "object",
1328
1314
  "properties": {
1329
1315
  "dataItemInternalKey": {
1330
- "description": "Internal key of the data item of the dimension to be updated",
1331
- "type": "string"
1316
+ "type": "string",
1317
+ "description": "Internal key of the data item of the dimension to be updated"
1332
1318
  },
1333
1319
  "dataItemUniqueSignature": {
1334
- "description": "Unique signature of the data item of the dimension to be updated",
1335
- "type": "string"
1320
+ "type": "string",
1321
+ "description": "Unique signature of the data item of the dimension to be updated"
1336
1322
  }
1337
1323
  },
1338
1324
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1339
1325
  "additionalProperties": false
1340
1326
  },
1341
1327
  "color": {
1342
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1343
1328
  "type": "string",
1344
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1329
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1330
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1345
1331
  },
1346
1332
  "operator": {
1347
1333
  "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
@@ -1359,14 +1345,7 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1359
1345
  },
1360
1346
  "value": {
1361
1347
  "description": "Value to compare against",
1362
- "anyOf": [
1363
- {
1364
- "type": "string"
1365
- },
1366
- {
1367
- "type": "number"
1368
- }
1369
- ]
1348
+ "type": ["string", "number"]
1370
1349
  }
1371
1350
  },
1372
1351
  "required": ["color", "value"],
@@ -1380,48 +1359,34 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1380
1359
  "type": "object",
1381
1360
  "properties": {
1382
1361
  "dataItemInternalKey": {
1383
- "description": "Internal key of the data item of the dimension to be updated",
1384
- "type": "string"
1362
+ "type": "string",
1363
+ "description": "Internal key of the data item of the dimension to be updated"
1385
1364
  },
1386
1365
  "dataItemUniqueSignature": {
1387
- "description": "Unique signature of the data item of the dimension to be updated",
1388
- "type": "string"
1366
+ "type": "string",
1367
+ "description": "Unique signature of the data item of the dimension to be updated"
1389
1368
  }
1390
1369
  },
1391
1370
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1392
1371
  "additionalProperties": false
1393
1372
  },
1394
1373
  "color": {
1395
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1396
1374
  "type": "string",
1397
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1375
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1376
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1398
1377
  },
1399
1378
  "operator": {
1400
- "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)",
1401
1379
  "type": "string",
1402
- "const": "between"
1380
+ "const": "between",
1381
+ "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)"
1403
1382
  },
1404
1383
  "value": {
1405
1384
  "description": "Lower bound of the range",
1406
- "anyOf": [
1407
- {
1408
- "type": "string"
1409
- },
1410
- {
1411
- "type": "number"
1412
- }
1413
- ]
1385
+ "type": ["string", "number"]
1414
1386
  },
1415
1387
  "secondValue": {
1416
1388
  "description": "Upper bound of the range",
1417
- "anyOf": [
1418
- {
1419
- "type": "string"
1420
- },
1421
- {
1422
- "type": "number"
1423
- }
1424
- ]
1389
+ "type": ["string", "number"]
1425
1390
  }
1426
1391
  },
1427
1392
  "required": ["color", "operator", "value", "secondValue"],
@@ -1435,41 +1400,34 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1435
1400
  "type": "object",
1436
1401
  "properties": {
1437
1402
  "dataItemInternalKey": {
1438
- "description": "Internal key of the data item of the dimension to be updated",
1439
- "type": "string"
1403
+ "type": "string",
1404
+ "description": "Internal key of the data item of the dimension to be updated"
1440
1405
  },
1441
1406
  "dataItemUniqueSignature": {
1442
- "description": "Unique signature of the data item of the dimension to be updated",
1443
- "type": "string"
1407
+ "type": "string",
1408
+ "description": "Unique signature of the data item of the dimension to be updated"
1444
1409
  }
1445
1410
  },
1446
1411
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1447
1412
  "additionalProperties": false
1448
1413
  },
1449
1414
  "color": {
1450
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1451
1415
  "type": "string",
1452
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1416
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1417
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1453
1418
  },
1454
1419
  "operator": {
1455
- "description": "Match (inList) or exclude (notInList) every value in values",
1456
1420
  "type": "string",
1457
- "enum": ["inList", "notInList"]
1421
+ "enum": ["inList", "notInList"],
1422
+ "description": "Match (inList) or exclude (notInList) every value in values"
1458
1423
  },
1459
1424
  "values": {
1460
- "description": "Values to match",
1461
1425
  "minItems": 1,
1462
1426
  "type": "array",
1463
1427
  "items": {
1464
- "anyOf": [
1465
- {
1466
- "type": "string"
1467
- },
1468
- {
1469
- "type": "number"
1470
- }
1471
- ]
1472
- }
1428
+ "type": ["string", "number"]
1429
+ },
1430
+ "description": "Values to match"
1473
1431
  },
1474
1432
  "delimiter": {
1475
1433
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -1481,11 +1439,13 @@ Replace all value colors, eg. color the dimension value "Happy" dark teal. Value
1481
1439
  "additionalProperties": false
1482
1440
  }
1483
1441
  ]
1484
- }
1442
+ },
1443
+ "description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all"
1485
1444
  }
1486
1445
  },
1487
1446
  "required": ["overwrites"],
1488
- "additionalProperties": false
1447
+ "additionalProperties": false,
1448
+ "title": "Set coloring overwrites schema"
1489
1449
  }
1490
1450
  ```
1491
1451
 
@@ -1517,11 +1477,9 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1517
1477
  ```json
1518
1478
  {
1519
1479
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1520
- "title": "Set coloring rules schema",
1521
1480
  "type": "object",
1522
1481
  "properties": {
1523
1482
  "rules": {
1524
- "description": "Ordered list of measure color rules; the first matching rule wins. An empty list removes them all",
1525
1483
  "type": "array",
1526
1484
  "items": {
1527
1485
  "anyOf": [
@@ -1529,41 +1487,34 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1529
1487
  "type": "object",
1530
1488
  "properties": {
1531
1489
  "measure": {
1532
- "description": "Measure whose value is compared",
1533
1490
  "type": "object",
1534
1491
  "properties": {
1535
1492
  "dataItemInternalKey": {
1536
- "description": "Internal key of the data item of the measure to be updated",
1537
- "type": "string"
1493
+ "type": "string",
1494
+ "description": "Internal key of the data item of the measure to be updated"
1538
1495
  },
1539
1496
  "dataItemUniqueSignature": {
1540
- "description": "Unique signature of the data item of the measure to be updated",
1541
- "type": "string"
1497
+ "type": "string",
1498
+ "description": "Unique signature of the data item of the measure to be updated"
1542
1499
  }
1543
1500
  },
1544
1501
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1545
- "additionalProperties": false
1502
+ "additionalProperties": false,
1503
+ "description": "Measure whose value is compared"
1546
1504
  },
1547
1505
  "color": {
1548
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1549
1506
  "type": "string",
1550
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1507
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1508
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1551
1509
  },
1552
1510
  "operator": {
1553
- "description": "How the measure value is compared",
1554
1511
  "type": "string",
1555
- "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"]
1512
+ "enum": ["equals", "not-equals", "greater", "less", "greater-equals", "less-equals"],
1513
+ "description": "How the measure value is compared"
1556
1514
  },
1557
1515
  "value": {
1558
1516
  "description": "Value to compare against",
1559
- "anyOf": [
1560
- {
1561
- "type": "string"
1562
- },
1563
- {
1564
- "type": "number"
1565
- }
1566
- ]
1517
+ "type": ["string", "number"]
1567
1518
  }
1568
1519
  },
1569
1520
  "required": ["measure", "color", "operator", "value"],
@@ -1573,52 +1524,38 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1573
1524
  "type": "object",
1574
1525
  "properties": {
1575
1526
  "measure": {
1576
- "description": "Measure whose value is compared",
1577
1527
  "type": "object",
1578
1528
  "properties": {
1579
1529
  "dataItemInternalKey": {
1580
- "description": "Internal key of the data item of the measure to be updated",
1581
- "type": "string"
1530
+ "type": "string",
1531
+ "description": "Internal key of the data item of the measure to be updated"
1582
1532
  },
1583
1533
  "dataItemUniqueSignature": {
1584
- "description": "Unique signature of the data item of the measure to be updated",
1585
- "type": "string"
1534
+ "type": "string",
1535
+ "description": "Unique signature of the data item of the measure to be updated"
1586
1536
  }
1587
1537
  },
1588
1538
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1589
- "additionalProperties": false
1539
+ "additionalProperties": false,
1540
+ "description": "Measure whose value is compared"
1590
1541
  },
1591
1542
  "color": {
1592
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1593
1543
  "type": "string",
1594
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1544
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1545
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1595
1546
  },
1596
1547
  "operator": {
1597
- "description": "Matches measure values from value to secondValue, both inclusive",
1598
1548
  "type": "string",
1599
- "const": "between"
1549
+ "const": "between",
1550
+ "description": "Matches measure values from value to secondValue, both inclusive"
1600
1551
  },
1601
1552
  "value": {
1602
1553
  "description": "Lower bound of the range",
1603
- "anyOf": [
1604
- {
1605
- "type": "string"
1606
- },
1607
- {
1608
- "type": "number"
1609
- }
1610
- ]
1554
+ "type": ["string", "number"]
1611
1555
  },
1612
1556
  "secondValue": {
1613
1557
  "description": "Upper bound of the range",
1614
- "anyOf": [
1615
- {
1616
- "type": "string"
1617
- },
1618
- {
1619
- "type": "number"
1620
- }
1621
- ]
1558
+ "type": ["string", "number"]
1622
1559
  }
1623
1560
  },
1624
1561
  "required": ["measure", "color", "operator", "value", "secondValue"],
@@ -1628,45 +1565,38 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1628
1565
  "type": "object",
1629
1566
  "properties": {
1630
1567
  "measure": {
1631
- "description": "Measure whose value is compared",
1632
1568
  "type": "object",
1633
1569
  "properties": {
1634
1570
  "dataItemInternalKey": {
1635
- "description": "Internal key of the data item of the measure to be updated",
1636
- "type": "string"
1571
+ "type": "string",
1572
+ "description": "Internal key of the data item of the measure to be updated"
1637
1573
  },
1638
1574
  "dataItemUniqueSignature": {
1639
- "description": "Unique signature of the data item of the measure to be updated",
1640
- "type": "string"
1575
+ "type": "string",
1576
+ "description": "Unique signature of the data item of the measure to be updated"
1641
1577
  }
1642
1578
  },
1643
1579
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1644
- "additionalProperties": false
1580
+ "additionalProperties": false,
1581
+ "description": "Measure whose value is compared"
1645
1582
  },
1646
1583
  "color": {
1647
- "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1648
1584
  "type": "string",
1649
- "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1585
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
1586
+ "description": "Color applied when the condition matches, eg. \"#0F766E\""
1650
1587
  },
1651
1588
  "operator": {
1652
- "description": "Match (inList) or exclude (notInList) every value in values",
1653
1589
  "type": "string",
1654
- "enum": ["inList", "notInList"]
1590
+ "enum": ["inList", "notInList"],
1591
+ "description": "Match (inList) or exclude (notInList) every value in values"
1655
1592
  },
1656
1593
  "values": {
1657
- "description": "Values to match",
1658
1594
  "minItems": 1,
1659
1595
  "type": "array",
1660
1596
  "items": {
1661
- "anyOf": [
1662
- {
1663
- "type": "string"
1664
- },
1665
- {
1666
- "type": "number"
1667
- }
1668
- ]
1669
- }
1597
+ "type": ["string", "number"]
1598
+ },
1599
+ "description": "Values to match"
1670
1600
  },
1671
1601
  "delimiter": {
1672
1602
  "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
@@ -1678,11 +1608,13 @@ Replace all measure color rules, eg. color marks red when Sales is below 100. Ru
1678
1608
  "additionalProperties": false
1679
1609
  }
1680
1610
  ]
1681
- }
1611
+ },
1612
+ "description": "Ordered list of measure color rules; the first matching rule wins. An empty list removes them all"
1682
1613
  }
1683
1614
  },
1684
1615
  "required": ["rules"],
1685
- "additionalProperties": false
1616
+ "additionalProperties": false,
1617
+ "title": "Set coloring rules schema"
1686
1618
  }
1687
1619
  ```
1688
1620
 
@@ -1697,9 +1629,9 @@ Set the order categorical colors and legend items follow: "alpha-asc" sorts asce
1697
1629
  ```json
1698
1630
  {
1699
1631
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1700
- "title": "Coloring sort order schema",
1701
1632
  "type": "string",
1702
- "enum": ["alpha-asc", "data"]
1633
+ "enum": ["alpha-asc", "data"],
1634
+ "title": "Coloring sort order schema"
1703
1635
  }
1704
1636
  ```
1705
1637
 
@@ -1714,9 +1646,9 @@ Set how colors are applied to the chart
1714
1646
  ```json
1715
1647
  {
1716
1648
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1717
- "title": "Coloring type schema",
1718
1649
  "type": "string",
1719
- "enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"]
1650
+ "enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"],
1651
+ "title": "Coloring type schema"
1720
1652
  }
1721
1653
  ```
1722
1654
 
@@ -1731,7 +1663,6 @@ Replace the whole custom gradient with a provided list of colors
1731
1663
  ```json
1732
1664
  {
1733
1665
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1734
- "title": "Custom gradient colors schema",
1735
1666
  "type": "object",
1736
1667
  "properties": {
1737
1668
  "colors": {
@@ -1744,7 +1675,8 @@ Replace the whole custom gradient with a provided list of colors
1744
1675
  }
1745
1676
  },
1746
1677
  "required": ["colors"],
1747
- "additionalProperties": false
1678
+ "additionalProperties": false,
1679
+ "title": "Custom gradient colors schema"
1748
1680
  }
1749
1681
  ```
1750
1682
 
@@ -1759,7 +1691,6 @@ Replace the whole custom categorical palette with a provided list of colors and
1759
1691
  ```json
1760
1692
  {
1761
1693
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1762
- "title": "Custom palette colors schema",
1763
1694
  "type": "object",
1764
1695
  "properties": {
1765
1696
  "colors": {
@@ -1772,7 +1703,8 @@ Replace the whole custom categorical palette with a provided list of colors and
1772
1703
  }
1773
1704
  },
1774
1705
  "required": ["colors"],
1775
- "additionalProperties": false
1706
+ "additionalProperties": false,
1707
+ "title": "Custom palette colors schema"
1776
1708
  }
1777
1709
  ```
1778
1710
 
@@ -1787,16 +1719,15 @@ Set the custom display format string for a dimension. This changes label formatt
1787
1719
  ```json
1788
1720
  {
1789
1721
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1790
- "title": "Dimension format string schema",
1791
1722
  "type": "object",
1792
1723
  "properties": {
1793
1724
  "dataItemInternalKey": {
1794
- "description": "Internal key of the data item of the dimension to be updated",
1795
- "type": "string"
1725
+ "type": "string",
1726
+ "description": "Internal key of the data item of the dimension to be updated"
1796
1727
  },
1797
1728
  "dataItemUniqueSignature": {
1798
- "description": "Unique signature of the data item of the dimension to be updated",
1799
- "type": "string"
1729
+ "type": "string",
1730
+ "description": "Unique signature of the data item of the dimension to be updated"
1800
1731
  },
1801
1732
  "formatString": {
1802
1733
  "anyOf": [
@@ -1821,7 +1752,8 @@ Set the custom display format string for a dimension. This changes label formatt
1821
1752
  }
1822
1753
  },
1823
1754
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1824
- "additionalProperties": false
1755
+ "additionalProperties": false,
1756
+ "title": "Dimension format string schema"
1825
1757
  }
1826
1758
  ```
1827
1759
 
@@ -1836,16 +1768,15 @@ Set the display format type used by a dimension. This changes label formatting o
1836
1768
  ```json
1837
1769
  {
1838
1770
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1839
- "title": "Dimension format type schema",
1840
1771
  "type": "object",
1841
1772
  "properties": {
1842
1773
  "dataItemInternalKey": {
1843
- "description": "Internal key of the data item of the dimension to be updated",
1844
- "type": "string"
1774
+ "type": "string",
1775
+ "description": "Internal key of the data item of the dimension to be updated"
1845
1776
  },
1846
1777
  "dataItemUniqueSignature": {
1847
- "description": "Unique signature of the data item of the dimension to be updated",
1848
- "type": "string"
1778
+ "type": "string",
1779
+ "description": "Unique signature of the data item of the dimension to be updated"
1849
1780
  },
1850
1781
  "formatType": {
1851
1782
  "anyOf": [
@@ -1940,7 +1871,8 @@ Set the display format type used by a dimension. This changes label formatting o
1940
1871
  }
1941
1872
  },
1942
1873
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
1943
- "additionalProperties": false
1874
+ "additionalProperties": false,
1875
+ "title": "Dimension format type schema"
1944
1876
  }
1945
1877
  ```
1946
1878
 
@@ -1955,18 +1887,17 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
1955
1887
  ```json
1956
1888
  {
1957
1889
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1958
- "title": "Dimension temporal grouping schema",
1959
- "anyOf": [
1890
+ "oneOf": [
1960
1891
  {
1961
1892
  "type": "object",
1962
1893
  "properties": {
1963
1894
  "dataItemInternalKey": {
1964
- "description": "Internal key of the data item of the dimension to be updated",
1965
- "type": "string"
1895
+ "type": "string",
1896
+ "description": "Internal key of the data item of the dimension to be updated"
1966
1897
  },
1967
1898
  "dataItemUniqueSignature": {
1968
- "description": "Unique signature of the data item of the dimension to be updated",
1969
- "type": "string"
1899
+ "type": "string",
1900
+ "description": "Unique signature of the data item of the dimension to be updated"
1970
1901
  },
1971
1902
  "mode": {
1972
1903
  "type": "string",
@@ -1980,12 +1911,12 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
1980
1911
  "type": "object",
1981
1912
  "properties": {
1982
1913
  "dataItemInternalKey": {
1983
- "description": "Internal key of the data item of the dimension to be updated",
1984
- "type": "string"
1914
+ "type": "string",
1915
+ "description": "Internal key of the data item of the dimension to be updated"
1985
1916
  },
1986
1917
  "dataItemUniqueSignature": {
1987
- "description": "Unique signature of the data item of the dimension to be updated",
1988
- "type": "string"
1918
+ "type": "string",
1919
+ "description": "Unique signature of the data item of the dimension to be updated"
1989
1920
  },
1990
1921
  "mode": {
1991
1922
  "type": "string",
@@ -2016,12 +1947,12 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
2016
1947
  "type": "object",
2017
1948
  "properties": {
2018
1949
  "dataItemInternalKey": {
2019
- "description": "Internal key of the data item of the dimension to be updated",
2020
- "type": "string"
1950
+ "type": "string",
1951
+ "description": "Internal key of the data item of the dimension to be updated"
2021
1952
  },
2022
1953
  "dataItemUniqueSignature": {
2023
- "description": "Unique signature of the data item of the dimension to be updated",
2024
- "type": "string"
1954
+ "type": "string",
1955
+ "description": "Unique signature of the data item of the dimension to be updated"
2025
1956
  },
2026
1957
  "mode": {
2027
1958
  "type": "string",
@@ -2047,7 +1978,8 @@ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel f
2047
1978
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
2048
1979
  "additionalProperties": false
2049
1980
  }
2050
- ]
1981
+ ],
1982
+ "title": "Dimension temporal grouping schema"
2051
1983
  }
2052
1984
  ```
2053
1985
 
@@ -2062,9 +1994,9 @@ Show or hide the chart legend
2062
1994
  ```json
2063
1995
  {
2064
1996
  "$schema": "https://json-schema.org/draft/2020-12/schema",
1997
+ "type": "boolean",
2065
1998
  "description": "Enable legend",
2066
- "title": "Legend enabled schema",
2067
- "type": "boolean"
1999
+ "title": "Legend enabled schema"
2068
2000
  }
2069
2001
  ```
2070
2002
 
@@ -2079,8 +2011,6 @@ Change the color of legend text labels
2079
2011
  ```json
2080
2012
  {
2081
2013
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2082
- "description": "Legend item label font color (hexadecimal color code)",
2083
- "title": "Legend item label fill schema",
2084
2014
  "anyOf": [
2085
2015
  {
2086
2016
  "type": "string",
@@ -2089,7 +2019,9 @@ Change the color of legend text labels
2089
2019
  {
2090
2020
  "type": "null"
2091
2021
  }
2092
- ]
2022
+ ],
2023
+ "description": "Legend item label font color (hexadecimal color code)",
2024
+ "title": "Legend item label fill schema"
2093
2025
  }
2094
2026
  ```
2095
2027
 
@@ -2104,8 +2036,8 @@ Adjust the font size of legend labels
2104
2036
  ```json
2105
2037
  {
2106
2038
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2107
- "title": "Legend item label font size schema",
2108
- "type": "number"
2039
+ "type": "number",
2040
+ "title": "Legend item label font size schema"
2109
2041
  }
2110
2042
  ```
2111
2043
 
@@ -2139,14 +2071,7 @@ Set the maximum number of characters shown in legend labels
2139
2071
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2140
2072
  "description": "Maximum number of glyphs in the legend item label",
2141
2073
  "title": "Legend item label max glyph count schema",
2142
- "anyOf": [
2143
- {
2144
- "type": "number"
2145
- },
2146
- {
2147
- "type": "null"
2148
- }
2149
- ]
2074
+ "type": ["number", "null"]
2150
2075
  }
2151
2076
  ```
2152
2077
 
@@ -2161,10 +2086,10 @@ Change where the legend appears on the chart
2161
2086
  ```json
2162
2087
  {
2163
2088
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2164
- "description": "Legend position",
2165
- "title": "Legend position schema",
2166
2089
  "type": "string",
2167
- "enum": ["left", "right", "top", "bottom"]
2090
+ "enum": ["left", "right", "top", "bottom"],
2091
+ "description": "Legend position",
2092
+ "title": "Legend position schema"
2168
2093
  }
2169
2094
  ```
2170
2095
 
@@ -2181,14 +2106,7 @@ Set a custom title for the legend
2181
2106
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2182
2107
  "description": "Legend title text",
2183
2108
  "title": "Legend title schema",
2184
- "anyOf": [
2185
- {
2186
- "type": "string"
2187
- },
2188
- {
2189
- "type": "null"
2190
- }
2191
- ]
2109
+ "type": ["string", "null"]
2192
2110
  }
2193
2111
  ```
2194
2112
 
@@ -2203,23 +2121,23 @@ Set the currency symbol used by a measure formatter
2203
2121
  ```json
2204
2122
  {
2205
2123
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2206
- "title": "Measure currency schema",
2207
2124
  "type": "object",
2208
2125
  "properties": {
2209
2126
  "dataItemInternalKey": {
2210
- "description": "Internal key of the data item of the measure to be updated",
2211
- "type": "string"
2127
+ "type": "string",
2128
+ "description": "Internal key of the data item of the measure to be updated"
2212
2129
  },
2213
2130
  "dataItemUniqueSignature": {
2214
- "description": "Unique signature of the data item of the measure to be updated",
2215
- "type": "string"
2131
+ "type": "string",
2132
+ "description": "Unique signature of the data item of the measure to be updated"
2216
2133
  },
2217
2134
  "currency": {
2218
2135
  "type": "string"
2219
2136
  }
2220
2137
  },
2221
2138
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2222
- "additionalProperties": false
2139
+ "additionalProperties": false,
2140
+ "title": "Measure currency schema"
2223
2141
  }
2224
2142
  ```
2225
2143
 
@@ -2234,23 +2152,23 @@ Set whether measure currency symbol is prefixed
2234
2152
  ```json
2235
2153
  {
2236
2154
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2237
- "title": "Measure currency is prefix schema",
2238
2155
  "type": "object",
2239
2156
  "properties": {
2240
2157
  "dataItemInternalKey": {
2241
- "description": "Internal key of the data item of the measure to be updated",
2242
- "type": "string"
2158
+ "type": "string",
2159
+ "description": "Internal key of the data item of the measure to be updated"
2243
2160
  },
2244
2161
  "dataItemUniqueSignature": {
2245
- "description": "Unique signature of the data item of the measure to be updated",
2246
- "type": "string"
2162
+ "type": "string",
2163
+ "description": "Unique signature of the data item of the measure to be updated"
2247
2164
  },
2248
2165
  "currencyIsPrefix": {
2249
2166
  "type": "boolean"
2250
2167
  }
2251
2168
  },
2252
2169
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2253
- "additionalProperties": false
2170
+ "additionalProperties": false,
2171
+ "title": "Measure currency is prefix schema"
2254
2172
  }
2255
2173
  ```
2256
2174
 
@@ -2265,16 +2183,15 @@ Configure a Defined parameter of a custom measure using its default, a static va
2265
2183
  ```json
2266
2184
  {
2267
2185
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2268
- "title": "Set measure defined parameter schema",
2269
2186
  "type": "object",
2270
2187
  "properties": {
2271
2188
  "dataItemInternalKey": {
2272
- "description": "Internal key of the data item of the measure to be updated",
2273
- "type": "string"
2189
+ "type": "string",
2190
+ "description": "Internal key of the data item of the measure to be updated"
2274
2191
  },
2275
2192
  "dataItemUniqueSignature": {
2276
- "description": "Unique signature of the data item of the measure to be updated",
2277
- "type": "string"
2193
+ "type": "string",
2194
+ "description": "Unique signature of the data item of the measure to be updated"
2278
2195
  },
2279
2196
  "collectionKey": {
2280
2197
  "description": "Measure collection to update. Defaults to primary measures.",
@@ -2282,13 +2199,12 @@ Configure a Defined parameter of a custom measure using its default, a static va
2282
2199
  "enum": ["measures", "supportingMeasures"]
2283
2200
  },
2284
2201
  "parameterName": {
2285
- "description": "Exact name of a Defined parameter exposed by the measure",
2286
2202
  "type": "string",
2287
- "minLength": 1
2203
+ "minLength": 1,
2204
+ "description": "Exact name of a Defined parameter exposed by the measure"
2288
2205
  },
2289
2206
  "value": {
2290
- "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
2291
- "anyOf": [
2207
+ "oneOf": [
2292
2208
  {
2293
2209
  "type": "object",
2294
2210
  "properties": {
@@ -2308,17 +2224,7 @@ Configure a Defined parameter of a custom measure using its default, a static va
2308
2224
  "const": "static"
2309
2225
  },
2310
2226
  "value": {
2311
- "anyOf": [
2312
- {
2313
- "type": "string"
2314
- },
2315
- {
2316
- "type": "number"
2317
- },
2318
- {
2319
- "type": "boolean"
2320
- }
2321
- ]
2227
+ "type": ["string", "number", "boolean"]
2322
2228
  }
2323
2229
  },
2324
2230
  "required": ["type", "value"],
@@ -2332,19 +2238,21 @@ Configure a Defined parameter of a custom measure using its default, a static va
2332
2238
  "const": "variable"
2333
2239
  },
2334
2240
  "variableName": {
2335
- "description": "Exact name of an existing compatible workbook variable",
2336
2241
  "type": "string",
2337
- "minLength": 1
2242
+ "minLength": 1,
2243
+ "description": "Exact name of an existing compatible workbook variable"
2338
2244
  }
2339
2245
  },
2340
2246
  "required": ["type", "variableName"],
2341
2247
  "additionalProperties": false
2342
2248
  }
2343
- ]
2249
+ ],
2250
+ "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable"
2344
2251
  }
2345
2252
  },
2346
2253
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
2347
- "additionalProperties": false
2254
+ "additionalProperties": false,
2255
+ "title": "Set measure defined parameter schema"
2348
2256
  }
2349
2257
  ```
2350
2258
 
@@ -2359,22 +2267,19 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2359
2267
  ```json
2360
2268
  {
2361
2269
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2362
- "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
2363
- "title": "Set measure filter schema",
2364
2270
  "anyOf": [
2365
2271
  {
2366
2272
  "type": "object",
2367
2273
  "properties": {
2368
2274
  "measureName": {
2369
- "description": "Visible measure name or label",
2370
- "type": "string"
2275
+ "type": "string",
2276
+ "description": "Visible measure name or label"
2371
2277
  },
2372
2278
  "fieldKey": {
2373
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2374
- "type": "string"
2279
+ "type": "string",
2280
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2375
2281
  },
2376
2282
  "operator": {
2377
- "description": "Filter operator that requires a value",
2378
2283
  "type": "string",
2379
2284
  "enum": [
2380
2285
  "equals",
@@ -2389,10 +2294,10 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2389
2294
  "notLike",
2390
2295
  "startsWith",
2391
2296
  "endsWith"
2392
- ]
2297
+ ],
2298
+ "description": "Filter operator that requires a value"
2393
2299
  },
2394
2300
  "value": {
2395
- "description": "Filter value",
2396
2301
  "anyOf": [
2397
2302
  {
2398
2303
  "type": "string"
@@ -2411,7 +2316,8 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2411
2316
  "required": ["type", "variableName"],
2412
2317
  "additionalProperties": false
2413
2318
  }
2414
- ]
2319
+ ],
2320
+ "description": "Filter value"
2415
2321
  }
2416
2322
  },
2417
2323
  "required": ["measureName", "fieldKey", "operator", "value"],
@@ -2421,20 +2327,19 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2421
2327
  "type": "object",
2422
2328
  "properties": {
2423
2329
  "measureName": {
2424
- "description": "Visible measure name or label",
2425
- "type": "string"
2330
+ "type": "string",
2331
+ "description": "Visible measure name or label"
2426
2332
  },
2427
2333
  "fieldKey": {
2428
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2429
- "type": "string"
2334
+ "type": "string",
2335
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2430
2336
  },
2431
2337
  "operator": {
2432
- "description": "Filter operator that requires valueFrom and valueTo",
2433
2338
  "type": "string",
2434
- "enum": ["isBetween", "isNotBetween"]
2339
+ "enum": ["isBetween", "isNotBetween"],
2340
+ "description": "Filter operator that requires valueFrom and valueTo"
2435
2341
  },
2436
2342
  "valueFrom": {
2437
- "description": "Lower filter value",
2438
2343
  "anyOf": [
2439
2344
  {
2440
2345
  "type": "string"
@@ -2453,10 +2358,10 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2453
2358
  "required": ["type", "variableName"],
2454
2359
  "additionalProperties": false
2455
2360
  }
2456
- ]
2361
+ ],
2362
+ "description": "Lower filter value"
2457
2363
  },
2458
2364
  "valueTo": {
2459
- "description": "Upper filter value",
2460
2365
  "anyOf": [
2461
2366
  {
2462
2367
  "type": "string"
@@ -2475,7 +2380,8 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2475
2380
  "required": ["type", "variableName"],
2476
2381
  "additionalProperties": false
2477
2382
  }
2478
- ]
2383
+ ],
2384
+ "description": "Upper filter value"
2479
2385
  }
2480
2386
  },
2481
2387
  "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
@@ -2485,25 +2391,25 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2485
2391
  "type": "object",
2486
2392
  "properties": {
2487
2393
  "measureName": {
2488
- "description": "Visible measure name or label",
2489
- "type": "string"
2394
+ "type": "string",
2395
+ "description": "Visible measure name or label"
2490
2396
  },
2491
2397
  "fieldKey": {
2492
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2493
- "type": "string"
2398
+ "type": "string",
2399
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2494
2400
  },
2495
2401
  "operator": {
2496
- "description": "Filter operator that requires a list of values",
2497
2402
  "type": "string",
2498
- "enum": ["inList", "excludedFromList"]
2403
+ "enum": ["inList", "excludedFromList"],
2404
+ "description": "Filter operator that requires a list of values"
2499
2405
  },
2500
2406
  "values": {
2501
- "description": "Filter values",
2502
2407
  "minItems": 1,
2503
2408
  "type": "array",
2504
2409
  "items": {
2505
2410
  "type": "string"
2506
- }
2411
+ },
2412
+ "description": "Filter values"
2507
2413
  }
2508
2414
  },
2509
2415
  "required": ["measureName", "fieldKey", "operator", "values"],
@@ -2513,23 +2419,25 @@ Set one measure filter before aggregation. Adds if none, replaces if one, fails
2513
2419
  "type": "object",
2514
2420
  "properties": {
2515
2421
  "measureName": {
2516
- "description": "Visible measure name or label",
2517
- "type": "string"
2422
+ "type": "string",
2423
+ "description": "Visible measure name or label"
2518
2424
  },
2519
2425
  "fieldKey": {
2520
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2521
- "type": "string"
2426
+ "type": "string",
2427
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2522
2428
  },
2523
2429
  "operator": {
2524
- "description": "Filter operator that does not require values",
2525
2430
  "type": "string",
2526
- "enum": ["isNull", "notNull"]
2431
+ "enum": ["isNull", "notNull"],
2432
+ "description": "Filter operator that does not require values"
2527
2433
  }
2528
2434
  },
2529
2435
  "required": ["measureName", "fieldKey", "operator"],
2530
2436
  "additionalProperties": false
2531
2437
  }
2532
- ]
2438
+ ],
2439
+ "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
2440
+ "title": "Set measure filter schema"
2533
2441
  }
2534
2442
  ```
2535
2443
 
@@ -2544,16 +2452,15 @@ Set the custom format string for a measure
2544
2452
  ```json
2545
2453
  {
2546
2454
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2547
- "title": "Measure format string schema",
2548
2455
  "type": "object",
2549
2456
  "properties": {
2550
2457
  "dataItemInternalKey": {
2551
- "description": "Internal key of the data item of the measure to be updated",
2552
- "type": "string"
2458
+ "type": "string",
2459
+ "description": "Internal key of the data item of the measure to be updated"
2553
2460
  },
2554
2461
  "dataItemUniqueSignature": {
2555
- "description": "Unique signature of the data item of the measure to be updated",
2556
- "type": "string"
2462
+ "type": "string",
2463
+ "description": "Unique signature of the data item of the measure to be updated"
2557
2464
  },
2558
2465
  "formatString": {
2559
2466
  "anyOf": [
@@ -2578,7 +2485,8 @@ Set the custom format string for a measure
2578
2485
  }
2579
2486
  },
2580
2487
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2581
- "additionalProperties": false
2488
+ "additionalProperties": false,
2489
+ "title": "Measure format string schema"
2582
2490
  }
2583
2491
  ```
2584
2492
 
@@ -2593,16 +2501,15 @@ Set the format type used by a measure
2593
2501
  ```json
2594
2502
  {
2595
2503
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2596
- "title": "Measure format type schema",
2597
2504
  "type": "object",
2598
2505
  "properties": {
2599
2506
  "dataItemInternalKey": {
2600
- "description": "Internal key of the data item of the measure to be updated",
2601
- "type": "string"
2507
+ "type": "string",
2508
+ "description": "Internal key of the data item of the measure to be updated"
2602
2509
  },
2603
2510
  "dataItemUniqueSignature": {
2604
- "description": "Unique signature of the data item of the measure to be updated",
2605
- "type": "string"
2511
+ "type": "string",
2512
+ "description": "Unique signature of the data item of the measure to be updated"
2606
2513
  },
2607
2514
  "formatType": {
2608
2515
  "anyOf": [
@@ -2697,7 +2604,8 @@ Set the format type used by a measure
2697
2604
  }
2698
2605
  },
2699
2606
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
2700
- "additionalProperties": false
2607
+ "additionalProperties": false,
2608
+ "title": "Measure format type schema"
2701
2609
  }
2702
2610
  ```
2703
2611
 
@@ -2712,16 +2620,15 @@ Set how negative values are displayed for a measure formatter
2712
2620
  ```json
2713
2621
  {
2714
2622
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2715
- "title": "Measure negative type schema",
2716
2623
  "type": "object",
2717
2624
  "properties": {
2718
2625
  "dataItemInternalKey": {
2719
- "description": "Internal key of the data item of the measure to be updated",
2720
- "type": "string"
2626
+ "type": "string",
2627
+ "description": "Internal key of the data item of the measure to be updated"
2721
2628
  },
2722
2629
  "dataItemUniqueSignature": {
2723
- "description": "Unique signature of the data item of the measure to be updated",
2724
- "type": "string"
2630
+ "type": "string",
2631
+ "description": "Unique signature of the data item of the measure to be updated"
2725
2632
  },
2726
2633
  "negativeType": {
2727
2634
  "type": "string",
@@ -2729,7 +2636,8 @@ Set how negative values are displayed for a measure formatter
2729
2636
  }
2730
2637
  },
2731
2638
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2732
- "additionalProperties": false
2639
+ "additionalProperties": false,
2640
+ "title": "Measure negative type schema"
2733
2641
  }
2734
2642
  ```
2735
2643
 
@@ -2744,18 +2652,15 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2744
2652
  ```json
2745
2653
  {
2746
2654
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2747
- "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
2748
- "title": "Set result filter schema",
2749
2655
  "anyOf": [
2750
2656
  {
2751
2657
  "type": "object",
2752
2658
  "properties": {
2753
2659
  "measureName": {
2754
- "description": "Visible measure name or label",
2755
- "type": "string"
2660
+ "type": "string",
2661
+ "description": "Visible measure name or label"
2756
2662
  },
2757
2663
  "operator": {
2758
- "description": "Filter operator that requires a value",
2759
2664
  "type": "string",
2760
2665
  "enum": [
2761
2666
  "equals",
@@ -2770,10 +2675,10 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2770
2675
  "notLike",
2771
2676
  "startsWith",
2772
2677
  "endsWith"
2773
- ]
2678
+ ],
2679
+ "description": "Filter operator that requires a value"
2774
2680
  },
2775
2681
  "value": {
2776
- "description": "Filter value",
2777
2682
  "anyOf": [
2778
2683
  {
2779
2684
  "type": "string"
@@ -2792,7 +2697,8 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2792
2697
  "required": ["type", "variableName"],
2793
2698
  "additionalProperties": false
2794
2699
  }
2795
- ]
2700
+ ],
2701
+ "description": "Filter value"
2796
2702
  }
2797
2703
  },
2798
2704
  "required": ["measureName", "operator", "value"],
@@ -2802,16 +2708,15 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2802
2708
  "type": "object",
2803
2709
  "properties": {
2804
2710
  "measureName": {
2805
- "description": "Visible measure name or label",
2806
- "type": "string"
2711
+ "type": "string",
2712
+ "description": "Visible measure name or label"
2807
2713
  },
2808
2714
  "operator": {
2809
- "description": "Filter operator that requires valueFrom and valueTo",
2810
2715
  "type": "string",
2811
- "enum": ["isBetween", "isNotBetween"]
2716
+ "enum": ["isBetween", "isNotBetween"],
2717
+ "description": "Filter operator that requires valueFrom and valueTo"
2812
2718
  },
2813
2719
  "valueFrom": {
2814
- "description": "Lower filter value",
2815
2720
  "anyOf": [
2816
2721
  {
2817
2722
  "type": "string"
@@ -2830,10 +2735,10 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2830
2735
  "required": ["type", "variableName"],
2831
2736
  "additionalProperties": false
2832
2737
  }
2833
- ]
2738
+ ],
2739
+ "description": "Lower filter value"
2834
2740
  },
2835
2741
  "valueTo": {
2836
- "description": "Upper filter value",
2837
2742
  "anyOf": [
2838
2743
  {
2839
2744
  "type": "string"
@@ -2852,7 +2757,8 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2852
2757
  "required": ["type", "variableName"],
2853
2758
  "additionalProperties": false
2854
2759
  }
2855
- ]
2760
+ ],
2761
+ "description": "Upper filter value"
2856
2762
  }
2857
2763
  },
2858
2764
  "required": ["measureName", "operator", "valueFrom", "valueTo"],
@@ -2862,21 +2768,21 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2862
2768
  "type": "object",
2863
2769
  "properties": {
2864
2770
  "measureName": {
2865
- "description": "Visible measure name or label",
2866
- "type": "string"
2771
+ "type": "string",
2772
+ "description": "Visible measure name or label"
2867
2773
  },
2868
2774
  "operator": {
2869
- "description": "Filter operator that requires a list of values",
2870
2775
  "type": "string",
2871
- "enum": ["inList", "excludedFromList"]
2776
+ "enum": ["inList", "excludedFromList"],
2777
+ "description": "Filter operator that requires a list of values"
2872
2778
  },
2873
2779
  "values": {
2874
- "description": "Filter values",
2875
2780
  "minItems": 1,
2876
2781
  "type": "array",
2877
2782
  "items": {
2878
2783
  "type": "string"
2879
- }
2784
+ },
2785
+ "description": "Filter values"
2880
2786
  }
2881
2787
  },
2882
2788
  "required": ["measureName", "operator", "values"],
@@ -2886,19 +2792,21 @@ Set one result filter after aggregation. Adds if none, replaces if one, fails if
2886
2792
  "type": "object",
2887
2793
  "properties": {
2888
2794
  "measureName": {
2889
- "description": "Visible measure name or label",
2890
- "type": "string"
2795
+ "type": "string",
2796
+ "description": "Visible measure name or label"
2891
2797
  },
2892
2798
  "operator": {
2893
- "description": "Filter operator that does not require values",
2894
2799
  "type": "string",
2895
- "enum": ["isNull", "notNull"]
2800
+ "enum": ["isNull", "notNull"],
2801
+ "description": "Filter operator that does not require values"
2896
2802
  }
2897
2803
  },
2898
2804
  "required": ["measureName", "operator"],
2899
2805
  "additionalProperties": false
2900
2806
  }
2901
- ]
2807
+ ],
2808
+ "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
2809
+ "title": "Set result filter schema"
2902
2810
  }
2903
2811
  ```
2904
2812
 
@@ -2913,7 +2821,6 @@ Set sorting direction for all matching sortable items by name
2913
2821
  ```json
2914
2822
  {
2915
2823
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2916
- "title": "Sorting direction by name schema",
2917
2824
  "type": "object",
2918
2825
  "properties": {
2919
2826
  "name": {
@@ -2926,7 +2833,8 @@ Set sorting direction for all matching sortable items by name
2926
2833
  }
2927
2834
  },
2928
2835
  "required": ["name", "sortDirection"],
2929
- "additionalProperties": false
2836
+ "additionalProperties": false,
2837
+ "title": "Sorting direction by name schema"
2930
2838
  }
2931
2839
  ```
2932
2840
 
@@ -2941,7 +2849,6 @@ Enable or disable sorting for all matching sortable items by name
2941
2849
  ```json
2942
2850
  {
2943
2851
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2944
- "title": "Sorting enabled by name schema",
2945
2852
  "type": "object",
2946
2853
  "properties": {
2947
2854
  "name": {
@@ -2953,7 +2860,8 @@ Enable or disable sorting for all matching sortable items by name
2953
2860
  }
2954
2861
  },
2955
2862
  "required": ["name"],
2956
- "additionalProperties": false
2863
+ "additionalProperties": false,
2864
+ "title": "Sorting enabled by name schema"
2957
2865
  }
2958
2866
  ```
2959
2867
 
@@ -2987,8 +2895,8 @@ Replace all static filters with a nested AND/OR filter group.
2987
2895
  "type": "object",
2988
2896
  "properties": {
2989
2897
  "fieldKey": {
2990
- "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2991
- "type": "string"
2898
+ "type": "string",
2899
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2992
2900
  },
2993
2901
  "operator": {
2994
2902
  "anyOf": [
@@ -3205,7 +3113,6 @@ Enable or disable all matching supporting measures by name
3205
3113
  ```json
3206
3114
  {
3207
3115
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3208
- "title": "Supporting measure enabled by name schema",
3209
3116
  "type": "object",
3210
3117
  "properties": {
3211
3118
  "name": {
@@ -3217,7 +3124,8 @@ Enable or disable all matching supporting measures by name
3217
3124
  }
3218
3125
  },
3219
3126
  "required": ["name", "enabled"],
3220
- "additionalProperties": false
3127
+ "additionalProperties": false,
3128
+ "title": "Supporting measure enabled by name schema"
3221
3129
  }
3222
3130
  ```
3223
3131
 
@@ -3444,24 +3352,24 @@ Enable or disable a dimension in the chart
3444
3352
  ```json
3445
3353
  {
3446
3354
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3447
- "title": "Toggle dimension schema",
3448
3355
  "type": "object",
3449
3356
  "properties": {
3450
3357
  "dataItemInternalKey": {
3451
- "description": "Internal key of the data item of the dimension to be toggled",
3452
- "type": "string"
3358
+ "type": "string",
3359
+ "description": "Internal key of the data item of the dimension to be toggled"
3453
3360
  },
3454
3361
  "dataItemUniqueSignature": {
3455
- "description": "Unique signature of the data item of the dimension to be toggled",
3456
- "type": "string"
3362
+ "type": "string",
3363
+ "description": "Unique signature of the data item of the dimension to be toggled"
3457
3364
  },
3458
3365
  "enabled": {
3459
- "description": "Whether the dimension should be enabled or disabled",
3460
- "type": "boolean"
3366
+ "type": "boolean",
3367
+ "description": "Whether the dimension should be enabled or disabled"
3461
3368
  }
3462
3369
  },
3463
3370
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
3464
- "additionalProperties": false
3371
+ "additionalProperties": false,
3372
+ "title": "Toggle dimension schema"
3465
3373
  }
3466
3374
  ```
3467
3375
 
@@ -3476,7 +3384,6 @@ Enable, disable, or toggle a dimension or measure by its name
3476
3384
  ```json
3477
3385
  {
3478
3386
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3479
- "title": "Toggle dimension or measure by name schema",
3480
3387
  "type": "object",
3481
3388
  "properties": {
3482
3389
  "name": {
@@ -3488,7 +3395,8 @@ Enable, disable, or toggle a dimension or measure by its name
3488
3395
  }
3489
3396
  },
3490
3397
  "required": ["name", "operation"],
3491
- "additionalProperties": false
3398
+ "additionalProperties": false,
3399
+ "title": "Toggle dimension or measure by name schema"
3492
3400
  }
3493
3401
  ```
3494
3402
 
@@ -3503,20 +3411,20 @@ Enable or disable a measure in the chart
3503
3411
  ```json
3504
3412
  {
3505
3413
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3506
- "title": "Toggle measure schema",
3507
3414
  "type": "object",
3508
3415
  "properties": {
3509
3416
  "dataItemInternalKey": {
3510
- "description": "Internal key of the data item of the measure to be toggled",
3511
- "type": "string"
3417
+ "type": "string",
3418
+ "description": "Internal key of the data item of the measure to be toggled"
3512
3419
  },
3513
3420
  "dataItemUniqueSignature": {
3514
- "description": "Unique signature of the data item of the measure to be toggled",
3515
- "type": "string"
3421
+ "type": "string",
3422
+ "description": "Unique signature of the data item of the measure to be toggled"
3516
3423
  }
3517
3424
  },
3518
3425
  "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3519
- "additionalProperties": false
3426
+ "additionalProperties": false,
3427
+ "title": "Toggle measure schema"
3520
3428
  }
3521
3429
  ```
3522
3430
 
@@ -3531,16 +3439,15 @@ Modify properties of an existing dimension
3531
3439
  ```json
3532
3440
  {
3533
3441
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3534
- "title": "Update dimension schema",
3535
3442
  "type": "object",
3536
3443
  "properties": {
3537
3444
  "dataItemInternalKey": {
3538
- "description": "Internal key of the data item of the dimension to be updated",
3539
- "type": "string"
3445
+ "type": "string",
3446
+ "description": "Internal key of the data item of the dimension to be updated"
3540
3447
  },
3541
3448
  "dataItemUniqueSignature": {
3542
- "description": "Unique signature of the data item of the dimension to be updated",
3543
- "type": "string"
3449
+ "type": "string",
3450
+ "description": "Unique signature of the data item of the dimension to be updated"
3544
3451
  },
3545
3452
  "changes": {
3546
3453
  "type": "object",
@@ -3566,7 +3473,8 @@ Modify properties of an existing dimension
3566
3473
  }
3567
3474
  },
3568
3475
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
3569
- "additionalProperties": false
3476
+ "additionalProperties": false,
3477
+ "title": "Update dimension schema"
3570
3478
  }
3571
3479
  ```
3572
3480
 
@@ -3581,16 +3489,15 @@ Modify properties of an existing measure
3581
3489
  ```json
3582
3490
  {
3583
3491
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3584
- "title": "Update measure schema",
3585
3492
  "type": "object",
3586
3493
  "properties": {
3587
3494
  "dataItemInternalKey": {
3588
- "description": "Internal key of the data item of the measure to be updated",
3589
- "type": "string"
3495
+ "type": "string",
3496
+ "description": "Internal key of the data item of the measure to be updated"
3590
3497
  },
3591
3498
  "dataItemUniqueSignature": {
3592
- "description": "Unique signature of the data item of the measure to be updated",
3593
- "type": "string"
3499
+ "type": "string",
3500
+ "description": "Unique signature of the data item of the measure to be updated"
3594
3501
  },
3595
3502
  "changes": {
3596
3503
  "type": "object",
@@ -3614,6 +3521,7 @@ Modify properties of an existing measure
3614
3521
  }
3615
3522
  },
3616
3523
  "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
3617
- "additionalProperties": false
3524
+ "additionalProperties": false,
3525
+ "title": "Update measure schema"
3618
3526
  }
3619
3527
  ```