@astrato-io/visualizations 0.0.0-stage → 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 (139) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/LICENSE +93 -0
  3. package/README.md +843 -2
  4. package/THIRD_PARTY_NOTICES.md +8477 -0
  5. package/VISUALIZATION_DEFINITIONS.md +2378 -0
  6. package/chunks/ClickAwayListener-BbeNMAvj.js +52 -0
  7. package/chunks/LinearProgress-B1FeWaen.js +253 -0
  8. package/chunks/accessors-DemrDevR.js +128 -0
  9. package/chunks/app-filter-bar.compiler-BGJ7HAbr.js +64 -0
  10. package/chunks/bar.compiler-CT0ZbQKc.js +374 -0
  11. package/chunks/builder-B6dWSIdD.js +12289 -0
  12. package/chunks/color-settings-ZIvgNTq1.js +10 -0
  13. package/chunks/coloring-B1XAfg6b.js +664 -0
  14. package/chunks/debounce-fn-CUixuz45.js +7 -0
  15. package/chunks/definitions-D3OVqmXl.js +2102 -0
  16. package/chunks/escobar-eDjtGpkC.js +34606 -0
  17. package/chunks/events-WZut5Ow6.js +4 -0
  18. package/chunks/extend-BKUkc4_i.js +37 -0
  19. package/chunks/filter.compiler-DBsyRBJt.js +70 -0
  20. package/chunks/filtering-tqjAyJH5.js +1072 -0
  21. package/chunks/grouping-type-On4s9Thj.js +3 -0
  22. package/chunks/handlers-VTBfIZYZ.js +13072 -0
  23. package/chunks/isEqual-BDxAhUo8.js +7514 -0
  24. package/chunks/line.compiler-CzdM5Ld0.js +198 -0
  25. package/chunks/metadata-BGElBy5Z.js +28 -0
  26. package/chunks/number.compiler-G-R7y16P.js +53 -0
  27. package/chunks/operations-CTNUX6Sy.js +26249 -0
  28. package/chunks/range-CiwTbMig.js +22 -0
  29. package/chunks/registry-CsQQzukD.js +920 -0
  30. package/chunks/requirements-DYjZCFyf.js +6 -0
  31. package/chunks/rolldown-runtime-DleVn1XH.js +28 -0
  32. package/chunks/set-coloring-datafield-B3uIS1Pe.js +8 -0
  33. package/chunks/shared-CBvcC5YV.js +1218 -0
  34. package/chunks/src-BOS6SqkZ.js +67 -0
  35. package/chunks/src-D9XogOrc.js +422 -0
  36. package/chunks/standalone-0M4HlmDW2.js +3944 -0
  37. package/chunks/standalone-0ashe9w1.js +411 -0
  38. package/chunks/standalone-B7jax8wa.js +339 -0
  39. package/chunks/standalone-BK0VYU-l.js +463 -0
  40. package/chunks/standalone-BMIbT1b2.js +4619 -0
  41. package/chunks/standalone-BZV5vOwA.js +6 -0
  42. package/chunks/standalone-BhDrWj4p.js +1980 -0
  43. package/chunks/standalone-BtSHCp2U2.js +673 -0
  44. package/chunks/standalone-BvaKdky9.js +344 -0
  45. package/chunks/standalone-BwtM31-f.js +2 -0
  46. package/chunks/standalone-C3gg736V.js +1129 -0
  47. package/chunks/standalone-CC1VUjO32.js +299 -0
  48. package/chunks/standalone-C_rYnZ0N.js +741 -0
  49. package/chunks/standalone-CoLrAxRV.js +13198 -0
  50. package/chunks/standalone-DC-aUgXC.js +3855 -0
  51. package/chunks/standalone-DCtRoTWg.js +675 -0
  52. package/chunks/standalone-DUDFTBqL.js +833 -0
  53. package/chunks/standalone-DhZkX9Td.js +2 -0
  54. package/chunks/standalone-DtLElfuM.js +512 -0
  55. package/chunks/standalone-G9Q4Uczu.js +726 -0
  56. package/chunks/standalone-JuLF-OoH.js +1762 -0
  57. package/chunks/standalone-_DeX21JJ.js +383 -0
  58. package/chunks/standalone-gFhKZh8m.js +179 -0
  59. package/chunks/standalone-tDNy-SFH.js +281 -0
  60. package/chunks/standalone-v1oxfU20.js +68 -0
  61. package/chunks/standalone-vzBY6q0I2.js +140 -0
  62. package/chunks/stroke-dash-UgMEcCS4.js +6 -0
  63. package/chunks/table.compiler-tb914oj3.js +222 -0
  64. package/chunks/typeof-CJDtcySz.js +13 -0
  65. package/chunks/ui-DQWtv2iM.js +63551 -0
  66. package/chunks/url-utils-B17gj_mr.js +5501 -0
  67. package/chunks/useFieldName-BvdcoJRl.js +7 -0
  68. package/chunks/utils-Bg7K-t6K.js +32379 -0
  69. package/chunks/view-Bn83C8d9.js +12466 -0
  70. package/definitions.js +3 -0
  71. package/docs/operations/astrato-app-filter-bar.md +161 -0
  72. package/docs/operations/bar.md +6968 -0
  73. package/docs/operations/combo.md +5804 -0
  74. package/docs/operations/date-picker.md +644 -0
  75. package/docs/operations/distribution-gauge.md +3082 -0
  76. package/docs/operations/dot.md +5570 -0
  77. package/docs/operations/filter.md +1483 -0
  78. package/docs/operations/gauge.md +3316 -0
  79. package/docs/operations/heatMap.md +5944 -0
  80. package/docs/operations/histogram.md +1856 -0
  81. package/docs/operations/iframe.md +56 -0
  82. package/docs/operations/image.md +177 -0
  83. package/docs/operations/index.md +46 -0
  84. package/docs/operations/line.md +6391 -0
  85. package/docs/operations/number.md +3903 -0
  86. package/docs/operations/pie.md +5956 -0
  87. package/docs/operations/radar.md +4566 -0
  88. package/docs/operations/sankey.md +3088 -0
  89. package/docs/operations/scatter.md +5969 -0
  90. package/docs/operations/shape.md +315 -0
  91. package/docs/operations/simpleTextObject.md +699 -0
  92. package/docs/operations/slider.md +220 -0
  93. package/docs/operations/table.md +8800 -0
  94. package/docs/operations/tree.md +2867 -0
  95. package/docs/operations/treemap.md +3527 -0
  96. package/docs/operations/waterfall.md +2928 -0
  97. package/docs/operations/word-cloud.md +3000 -0
  98. package/getters.js +18 -0
  99. package/index.js +1183 -0
  100. package/metadata.js +20 -0
  101. package/operations.js +64 -0
  102. package/package.json +185 -4
  103. package/src/definitions/index.d.ts +2 -0
  104. package/src/definitions/model/definitions/available-fields.d.ts +35 -0
  105. package/src/definitions/model/definitions/compilers/compile.d.ts +7 -0
  106. package/src/definitions/model/definitions/data-item-resolution.d.ts +19 -0
  107. package/src/definitions/model/definitions/descriptors/descriptor-metadata.d.ts +1341 -0
  108. package/src/definitions/model/definitions/descriptors/json-schema.d.ts +2 -0
  109. package/src/definitions/model/definitions/diagnostics.d.ts +5 -0
  110. package/src/definitions/model/definitions/field-suggestions.d.ts +2 -0
  111. package/src/definitions/model/definitions/index.d.ts +23 -0
  112. package/src/definitions/model/definitions/registry/compile.d.ts +2 -0
  113. package/src/definitions/model/definitions/registry/descriptor-registry.d.ts +3 -0
  114. package/src/definitions/model/definitions/schema-registry.d.ts +660 -0
  115. package/src/definitions/model/definitions/schemas/app-filter-bar.schema.d.ts +22 -0
  116. package/src/definitions/model/definitions/schemas/bar.schema.d.ts +73 -0
  117. package/src/definitions/model/definitions/schemas/broad-chart.schema.d.ts +68 -0
  118. package/src/definitions/model/definitions/schemas/common.schema.d.ts +303 -0
  119. package/src/definitions/model/definitions/schemas/filter.schema.d.ts +22 -0
  120. package/src/definitions/model/definitions/schemas/index.d.ts +9 -0
  121. package/src/definitions/model/definitions/schemas/line.schema.d.ts +72 -0
  122. package/src/definitions/model/definitions/schemas/number.schema.d.ts +21 -0
  123. package/src/definitions/model/definitions/schemas/object.schema.d.ts +215 -0
  124. package/src/definitions/model/definitions/schemas/table.schema.d.ts +458 -0
  125. package/src/definitions/model/definitions/types/compilation.types.d.ts +36 -0
  126. package/src/definitions/model/definitions/types/definition.types.d.ts +2 -0
  127. package/src/definitions/model/definitions/types/descriptor.types.d.ts +39 -0
  128. package/src/definitions/model/definitions/types/index.d.ts +3 -0
  129. package/src/definitions/model/definitions/validation.d.ts +3 -0
  130. package/src/getters/index.d.ts +30 -0
  131. package/src/index.d.ts +4 -0
  132. package/src/metadata/index.d.ts +4 -0
  133. package/src/operations/index.d.ts +30 -0
  134. package/src/registry/index.d.ts +6 -0
  135. package/src/runtime/index.d.ts +2 -0
  136. package/src/types.d.ts +307 -0
  137. package/src/visualization-catalog.d.ts +82 -0
  138. package/src/web-components/index.d.ts +12 -0
  139. package/styles.css +2 -0
@@ -0,0 +1,2928 @@
1
+ <!-- Generated from operation manifests. Do not edit this file manually. -->
2
+
3
+ # `waterfall` operations
4
+
5
+ Reference for `@astrato-io/visualizations@0.6.5`.
6
+
7
+ [All visualization types](./index.md)
8
+
9
+ Use each schema below for the request’s `payload`, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
10
+
11
+ ## Available operations
12
+
13
+ - [`addDimension`](#adddimension)
14
+ - [`addMeasure`](#addmeasure)
15
+ - [`addMeasureAxisBand`](#addmeasureaxisband)
16
+ - [`addMeasureFilter`](#addmeasurefilter)
17
+ - [`addResultFilter`](#addresultfilter)
18
+ - [`changeMeasureAggregation`](#changemeasureaggregation)
19
+ - [`clearMeasureFilter`](#clearmeasurefilter)
20
+ - [`clearResultFilter`](#clearresultfilter)
21
+ - [`duplicateDimension`](#duplicatedimension)
22
+ - [`duplicateMeasure`](#duplicatemeasure)
23
+ - [`removeDimension`](#removedimension)
24
+ - [`removeMeasure`](#removemeasure)
25
+ - [`removeMeasureAxisBand`](#removemeasureaxisband)
26
+ - [`setAnimationEnabled`](#setanimationenabled)
27
+ - [`setAxisLabelColor`](#setaxislabelcolor)
28
+ - [`setAxisLineColor`](#setaxislinecolor)
29
+ - [`setAxisRangeMax`](#setaxisrangemax)
30
+ - [`setAxisRangeMin`](#setaxisrangemin)
31
+ - [`setAxisRangeOption`](#setaxisrangeoption)
32
+ - [`setAxisStartsAtZero`](#setaxisstartsatzero)
33
+ - [`setAxisTickColor`](#setaxistickcolor)
34
+ - [`setAxisTitle`](#setaxistitle)
35
+ - [`setAxisTitleColor`](#setaxistitlecolor)
36
+ - [`setDimensionFormatString`](#setdimensionformatstring)
37
+ - [`setDimensionFormatType`](#setdimensionformattype)
38
+ - [`setDimensionTemporalGrouping`](#setdimensiontemporalgrouping)
39
+ - [`setInvertAxis`](#setinvertaxis)
40
+ - [`setLabelOverlap`](#setlabeloverlap)
41
+ - [`setMeasureAxisBands`](#setmeasureaxisbands)
42
+ - [`setMeasureCurrency`](#setmeasurecurrency)
43
+ - [`setMeasureCurrencyIsPrefix`](#setmeasurecurrencyisprefix)
44
+ - [`setMeasureDataLabelFontSize`](#setmeasuredatalabelfontsize)
45
+ - [`setMeasureDataLabelShowBackdrop`](#setmeasuredatalabelshowbackdrop)
46
+ - [`setMeasureDataLabelsShow`](#setmeasuredatalabelsshow)
47
+ - [`setMeasureDefinedParameter`](#setmeasuredefinedparameter)
48
+ - [`setMeasureFilter`](#setmeasurefilter)
49
+ - [`setMeasureFormatString`](#setmeasureformatstring)
50
+ - [`setMeasureFormatType`](#setmeasureformattype)
51
+ - [`setMeasureNegativeType`](#setmeasurenegativetype)
52
+ - [`setOrientation`](#setorientation)
53
+ - [`setResultFilter`](#setresultfilter)
54
+ - [`setShowAxisLabels`](#setshowaxislabels)
55
+ - [`setShowAxisLine`](#setshowaxisline)
56
+ - [`setShowAxisTicks`](#setshowaxisticks)
57
+ - [`setShowAxisTitle`](#setshowaxistitle)
58
+ - [`setShowAxisTooltip`](#setshowaxistooltip)
59
+ - [`setStaticFilterGroup`](#setstaticfiltergroup)
60
+ - [`setSupportingMeasureEnabled`](#setsupportingmeasureenabled)
61
+ - [`setWaterfallTotalDataLabelFontSize`](#setwaterfalltotaldatalabelfontsize)
62
+ - [`setWaterfallTotalDataLabelShow`](#setwaterfalltotaldatalabelshow)
63
+ - [`setWaterfallTotalDataLabelShowBackdrop`](#setwaterfalltotaldatalabelshowbackdrop)
64
+ - [`toggleDimension`](#toggledimension)
65
+ - [`toggleDimensionOrMeasureByName`](#toggledimensionormeasurebyname)
66
+ - [`toggleMeasure`](#togglemeasure)
67
+ - [`updateDimension`](#updatedimension)
68
+ - [`updateMeasure`](#updatemeasure)
69
+
70
+ ## `addDimension`
71
+
72
+ Add dimension
73
+
74
+ Add a new dimension to the chart
75
+
76
+ **Payload schema**
77
+
78
+ ```json
79
+ {
80
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
81
+ "type": "object",
82
+ "properties": {
83
+ "key": {
84
+ "type": "string",
85
+ "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\""
86
+ }
87
+ },
88
+ "required": ["key"],
89
+ "additionalProperties": false,
90
+ "title": "Add dimension schema"
91
+ }
92
+ ```
93
+
94
+ ## `addMeasure`
95
+
96
+ Add measure
97
+
98
+ Add a new measure to the chart
99
+
100
+ **Payload schema**
101
+
102
+ ```json
103
+ {
104
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
105
+ "oneOf": [
106
+ {
107
+ "type": "object",
108
+ "properties": {
109
+ "sourceKind": {
110
+ "type": "string",
111
+ "const": "field",
112
+ "description": "Raw database field from available data `fields`."
113
+ },
114
+ "key": {
115
+ "type": "string",
116
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
117
+ },
118
+ "aggregation": {
119
+ "type": "string",
120
+ "description": "Required for raw database fields. Use one of the aggregation names returned for that field."
121
+ }
122
+ },
123
+ "required": ["sourceKind", "key", "aggregation"],
124
+ "additionalProperties": false
125
+ },
126
+ {
127
+ "type": "object",
128
+ "properties": {
129
+ "sourceKind": {
130
+ "type": "string",
131
+ "const": "measure",
132
+ "description": "Predefined/user-defined measure from available data `measures`."
133
+ },
134
+ "key": {
135
+ "type": "string",
136
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
137
+ }
138
+ },
139
+ "required": ["sourceKind", "key"],
140
+ "additionalProperties": false
141
+ },
142
+ {
143
+ "type": "object",
144
+ "properties": {
145
+ "sourceKind": {
146
+ "type": "string",
147
+ "const": "calculation",
148
+ "description": "Predefined calculation from available data `measures`."
149
+ },
150
+ "key": {
151
+ "type": "string",
152
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
153
+ }
154
+ },
155
+ "required": ["sourceKind", "key"],
156
+ "additionalProperties": false
157
+ }
158
+ ],
159
+ "title": "Add measure schema"
160
+ }
161
+ ```
162
+
163
+ ## `addMeasureAxisBand`
164
+
165
+ Add measure axis band
166
+
167
+ Add a shaded band on the primary measure axis between two measure values
168
+
169
+ **Payload schema**
170
+
171
+ ```json
172
+ {
173
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
174
+ "type": "object",
175
+ "properties": {
176
+ "start": {
177
+ "type": "number",
178
+ "description": "Measure axis value where the band starts"
179
+ },
180
+ "end": {
181
+ "type": "number",
182
+ "description": "Measure axis value where the band ends"
183
+ },
184
+ "color": {
185
+ "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted",
186
+ "type": "string",
187
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
188
+ },
189
+ "label": {
190
+ "description": "Text drawn inside the band",
191
+ "type": "string"
192
+ }
193
+ },
194
+ "required": ["start", "end"],
195
+ "additionalProperties": false,
196
+ "title": "Add measure axis band schema"
197
+ }
198
+ ```
199
+
200
+ ## `addMeasureFilter`
201
+
202
+ Add measure filter
203
+
204
+ Add another measure filter before aggregation. Keeps existing filters.
205
+
206
+ **Payload schema**
207
+
208
+ ```json
209
+ {
210
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
211
+ "anyOf": [
212
+ {
213
+ "type": "object",
214
+ "properties": {
215
+ "measureName": {
216
+ "type": "string",
217
+ "description": "Visible measure name or label"
218
+ },
219
+ "fieldKey": {
220
+ "type": "string",
221
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
222
+ },
223
+ "operator": {
224
+ "type": "string",
225
+ "enum": [
226
+ "equals",
227
+ "doesNotEqual",
228
+ "greaterThan",
229
+ "lessThan",
230
+ "greaterThanOrEqualTo",
231
+ "lessThanOrEqualTo",
232
+ "contains",
233
+ "excludes",
234
+ "like",
235
+ "notLike",
236
+ "startsWith",
237
+ "endsWith"
238
+ ],
239
+ "description": "Filter operator that requires a value"
240
+ },
241
+ "value": {
242
+ "anyOf": [
243
+ {
244
+ "type": "string"
245
+ },
246
+ {
247
+ "type": "object",
248
+ "properties": {
249
+ "type": {
250
+ "type": "string",
251
+ "const": "variable"
252
+ },
253
+ "variableName": {
254
+ "type": "string"
255
+ }
256
+ },
257
+ "required": ["type", "variableName"],
258
+ "additionalProperties": false
259
+ }
260
+ ],
261
+ "description": "Filter value"
262
+ }
263
+ },
264
+ "required": ["measureName", "fieldKey", "operator", "value"],
265
+ "additionalProperties": false
266
+ },
267
+ {
268
+ "type": "object",
269
+ "properties": {
270
+ "measureName": {
271
+ "type": "string",
272
+ "description": "Visible measure name or label"
273
+ },
274
+ "fieldKey": {
275
+ "type": "string",
276
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
277
+ },
278
+ "operator": {
279
+ "type": "string",
280
+ "enum": ["isBetween", "isNotBetween"],
281
+ "description": "Filter operator that requires valueFrom and valueTo"
282
+ },
283
+ "valueFrom": {
284
+ "anyOf": [
285
+ {
286
+ "type": "string"
287
+ },
288
+ {
289
+ "type": "object",
290
+ "properties": {
291
+ "type": {
292
+ "type": "string",
293
+ "const": "variable"
294
+ },
295
+ "variableName": {
296
+ "type": "string"
297
+ }
298
+ },
299
+ "required": ["type", "variableName"],
300
+ "additionalProperties": false
301
+ }
302
+ ],
303
+ "description": "Lower filter value"
304
+ },
305
+ "valueTo": {
306
+ "anyOf": [
307
+ {
308
+ "type": "string"
309
+ },
310
+ {
311
+ "type": "object",
312
+ "properties": {
313
+ "type": {
314
+ "type": "string",
315
+ "const": "variable"
316
+ },
317
+ "variableName": {
318
+ "type": "string"
319
+ }
320
+ },
321
+ "required": ["type", "variableName"],
322
+ "additionalProperties": false
323
+ }
324
+ ],
325
+ "description": "Upper filter value"
326
+ }
327
+ },
328
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
329
+ "additionalProperties": false
330
+ },
331
+ {
332
+ "type": "object",
333
+ "properties": {
334
+ "measureName": {
335
+ "type": "string",
336
+ "description": "Visible measure name or label"
337
+ },
338
+ "fieldKey": {
339
+ "type": "string",
340
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
341
+ },
342
+ "operator": {
343
+ "type": "string",
344
+ "enum": ["inList", "excludedFromList"],
345
+ "description": "Filter operator that requires a list of values"
346
+ },
347
+ "values": {
348
+ "minItems": 1,
349
+ "type": "array",
350
+ "items": {
351
+ "type": "string"
352
+ },
353
+ "description": "Filter values"
354
+ }
355
+ },
356
+ "required": ["measureName", "fieldKey", "operator", "values"],
357
+ "additionalProperties": false
358
+ },
359
+ {
360
+ "type": "object",
361
+ "properties": {
362
+ "measureName": {
363
+ "type": "string",
364
+ "description": "Visible measure name or label"
365
+ },
366
+ "fieldKey": {
367
+ "type": "string",
368
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
369
+ },
370
+ "operator": {
371
+ "type": "string",
372
+ "enum": ["isNull", "notNull"],
373
+ "description": "Filter operator that does not require values"
374
+ }
375
+ },
376
+ "required": ["measureName", "fieldKey", "operator"],
377
+ "additionalProperties": false
378
+ }
379
+ ],
380
+ "description": "Add another measure filter before aggregation. Keeps existing filters.",
381
+ "title": "Add measure filter schema"
382
+ }
383
+ ```
384
+
385
+ ## `addResultFilter`
386
+
387
+ Add result filter
388
+
389
+ Add another result filter after aggregation. Keeps existing result filters.
390
+
391
+ **Payload schema**
392
+
393
+ ```json
394
+ {
395
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
396
+ "anyOf": [
397
+ {
398
+ "type": "object",
399
+ "properties": {
400
+ "measureName": {
401
+ "type": "string",
402
+ "description": "Visible measure name or label"
403
+ },
404
+ "operator": {
405
+ "type": "string",
406
+ "enum": [
407
+ "equals",
408
+ "doesNotEqual",
409
+ "greaterThan",
410
+ "lessThan",
411
+ "greaterThanOrEqualTo",
412
+ "lessThanOrEqualTo",
413
+ "contains",
414
+ "excludes",
415
+ "like",
416
+ "notLike",
417
+ "startsWith",
418
+ "endsWith"
419
+ ],
420
+ "description": "Filter operator that requires a value"
421
+ },
422
+ "value": {
423
+ "anyOf": [
424
+ {
425
+ "type": "string"
426
+ },
427
+ {
428
+ "type": "object",
429
+ "properties": {
430
+ "type": {
431
+ "type": "string",
432
+ "const": "variable"
433
+ },
434
+ "variableName": {
435
+ "type": "string"
436
+ }
437
+ },
438
+ "required": ["type", "variableName"],
439
+ "additionalProperties": false
440
+ }
441
+ ],
442
+ "description": "Filter value"
443
+ }
444
+ },
445
+ "required": ["measureName", "operator", "value"],
446
+ "additionalProperties": false
447
+ },
448
+ {
449
+ "type": "object",
450
+ "properties": {
451
+ "measureName": {
452
+ "type": "string",
453
+ "description": "Visible measure name or label"
454
+ },
455
+ "operator": {
456
+ "type": "string",
457
+ "enum": ["isBetween", "isNotBetween"],
458
+ "description": "Filter operator that requires valueFrom and valueTo"
459
+ },
460
+ "valueFrom": {
461
+ "anyOf": [
462
+ {
463
+ "type": "string"
464
+ },
465
+ {
466
+ "type": "object",
467
+ "properties": {
468
+ "type": {
469
+ "type": "string",
470
+ "const": "variable"
471
+ },
472
+ "variableName": {
473
+ "type": "string"
474
+ }
475
+ },
476
+ "required": ["type", "variableName"],
477
+ "additionalProperties": false
478
+ }
479
+ ],
480
+ "description": "Lower filter value"
481
+ },
482
+ "valueTo": {
483
+ "anyOf": [
484
+ {
485
+ "type": "string"
486
+ },
487
+ {
488
+ "type": "object",
489
+ "properties": {
490
+ "type": {
491
+ "type": "string",
492
+ "const": "variable"
493
+ },
494
+ "variableName": {
495
+ "type": "string"
496
+ }
497
+ },
498
+ "required": ["type", "variableName"],
499
+ "additionalProperties": false
500
+ }
501
+ ],
502
+ "description": "Upper filter value"
503
+ }
504
+ },
505
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
506
+ "additionalProperties": false
507
+ },
508
+ {
509
+ "type": "object",
510
+ "properties": {
511
+ "measureName": {
512
+ "type": "string",
513
+ "description": "Visible measure name or label"
514
+ },
515
+ "operator": {
516
+ "type": "string",
517
+ "enum": ["inList", "excludedFromList"],
518
+ "description": "Filter operator that requires a list of values"
519
+ },
520
+ "values": {
521
+ "minItems": 1,
522
+ "type": "array",
523
+ "items": {
524
+ "type": "string"
525
+ },
526
+ "description": "Filter values"
527
+ }
528
+ },
529
+ "required": ["measureName", "operator", "values"],
530
+ "additionalProperties": false
531
+ },
532
+ {
533
+ "type": "object",
534
+ "properties": {
535
+ "measureName": {
536
+ "type": "string",
537
+ "description": "Visible measure name or label"
538
+ },
539
+ "operator": {
540
+ "type": "string",
541
+ "enum": ["isNull", "notNull"],
542
+ "description": "Filter operator that does not require values"
543
+ }
544
+ },
545
+ "required": ["measureName", "operator"],
546
+ "additionalProperties": false
547
+ }
548
+ ],
549
+ "description": "Add another result filter after aggregation. Keeps existing result filters.",
550
+ "title": "Add result filter schema"
551
+ }
552
+ ```
553
+
554
+ ## `changeMeasureAggregation`
555
+
556
+ Measure aggregation
557
+
558
+ Change how a measure is aggregated
559
+
560
+ **Payload schema**
561
+
562
+ ```json
563
+ {
564
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
565
+ "type": "object",
566
+ "properties": {
567
+ "dataItemInternalKey": {
568
+ "type": "string",
569
+ "description": "Internal key of the data item of the measure to be updated"
570
+ },
571
+ "dataItemUniqueSignature": {
572
+ "type": "string",
573
+ "description": "Unique signature of the data item of the measure to be updated"
574
+ },
575
+ "aggregation": {
576
+ "type": "string",
577
+ "minLength": 1,
578
+ "description": "Aggregation function to be used for the measure"
579
+ }
580
+ },
581
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
582
+ "additionalProperties": false,
583
+ "title": "Change measure aggregation schema"
584
+ }
585
+ ```
586
+
587
+ ## `clearMeasureFilter`
588
+
589
+ Clear measure filter
590
+
591
+ Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.
592
+
593
+ **Payload schema**
594
+
595
+ ```json
596
+ {
597
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
598
+ "type": "object",
599
+ "properties": {
600
+ "measureName": {
601
+ "type": "string",
602
+ "description": "Visible measure name or label"
603
+ },
604
+ "fieldKey": {
605
+ "type": "string",
606
+ "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."
607
+ }
608
+ },
609
+ "required": ["measureName"],
610
+ "additionalProperties": false,
611
+ "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
612
+ "title": "Clear measure filter schema"
613
+ }
614
+ ```
615
+
616
+ ## `clearResultFilter`
617
+
618
+ Clear result filter
619
+
620
+ Clear all result filters for one measure.
621
+
622
+ **Payload schema**
623
+
624
+ ```json
625
+ {
626
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
627
+ "type": "object",
628
+ "properties": {
629
+ "measureName": {
630
+ "type": "string",
631
+ "description": "Visible measure name or label"
632
+ }
633
+ },
634
+ "required": ["measureName"],
635
+ "additionalProperties": false,
636
+ "description": "Clear all result filters for one measure.",
637
+ "title": "Clear result filter schema"
638
+ }
639
+ ```
640
+
641
+ ## `duplicateDimension`
642
+
643
+ Duplicate dimension
644
+
645
+ Create a copy of an existing dimension
646
+
647
+ **Payload schema**
648
+
649
+ ```json
650
+ {
651
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
652
+ "type": "object",
653
+ "properties": {
654
+ "dataItemInternalKey": {
655
+ "type": "string",
656
+ "description": "Internal key of the data item of the dimension to be duplicated"
657
+ },
658
+ "dataItemUniqueSignature": {
659
+ "type": "string",
660
+ "description": "Unique signature of the data item of the dimension to be duplicated"
661
+ }
662
+ },
663
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
664
+ "additionalProperties": false,
665
+ "title": "Duplicate dimension schema"
666
+ }
667
+ ```
668
+
669
+ ## `duplicateMeasure`
670
+
671
+ Duplicate measure
672
+
673
+ Create a copy of an existing measure
674
+
675
+ **Payload schema**
676
+
677
+ ```json
678
+ {
679
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
680
+ "type": "object",
681
+ "properties": {
682
+ "dataItemInternalKey": {
683
+ "type": "string",
684
+ "description": "Internal key of the data item of the measure to be duplicated"
685
+ },
686
+ "dataItemUniqueSignature": {
687
+ "type": "string",
688
+ "description": "Unique signature of the data item of the measure to be duplicated"
689
+ }
690
+ },
691
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
692
+ "additionalProperties": false,
693
+ "title": "Duplicate measure schema"
694
+ }
695
+ ```
696
+
697
+ ## `removeDimension`
698
+
699
+ Remove dimension
700
+
701
+ Remove a dimension from the chart
702
+
703
+ **Payload schema**
704
+
705
+ ```json
706
+ {
707
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
708
+ "type": "object",
709
+ "properties": {
710
+ "dataItemInternalKey": {
711
+ "type": "string",
712
+ "description": "Internal key of the data item of the dimension to be removed"
713
+ },
714
+ "dataItemUniqueSignature": {
715
+ "type": "string",
716
+ "description": "Unique signature of the data item of the dimension to be removed"
717
+ }
718
+ },
719
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
720
+ "additionalProperties": false,
721
+ "title": "Remove dimension schema"
722
+ }
723
+ ```
724
+
725
+ ## `removeMeasure`
726
+
727
+ Remove measure
728
+
729
+ Remove a measure from the chart
730
+
731
+ **Payload schema**
732
+
733
+ ```json
734
+ {
735
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
736
+ "type": "object",
737
+ "properties": {
738
+ "dataItemInternalKey": {
739
+ "type": "string",
740
+ "description": "Internal key of the data item of the measure to be removed"
741
+ },
742
+ "dataItemUniqueSignature": {
743
+ "type": "string",
744
+ "description": "Unique signature of the data item of the measure to be removed"
745
+ }
746
+ },
747
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
748
+ "additionalProperties": false,
749
+ "title": "Remove measure schema"
750
+ }
751
+ ```
752
+
753
+ ## `removeMeasureAxisBand`
754
+
755
+ Remove measure axis band
756
+
757
+ Remove one shaded band from the primary measure axis by its position
758
+
759
+ **Payload schema**
760
+
761
+ ```json
762
+ {
763
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
764
+ "type": "object",
765
+ "properties": {
766
+ "index": {
767
+ "type": "integer",
768
+ "minimum": 0,
769
+ "maximum": 9007199254740991,
770
+ "description": "Zero-based position of the band to remove"
771
+ }
772
+ },
773
+ "required": ["index"],
774
+ "additionalProperties": false,
775
+ "title": "Remove measure axis band schema"
776
+ }
777
+ ```
778
+
779
+ ## `setAnimationEnabled`
780
+
781
+ Animations
782
+
783
+ Turn the chart animations on or off. They are on by default; the host can still disable them regardless of this setting
784
+
785
+ **Payload schema**
786
+
787
+ ```json
788
+ {
789
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
790
+ "type": "object",
791
+ "properties": {
792
+ "enabled": {
793
+ "type": "boolean",
794
+ "description": "Whether the chart animates when it first renders and when its data changes"
795
+ }
796
+ },
797
+ "required": ["enabled"],
798
+ "additionalProperties": false,
799
+ "title": "Set animation enabled schema"
800
+ }
801
+ ```
802
+
803
+ ## `setAxisLabelColor`
804
+
805
+ Axis label color
806
+
807
+ Change the color of axis value labels
808
+
809
+ **Payload schema**
810
+
811
+ ```json
812
+ {
813
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
814
+ "type": "object",
815
+ "properties": {
816
+ "labelColor": {
817
+ "anyOf": [
818
+ {
819
+ "type": "string",
820
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
821
+ },
822
+ {
823
+ "type": "null"
824
+ }
825
+ ]
826
+ },
827
+ "axisName": {
828
+ "type": "string",
829
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
830
+ }
831
+ },
832
+ "required": ["axisName"],
833
+ "additionalProperties": false,
834
+ "title": "Axis label color schema"
835
+ }
836
+ ```
837
+
838
+ ## `setAxisLineColor`
839
+
840
+ Axis line color
841
+
842
+ Change the color of axis lines
843
+
844
+ **Payload schema**
845
+
846
+ ```json
847
+ {
848
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
849
+ "type": "object",
850
+ "properties": {
851
+ "lineColor": {
852
+ "anyOf": [
853
+ {
854
+ "type": "string",
855
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
856
+ },
857
+ {
858
+ "type": "null"
859
+ }
860
+ ]
861
+ },
862
+ "axisName": {
863
+ "type": "string",
864
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
865
+ }
866
+ },
867
+ "required": ["axisName"],
868
+ "additionalProperties": false,
869
+ "title": "Axis line color schema"
870
+ }
871
+ ```
872
+
873
+ ## `setAxisRangeMax`
874
+
875
+ Axis range maximum
876
+
877
+ Set the maximum of a measure axis. Applies only when the axis range option is minmax or max, e.g. to give several charts the same scale.
878
+
879
+ **Payload schema**
880
+
881
+ ```json
882
+ {
883
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
884
+ "type": "object",
885
+ "properties": {
886
+ "axisName": {
887
+ "type": "string",
888
+ "enum": ["primaryMeasure"]
889
+ },
890
+ "maxValue": {
891
+ "type": "number"
892
+ }
893
+ },
894
+ "required": ["axisName", "maxValue"],
895
+ "additionalProperties": false,
896
+ "title": "Axis range max schema"
897
+ }
898
+ ```
899
+
900
+ ## `setAxisRangeMin`
901
+
902
+ Axis range minimum
903
+
904
+ Set the minimum of a measure axis. Applies only when the axis range option is minmax or min, e.g. to give several charts the same scale.
905
+
906
+ **Payload schema**
907
+
908
+ ```json
909
+ {
910
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
911
+ "type": "object",
912
+ "properties": {
913
+ "axisName": {
914
+ "type": "string",
915
+ "enum": ["primaryMeasure"]
916
+ },
917
+ "minValue": {
918
+ "type": "number"
919
+ }
920
+ },
921
+ "required": ["axisName", "minValue"],
922
+ "additionalProperties": false,
923
+ "title": "Axis range min schema"
924
+ }
925
+ ```
926
+
927
+ ## `setAxisRangeOption`
928
+
929
+ Axis range
930
+
931
+ Choose how a measure axis range is set: auto fits the data, minmax fixes both ends, min or max fixes one end. Fixed ends take their values from setAxisRangeMin and setAxisRangeMax.
932
+
933
+ **Payload schema**
934
+
935
+ ```json
936
+ {
937
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
938
+ "type": "object",
939
+ "properties": {
940
+ "axisName": {
941
+ "type": "string",
942
+ "enum": ["primaryMeasure"]
943
+ },
944
+ "axisRangeOption": {
945
+ "type": "string",
946
+ "enum": ["auto", "minmax", "max", "min"]
947
+ }
948
+ },
949
+ "required": ["axisName", "axisRangeOption"],
950
+ "additionalProperties": false,
951
+ "title": "Axis range option schema"
952
+ }
953
+ ```
954
+
955
+ ## `setAxisStartsAtZero`
956
+
957
+ Axis starts at zero
958
+
959
+ Make an auto-ranged measure axis always include zero. Applies only when the axis range option is auto.
960
+
961
+ **Payload schema**
962
+
963
+ ```json
964
+ {
965
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
966
+ "type": "object",
967
+ "properties": {
968
+ "axisName": {
969
+ "type": "string",
970
+ "enum": ["primaryMeasure"]
971
+ },
972
+ "startsAtZero": {
973
+ "type": "boolean"
974
+ }
975
+ },
976
+ "required": ["axisName", "startsAtZero"],
977
+ "additionalProperties": false,
978
+ "title": "Axis starts at zero schema"
979
+ }
980
+ ```
981
+
982
+ ## `setAxisTickColor`
983
+
984
+ Axis tick color
985
+
986
+ Change the color of axis tick marks
987
+
988
+ **Payload schema**
989
+
990
+ ```json
991
+ {
992
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
993
+ "type": "object",
994
+ "properties": {
995
+ "tickColor": {
996
+ "anyOf": [
997
+ {
998
+ "type": "string",
999
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1000
+ },
1001
+ {
1002
+ "type": "null"
1003
+ }
1004
+ ]
1005
+ },
1006
+ "axisName": {
1007
+ "type": "string",
1008
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
1009
+ }
1010
+ },
1011
+ "required": ["axisName"],
1012
+ "additionalProperties": false,
1013
+ "title": "Axis tick color schema"
1014
+ }
1015
+ ```
1016
+
1017
+ ## `setAxisTitle`
1018
+
1019
+ Axis title
1020
+
1021
+ Set a custom title for an axis
1022
+
1023
+ **Payload schema**
1024
+
1025
+ ```json
1026
+ {
1027
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1028
+ "type": "object",
1029
+ "properties": {
1030
+ "axisTitle": {
1031
+ "type": "string"
1032
+ },
1033
+ "axisName": {
1034
+ "type": "string",
1035
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
1036
+ }
1037
+ },
1038
+ "required": ["axisName"],
1039
+ "additionalProperties": false,
1040
+ "title": "Axis title schema"
1041
+ }
1042
+ ```
1043
+
1044
+ ## `setAxisTitleColor`
1045
+
1046
+ Axis title color
1047
+
1048
+ Change the color of axis titles
1049
+
1050
+ **Payload schema**
1051
+
1052
+ ```json
1053
+ {
1054
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1055
+ "type": "object",
1056
+ "properties": {
1057
+ "titleColor": {
1058
+ "anyOf": [
1059
+ {
1060
+ "type": "string",
1061
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1062
+ },
1063
+ {
1064
+ "type": "null"
1065
+ }
1066
+ ]
1067
+ },
1068
+ "axisName": {
1069
+ "type": "string",
1070
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
1071
+ }
1072
+ },
1073
+ "required": ["axisName"],
1074
+ "additionalProperties": false,
1075
+ "title": "Axis title color schema"
1076
+ }
1077
+ ```
1078
+
1079
+ ## `setDimensionFormatString`
1080
+
1081
+ Dimension format string
1082
+
1083
+ Set the custom display format string for a dimension. This changes label formatting only and does not change temporal grouping.
1084
+
1085
+ **Payload schema**
1086
+
1087
+ ```json
1088
+ {
1089
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1090
+ "type": "object",
1091
+ "properties": {
1092
+ "dataItemInternalKey": {
1093
+ "type": "string",
1094
+ "description": "Internal key of the data item of the dimension to be updated"
1095
+ },
1096
+ "dataItemUniqueSignature": {
1097
+ "type": "string",
1098
+ "description": "Unique signature of the data item of the dimension to be updated"
1099
+ },
1100
+ "formatString": {
1101
+ "anyOf": [
1102
+ {
1103
+ "type": "string"
1104
+ },
1105
+ {
1106
+ "type": "object",
1107
+ "properties": {
1108
+ "type": {
1109
+ "type": "string",
1110
+ "const": "variable"
1111
+ },
1112
+ "variableName": {
1113
+ "type": "string"
1114
+ }
1115
+ },
1116
+ "required": ["type", "variableName"],
1117
+ "additionalProperties": false
1118
+ }
1119
+ ]
1120
+ }
1121
+ },
1122
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1123
+ "additionalProperties": false,
1124
+ "title": "Dimension format string schema"
1125
+ }
1126
+ ```
1127
+
1128
+ ## `setDimensionFormatType`
1129
+
1130
+ Dimension format type
1131
+
1132
+ Set the display format type used by a dimension. This changes label formatting only and does not change temporal grouping.
1133
+
1134
+ **Payload schema**
1135
+
1136
+ ```json
1137
+ {
1138
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1139
+ "type": "object",
1140
+ "properties": {
1141
+ "dataItemInternalKey": {
1142
+ "type": "string",
1143
+ "description": "Internal key of the data item of the dimension to be updated"
1144
+ },
1145
+ "dataItemUniqueSignature": {
1146
+ "type": "string",
1147
+ "description": "Unique signature of the data item of the dimension to be updated"
1148
+ },
1149
+ "formatType": {
1150
+ "anyOf": [
1151
+ {
1152
+ "type": "string",
1153
+ "enum": [
1154
+ "custom",
1155
+ "inherit",
1156
+ "none",
1157
+ "defaultNumber",
1158
+ "defaultMoney",
1159
+ "numberNoDecimal",
1160
+ "number1Decimal",
1161
+ "number2Decimal",
1162
+ "abbreviationAuto",
1163
+ "abbreviationNoDecimal",
1164
+ "abbreviation1Decimal",
1165
+ "abbreviation2Decimal",
1166
+ "percentageNoDecimal",
1167
+ "percentage1Decimal",
1168
+ "percentage2Decimal",
1169
+ "money0Decimal",
1170
+ "money2Decimal",
1171
+ "durationDays",
1172
+ "durationHours",
1173
+ "durationMinutes",
1174
+ "durationSeconds"
1175
+ ]
1176
+ },
1177
+ {
1178
+ "type": "string",
1179
+ "enum": [
1180
+ "defaultDate",
1181
+ "defaultDatetime",
1182
+ "defaultTime",
1183
+ "ddmmyyyy",
1184
+ "ddmmyyyy2",
1185
+ "ddmmyyyy3",
1186
+ "yyyymmdd",
1187
+ "mmddyyyy",
1188
+ "mmddyyyy2",
1189
+ "ddmmmmyyyy",
1190
+ "ddmmmyyyy",
1191
+ "ddmmmyy",
1192
+ "mmmmddyyyy",
1193
+ "yyyy",
1194
+ "yy",
1195
+ "mmmyyyy",
1196
+ "yyyymmm",
1197
+ "yyyymmmm",
1198
+ "mmyyyy",
1199
+ "yyyymm",
1200
+ "mmmmyyyy",
1201
+ "yyyywn",
1202
+ "wnyyyy",
1203
+ "yywn",
1204
+ "yyyyq",
1205
+ "qyyyy",
1206
+ "yyyymmddhhmmss",
1207
+ "yyyymmddhmmss",
1208
+ "yyyymmddhhmm",
1209
+ "yyyymmddhh",
1210
+ "yyyymmddhmm",
1211
+ "yyyymmddh",
1212
+ "ddmmmyyyyhhmmss",
1213
+ "ddmmmyyyyhmmss",
1214
+ "ddmmmyyyyhhmm",
1215
+ "ddmmmyyyyhmm",
1216
+ "ddmmmyyyyh",
1217
+ "hhmmss",
1218
+ "hhmm",
1219
+ "hmm",
1220
+ "h",
1221
+ "hh",
1222
+ "hmmss",
1223
+ "month",
1224
+ "month2",
1225
+ "monthn",
1226
+ "month3",
1227
+ "quarter",
1228
+ "quarter2",
1229
+ "week1",
1230
+ "week2",
1231
+ "week3",
1232
+ "day",
1233
+ "dayOfWeek",
1234
+ "hhn",
1235
+ "hn"
1236
+ ]
1237
+ }
1238
+ ]
1239
+ }
1240
+ },
1241
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
1242
+ "additionalProperties": false,
1243
+ "title": "Dimension format type schema"
1244
+ }
1245
+ ```
1246
+
1247
+ ## `setDimensionTemporalGrouping`
1248
+
1249
+ Dimension temporal grouping
1250
+
1251
+ Set the temporal grouping of a date dimension. Use mode "level" with dateLevel for year-aware buckets such as month-over-time, mode "part" with datePart for date parts such as month-of-year, or mode "none" to clear temporal grouping.
1252
+
1253
+ **Payload schema**
1254
+
1255
+ ```json
1256
+ {
1257
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1258
+ "oneOf": [
1259
+ {
1260
+ "type": "object",
1261
+ "properties": {
1262
+ "dataItemInternalKey": {
1263
+ "type": "string",
1264
+ "description": "Internal key of the data item of the dimension to be updated"
1265
+ },
1266
+ "dataItemUniqueSignature": {
1267
+ "type": "string",
1268
+ "description": "Unique signature of the data item of the dimension to be updated"
1269
+ },
1270
+ "mode": {
1271
+ "type": "string",
1272
+ "const": "none"
1273
+ }
1274
+ },
1275
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"],
1276
+ "additionalProperties": false
1277
+ },
1278
+ {
1279
+ "type": "object",
1280
+ "properties": {
1281
+ "dataItemInternalKey": {
1282
+ "type": "string",
1283
+ "description": "Internal key of the data item of the dimension to be updated"
1284
+ },
1285
+ "dataItemUniqueSignature": {
1286
+ "type": "string",
1287
+ "description": "Unique signature of the data item of the dimension to be updated"
1288
+ },
1289
+ "mode": {
1290
+ "type": "string",
1291
+ "const": "level"
1292
+ },
1293
+ "dateLevel": {
1294
+ "type": "string",
1295
+ "enum": [
1296
+ "year",
1297
+ "year-end",
1298
+ "quarter",
1299
+ "quarter-end",
1300
+ "month",
1301
+ "month-end",
1302
+ "week",
1303
+ "week-end",
1304
+ "day",
1305
+ "hour",
1306
+ "minute",
1307
+ "second"
1308
+ ]
1309
+ }
1310
+ },
1311
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"],
1312
+ "additionalProperties": false
1313
+ },
1314
+ {
1315
+ "type": "object",
1316
+ "properties": {
1317
+ "dataItemInternalKey": {
1318
+ "type": "string",
1319
+ "description": "Internal key of the data item of the dimension to be updated"
1320
+ },
1321
+ "dataItemUniqueSignature": {
1322
+ "type": "string",
1323
+ "description": "Unique signature of the data item of the dimension to be updated"
1324
+ },
1325
+ "mode": {
1326
+ "type": "string",
1327
+ "const": "part"
1328
+ },
1329
+ "datePart": {
1330
+ "type": "string",
1331
+ "enum": [
1332
+ "year",
1333
+ "month",
1334
+ "day",
1335
+ "dayofweekiso",
1336
+ "dayofyear",
1337
+ "weekiso",
1338
+ "quarter",
1339
+ "yearofweekiso",
1340
+ "hour",
1341
+ "minute",
1342
+ "second"
1343
+ ]
1344
+ }
1345
+ },
1346
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
1347
+ "additionalProperties": false
1348
+ }
1349
+ ],
1350
+ "title": "Dimension temporal grouping schema"
1351
+ }
1352
+ ```
1353
+
1354
+ ## `setInvertAxis`
1355
+
1356
+ Invert axis
1357
+
1358
+ Reverse the direction of an axis. axisName defaults to the dimension axis; pass a measure axis to flip its value scale, e.g. to put rank 1 at the top.
1359
+
1360
+ **Payload schema**
1361
+
1362
+ ```json
1363
+ {
1364
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1365
+ "type": "object",
1366
+ "properties": {
1367
+ "invertAxis": {
1368
+ "type": "boolean"
1369
+ },
1370
+ "axisName": {
1371
+ "type": "string",
1372
+ "enum": ["dimension", "primaryMeasure"]
1373
+ }
1374
+ },
1375
+ "required": ["invertAxis"],
1376
+ "additionalProperties": false,
1377
+ "title": "Invert axis schema"
1378
+ }
1379
+ ```
1380
+
1381
+ ## `setLabelOverlap`
1382
+
1383
+ Axis label overlap
1384
+
1385
+ Control how axis labels behave when they overlap
1386
+
1387
+ **Payload schema**
1388
+
1389
+ ```json
1390
+ {
1391
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1392
+ "type": "object",
1393
+ "properties": {
1394
+ "labelOverlap": {
1395
+ "type": "string",
1396
+ "enum": ["auto", "show-last"]
1397
+ }
1398
+ },
1399
+ "additionalProperties": false,
1400
+ "title": "Label overlap schema"
1401
+ }
1402
+ ```
1403
+
1404
+ ## `setMeasureAxisBands`
1405
+
1406
+ Measure axis bands
1407
+
1408
+ Replace all shaded bands on the primary measure axis. Each band fills the plot between two measure values
1409
+
1410
+ **Payload schema**
1411
+
1412
+ ```json
1413
+ {
1414
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1415
+ "type": "object",
1416
+ "properties": {
1417
+ "bands": {
1418
+ "type": "array",
1419
+ "items": {
1420
+ "type": "object",
1421
+ "properties": {
1422
+ "start": {
1423
+ "type": "number",
1424
+ "description": "Measure axis value where the band starts"
1425
+ },
1426
+ "end": {
1427
+ "type": "number",
1428
+ "description": "Measure axis value where the band ends"
1429
+ },
1430
+ "color": {
1431
+ "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted",
1432
+ "type": "string",
1433
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1434
+ },
1435
+ "label": {
1436
+ "description": "Text drawn inside the band",
1437
+ "type": "string"
1438
+ }
1439
+ },
1440
+ "required": ["start", "end"],
1441
+ "additionalProperties": false
1442
+ },
1443
+ "description": "Bands to draw, in order; an empty array removes all bands"
1444
+ }
1445
+ },
1446
+ "required": ["bands"],
1447
+ "additionalProperties": false,
1448
+ "title": "Set measure axis bands schema"
1449
+ }
1450
+ ```
1451
+
1452
+ ## `setMeasureCurrency`
1453
+
1454
+ Measure currency
1455
+
1456
+ Set the currency symbol used by a measure formatter
1457
+
1458
+ **Payload schema**
1459
+
1460
+ ```json
1461
+ {
1462
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1463
+ "type": "object",
1464
+ "properties": {
1465
+ "dataItemInternalKey": {
1466
+ "type": "string",
1467
+ "description": "Internal key of the data item of the measure to be updated"
1468
+ },
1469
+ "dataItemUniqueSignature": {
1470
+ "type": "string",
1471
+ "description": "Unique signature of the data item of the measure to be updated"
1472
+ },
1473
+ "currency": {
1474
+ "type": "string"
1475
+ }
1476
+ },
1477
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1478
+ "additionalProperties": false,
1479
+ "title": "Measure currency schema"
1480
+ }
1481
+ ```
1482
+
1483
+ ## `setMeasureCurrencyIsPrefix`
1484
+
1485
+ Measure currency is prefix
1486
+
1487
+ Set whether measure currency symbol is prefixed
1488
+
1489
+ **Payload schema**
1490
+
1491
+ ```json
1492
+ {
1493
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1494
+ "type": "object",
1495
+ "properties": {
1496
+ "dataItemInternalKey": {
1497
+ "type": "string",
1498
+ "description": "Internal key of the data item of the measure to be updated"
1499
+ },
1500
+ "dataItemUniqueSignature": {
1501
+ "type": "string",
1502
+ "description": "Unique signature of the data item of the measure to be updated"
1503
+ },
1504
+ "currencyIsPrefix": {
1505
+ "type": "boolean"
1506
+ }
1507
+ },
1508
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1509
+ "additionalProperties": false,
1510
+ "title": "Measure currency is prefix schema"
1511
+ }
1512
+ ```
1513
+
1514
+ ## `setMeasureDataLabelFontSize`
1515
+
1516
+ Measure data label font size
1517
+
1518
+ Set the font size of data labels for a measure
1519
+
1520
+ **Payload schema**
1521
+
1522
+ ```json
1523
+ {
1524
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1525
+ "type": "object",
1526
+ "properties": {
1527
+ "dataItemInternalKey": {
1528
+ "type": "string",
1529
+ "description": "Internal key of the data item of the measure to be updated"
1530
+ },
1531
+ "dataItemUniqueSignature": {
1532
+ "type": "string",
1533
+ "description": "Unique signature of the data item of the measure to be updated"
1534
+ },
1535
+ "fontSize": {
1536
+ "anyOf": [
1537
+ {
1538
+ "type": "number"
1539
+ },
1540
+ {
1541
+ "type": "object",
1542
+ "properties": {
1543
+ "type": {
1544
+ "type": "string",
1545
+ "const": "variable"
1546
+ },
1547
+ "variableName": {
1548
+ "type": "string"
1549
+ }
1550
+ },
1551
+ "required": ["type", "variableName"],
1552
+ "additionalProperties": false
1553
+ }
1554
+ ]
1555
+ }
1556
+ },
1557
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1558
+ "additionalProperties": false,
1559
+ "title": "Set measure data label font size schema"
1560
+ }
1561
+ ```
1562
+
1563
+ ## `setMeasureDataLabelShowBackdrop`
1564
+
1565
+ Measure data label backdrop
1566
+
1567
+ Show or hide the backdrop behind measure data labels
1568
+
1569
+ **Payload schema**
1570
+
1571
+ ```json
1572
+ {
1573
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1574
+ "type": "object",
1575
+ "properties": {
1576
+ "dataItemInternalKey": {
1577
+ "type": "string",
1578
+ "description": "Internal key of the data item of the measure to be updated"
1579
+ },
1580
+ "dataItemUniqueSignature": {
1581
+ "type": "string",
1582
+ "description": "Unique signature of the data item of the measure to be updated"
1583
+ },
1584
+ "showBackdrop": {
1585
+ "type": "boolean"
1586
+ }
1587
+ },
1588
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1589
+ "additionalProperties": false,
1590
+ "title": "Set measure data label backdrop schema"
1591
+ }
1592
+ ```
1593
+
1594
+ ## `setMeasureDataLabelsShow`
1595
+
1596
+ Show measure data labels
1597
+
1598
+ Show or hide data labels for a measure
1599
+
1600
+ **Payload schema**
1601
+
1602
+ ```json
1603
+ {
1604
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1605
+ "type": "object",
1606
+ "properties": {
1607
+ "dataItemInternalKey": {
1608
+ "type": "string",
1609
+ "description": "Internal key of the data item of the measure to be updated"
1610
+ },
1611
+ "dataItemUniqueSignature": {
1612
+ "type": "string",
1613
+ "description": "Unique signature of the data item of the measure to be updated"
1614
+ },
1615
+ "show": {
1616
+ "type": "boolean"
1617
+ }
1618
+ },
1619
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1620
+ "additionalProperties": false,
1621
+ "title": "Set measure data labels show schema"
1622
+ }
1623
+ ```
1624
+
1625
+ ## `setMeasureDefinedParameter`
1626
+
1627
+ Measure defined parameter
1628
+
1629
+ Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
1630
+
1631
+ **Payload schema**
1632
+
1633
+ ```json
1634
+ {
1635
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1636
+ "type": "object",
1637
+ "properties": {
1638
+ "dataItemInternalKey": {
1639
+ "type": "string",
1640
+ "description": "Internal key of the data item of the measure to be updated"
1641
+ },
1642
+ "dataItemUniqueSignature": {
1643
+ "type": "string",
1644
+ "description": "Unique signature of the data item of the measure to be updated"
1645
+ },
1646
+ "collectionKey": {
1647
+ "description": "Measure collection to update. Defaults to primary measures.",
1648
+ "type": "string",
1649
+ "enum": ["measures", "supportingMeasures"]
1650
+ },
1651
+ "parameterName": {
1652
+ "type": "string",
1653
+ "minLength": 1,
1654
+ "description": "Exact name of a Defined parameter exposed by the measure"
1655
+ },
1656
+ "value": {
1657
+ "oneOf": [
1658
+ {
1659
+ "type": "object",
1660
+ "properties": {
1661
+ "type": {
1662
+ "type": "string",
1663
+ "const": "default"
1664
+ }
1665
+ },
1666
+ "required": ["type"],
1667
+ "additionalProperties": false
1668
+ },
1669
+ {
1670
+ "type": "object",
1671
+ "properties": {
1672
+ "type": {
1673
+ "type": "string",
1674
+ "const": "static"
1675
+ },
1676
+ "value": {
1677
+ "type": ["string", "number", "boolean"]
1678
+ }
1679
+ },
1680
+ "required": ["type", "value"],
1681
+ "additionalProperties": false
1682
+ },
1683
+ {
1684
+ "type": "object",
1685
+ "properties": {
1686
+ "type": {
1687
+ "type": "string",
1688
+ "const": "variable"
1689
+ },
1690
+ "variableName": {
1691
+ "type": "string",
1692
+ "minLength": 1,
1693
+ "description": "Exact name of an existing compatible workbook variable"
1694
+ }
1695
+ },
1696
+ "required": ["type", "variableName"],
1697
+ "additionalProperties": false
1698
+ }
1699
+ ],
1700
+ "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable"
1701
+ }
1702
+ },
1703
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
1704
+ "additionalProperties": false,
1705
+ "title": "Set measure defined parameter schema"
1706
+ }
1707
+ ```
1708
+
1709
+ ## `setMeasureFilter`
1710
+
1711
+ Set measure filter
1712
+
1713
+ Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
1714
+
1715
+ **Payload schema**
1716
+
1717
+ ```json
1718
+ {
1719
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1720
+ "anyOf": [
1721
+ {
1722
+ "type": "object",
1723
+ "properties": {
1724
+ "measureName": {
1725
+ "type": "string",
1726
+ "description": "Visible measure name or label"
1727
+ },
1728
+ "fieldKey": {
1729
+ "type": "string",
1730
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
1731
+ },
1732
+ "operator": {
1733
+ "type": "string",
1734
+ "enum": [
1735
+ "equals",
1736
+ "doesNotEqual",
1737
+ "greaterThan",
1738
+ "lessThan",
1739
+ "greaterThanOrEqualTo",
1740
+ "lessThanOrEqualTo",
1741
+ "contains",
1742
+ "excludes",
1743
+ "like",
1744
+ "notLike",
1745
+ "startsWith",
1746
+ "endsWith"
1747
+ ],
1748
+ "description": "Filter operator that requires a value"
1749
+ },
1750
+ "value": {
1751
+ "anyOf": [
1752
+ {
1753
+ "type": "string"
1754
+ },
1755
+ {
1756
+ "type": "object",
1757
+ "properties": {
1758
+ "type": {
1759
+ "type": "string",
1760
+ "const": "variable"
1761
+ },
1762
+ "variableName": {
1763
+ "type": "string"
1764
+ }
1765
+ },
1766
+ "required": ["type", "variableName"],
1767
+ "additionalProperties": false
1768
+ }
1769
+ ],
1770
+ "description": "Filter value"
1771
+ }
1772
+ },
1773
+ "required": ["measureName", "fieldKey", "operator", "value"],
1774
+ "additionalProperties": false
1775
+ },
1776
+ {
1777
+ "type": "object",
1778
+ "properties": {
1779
+ "measureName": {
1780
+ "type": "string",
1781
+ "description": "Visible measure name or label"
1782
+ },
1783
+ "fieldKey": {
1784
+ "type": "string",
1785
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
1786
+ },
1787
+ "operator": {
1788
+ "type": "string",
1789
+ "enum": ["isBetween", "isNotBetween"],
1790
+ "description": "Filter operator that requires valueFrom and valueTo"
1791
+ },
1792
+ "valueFrom": {
1793
+ "anyOf": [
1794
+ {
1795
+ "type": "string"
1796
+ },
1797
+ {
1798
+ "type": "object",
1799
+ "properties": {
1800
+ "type": {
1801
+ "type": "string",
1802
+ "const": "variable"
1803
+ },
1804
+ "variableName": {
1805
+ "type": "string"
1806
+ }
1807
+ },
1808
+ "required": ["type", "variableName"],
1809
+ "additionalProperties": false
1810
+ }
1811
+ ],
1812
+ "description": "Lower filter value"
1813
+ },
1814
+ "valueTo": {
1815
+ "anyOf": [
1816
+ {
1817
+ "type": "string"
1818
+ },
1819
+ {
1820
+ "type": "object",
1821
+ "properties": {
1822
+ "type": {
1823
+ "type": "string",
1824
+ "const": "variable"
1825
+ },
1826
+ "variableName": {
1827
+ "type": "string"
1828
+ }
1829
+ },
1830
+ "required": ["type", "variableName"],
1831
+ "additionalProperties": false
1832
+ }
1833
+ ],
1834
+ "description": "Upper filter value"
1835
+ }
1836
+ },
1837
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
1838
+ "additionalProperties": false
1839
+ },
1840
+ {
1841
+ "type": "object",
1842
+ "properties": {
1843
+ "measureName": {
1844
+ "type": "string",
1845
+ "description": "Visible measure name or label"
1846
+ },
1847
+ "fieldKey": {
1848
+ "type": "string",
1849
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
1850
+ },
1851
+ "operator": {
1852
+ "type": "string",
1853
+ "enum": ["inList", "excludedFromList"],
1854
+ "description": "Filter operator that requires a list of values"
1855
+ },
1856
+ "values": {
1857
+ "minItems": 1,
1858
+ "type": "array",
1859
+ "items": {
1860
+ "type": "string"
1861
+ },
1862
+ "description": "Filter values"
1863
+ }
1864
+ },
1865
+ "required": ["measureName", "fieldKey", "operator", "values"],
1866
+ "additionalProperties": false
1867
+ },
1868
+ {
1869
+ "type": "object",
1870
+ "properties": {
1871
+ "measureName": {
1872
+ "type": "string",
1873
+ "description": "Visible measure name or label"
1874
+ },
1875
+ "fieldKey": {
1876
+ "type": "string",
1877
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
1878
+ },
1879
+ "operator": {
1880
+ "type": "string",
1881
+ "enum": ["isNull", "notNull"],
1882
+ "description": "Filter operator that does not require values"
1883
+ }
1884
+ },
1885
+ "required": ["measureName", "fieldKey", "operator"],
1886
+ "additionalProperties": false
1887
+ }
1888
+ ],
1889
+ "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
1890
+ "title": "Set measure filter schema"
1891
+ }
1892
+ ```
1893
+
1894
+ ## `setMeasureFormatString`
1895
+
1896
+ Measure format string
1897
+
1898
+ Set the custom format string for a measure
1899
+
1900
+ **Payload schema**
1901
+
1902
+ ```json
1903
+ {
1904
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1905
+ "type": "object",
1906
+ "properties": {
1907
+ "dataItemInternalKey": {
1908
+ "type": "string",
1909
+ "description": "Internal key of the data item of the measure to be updated"
1910
+ },
1911
+ "dataItemUniqueSignature": {
1912
+ "type": "string",
1913
+ "description": "Unique signature of the data item of the measure to be updated"
1914
+ },
1915
+ "formatString": {
1916
+ "anyOf": [
1917
+ {
1918
+ "type": "string"
1919
+ },
1920
+ {
1921
+ "type": "object",
1922
+ "properties": {
1923
+ "type": {
1924
+ "type": "string",
1925
+ "const": "variable"
1926
+ },
1927
+ "variableName": {
1928
+ "type": "string"
1929
+ }
1930
+ },
1931
+ "required": ["type", "variableName"],
1932
+ "additionalProperties": false
1933
+ }
1934
+ ]
1935
+ }
1936
+ },
1937
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1938
+ "additionalProperties": false,
1939
+ "title": "Measure format string schema"
1940
+ }
1941
+ ```
1942
+
1943
+ ## `setMeasureFormatType`
1944
+
1945
+ Measure format type
1946
+
1947
+ Set the format type used by a measure
1948
+
1949
+ **Payload schema**
1950
+
1951
+ ```json
1952
+ {
1953
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1954
+ "type": "object",
1955
+ "properties": {
1956
+ "dataItemInternalKey": {
1957
+ "type": "string",
1958
+ "description": "Internal key of the data item of the measure to be updated"
1959
+ },
1960
+ "dataItemUniqueSignature": {
1961
+ "type": "string",
1962
+ "description": "Unique signature of the data item of the measure to be updated"
1963
+ },
1964
+ "formatType": {
1965
+ "anyOf": [
1966
+ {
1967
+ "type": "string",
1968
+ "enum": [
1969
+ "custom",
1970
+ "inherit",
1971
+ "none",
1972
+ "defaultNumber",
1973
+ "defaultMoney",
1974
+ "numberNoDecimal",
1975
+ "number1Decimal",
1976
+ "number2Decimal",
1977
+ "abbreviationAuto",
1978
+ "abbreviationNoDecimal",
1979
+ "abbreviation1Decimal",
1980
+ "abbreviation2Decimal",
1981
+ "percentageNoDecimal",
1982
+ "percentage1Decimal",
1983
+ "percentage2Decimal",
1984
+ "money0Decimal",
1985
+ "money2Decimal",
1986
+ "durationDays",
1987
+ "durationHours",
1988
+ "durationMinutes",
1989
+ "durationSeconds"
1990
+ ]
1991
+ },
1992
+ {
1993
+ "type": "string",
1994
+ "enum": [
1995
+ "defaultDate",
1996
+ "defaultDatetime",
1997
+ "defaultTime",
1998
+ "ddmmyyyy",
1999
+ "ddmmyyyy2",
2000
+ "ddmmyyyy3",
2001
+ "yyyymmdd",
2002
+ "mmddyyyy",
2003
+ "mmddyyyy2",
2004
+ "ddmmmmyyyy",
2005
+ "ddmmmyyyy",
2006
+ "ddmmmyy",
2007
+ "mmmmddyyyy",
2008
+ "yyyy",
2009
+ "yy",
2010
+ "mmmyyyy",
2011
+ "yyyymmm",
2012
+ "yyyymmmm",
2013
+ "mmyyyy",
2014
+ "yyyymm",
2015
+ "mmmmyyyy",
2016
+ "yyyywn",
2017
+ "wnyyyy",
2018
+ "yywn",
2019
+ "yyyyq",
2020
+ "qyyyy",
2021
+ "yyyymmddhhmmss",
2022
+ "yyyymmddhmmss",
2023
+ "yyyymmddhhmm",
2024
+ "yyyymmddhh",
2025
+ "yyyymmddhmm",
2026
+ "yyyymmddh",
2027
+ "ddmmmyyyyhhmmss",
2028
+ "ddmmmyyyyhmmss",
2029
+ "ddmmmyyyyhhmm",
2030
+ "ddmmmyyyyhmm",
2031
+ "ddmmmyyyyh",
2032
+ "hhmmss",
2033
+ "hhmm",
2034
+ "hmm",
2035
+ "h",
2036
+ "hh",
2037
+ "hmmss",
2038
+ "month",
2039
+ "month2",
2040
+ "monthn",
2041
+ "month3",
2042
+ "quarter",
2043
+ "quarter2",
2044
+ "week1",
2045
+ "week2",
2046
+ "week3",
2047
+ "day",
2048
+ "dayOfWeek",
2049
+ "hhn",
2050
+ "hn"
2051
+ ]
2052
+ }
2053
+ ]
2054
+ }
2055
+ },
2056
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
2057
+ "additionalProperties": false,
2058
+ "title": "Measure format type schema"
2059
+ }
2060
+ ```
2061
+
2062
+ ## `setMeasureNegativeType`
2063
+
2064
+ Measure negative type
2065
+
2066
+ Set how negative values are displayed for a measure formatter
2067
+
2068
+ **Payload schema**
2069
+
2070
+ ```json
2071
+ {
2072
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2073
+ "type": "object",
2074
+ "properties": {
2075
+ "dataItemInternalKey": {
2076
+ "type": "string",
2077
+ "description": "Internal key of the data item of the measure to be updated"
2078
+ },
2079
+ "dataItemUniqueSignature": {
2080
+ "type": "string",
2081
+ "description": "Unique signature of the data item of the measure to be updated"
2082
+ },
2083
+ "negativeType": {
2084
+ "type": "string",
2085
+ "enum": ["symbol", "parenthesis"]
2086
+ }
2087
+ },
2088
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2089
+ "additionalProperties": false,
2090
+ "title": "Measure negative type schema"
2091
+ }
2092
+ ```
2093
+
2094
+ ## `setOrientation`
2095
+
2096
+ Orientation
2097
+
2098
+ Set the orientation of the waterfall chart
2099
+
2100
+ **Payload schema**
2101
+
2102
+ ```json
2103
+ {
2104
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2105
+ "title": "Waterfall chart orientation schema",
2106
+ "type": "string",
2107
+ "enum": ["horizontal", "vertical"]
2108
+ }
2109
+ ```
2110
+
2111
+ ## `setResultFilter`
2112
+
2113
+ Set result filter
2114
+
2115
+ Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
2116
+
2117
+ **Payload schema**
2118
+
2119
+ ```json
2120
+ {
2121
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2122
+ "anyOf": [
2123
+ {
2124
+ "type": "object",
2125
+ "properties": {
2126
+ "measureName": {
2127
+ "type": "string",
2128
+ "description": "Visible measure name or label"
2129
+ },
2130
+ "operator": {
2131
+ "type": "string",
2132
+ "enum": [
2133
+ "equals",
2134
+ "doesNotEqual",
2135
+ "greaterThan",
2136
+ "lessThan",
2137
+ "greaterThanOrEqualTo",
2138
+ "lessThanOrEqualTo",
2139
+ "contains",
2140
+ "excludes",
2141
+ "like",
2142
+ "notLike",
2143
+ "startsWith",
2144
+ "endsWith"
2145
+ ],
2146
+ "description": "Filter operator that requires a value"
2147
+ },
2148
+ "value": {
2149
+ "anyOf": [
2150
+ {
2151
+ "type": "string"
2152
+ },
2153
+ {
2154
+ "type": "object",
2155
+ "properties": {
2156
+ "type": {
2157
+ "type": "string",
2158
+ "const": "variable"
2159
+ },
2160
+ "variableName": {
2161
+ "type": "string"
2162
+ }
2163
+ },
2164
+ "required": ["type", "variableName"],
2165
+ "additionalProperties": false
2166
+ }
2167
+ ],
2168
+ "description": "Filter value"
2169
+ }
2170
+ },
2171
+ "required": ["measureName", "operator", "value"],
2172
+ "additionalProperties": false
2173
+ },
2174
+ {
2175
+ "type": "object",
2176
+ "properties": {
2177
+ "measureName": {
2178
+ "type": "string",
2179
+ "description": "Visible measure name or label"
2180
+ },
2181
+ "operator": {
2182
+ "type": "string",
2183
+ "enum": ["isBetween", "isNotBetween"],
2184
+ "description": "Filter operator that requires valueFrom and valueTo"
2185
+ },
2186
+ "valueFrom": {
2187
+ "anyOf": [
2188
+ {
2189
+ "type": "string"
2190
+ },
2191
+ {
2192
+ "type": "object",
2193
+ "properties": {
2194
+ "type": {
2195
+ "type": "string",
2196
+ "const": "variable"
2197
+ },
2198
+ "variableName": {
2199
+ "type": "string"
2200
+ }
2201
+ },
2202
+ "required": ["type", "variableName"],
2203
+ "additionalProperties": false
2204
+ }
2205
+ ],
2206
+ "description": "Lower filter value"
2207
+ },
2208
+ "valueTo": {
2209
+ "anyOf": [
2210
+ {
2211
+ "type": "string"
2212
+ },
2213
+ {
2214
+ "type": "object",
2215
+ "properties": {
2216
+ "type": {
2217
+ "type": "string",
2218
+ "const": "variable"
2219
+ },
2220
+ "variableName": {
2221
+ "type": "string"
2222
+ }
2223
+ },
2224
+ "required": ["type", "variableName"],
2225
+ "additionalProperties": false
2226
+ }
2227
+ ],
2228
+ "description": "Upper filter value"
2229
+ }
2230
+ },
2231
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
2232
+ "additionalProperties": false
2233
+ },
2234
+ {
2235
+ "type": "object",
2236
+ "properties": {
2237
+ "measureName": {
2238
+ "type": "string",
2239
+ "description": "Visible measure name or label"
2240
+ },
2241
+ "operator": {
2242
+ "type": "string",
2243
+ "enum": ["inList", "excludedFromList"],
2244
+ "description": "Filter operator that requires a list of values"
2245
+ },
2246
+ "values": {
2247
+ "minItems": 1,
2248
+ "type": "array",
2249
+ "items": {
2250
+ "type": "string"
2251
+ },
2252
+ "description": "Filter values"
2253
+ }
2254
+ },
2255
+ "required": ["measureName", "operator", "values"],
2256
+ "additionalProperties": false
2257
+ },
2258
+ {
2259
+ "type": "object",
2260
+ "properties": {
2261
+ "measureName": {
2262
+ "type": "string",
2263
+ "description": "Visible measure name or label"
2264
+ },
2265
+ "operator": {
2266
+ "type": "string",
2267
+ "enum": ["isNull", "notNull"],
2268
+ "description": "Filter operator that does not require values"
2269
+ }
2270
+ },
2271
+ "required": ["measureName", "operator"],
2272
+ "additionalProperties": false
2273
+ }
2274
+ ],
2275
+ "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
2276
+ "title": "Set result filter schema"
2277
+ }
2278
+ ```
2279
+
2280
+ ## `setShowAxisLabels`
2281
+
2282
+ Show axis labels
2283
+
2284
+ Show or hide value labels on chart axes
2285
+
2286
+ **Payload schema**
2287
+
2288
+ ```json
2289
+ {
2290
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2291
+ "type": "object",
2292
+ "properties": {
2293
+ "showLabels": {
2294
+ "type": "boolean"
2295
+ },
2296
+ "axisName": {
2297
+ "type": "string",
2298
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2299
+ }
2300
+ },
2301
+ "required": ["axisName"],
2302
+ "additionalProperties": false,
2303
+ "title": "Axis labels schema"
2304
+ }
2305
+ ```
2306
+
2307
+ ## `setShowAxisLine`
2308
+
2309
+ Show axis line
2310
+
2311
+ Show or hide the axis lines on the chart
2312
+
2313
+ **Payload schema**
2314
+
2315
+ ```json
2316
+ {
2317
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2318
+ "type": "object",
2319
+ "properties": {
2320
+ "showAxisLine": {
2321
+ "type": "boolean"
2322
+ },
2323
+ "axisName": {
2324
+ "type": "string",
2325
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2326
+ }
2327
+ },
2328
+ "required": ["axisName"],
2329
+ "additionalProperties": false,
2330
+ "title": "Axis line schema"
2331
+ }
2332
+ ```
2333
+
2334
+ ## `setShowAxisTicks`
2335
+
2336
+ Show axis ticks
2337
+
2338
+ Show or hide tick marks on chart axes
2339
+
2340
+ **Payload schema**
2341
+
2342
+ ```json
2343
+ {
2344
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2345
+ "type": "object",
2346
+ "properties": {
2347
+ "showAxisTicks": {
2348
+ "type": "boolean"
2349
+ },
2350
+ "axisName": {
2351
+ "type": "string",
2352
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2353
+ }
2354
+ },
2355
+ "required": ["axisName"],
2356
+ "additionalProperties": false,
2357
+ "title": "Axis ticks schema"
2358
+ }
2359
+ ```
2360
+
2361
+ ## `setShowAxisTitle`
2362
+
2363
+ Show axis title
2364
+
2365
+ Show or hide axis titles on the chart
2366
+
2367
+ **Payload schema**
2368
+
2369
+ ```json
2370
+ {
2371
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2372
+ "type": "object",
2373
+ "properties": {
2374
+ "showAxisName": {
2375
+ "type": "boolean"
2376
+ },
2377
+ "axisName": {
2378
+ "type": "string",
2379
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2380
+ }
2381
+ },
2382
+ "required": ["axisName"],
2383
+ "additionalProperties": false,
2384
+ "title": "Axis title schema"
2385
+ }
2386
+ ```
2387
+
2388
+ ## `setShowAxisTooltip`
2389
+
2390
+ Show axis tooltip
2391
+
2392
+ Show or hide tooltips when hovering over axis values
2393
+
2394
+ **Payload schema**
2395
+
2396
+ ```json
2397
+ {
2398
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2399
+ "type": "object",
2400
+ "properties": {
2401
+ "showAxisTooltip": {
2402
+ "type": "boolean"
2403
+ },
2404
+ "axisName": {
2405
+ "type": "string",
2406
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2407
+ }
2408
+ },
2409
+ "required": ["axisName"],
2410
+ "additionalProperties": false,
2411
+ "title": "Show axis tooltip schema"
2412
+ }
2413
+ ```
2414
+
2415
+ ## `setStaticFilterGroup`
2416
+
2417
+ Set static filter group
2418
+
2419
+ Replace all static filters with a nested AND/OR filter group.
2420
+
2421
+ **Payload schema**
2422
+
2423
+ ```json
2424
+ {
2425
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2426
+ "description": "Replace all static filters with this nested AND/OR filter group.",
2427
+ "title": "Set static filter group schema",
2428
+ "$ref": "#/$defs/__schema0",
2429
+ "$defs": {
2430
+ "__schema0": {
2431
+ "type": "object",
2432
+ "properties": {
2433
+ "operator": {
2434
+ "type": "string",
2435
+ "enum": ["and", "or"]
2436
+ },
2437
+ "filters": {
2438
+ "type": "array",
2439
+ "items": {
2440
+ "anyOf": [
2441
+ {
2442
+ "type": "object",
2443
+ "properties": {
2444
+ "fieldKey": {
2445
+ "type": "string",
2446
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
2447
+ },
2448
+ "operator": {
2449
+ "anyOf": [
2450
+ {
2451
+ "type": "string",
2452
+ "enum": [
2453
+ "equals",
2454
+ "doesNotEqual",
2455
+ "greaterThan",
2456
+ "lessThan",
2457
+ "greaterThanOrEqualTo",
2458
+ "lessThanOrEqualTo",
2459
+ "isBetween",
2460
+ "isNotBetween",
2461
+ "isNull",
2462
+ "notNull",
2463
+ "contains",
2464
+ "excludes",
2465
+ "like",
2466
+ "notLike",
2467
+ "startsWith",
2468
+ "endsWith",
2469
+ "predefined_date_range",
2470
+ "previous",
2471
+ "current",
2472
+ "before",
2473
+ "after",
2474
+ "inList",
2475
+ "excludedFromList",
2476
+ "divider"
2477
+ ]
2478
+ },
2479
+ {
2480
+ "type": "string",
2481
+ "enum": [
2482
+ "ytd",
2483
+ "mtd",
2484
+ "qtd",
2485
+ "wtd",
2486
+ "pytd",
2487
+ "pmtd",
2488
+ "pqtd",
2489
+ "pwtd",
2490
+ "l12m",
2491
+ "l90d",
2492
+ "l30d",
2493
+ "l7d",
2494
+ "cy",
2495
+ "cq",
2496
+ "cm",
2497
+ "py",
2498
+ "pm",
2499
+ "pq",
2500
+ "pw",
2501
+ "today",
2502
+ "yesterday",
2503
+ "mindate",
2504
+ "maxdate"
2505
+ ]
2506
+ }
2507
+ ]
2508
+ },
2509
+ "values": {
2510
+ "type": "object",
2511
+ "properties": {
2512
+ "value": {
2513
+ "anyOf": [
2514
+ {
2515
+ "type": "string"
2516
+ },
2517
+ {
2518
+ "type": "object",
2519
+ "properties": {
2520
+ "type": {
2521
+ "type": "string",
2522
+ "const": "variable"
2523
+ },
2524
+ "variableName": {
2525
+ "type": "string"
2526
+ }
2527
+ },
2528
+ "required": ["type", "variableName"],
2529
+ "additionalProperties": false
2530
+ }
2531
+ ]
2532
+ },
2533
+ "valueFrom": {
2534
+ "anyOf": [
2535
+ {
2536
+ "type": "string"
2537
+ },
2538
+ {
2539
+ "type": "object",
2540
+ "properties": {
2541
+ "type": {
2542
+ "type": "string",
2543
+ "const": "variable"
2544
+ },
2545
+ "variableName": {
2546
+ "type": "string"
2547
+ }
2548
+ },
2549
+ "required": ["type", "variableName"],
2550
+ "additionalProperties": false
2551
+ }
2552
+ ]
2553
+ },
2554
+ "valueTo": {
2555
+ "anyOf": [
2556
+ {
2557
+ "type": "string"
2558
+ },
2559
+ {
2560
+ "type": "object",
2561
+ "properties": {
2562
+ "type": {
2563
+ "type": "string",
2564
+ "const": "variable"
2565
+ },
2566
+ "variableName": {
2567
+ "type": "string"
2568
+ }
2569
+ },
2570
+ "required": ["type", "variableName"],
2571
+ "additionalProperties": false
2572
+ }
2573
+ ]
2574
+ },
2575
+ "secondValue": {
2576
+ "anyOf": [
2577
+ {
2578
+ "type": "string"
2579
+ },
2580
+ {
2581
+ "type": "object",
2582
+ "properties": {
2583
+ "type": {
2584
+ "type": "string",
2585
+ "const": "variable"
2586
+ },
2587
+ "variableName": {
2588
+ "type": "string"
2589
+ }
2590
+ },
2591
+ "required": ["type", "variableName"],
2592
+ "additionalProperties": false
2593
+ }
2594
+ ]
2595
+ }
2596
+ },
2597
+ "additionalProperties": false
2598
+ },
2599
+ "dateFilter": {
2600
+ "anyOf": [
2601
+ {
2602
+ "type": "string",
2603
+ "enum": [
2604
+ "ytd",
2605
+ "mtd",
2606
+ "qtd",
2607
+ "wtd",
2608
+ "pytd",
2609
+ "pmtd",
2610
+ "pqtd",
2611
+ "pwtd",
2612
+ "l12m",
2613
+ "l90d",
2614
+ "l30d",
2615
+ "l7d",
2616
+ "cy",
2617
+ "cq",
2618
+ "cm",
2619
+ "py",
2620
+ "pm",
2621
+ "pq",
2622
+ "pw",
2623
+ "today",
2624
+ "yesterday",
2625
+ "mindate",
2626
+ "maxdate"
2627
+ ]
2628
+ },
2629
+ {
2630
+ "type": "null"
2631
+ }
2632
+ ]
2633
+ }
2634
+ },
2635
+ "required": ["fieldKey", "operator", "values"],
2636
+ "additionalProperties": false
2637
+ },
2638
+ {
2639
+ "$ref": "#/$defs/__schema0"
2640
+ }
2641
+ ]
2642
+ }
2643
+ }
2644
+ },
2645
+ "required": ["operator", "filters"],
2646
+ "additionalProperties": false
2647
+ }
2648
+ }
2649
+ }
2650
+ ```
2651
+
2652
+ ## `setSupportingMeasureEnabled`
2653
+
2654
+ Supporting measure enabled
2655
+
2656
+ Enable or disable all matching supporting measures by name
2657
+
2658
+ **Payload schema**
2659
+
2660
+ ```json
2661
+ {
2662
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2663
+ "type": "object",
2664
+ "properties": {
2665
+ "name": {
2666
+ "type": "string",
2667
+ "minLength": 1
2668
+ },
2669
+ "enabled": {
2670
+ "type": "boolean"
2671
+ }
2672
+ },
2673
+ "required": ["name", "enabled"],
2674
+ "additionalProperties": false,
2675
+ "title": "Supporting measure enabled by name schema"
2676
+ }
2677
+ ```
2678
+
2679
+ ## `setWaterfallTotalDataLabelFontSize`
2680
+
2681
+ Total data label font size
2682
+
2683
+ Set the font size of the total data label
2684
+
2685
+ **Payload schema**
2686
+
2687
+ ```json
2688
+ {
2689
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2690
+ "title": "Waterfall total data label font size schema",
2691
+ "anyOf": [
2692
+ {
2693
+ "type": "number"
2694
+ },
2695
+ {
2696
+ "type": "object",
2697
+ "properties": {
2698
+ "type": {
2699
+ "type": "string",
2700
+ "const": "variable"
2701
+ },
2702
+ "variableName": {
2703
+ "type": "string"
2704
+ }
2705
+ },
2706
+ "required": ["type", "variableName"],
2707
+ "additionalProperties": false
2708
+ }
2709
+ ]
2710
+ }
2711
+ ```
2712
+
2713
+ ## `setWaterfallTotalDataLabelShow`
2714
+
2715
+ Show total data label
2716
+
2717
+ Show or hide the total data label
2718
+
2719
+ **Payload schema**
2720
+
2721
+ ```json
2722
+ {
2723
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2724
+ "type": "boolean",
2725
+ "title": "Waterfall total data label show schema"
2726
+ }
2727
+ ```
2728
+
2729
+ ## `setWaterfallTotalDataLabelShowBackdrop`
2730
+
2731
+ Total data label backdrop
2732
+
2733
+ Show or hide the backdrop behind the total data label
2734
+
2735
+ **Payload schema**
2736
+
2737
+ ```json
2738
+ {
2739
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2740
+ "type": "boolean",
2741
+ "title": "Waterfall total data label backdrop schema"
2742
+ }
2743
+ ```
2744
+
2745
+ ## `toggleDimension`
2746
+
2747
+ Toggle dimension
2748
+
2749
+ Enable or disable a dimension in the chart
2750
+
2751
+ **Payload schema**
2752
+
2753
+ ```json
2754
+ {
2755
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2756
+ "type": "object",
2757
+ "properties": {
2758
+ "dataItemInternalKey": {
2759
+ "type": "string",
2760
+ "description": "Internal key of the data item of the dimension to be toggled"
2761
+ },
2762
+ "dataItemUniqueSignature": {
2763
+ "type": "string",
2764
+ "description": "Unique signature of the data item of the dimension to be toggled"
2765
+ },
2766
+ "enabled": {
2767
+ "type": "boolean",
2768
+ "description": "Whether the dimension should be enabled or disabled"
2769
+ }
2770
+ },
2771
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
2772
+ "additionalProperties": false,
2773
+ "title": "Toggle dimension schema"
2774
+ }
2775
+ ```
2776
+
2777
+ ## `toggleDimensionOrMeasureByName`
2778
+
2779
+ Toggle dimension/measure by name
2780
+
2781
+ Enable, disable, or toggle a dimension or measure by its name
2782
+
2783
+ **Payload schema**
2784
+
2785
+ ```json
2786
+ {
2787
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2788
+ "type": "object",
2789
+ "properties": {
2790
+ "name": {
2791
+ "type": "string"
2792
+ },
2793
+ "operation": {
2794
+ "type": "string",
2795
+ "enum": ["enable", "disable", "toggle"]
2796
+ }
2797
+ },
2798
+ "required": ["name", "operation"],
2799
+ "additionalProperties": false,
2800
+ "title": "Toggle dimension or measure by name schema"
2801
+ }
2802
+ ```
2803
+
2804
+ ## `toggleMeasure`
2805
+
2806
+ Toggle measure
2807
+
2808
+ Enable or disable a measure in the chart
2809
+
2810
+ **Payload schema**
2811
+
2812
+ ```json
2813
+ {
2814
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2815
+ "type": "object",
2816
+ "properties": {
2817
+ "dataItemInternalKey": {
2818
+ "type": "string",
2819
+ "description": "Internal key of the data item of the measure to be toggled"
2820
+ },
2821
+ "dataItemUniqueSignature": {
2822
+ "type": "string",
2823
+ "description": "Unique signature of the data item of the measure to be toggled"
2824
+ }
2825
+ },
2826
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2827
+ "additionalProperties": false,
2828
+ "title": "Toggle measure schema"
2829
+ }
2830
+ ```
2831
+
2832
+ ## `updateDimension`
2833
+
2834
+ Update dimension
2835
+
2836
+ Modify properties of an existing dimension
2837
+
2838
+ **Payload schema**
2839
+
2840
+ ```json
2841
+ {
2842
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2843
+ "type": "object",
2844
+ "properties": {
2845
+ "dataItemInternalKey": {
2846
+ "type": "string",
2847
+ "description": "Internal key of the data item of the dimension to be updated"
2848
+ },
2849
+ "dataItemUniqueSignature": {
2850
+ "type": "string",
2851
+ "description": "Unique signature of the data item of the dimension to be updated"
2852
+ },
2853
+ "changes": {
2854
+ "type": "object",
2855
+ "properties": {
2856
+ "customLabel": {
2857
+ "type": "object",
2858
+ "properties": {
2859
+ "enabled": {
2860
+ "type": "boolean"
2861
+ },
2862
+ "value": {
2863
+ "type": "string"
2864
+ }
2865
+ },
2866
+ "required": ["enabled"],
2867
+ "additionalProperties": false
2868
+ },
2869
+ "showNullValues": {
2870
+ "type": "boolean"
2871
+ }
2872
+ },
2873
+ "additionalProperties": false
2874
+ }
2875
+ },
2876
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
2877
+ "additionalProperties": false,
2878
+ "title": "Update dimension schema"
2879
+ }
2880
+ ```
2881
+
2882
+ ## `updateMeasure`
2883
+
2884
+ Update measure
2885
+
2886
+ Modify properties of an existing measure
2887
+
2888
+ **Payload schema**
2889
+
2890
+ ```json
2891
+ {
2892
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2893
+ "type": "object",
2894
+ "properties": {
2895
+ "dataItemInternalKey": {
2896
+ "type": "string",
2897
+ "description": "Internal key of the data item of the measure to be updated"
2898
+ },
2899
+ "dataItemUniqueSignature": {
2900
+ "type": "string",
2901
+ "description": "Unique signature of the data item of the measure to be updated"
2902
+ },
2903
+ "changes": {
2904
+ "type": "object",
2905
+ "properties": {
2906
+ "customLabel": {
2907
+ "type": "object",
2908
+ "properties": {
2909
+ "enabled": {
2910
+ "type": "boolean"
2911
+ },
2912
+ "value": {
2913
+ "type": "string"
2914
+ }
2915
+ },
2916
+ "required": ["enabled"],
2917
+ "additionalProperties": false
2918
+ }
2919
+ },
2920
+ "required": ["customLabel"],
2921
+ "additionalProperties": false
2922
+ }
2923
+ },
2924
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
2925
+ "additionalProperties": false,
2926
+ "title": "Update measure schema"
2927
+ }
2928
+ ```