@astrato-io/visualizations 0.0.0-stage → 0.6.4

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 (145) 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 +8387 -0
  5. package/VISUALIZATION_DEFINITIONS.md +2378 -0
  6. package/chunks/LinearProgress-CUZ0D8_t.js +253 -0
  7. package/chunks/Radio-Ciu-F4CU.js +957 -0
  8. package/chunks/ToggleButton-BCJc3Jlc.js +153 -0
  9. package/chunks/_baseFlatten-DPXPOrea.js +7076 -0
  10. package/chunks/accessors-DemrDevR.js +128 -0
  11. package/chunks/app-filter-bar.compiler-j_CVoWTa.js +55 -0
  12. package/chunks/bar.compiler-oqaPzIut.js +370 -0
  13. package/chunks/color-settings-ZIvgNTq1.js +10 -0
  14. package/chunks/coloring-C16AUZEi.js +663 -0
  15. package/chunks/data-item-resolution-1lvYB5ln.js +53 -0
  16. package/chunks/debounce-fn-CUixuz45.js +7 -0
  17. package/chunks/escobar-BGqT1EsE.js +34580 -0
  18. package/chunks/event-bus-KiSiCJrC.js +2683 -0
  19. package/chunks/events-WZut5Ow6.js +4 -0
  20. package/chunks/extend-BKUkc4_i.js +37 -0
  21. package/chunks/filter.compiler-CuLtc_02.js +60 -0
  22. package/chunks/filtering-Yq4DEa0t.js +953 -0
  23. package/chunks/gauge-target-type-BkKXAqkX.js +4 -0
  24. package/chunks/grouping-type-BX_9Ix5q.js +3 -0
  25. package/chunks/interfaces-VUY4_yVO.js +8742 -0
  26. package/chunks/line-settings-DfYTUyPz.js +4 -0
  27. package/chunks/line.compiler-BpA_6Tc7.js +188 -0
  28. package/chunks/metadata-CPXdYoln.js +28 -0
  29. package/chunks/number.compiler-DbkWcG4S.js +44 -0
  30. package/chunks/pie-uv42Eqal.js +10 -0
  31. package/chunks/range-DrzdfBX4.js +22 -0
  32. package/chunks/registry-CExpGJ1N.js +920 -0
  33. package/chunks/requirements-DNhuShLS.js +6 -0
  34. package/chunks/rolldown-runtime-DleVn1XH.js +28 -0
  35. package/chunks/set-coloring-datafield-B3uIS1Pe.js +8 -0
  36. package/chunks/shared-CKDL4hx9.js +1171 -0
  37. package/chunks/src-BC7cGcJ-.js +2024 -0
  38. package/chunks/src-BOS6SqkZ.js +67 -0
  39. package/chunks/src-C0LgoUWY.js +26105 -0
  40. package/chunks/src-Cum_2NLV.js +12145 -0
  41. package/chunks/src-D9XogOrc.js +422 -0
  42. package/chunks/src-Dun_jXtz.js +10295 -0
  43. package/chunks/src-DvX5LU9T.js +14742 -0
  44. package/chunks/standalone-87YV_m9n.js +687 -0
  45. package/chunks/standalone-BDCwI6Hn.js +4619 -0
  46. package/chunks/standalone-BH5NqDwp.js +1763 -0
  47. package/chunks/standalone-BLVAWLNJ.js +385 -0
  48. package/chunks/standalone-BPomtAVs.js +2 -0
  49. package/chunks/standalone-BXyBcUOQ.js +2 -0
  50. package/chunks/standalone-BYm1UjLr.js +140 -0
  51. package/chunks/standalone-BllF4rDp.js +383 -0
  52. package/chunks/standalone-BmfMt74U.js +726 -0
  53. package/chunks/standalone-BqWyrnZI.js +281 -0
  54. package/chunks/standalone-C85u7U6I.js +340 -0
  55. package/chunks/standalone-CCNtaJ7s.js +741 -0
  56. package/chunks/standalone-CDQnr6qT.js +345 -0
  57. package/chunks/standalone-CNyNHKVx.js +674 -0
  58. package/chunks/standalone-CY57qwZ-.js +1129 -0
  59. package/chunks/standalone-CZynjFG7.js +12979 -0
  60. package/chunks/standalone-D5vnf-9y.js +3943 -0
  61. package/chunks/standalone-DFPva_ku.js +299 -0
  62. package/chunks/standalone-DQxxNwF8.js +675 -0
  63. package/chunks/standalone-DS9T0FZ-.js +830 -0
  64. package/chunks/standalone-Dx3MLlrO.js +512 -0
  65. package/chunks/standalone-DzixzZAL.js +411 -0
  66. package/chunks/standalone-QJ1kKMnO.js +6 -0
  67. package/chunks/standalone-jiz0L2Dg.js +3855 -0
  68. package/chunks/standalone-lBm9hQ-q.js +179 -0
  69. package/chunks/standalone-rJ45Zfl1.js +68 -0
  70. package/chunks/stroke-dash-UgMEcCS4.js +6 -0
  71. package/chunks/table.compiler-BrXkm4Fz.js +213 -0
  72. package/chunks/toInteger-DVZr-D1j.js +11 -0
  73. package/chunks/treemap-x_zmJoG7.js +23 -0
  74. package/chunks/typeof-CJDtcySz.js +13 -0
  75. package/chunks/types-dVVCsDWD.js +4 -0
  76. package/chunks/ui-D1HQNIBy.js +54039 -0
  77. package/chunks/url-utils-B17gj_mr.js +5501 -0
  78. package/chunks/useFieldName-oqQ3bvnO.js +7 -0
  79. package/chunks/utils-Ba9T0TqC.js +31097 -0
  80. package/chunks/view-CLqWMV7Z.js +156 -0
  81. package/definitions.js +3 -0
  82. package/docs/operations/astrato-app-filter-bar.md +161 -0
  83. package/docs/operations/bar.md +7050 -0
  84. package/docs/operations/combo.md +5825 -0
  85. package/docs/operations/date-picker.md +644 -0
  86. package/docs/operations/distribution-gauge.md +3218 -0
  87. package/docs/operations/dot.md +5662 -0
  88. package/docs/operations/filter.md +1507 -0
  89. package/docs/operations/gauge.md +3452 -0
  90. package/docs/operations/heatMap.md +6026 -0
  91. package/docs/operations/histogram.md +1870 -0
  92. package/docs/operations/iframe.md +56 -0
  93. package/docs/operations/image.md +177 -0
  94. package/docs/operations/index.md +46 -0
  95. package/docs/operations/line.md +6468 -0
  96. package/docs/operations/number.md +3969 -0
  97. package/docs/operations/pie.md +6089 -0
  98. package/docs/operations/radar.md +4646 -0
  99. package/docs/operations/sankey.md +3210 -0
  100. package/docs/operations/scatter.md +6075 -0
  101. package/docs/operations/shape.md +315 -0
  102. package/docs/operations/simpleTextObject.md +706 -0
  103. package/docs/operations/slider.md +230 -0
  104. package/docs/operations/table.md +8790 -0
  105. package/docs/operations/tree.md +2874 -0
  106. package/docs/operations/treemap.md +3619 -0
  107. package/docs/operations/waterfall.md +2938 -0
  108. package/docs/operations/word-cloud.md +3071 -0
  109. package/getters.js +18 -0
  110. package/index.js +1183 -0
  111. package/metadata.js +20 -0
  112. package/operations.js +64 -0
  113. package/package.json +191 -4
  114. package/src/definitions/index.d.ts +2 -0
  115. package/src/definitions/shared/index.d.ts +5 -0
  116. package/src/definitions/shared/lib/available-fields.d.ts +36 -0
  117. package/src/definitions/shared/lib/compilers/index.d.ts +7 -0
  118. package/src/definitions/shared/lib/registry/compile.d.ts +2 -0
  119. package/src/definitions/shared/lib/registry/descriptor-registry.d.ts +587 -0
  120. package/src/definitions/shared/lib/registry/index.d.ts +3 -0
  121. package/src/definitions/shared/lib/registry/validation.d.ts +3 -0
  122. package/src/definitions/shared/lib/schemas/app-filter-bar.schema.d.ts +22 -0
  123. package/src/definitions/shared/lib/schemas/bar.schema.d.ts +73 -0
  124. package/src/definitions/shared/lib/schemas/broad-chart.schema.d.ts +68 -0
  125. package/src/definitions/shared/lib/schemas/common.schema.d.ts +304 -0
  126. package/src/definitions/shared/lib/schemas/filter.schema.d.ts +22 -0
  127. package/src/definitions/shared/lib/schemas/index.d.ts +9 -0
  128. package/src/definitions/shared/lib/schemas/line.schema.d.ts +72 -0
  129. package/src/definitions/shared/lib/schemas/number.schema.d.ts +21 -0
  130. package/src/definitions/shared/lib/schemas/object.schema.d.ts +215 -0
  131. package/src/definitions/shared/lib/schemas/table.schema.d.ts +458 -0
  132. package/src/definitions/shared/lib/types/compilation.types.d.ts +36 -0
  133. package/src/definitions/shared/lib/types/definition.types.d.ts +2 -0
  134. package/src/definitions/shared/lib/types/descriptor.types.d.ts +39 -0
  135. package/src/definitions/shared/lib/types/index.d.ts +3 -0
  136. package/src/getters/index.d.ts +30 -0
  137. package/src/index.d.ts +4 -0
  138. package/src/metadata/index.d.ts +4 -0
  139. package/src/operations/index.d.ts +30 -0
  140. package/src/registry/index.d.ts +6 -0
  141. package/src/runtime/index.d.ts +2 -0
  142. package/src/types.d.ts +307 -0
  143. package/src/visualization-catalog.d.ts +82 -0
  144. package/src/web-components/index.d.ts +12 -0
  145. package/styles.css +2 -0
@@ -0,0 +1,2938 @@
1
+ <!-- Generated from operation manifests. Do not edit this file manually. -->
2
+
3
+ # `waterfall` operations
4
+
5
+ Reference for `@astrato-io/visualizations@0.6.4`.
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
+ "title": "Add dimension schema",
82
+ "type": "object",
83
+ "properties": {
84
+ "key": {
85
+ "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"",
86
+ "type": "string"
87
+ }
88
+ },
89
+ "required": ["key"],
90
+ "additionalProperties": false
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
+ "title": "Add measure schema",
106
+ "anyOf": [
107
+ {
108
+ "type": "object",
109
+ "properties": {
110
+ "sourceKind": {
111
+ "description": "Raw database field from available data `fields`.",
112
+ "type": "string",
113
+ "const": "field"
114
+ },
115
+ "key": {
116
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
117
+ "type": "string"
118
+ },
119
+ "aggregation": {
120
+ "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
121
+ "type": "string"
122
+ }
123
+ },
124
+ "required": ["sourceKind", "key", "aggregation"],
125
+ "additionalProperties": false
126
+ },
127
+ {
128
+ "type": "object",
129
+ "properties": {
130
+ "sourceKind": {
131
+ "description": "Predefined/user-defined measure from available data `measures`.",
132
+ "type": "string",
133
+ "const": "measure"
134
+ },
135
+ "key": {
136
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
137
+ "type": "string"
138
+ }
139
+ },
140
+ "required": ["sourceKind", "key"],
141
+ "additionalProperties": false
142
+ },
143
+ {
144
+ "type": "object",
145
+ "properties": {
146
+ "sourceKind": {
147
+ "description": "Predefined calculation from available data `measures`.",
148
+ "type": "string",
149
+ "const": "calculation"
150
+ },
151
+ "key": {
152
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
153
+ "type": "string"
154
+ }
155
+ },
156
+ "required": ["sourceKind", "key"],
157
+ "additionalProperties": false
158
+ }
159
+ ]
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
+ "title": "Add measure axis band schema",
175
+ "type": "object",
176
+ "properties": {
177
+ "start": {
178
+ "description": "Measure axis value where the band starts",
179
+ "type": "number"
180
+ },
181
+ "end": {
182
+ "description": "Measure axis value where the band ends",
183
+ "type": "number"
184
+ },
185
+ "color": {
186
+ "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted",
187
+ "type": "string",
188
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
189
+ },
190
+ "label": {
191
+ "description": "Text drawn inside the band",
192
+ "type": "string"
193
+ }
194
+ },
195
+ "required": ["start", "end"],
196
+ "additionalProperties": false
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
+ "description": "Add another measure filter before aggregation. Keeps existing filters.",
212
+ "title": "Add measure filter schema",
213
+ "anyOf": [
214
+ {
215
+ "type": "object",
216
+ "properties": {
217
+ "measureName": {
218
+ "description": "Visible measure name or label",
219
+ "type": "string"
220
+ },
221
+ "fieldKey": {
222
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
223
+ "type": "string"
224
+ },
225
+ "operator": {
226
+ "description": "Filter operator that requires a value",
227
+ "type": "string",
228
+ "enum": [
229
+ "equals",
230
+ "doesNotEqual",
231
+ "greaterThan",
232
+ "lessThan",
233
+ "greaterThanOrEqualTo",
234
+ "lessThanOrEqualTo",
235
+ "contains",
236
+ "excludes",
237
+ "like",
238
+ "notLike",
239
+ "startsWith",
240
+ "endsWith"
241
+ ]
242
+ },
243
+ "value": {
244
+ "description": "Filter value",
245
+ "anyOf": [
246
+ {
247
+ "type": "string"
248
+ },
249
+ {
250
+ "type": "object",
251
+ "properties": {
252
+ "type": {
253
+ "type": "string",
254
+ "const": "variable"
255
+ },
256
+ "variableName": {
257
+ "type": "string"
258
+ }
259
+ },
260
+ "required": ["type", "variableName"],
261
+ "additionalProperties": false
262
+ }
263
+ ]
264
+ }
265
+ },
266
+ "required": ["measureName", "fieldKey", "operator", "value"],
267
+ "additionalProperties": false
268
+ },
269
+ {
270
+ "type": "object",
271
+ "properties": {
272
+ "measureName": {
273
+ "description": "Visible measure name or label",
274
+ "type": "string"
275
+ },
276
+ "fieldKey": {
277
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
278
+ "type": "string"
279
+ },
280
+ "operator": {
281
+ "description": "Filter operator that requires valueFrom and valueTo",
282
+ "type": "string",
283
+ "enum": ["isBetween", "isNotBetween"]
284
+ },
285
+ "valueFrom": {
286
+ "description": "Lower filter value",
287
+ "anyOf": [
288
+ {
289
+ "type": "string"
290
+ },
291
+ {
292
+ "type": "object",
293
+ "properties": {
294
+ "type": {
295
+ "type": "string",
296
+ "const": "variable"
297
+ },
298
+ "variableName": {
299
+ "type": "string"
300
+ }
301
+ },
302
+ "required": ["type", "variableName"],
303
+ "additionalProperties": false
304
+ }
305
+ ]
306
+ },
307
+ "valueTo": {
308
+ "description": "Upper filter value",
309
+ "anyOf": [
310
+ {
311
+ "type": "string"
312
+ },
313
+ {
314
+ "type": "object",
315
+ "properties": {
316
+ "type": {
317
+ "type": "string",
318
+ "const": "variable"
319
+ },
320
+ "variableName": {
321
+ "type": "string"
322
+ }
323
+ },
324
+ "required": ["type", "variableName"],
325
+ "additionalProperties": false
326
+ }
327
+ ]
328
+ }
329
+ },
330
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
331
+ "additionalProperties": false
332
+ },
333
+ {
334
+ "type": "object",
335
+ "properties": {
336
+ "measureName": {
337
+ "description": "Visible measure name or label",
338
+ "type": "string"
339
+ },
340
+ "fieldKey": {
341
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
342
+ "type": "string"
343
+ },
344
+ "operator": {
345
+ "description": "Filter operator that requires a list of values",
346
+ "type": "string",
347
+ "enum": ["inList", "excludedFromList"]
348
+ },
349
+ "values": {
350
+ "description": "Filter values",
351
+ "minItems": 1,
352
+ "type": "array",
353
+ "items": {
354
+ "type": "string"
355
+ }
356
+ }
357
+ },
358
+ "required": ["measureName", "fieldKey", "operator", "values"],
359
+ "additionalProperties": false
360
+ },
361
+ {
362
+ "type": "object",
363
+ "properties": {
364
+ "measureName": {
365
+ "description": "Visible measure name or label",
366
+ "type": "string"
367
+ },
368
+ "fieldKey": {
369
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
370
+ "type": "string"
371
+ },
372
+ "operator": {
373
+ "description": "Filter operator that does not require values",
374
+ "type": "string",
375
+ "enum": ["isNull", "notNull"]
376
+ }
377
+ },
378
+ "required": ["measureName", "fieldKey", "operator"],
379
+ "additionalProperties": false
380
+ }
381
+ ]
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
+ "description": "Add another result filter after aggregation. Keeps existing result filters.",
397
+ "title": "Add result filter schema",
398
+ "anyOf": [
399
+ {
400
+ "type": "object",
401
+ "properties": {
402
+ "measureName": {
403
+ "description": "Visible measure name or label",
404
+ "type": "string"
405
+ },
406
+ "operator": {
407
+ "description": "Filter operator that requires a value",
408
+ "type": "string",
409
+ "enum": [
410
+ "equals",
411
+ "doesNotEqual",
412
+ "greaterThan",
413
+ "lessThan",
414
+ "greaterThanOrEqualTo",
415
+ "lessThanOrEqualTo",
416
+ "contains",
417
+ "excludes",
418
+ "like",
419
+ "notLike",
420
+ "startsWith",
421
+ "endsWith"
422
+ ]
423
+ },
424
+ "value": {
425
+ "description": "Filter value",
426
+ "anyOf": [
427
+ {
428
+ "type": "string"
429
+ },
430
+ {
431
+ "type": "object",
432
+ "properties": {
433
+ "type": {
434
+ "type": "string",
435
+ "const": "variable"
436
+ },
437
+ "variableName": {
438
+ "type": "string"
439
+ }
440
+ },
441
+ "required": ["type", "variableName"],
442
+ "additionalProperties": false
443
+ }
444
+ ]
445
+ }
446
+ },
447
+ "required": ["measureName", "operator", "value"],
448
+ "additionalProperties": false
449
+ },
450
+ {
451
+ "type": "object",
452
+ "properties": {
453
+ "measureName": {
454
+ "description": "Visible measure name or label",
455
+ "type": "string"
456
+ },
457
+ "operator": {
458
+ "description": "Filter operator that requires valueFrom and valueTo",
459
+ "type": "string",
460
+ "enum": ["isBetween", "isNotBetween"]
461
+ },
462
+ "valueFrom": {
463
+ "description": "Lower filter value",
464
+ "anyOf": [
465
+ {
466
+ "type": "string"
467
+ },
468
+ {
469
+ "type": "object",
470
+ "properties": {
471
+ "type": {
472
+ "type": "string",
473
+ "const": "variable"
474
+ },
475
+ "variableName": {
476
+ "type": "string"
477
+ }
478
+ },
479
+ "required": ["type", "variableName"],
480
+ "additionalProperties": false
481
+ }
482
+ ]
483
+ },
484
+ "valueTo": {
485
+ "description": "Upper filter value",
486
+ "anyOf": [
487
+ {
488
+ "type": "string"
489
+ },
490
+ {
491
+ "type": "object",
492
+ "properties": {
493
+ "type": {
494
+ "type": "string",
495
+ "const": "variable"
496
+ },
497
+ "variableName": {
498
+ "type": "string"
499
+ }
500
+ },
501
+ "required": ["type", "variableName"],
502
+ "additionalProperties": false
503
+ }
504
+ ]
505
+ }
506
+ },
507
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
508
+ "additionalProperties": false
509
+ },
510
+ {
511
+ "type": "object",
512
+ "properties": {
513
+ "measureName": {
514
+ "description": "Visible measure name or label",
515
+ "type": "string"
516
+ },
517
+ "operator": {
518
+ "description": "Filter operator that requires a list of values",
519
+ "type": "string",
520
+ "enum": ["inList", "excludedFromList"]
521
+ },
522
+ "values": {
523
+ "description": "Filter values",
524
+ "minItems": 1,
525
+ "type": "array",
526
+ "items": {
527
+ "type": "string"
528
+ }
529
+ }
530
+ },
531
+ "required": ["measureName", "operator", "values"],
532
+ "additionalProperties": false
533
+ },
534
+ {
535
+ "type": "object",
536
+ "properties": {
537
+ "measureName": {
538
+ "description": "Visible measure name or label",
539
+ "type": "string"
540
+ },
541
+ "operator": {
542
+ "description": "Filter operator that does not require values",
543
+ "type": "string",
544
+ "enum": ["isNull", "notNull"]
545
+ }
546
+ },
547
+ "required": ["measureName", "operator"],
548
+ "additionalProperties": false
549
+ }
550
+ ]
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
+ "title": "Change measure aggregation schema",
566
+ "type": "object",
567
+ "properties": {
568
+ "dataItemInternalKey": {
569
+ "description": "Internal key of the data item of the measure to be updated",
570
+ "type": "string"
571
+ },
572
+ "dataItemUniqueSignature": {
573
+ "description": "Unique signature of the data item of the measure to be updated",
574
+ "type": "string"
575
+ },
576
+ "aggregation": {
577
+ "description": "Aggregation function to be used for the measure",
578
+ "type": "string",
579
+ "minLength": 1
580
+ }
581
+ },
582
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
583
+ "additionalProperties": false
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
+ "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
599
+ "title": "Clear measure filter schema",
600
+ "type": "object",
601
+ "properties": {
602
+ "measureName": {
603
+ "description": "Visible measure name or label",
604
+ "type": "string"
605
+ },
606
+ "fieldKey": {
607
+ "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.",
608
+ "type": "string"
609
+ }
610
+ },
611
+ "required": ["measureName"],
612
+ "additionalProperties": false
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
+ "description": "Clear all result filters for one measure.",
628
+ "title": "Clear result filter schema",
629
+ "type": "object",
630
+ "properties": {
631
+ "measureName": {
632
+ "description": "Visible measure name or label",
633
+ "type": "string"
634
+ }
635
+ },
636
+ "required": ["measureName"],
637
+ "additionalProperties": false
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
+ "title": "Duplicate dimension schema",
653
+ "type": "object",
654
+ "properties": {
655
+ "dataItemInternalKey": {
656
+ "description": "Internal key of the data item of the dimension to be duplicated",
657
+ "type": "string"
658
+ },
659
+ "dataItemUniqueSignature": {
660
+ "description": "Unique signature of the data item of the dimension to be duplicated",
661
+ "type": "string"
662
+ }
663
+ },
664
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
665
+ "additionalProperties": false
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
+ "title": "Duplicate measure schema",
681
+ "type": "object",
682
+ "properties": {
683
+ "dataItemInternalKey": {
684
+ "description": "Internal key of the data item of the measure to be duplicated",
685
+ "type": "string"
686
+ },
687
+ "dataItemUniqueSignature": {
688
+ "description": "Unique signature of the data item of the measure to be duplicated",
689
+ "type": "string"
690
+ }
691
+ },
692
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
693
+ "additionalProperties": false
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
+ "title": "Remove dimension schema",
709
+ "type": "object",
710
+ "properties": {
711
+ "dataItemInternalKey": {
712
+ "description": "Internal key of the data item of the dimension to be removed",
713
+ "type": "string"
714
+ },
715
+ "dataItemUniqueSignature": {
716
+ "description": "Unique signature of the data item of the dimension to be removed",
717
+ "type": "string"
718
+ }
719
+ },
720
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
721
+ "additionalProperties": false
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
+ "title": "Remove measure schema",
737
+ "type": "object",
738
+ "properties": {
739
+ "dataItemInternalKey": {
740
+ "description": "Internal key of the data item of the measure to be removed",
741
+ "type": "string"
742
+ },
743
+ "dataItemUniqueSignature": {
744
+ "description": "Unique signature of the data item of the measure to be removed",
745
+ "type": "string"
746
+ }
747
+ },
748
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
749
+ "additionalProperties": false
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
+ "title": "Remove measure axis band schema",
765
+ "type": "object",
766
+ "properties": {
767
+ "index": {
768
+ "description": "Zero-based position of the band to remove",
769
+ "type": "integer",
770
+ "minimum": 0,
771
+ "maximum": 9007199254740991
772
+ }
773
+ },
774
+ "required": ["index"],
775
+ "additionalProperties": false
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
+ "title": "Set animation enabled schema",
791
+ "type": "object",
792
+ "properties": {
793
+ "enabled": {
794
+ "description": "Whether the chart animates when it first renders and when its data changes",
795
+ "type": "boolean"
796
+ }
797
+ },
798
+ "required": ["enabled"],
799
+ "additionalProperties": false
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
+ "title": "Axis label color schema",
815
+ "type": "object",
816
+ "properties": {
817
+ "labelColor": {
818
+ "anyOf": [
819
+ {
820
+ "type": "string",
821
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
822
+ },
823
+ {
824
+ "type": "null"
825
+ }
826
+ ]
827
+ },
828
+ "axisName": {
829
+ "type": "string",
830
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
831
+ }
832
+ },
833
+ "required": ["axisName"],
834
+ "additionalProperties": false
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
+ "title": "Axis line color schema",
850
+ "type": "object",
851
+ "properties": {
852
+ "lineColor": {
853
+ "anyOf": [
854
+ {
855
+ "type": "string",
856
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
857
+ },
858
+ {
859
+ "type": "null"
860
+ }
861
+ ]
862
+ },
863
+ "axisName": {
864
+ "type": "string",
865
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
866
+ }
867
+ },
868
+ "required": ["axisName"],
869
+ "additionalProperties": false
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
+ "title": "Axis range max schema",
885
+ "type": "object",
886
+ "properties": {
887
+ "axisName": {
888
+ "type": "string",
889
+ "enum": ["primaryMeasure"]
890
+ },
891
+ "maxValue": {
892
+ "type": "number"
893
+ }
894
+ },
895
+ "required": ["axisName", "maxValue"],
896
+ "additionalProperties": false
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
+ "title": "Axis range min schema",
912
+ "type": "object",
913
+ "properties": {
914
+ "axisName": {
915
+ "type": "string",
916
+ "enum": ["primaryMeasure"]
917
+ },
918
+ "minValue": {
919
+ "type": "number"
920
+ }
921
+ },
922
+ "required": ["axisName", "minValue"],
923
+ "additionalProperties": false
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
+ "title": "Axis range option schema",
939
+ "type": "object",
940
+ "properties": {
941
+ "axisName": {
942
+ "type": "string",
943
+ "enum": ["primaryMeasure"]
944
+ },
945
+ "axisRangeOption": {
946
+ "type": "string",
947
+ "enum": ["auto", "minmax", "max", "min"]
948
+ }
949
+ },
950
+ "required": ["axisName", "axisRangeOption"],
951
+ "additionalProperties": false
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
+ "title": "Axis starts at zero schema",
967
+ "type": "object",
968
+ "properties": {
969
+ "axisName": {
970
+ "type": "string",
971
+ "enum": ["primaryMeasure"]
972
+ },
973
+ "startsAtZero": {
974
+ "type": "boolean"
975
+ }
976
+ },
977
+ "required": ["axisName", "startsAtZero"],
978
+ "additionalProperties": false
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
+ "title": "Axis tick color schema",
994
+ "type": "object",
995
+ "properties": {
996
+ "tickColor": {
997
+ "anyOf": [
998
+ {
999
+ "type": "string",
1000
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1001
+ },
1002
+ {
1003
+ "type": "null"
1004
+ }
1005
+ ]
1006
+ },
1007
+ "axisName": {
1008
+ "type": "string",
1009
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
1010
+ }
1011
+ },
1012
+ "required": ["axisName"],
1013
+ "additionalProperties": false
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
+ "title": "Axis title schema",
1029
+ "type": "object",
1030
+ "properties": {
1031
+ "axisTitle": {
1032
+ "type": "string"
1033
+ },
1034
+ "axisName": {
1035
+ "type": "string",
1036
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
1037
+ }
1038
+ },
1039
+ "required": ["axisName"],
1040
+ "additionalProperties": false
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
+ "title": "Axis title color schema",
1056
+ "type": "object",
1057
+ "properties": {
1058
+ "titleColor": {
1059
+ "anyOf": [
1060
+ {
1061
+ "type": "string",
1062
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1063
+ },
1064
+ {
1065
+ "type": "null"
1066
+ }
1067
+ ]
1068
+ },
1069
+ "axisName": {
1070
+ "type": "string",
1071
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
1072
+ }
1073
+ },
1074
+ "required": ["axisName"],
1075
+ "additionalProperties": false
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
+ "title": "Dimension format string schema",
1091
+ "type": "object",
1092
+ "properties": {
1093
+ "dataItemInternalKey": {
1094
+ "description": "Internal key of the data item of the dimension to be updated",
1095
+ "type": "string"
1096
+ },
1097
+ "dataItemUniqueSignature": {
1098
+ "description": "Unique signature of the data item of the dimension to be updated",
1099
+ "type": "string"
1100
+ },
1101
+ "formatString": {
1102
+ "anyOf": [
1103
+ {
1104
+ "type": "string"
1105
+ },
1106
+ {
1107
+ "type": "object",
1108
+ "properties": {
1109
+ "type": {
1110
+ "type": "string",
1111
+ "const": "variable"
1112
+ },
1113
+ "variableName": {
1114
+ "type": "string"
1115
+ }
1116
+ },
1117
+ "required": ["type", "variableName"],
1118
+ "additionalProperties": false
1119
+ }
1120
+ ]
1121
+ }
1122
+ },
1123
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1124
+ "additionalProperties": false
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
+ "title": "Dimension format type schema",
1140
+ "type": "object",
1141
+ "properties": {
1142
+ "dataItemInternalKey": {
1143
+ "description": "Internal key of the data item of the dimension to be updated",
1144
+ "type": "string"
1145
+ },
1146
+ "dataItemUniqueSignature": {
1147
+ "description": "Unique signature of the data item of the dimension to be updated",
1148
+ "type": "string"
1149
+ },
1150
+ "formatType": {
1151
+ "anyOf": [
1152
+ {
1153
+ "type": "string",
1154
+ "enum": [
1155
+ "custom",
1156
+ "inherit",
1157
+ "none",
1158
+ "defaultNumber",
1159
+ "defaultMoney",
1160
+ "numberNoDecimal",
1161
+ "number1Decimal",
1162
+ "number2Decimal",
1163
+ "abbreviationAuto",
1164
+ "abbreviationNoDecimal",
1165
+ "abbreviation1Decimal",
1166
+ "abbreviation2Decimal",
1167
+ "percentageNoDecimal",
1168
+ "percentage1Decimal",
1169
+ "percentage2Decimal",
1170
+ "money0Decimal",
1171
+ "money2Decimal",
1172
+ "durationDays",
1173
+ "durationHours",
1174
+ "durationMinutes",
1175
+ "durationSeconds"
1176
+ ]
1177
+ },
1178
+ {
1179
+ "type": "string",
1180
+ "enum": [
1181
+ "defaultDate",
1182
+ "defaultDatetime",
1183
+ "defaultTime",
1184
+ "ddmmyyyy",
1185
+ "ddmmyyyy2",
1186
+ "ddmmyyyy3",
1187
+ "yyyymmdd",
1188
+ "mmddyyyy",
1189
+ "mmddyyyy2",
1190
+ "ddmmmmyyyy",
1191
+ "ddmmmyyyy",
1192
+ "ddmmmyy",
1193
+ "mmmmddyyyy",
1194
+ "yyyy",
1195
+ "yy",
1196
+ "mmmyyyy",
1197
+ "yyyymmm",
1198
+ "yyyymmmm",
1199
+ "mmyyyy",
1200
+ "yyyymm",
1201
+ "mmmmyyyy",
1202
+ "yyyywn",
1203
+ "wnyyyy",
1204
+ "yywn",
1205
+ "yyyyq",
1206
+ "qyyyy",
1207
+ "yyyymmddhhmmss",
1208
+ "yyyymmddhmmss",
1209
+ "yyyymmddhhmm",
1210
+ "yyyymmddhh",
1211
+ "yyyymmddhmm",
1212
+ "yyyymmddh",
1213
+ "ddmmmyyyyhhmmss",
1214
+ "ddmmmyyyyhmmss",
1215
+ "ddmmmyyyyhhmm",
1216
+ "ddmmmyyyyhmm",
1217
+ "ddmmmyyyyh",
1218
+ "hhmmss",
1219
+ "hhmm",
1220
+ "hmm",
1221
+ "h",
1222
+ "hh",
1223
+ "hmmss",
1224
+ "month",
1225
+ "month2",
1226
+ "monthn",
1227
+ "month3",
1228
+ "quarter",
1229
+ "quarter2",
1230
+ "week1",
1231
+ "week2",
1232
+ "week3",
1233
+ "day",
1234
+ "dayOfWeek",
1235
+ "hhn",
1236
+ "hn"
1237
+ ]
1238
+ }
1239
+ ]
1240
+ }
1241
+ },
1242
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
1243
+ "additionalProperties": false
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
+ "title": "Dimension temporal grouping schema",
1259
+ "anyOf": [
1260
+ {
1261
+ "type": "object",
1262
+ "properties": {
1263
+ "dataItemInternalKey": {
1264
+ "description": "Internal key of the data item of the dimension to be updated",
1265
+ "type": "string"
1266
+ },
1267
+ "dataItemUniqueSignature": {
1268
+ "description": "Unique signature of the data item of the dimension to be updated",
1269
+ "type": "string"
1270
+ },
1271
+ "mode": {
1272
+ "type": "string",
1273
+ "const": "none"
1274
+ }
1275
+ },
1276
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"],
1277
+ "additionalProperties": false
1278
+ },
1279
+ {
1280
+ "type": "object",
1281
+ "properties": {
1282
+ "dataItemInternalKey": {
1283
+ "description": "Internal key of the data item of the dimension to be updated",
1284
+ "type": "string"
1285
+ },
1286
+ "dataItemUniqueSignature": {
1287
+ "description": "Unique signature of the data item of the dimension to be updated",
1288
+ "type": "string"
1289
+ },
1290
+ "mode": {
1291
+ "type": "string",
1292
+ "const": "level"
1293
+ },
1294
+ "dateLevel": {
1295
+ "type": "string",
1296
+ "enum": [
1297
+ "year",
1298
+ "year-end",
1299
+ "quarter",
1300
+ "quarter-end",
1301
+ "month",
1302
+ "month-end",
1303
+ "week",
1304
+ "week-end",
1305
+ "day",
1306
+ "hour",
1307
+ "minute",
1308
+ "second"
1309
+ ]
1310
+ }
1311
+ },
1312
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"],
1313
+ "additionalProperties": false
1314
+ },
1315
+ {
1316
+ "type": "object",
1317
+ "properties": {
1318
+ "dataItemInternalKey": {
1319
+ "description": "Internal key of the data item of the dimension to be updated",
1320
+ "type": "string"
1321
+ },
1322
+ "dataItemUniqueSignature": {
1323
+ "description": "Unique signature of the data item of the dimension to be updated",
1324
+ "type": "string"
1325
+ },
1326
+ "mode": {
1327
+ "type": "string",
1328
+ "const": "part"
1329
+ },
1330
+ "datePart": {
1331
+ "type": "string",
1332
+ "enum": [
1333
+ "year",
1334
+ "month",
1335
+ "day",
1336
+ "dayofweekiso",
1337
+ "dayofyear",
1338
+ "weekiso",
1339
+ "quarter",
1340
+ "yearofweekiso",
1341
+ "hour",
1342
+ "minute",
1343
+ "second"
1344
+ ]
1345
+ }
1346
+ },
1347
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
1348
+ "additionalProperties": false
1349
+ }
1350
+ ]
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
+ "title": "Invert axis schema",
1366
+ "type": "object",
1367
+ "properties": {
1368
+ "invertAxis": {
1369
+ "type": "boolean"
1370
+ },
1371
+ "axisName": {
1372
+ "type": "string",
1373
+ "enum": ["dimension", "primaryMeasure"]
1374
+ }
1375
+ },
1376
+ "required": ["invertAxis"],
1377
+ "additionalProperties": false
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
+ "title": "Label overlap schema",
1393
+ "type": "object",
1394
+ "properties": {
1395
+ "labelOverlap": {
1396
+ "type": "string",
1397
+ "enum": ["auto", "show-last"]
1398
+ }
1399
+ },
1400
+ "additionalProperties": false
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
+ "title": "Set measure axis bands schema",
1416
+ "type": "object",
1417
+ "properties": {
1418
+ "bands": {
1419
+ "description": "Bands to draw, in order; an empty array removes all bands",
1420
+ "type": "array",
1421
+ "items": {
1422
+ "type": "object",
1423
+ "properties": {
1424
+ "start": {
1425
+ "description": "Measure axis value where the band starts",
1426
+ "type": "number"
1427
+ },
1428
+ "end": {
1429
+ "description": "Measure axis value where the band ends",
1430
+ "type": "number"
1431
+ },
1432
+ "color": {
1433
+ "description": "Band fill as #RRGGBB or #RRGGBBAA; defaults to a light grey when omitted",
1434
+ "type": "string",
1435
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1436
+ },
1437
+ "label": {
1438
+ "description": "Text drawn inside the band",
1439
+ "type": "string"
1440
+ }
1441
+ },
1442
+ "required": ["start", "end"],
1443
+ "additionalProperties": false
1444
+ }
1445
+ }
1446
+ },
1447
+ "required": ["bands"],
1448
+ "additionalProperties": false
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
+ "title": "Measure currency schema",
1464
+ "type": "object",
1465
+ "properties": {
1466
+ "dataItemInternalKey": {
1467
+ "description": "Internal key of the data item of the measure to be updated",
1468
+ "type": "string"
1469
+ },
1470
+ "dataItemUniqueSignature": {
1471
+ "description": "Unique signature of the data item of the measure to be updated",
1472
+ "type": "string"
1473
+ },
1474
+ "currency": {
1475
+ "type": "string"
1476
+ }
1477
+ },
1478
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1479
+ "additionalProperties": false
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
+ "title": "Measure currency is prefix schema",
1495
+ "type": "object",
1496
+ "properties": {
1497
+ "dataItemInternalKey": {
1498
+ "description": "Internal key of the data item of the measure to be updated",
1499
+ "type": "string"
1500
+ },
1501
+ "dataItemUniqueSignature": {
1502
+ "description": "Unique signature of the data item of the measure to be updated",
1503
+ "type": "string"
1504
+ },
1505
+ "currencyIsPrefix": {
1506
+ "type": "boolean"
1507
+ }
1508
+ },
1509
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1510
+ "additionalProperties": false
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
+ "title": "Set measure data label font size schema",
1526
+ "type": "object",
1527
+ "properties": {
1528
+ "dataItemInternalKey": {
1529
+ "description": "Internal key of the data item of the measure to be updated",
1530
+ "type": "string"
1531
+ },
1532
+ "dataItemUniqueSignature": {
1533
+ "description": "Unique signature of the data item of the measure to be updated",
1534
+ "type": "string"
1535
+ },
1536
+ "fontSize": {
1537
+ "anyOf": [
1538
+ {
1539
+ "type": "number"
1540
+ },
1541
+ {
1542
+ "type": "object",
1543
+ "properties": {
1544
+ "type": {
1545
+ "type": "string",
1546
+ "const": "variable"
1547
+ },
1548
+ "variableName": {
1549
+ "type": "string"
1550
+ }
1551
+ },
1552
+ "required": ["type", "variableName"],
1553
+ "additionalProperties": false
1554
+ }
1555
+ ]
1556
+ }
1557
+ },
1558
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1559
+ "additionalProperties": false
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
+ "title": "Set measure data label backdrop schema",
1575
+ "type": "object",
1576
+ "properties": {
1577
+ "dataItemInternalKey": {
1578
+ "description": "Internal key of the data item of the measure to be updated",
1579
+ "type": "string"
1580
+ },
1581
+ "dataItemUniqueSignature": {
1582
+ "description": "Unique signature of the data item of the measure to be updated",
1583
+ "type": "string"
1584
+ },
1585
+ "showBackdrop": {
1586
+ "type": "boolean"
1587
+ }
1588
+ },
1589
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1590
+ "additionalProperties": false
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
+ "title": "Set measure data labels show schema",
1606
+ "type": "object",
1607
+ "properties": {
1608
+ "dataItemInternalKey": {
1609
+ "description": "Internal key of the data item of the measure to be updated",
1610
+ "type": "string"
1611
+ },
1612
+ "dataItemUniqueSignature": {
1613
+ "description": "Unique signature of the data item of the measure to be updated",
1614
+ "type": "string"
1615
+ },
1616
+ "show": {
1617
+ "type": "boolean"
1618
+ }
1619
+ },
1620
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1621
+ "additionalProperties": false
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
+ "title": "Set measure defined parameter schema",
1637
+ "type": "object",
1638
+ "properties": {
1639
+ "dataItemInternalKey": {
1640
+ "description": "Internal key of the data item of the measure to be updated",
1641
+ "type": "string"
1642
+ },
1643
+ "dataItemUniqueSignature": {
1644
+ "description": "Unique signature of the data item of the measure to be updated",
1645
+ "type": "string"
1646
+ },
1647
+ "collectionKey": {
1648
+ "description": "Measure collection to update. Defaults to primary measures.",
1649
+ "type": "string",
1650
+ "enum": ["measures", "supportingMeasures"]
1651
+ },
1652
+ "parameterName": {
1653
+ "description": "Exact name of a Defined parameter exposed by the measure",
1654
+ "type": "string",
1655
+ "minLength": 1
1656
+ },
1657
+ "value": {
1658
+ "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
1659
+ "anyOf": [
1660
+ {
1661
+ "type": "object",
1662
+ "properties": {
1663
+ "type": {
1664
+ "type": "string",
1665
+ "const": "default"
1666
+ }
1667
+ },
1668
+ "required": ["type"],
1669
+ "additionalProperties": false
1670
+ },
1671
+ {
1672
+ "type": "object",
1673
+ "properties": {
1674
+ "type": {
1675
+ "type": "string",
1676
+ "const": "static"
1677
+ },
1678
+ "value": {
1679
+ "anyOf": [
1680
+ {
1681
+ "type": "string"
1682
+ },
1683
+ {
1684
+ "type": "number"
1685
+ },
1686
+ {
1687
+ "type": "boolean"
1688
+ }
1689
+ ]
1690
+ }
1691
+ },
1692
+ "required": ["type", "value"],
1693
+ "additionalProperties": false
1694
+ },
1695
+ {
1696
+ "type": "object",
1697
+ "properties": {
1698
+ "type": {
1699
+ "type": "string",
1700
+ "const": "variable"
1701
+ },
1702
+ "variableName": {
1703
+ "description": "Exact name of an existing compatible workbook variable",
1704
+ "type": "string",
1705
+ "minLength": 1
1706
+ }
1707
+ },
1708
+ "required": ["type", "variableName"],
1709
+ "additionalProperties": false
1710
+ }
1711
+ ]
1712
+ }
1713
+ },
1714
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
1715
+ "additionalProperties": false
1716
+ }
1717
+ ```
1718
+
1719
+ ## `setMeasureFilter`
1720
+
1721
+ Set measure filter
1722
+
1723
+ Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
1724
+
1725
+ **Payload schema**
1726
+
1727
+ ```json
1728
+ {
1729
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1730
+ "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
1731
+ "title": "Set measure filter schema",
1732
+ "anyOf": [
1733
+ {
1734
+ "type": "object",
1735
+ "properties": {
1736
+ "measureName": {
1737
+ "description": "Visible measure name or label",
1738
+ "type": "string"
1739
+ },
1740
+ "fieldKey": {
1741
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
1742
+ "type": "string"
1743
+ },
1744
+ "operator": {
1745
+ "description": "Filter operator that requires a value",
1746
+ "type": "string",
1747
+ "enum": [
1748
+ "equals",
1749
+ "doesNotEqual",
1750
+ "greaterThan",
1751
+ "lessThan",
1752
+ "greaterThanOrEqualTo",
1753
+ "lessThanOrEqualTo",
1754
+ "contains",
1755
+ "excludes",
1756
+ "like",
1757
+ "notLike",
1758
+ "startsWith",
1759
+ "endsWith"
1760
+ ]
1761
+ },
1762
+ "value": {
1763
+ "description": "Filter value",
1764
+ "anyOf": [
1765
+ {
1766
+ "type": "string"
1767
+ },
1768
+ {
1769
+ "type": "object",
1770
+ "properties": {
1771
+ "type": {
1772
+ "type": "string",
1773
+ "const": "variable"
1774
+ },
1775
+ "variableName": {
1776
+ "type": "string"
1777
+ }
1778
+ },
1779
+ "required": ["type", "variableName"],
1780
+ "additionalProperties": false
1781
+ }
1782
+ ]
1783
+ }
1784
+ },
1785
+ "required": ["measureName", "fieldKey", "operator", "value"],
1786
+ "additionalProperties": false
1787
+ },
1788
+ {
1789
+ "type": "object",
1790
+ "properties": {
1791
+ "measureName": {
1792
+ "description": "Visible measure name or label",
1793
+ "type": "string"
1794
+ },
1795
+ "fieldKey": {
1796
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
1797
+ "type": "string"
1798
+ },
1799
+ "operator": {
1800
+ "description": "Filter operator that requires valueFrom and valueTo",
1801
+ "type": "string",
1802
+ "enum": ["isBetween", "isNotBetween"]
1803
+ },
1804
+ "valueFrom": {
1805
+ "description": "Lower filter value",
1806
+ "anyOf": [
1807
+ {
1808
+ "type": "string"
1809
+ },
1810
+ {
1811
+ "type": "object",
1812
+ "properties": {
1813
+ "type": {
1814
+ "type": "string",
1815
+ "const": "variable"
1816
+ },
1817
+ "variableName": {
1818
+ "type": "string"
1819
+ }
1820
+ },
1821
+ "required": ["type", "variableName"],
1822
+ "additionalProperties": false
1823
+ }
1824
+ ]
1825
+ },
1826
+ "valueTo": {
1827
+ "description": "Upper filter value",
1828
+ "anyOf": [
1829
+ {
1830
+ "type": "string"
1831
+ },
1832
+ {
1833
+ "type": "object",
1834
+ "properties": {
1835
+ "type": {
1836
+ "type": "string",
1837
+ "const": "variable"
1838
+ },
1839
+ "variableName": {
1840
+ "type": "string"
1841
+ }
1842
+ },
1843
+ "required": ["type", "variableName"],
1844
+ "additionalProperties": false
1845
+ }
1846
+ ]
1847
+ }
1848
+ },
1849
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
1850
+ "additionalProperties": false
1851
+ },
1852
+ {
1853
+ "type": "object",
1854
+ "properties": {
1855
+ "measureName": {
1856
+ "description": "Visible measure name or label",
1857
+ "type": "string"
1858
+ },
1859
+ "fieldKey": {
1860
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
1861
+ "type": "string"
1862
+ },
1863
+ "operator": {
1864
+ "description": "Filter operator that requires a list of values",
1865
+ "type": "string",
1866
+ "enum": ["inList", "excludedFromList"]
1867
+ },
1868
+ "values": {
1869
+ "description": "Filter values",
1870
+ "minItems": 1,
1871
+ "type": "array",
1872
+ "items": {
1873
+ "type": "string"
1874
+ }
1875
+ }
1876
+ },
1877
+ "required": ["measureName", "fieldKey", "operator", "values"],
1878
+ "additionalProperties": false
1879
+ },
1880
+ {
1881
+ "type": "object",
1882
+ "properties": {
1883
+ "measureName": {
1884
+ "description": "Visible measure name or label",
1885
+ "type": "string"
1886
+ },
1887
+ "fieldKey": {
1888
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
1889
+ "type": "string"
1890
+ },
1891
+ "operator": {
1892
+ "description": "Filter operator that does not require values",
1893
+ "type": "string",
1894
+ "enum": ["isNull", "notNull"]
1895
+ }
1896
+ },
1897
+ "required": ["measureName", "fieldKey", "operator"],
1898
+ "additionalProperties": false
1899
+ }
1900
+ ]
1901
+ }
1902
+ ```
1903
+
1904
+ ## `setMeasureFormatString`
1905
+
1906
+ Measure format string
1907
+
1908
+ Set the custom format string for a measure
1909
+
1910
+ **Payload schema**
1911
+
1912
+ ```json
1913
+ {
1914
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1915
+ "title": "Measure format string schema",
1916
+ "type": "object",
1917
+ "properties": {
1918
+ "dataItemInternalKey": {
1919
+ "description": "Internal key of the data item of the measure to be updated",
1920
+ "type": "string"
1921
+ },
1922
+ "dataItemUniqueSignature": {
1923
+ "description": "Unique signature of the data item of the measure to be updated",
1924
+ "type": "string"
1925
+ },
1926
+ "formatString": {
1927
+ "anyOf": [
1928
+ {
1929
+ "type": "string"
1930
+ },
1931
+ {
1932
+ "type": "object",
1933
+ "properties": {
1934
+ "type": {
1935
+ "type": "string",
1936
+ "const": "variable"
1937
+ },
1938
+ "variableName": {
1939
+ "type": "string"
1940
+ }
1941
+ },
1942
+ "required": ["type", "variableName"],
1943
+ "additionalProperties": false
1944
+ }
1945
+ ]
1946
+ }
1947
+ },
1948
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1949
+ "additionalProperties": false
1950
+ }
1951
+ ```
1952
+
1953
+ ## `setMeasureFormatType`
1954
+
1955
+ Measure format type
1956
+
1957
+ Set the format type used by a measure
1958
+
1959
+ **Payload schema**
1960
+
1961
+ ```json
1962
+ {
1963
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1964
+ "title": "Measure format type schema",
1965
+ "type": "object",
1966
+ "properties": {
1967
+ "dataItemInternalKey": {
1968
+ "description": "Internal key of the data item of the measure to be updated",
1969
+ "type": "string"
1970
+ },
1971
+ "dataItemUniqueSignature": {
1972
+ "description": "Unique signature of the data item of the measure to be updated",
1973
+ "type": "string"
1974
+ },
1975
+ "formatType": {
1976
+ "anyOf": [
1977
+ {
1978
+ "type": "string",
1979
+ "enum": [
1980
+ "custom",
1981
+ "inherit",
1982
+ "none",
1983
+ "defaultNumber",
1984
+ "defaultMoney",
1985
+ "numberNoDecimal",
1986
+ "number1Decimal",
1987
+ "number2Decimal",
1988
+ "abbreviationAuto",
1989
+ "abbreviationNoDecimal",
1990
+ "abbreviation1Decimal",
1991
+ "abbreviation2Decimal",
1992
+ "percentageNoDecimal",
1993
+ "percentage1Decimal",
1994
+ "percentage2Decimal",
1995
+ "money0Decimal",
1996
+ "money2Decimal",
1997
+ "durationDays",
1998
+ "durationHours",
1999
+ "durationMinutes",
2000
+ "durationSeconds"
2001
+ ]
2002
+ },
2003
+ {
2004
+ "type": "string",
2005
+ "enum": [
2006
+ "defaultDate",
2007
+ "defaultDatetime",
2008
+ "defaultTime",
2009
+ "ddmmyyyy",
2010
+ "ddmmyyyy2",
2011
+ "ddmmyyyy3",
2012
+ "yyyymmdd",
2013
+ "mmddyyyy",
2014
+ "mmddyyyy2",
2015
+ "ddmmmmyyyy",
2016
+ "ddmmmyyyy",
2017
+ "ddmmmyy",
2018
+ "mmmmddyyyy",
2019
+ "yyyy",
2020
+ "yy",
2021
+ "mmmyyyy",
2022
+ "yyyymmm",
2023
+ "yyyymmmm",
2024
+ "mmyyyy",
2025
+ "yyyymm",
2026
+ "mmmmyyyy",
2027
+ "yyyywn",
2028
+ "wnyyyy",
2029
+ "yywn",
2030
+ "yyyyq",
2031
+ "qyyyy",
2032
+ "yyyymmddhhmmss",
2033
+ "yyyymmddhmmss",
2034
+ "yyyymmddhhmm",
2035
+ "yyyymmddhh",
2036
+ "yyyymmddhmm",
2037
+ "yyyymmddh",
2038
+ "ddmmmyyyyhhmmss",
2039
+ "ddmmmyyyyhmmss",
2040
+ "ddmmmyyyyhhmm",
2041
+ "ddmmmyyyyhmm",
2042
+ "ddmmmyyyyh",
2043
+ "hhmmss",
2044
+ "hhmm",
2045
+ "hmm",
2046
+ "h",
2047
+ "hh",
2048
+ "hmmss",
2049
+ "month",
2050
+ "month2",
2051
+ "monthn",
2052
+ "month3",
2053
+ "quarter",
2054
+ "quarter2",
2055
+ "week1",
2056
+ "week2",
2057
+ "week3",
2058
+ "day",
2059
+ "dayOfWeek",
2060
+ "hhn",
2061
+ "hn"
2062
+ ]
2063
+ }
2064
+ ]
2065
+ }
2066
+ },
2067
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
2068
+ "additionalProperties": false
2069
+ }
2070
+ ```
2071
+
2072
+ ## `setMeasureNegativeType`
2073
+
2074
+ Measure negative type
2075
+
2076
+ Set how negative values are displayed for a measure formatter
2077
+
2078
+ **Payload schema**
2079
+
2080
+ ```json
2081
+ {
2082
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2083
+ "title": "Measure negative type schema",
2084
+ "type": "object",
2085
+ "properties": {
2086
+ "dataItemInternalKey": {
2087
+ "description": "Internal key of the data item of the measure to be updated",
2088
+ "type": "string"
2089
+ },
2090
+ "dataItemUniqueSignature": {
2091
+ "description": "Unique signature of the data item of the measure to be updated",
2092
+ "type": "string"
2093
+ },
2094
+ "negativeType": {
2095
+ "type": "string",
2096
+ "enum": ["symbol", "parenthesis"]
2097
+ }
2098
+ },
2099
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2100
+ "additionalProperties": false
2101
+ }
2102
+ ```
2103
+
2104
+ ## `setOrientation`
2105
+
2106
+ Orientation
2107
+
2108
+ Set the orientation of the waterfall chart
2109
+
2110
+ **Payload schema**
2111
+
2112
+ ```json
2113
+ {
2114
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2115
+ "title": "Waterfall chart orientation schema",
2116
+ "type": "string",
2117
+ "enum": ["horizontal", "vertical"]
2118
+ }
2119
+ ```
2120
+
2121
+ ## `setResultFilter`
2122
+
2123
+ Set result filter
2124
+
2125
+ Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
2126
+
2127
+ **Payload schema**
2128
+
2129
+ ```json
2130
+ {
2131
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2132
+ "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
2133
+ "title": "Set result filter schema",
2134
+ "anyOf": [
2135
+ {
2136
+ "type": "object",
2137
+ "properties": {
2138
+ "measureName": {
2139
+ "description": "Visible measure name or label",
2140
+ "type": "string"
2141
+ },
2142
+ "operator": {
2143
+ "description": "Filter operator that requires a value",
2144
+ "type": "string",
2145
+ "enum": [
2146
+ "equals",
2147
+ "doesNotEqual",
2148
+ "greaterThan",
2149
+ "lessThan",
2150
+ "greaterThanOrEqualTo",
2151
+ "lessThanOrEqualTo",
2152
+ "contains",
2153
+ "excludes",
2154
+ "like",
2155
+ "notLike",
2156
+ "startsWith",
2157
+ "endsWith"
2158
+ ]
2159
+ },
2160
+ "value": {
2161
+ "description": "Filter value",
2162
+ "anyOf": [
2163
+ {
2164
+ "type": "string"
2165
+ },
2166
+ {
2167
+ "type": "object",
2168
+ "properties": {
2169
+ "type": {
2170
+ "type": "string",
2171
+ "const": "variable"
2172
+ },
2173
+ "variableName": {
2174
+ "type": "string"
2175
+ }
2176
+ },
2177
+ "required": ["type", "variableName"],
2178
+ "additionalProperties": false
2179
+ }
2180
+ ]
2181
+ }
2182
+ },
2183
+ "required": ["measureName", "operator", "value"],
2184
+ "additionalProperties": false
2185
+ },
2186
+ {
2187
+ "type": "object",
2188
+ "properties": {
2189
+ "measureName": {
2190
+ "description": "Visible measure name or label",
2191
+ "type": "string"
2192
+ },
2193
+ "operator": {
2194
+ "description": "Filter operator that requires valueFrom and valueTo",
2195
+ "type": "string",
2196
+ "enum": ["isBetween", "isNotBetween"]
2197
+ },
2198
+ "valueFrom": {
2199
+ "description": "Lower filter value",
2200
+ "anyOf": [
2201
+ {
2202
+ "type": "string"
2203
+ },
2204
+ {
2205
+ "type": "object",
2206
+ "properties": {
2207
+ "type": {
2208
+ "type": "string",
2209
+ "const": "variable"
2210
+ },
2211
+ "variableName": {
2212
+ "type": "string"
2213
+ }
2214
+ },
2215
+ "required": ["type", "variableName"],
2216
+ "additionalProperties": false
2217
+ }
2218
+ ]
2219
+ },
2220
+ "valueTo": {
2221
+ "description": "Upper filter value",
2222
+ "anyOf": [
2223
+ {
2224
+ "type": "string"
2225
+ },
2226
+ {
2227
+ "type": "object",
2228
+ "properties": {
2229
+ "type": {
2230
+ "type": "string",
2231
+ "const": "variable"
2232
+ },
2233
+ "variableName": {
2234
+ "type": "string"
2235
+ }
2236
+ },
2237
+ "required": ["type", "variableName"],
2238
+ "additionalProperties": false
2239
+ }
2240
+ ]
2241
+ }
2242
+ },
2243
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
2244
+ "additionalProperties": false
2245
+ },
2246
+ {
2247
+ "type": "object",
2248
+ "properties": {
2249
+ "measureName": {
2250
+ "description": "Visible measure name or label",
2251
+ "type": "string"
2252
+ },
2253
+ "operator": {
2254
+ "description": "Filter operator that requires a list of values",
2255
+ "type": "string",
2256
+ "enum": ["inList", "excludedFromList"]
2257
+ },
2258
+ "values": {
2259
+ "description": "Filter values",
2260
+ "minItems": 1,
2261
+ "type": "array",
2262
+ "items": {
2263
+ "type": "string"
2264
+ }
2265
+ }
2266
+ },
2267
+ "required": ["measureName", "operator", "values"],
2268
+ "additionalProperties": false
2269
+ },
2270
+ {
2271
+ "type": "object",
2272
+ "properties": {
2273
+ "measureName": {
2274
+ "description": "Visible measure name or label",
2275
+ "type": "string"
2276
+ },
2277
+ "operator": {
2278
+ "description": "Filter operator that does not require values",
2279
+ "type": "string",
2280
+ "enum": ["isNull", "notNull"]
2281
+ }
2282
+ },
2283
+ "required": ["measureName", "operator"],
2284
+ "additionalProperties": false
2285
+ }
2286
+ ]
2287
+ }
2288
+ ```
2289
+
2290
+ ## `setShowAxisLabels`
2291
+
2292
+ Show axis labels
2293
+
2294
+ Show or hide value labels on chart axes
2295
+
2296
+ **Payload schema**
2297
+
2298
+ ```json
2299
+ {
2300
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2301
+ "title": "Axis labels schema",
2302
+ "type": "object",
2303
+ "properties": {
2304
+ "showLabels": {
2305
+ "type": "boolean"
2306
+ },
2307
+ "axisName": {
2308
+ "type": "string",
2309
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2310
+ }
2311
+ },
2312
+ "required": ["axisName"],
2313
+ "additionalProperties": false
2314
+ }
2315
+ ```
2316
+
2317
+ ## `setShowAxisLine`
2318
+
2319
+ Show axis line
2320
+
2321
+ Show or hide the axis lines on the chart
2322
+
2323
+ **Payload schema**
2324
+
2325
+ ```json
2326
+ {
2327
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2328
+ "title": "Axis line schema",
2329
+ "type": "object",
2330
+ "properties": {
2331
+ "showAxisLine": {
2332
+ "type": "boolean"
2333
+ },
2334
+ "axisName": {
2335
+ "type": "string",
2336
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2337
+ }
2338
+ },
2339
+ "required": ["axisName"],
2340
+ "additionalProperties": false
2341
+ }
2342
+ ```
2343
+
2344
+ ## `setShowAxisTicks`
2345
+
2346
+ Show axis ticks
2347
+
2348
+ Show or hide tick marks on chart axes
2349
+
2350
+ **Payload schema**
2351
+
2352
+ ```json
2353
+ {
2354
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2355
+ "title": "Axis ticks schema",
2356
+ "type": "object",
2357
+ "properties": {
2358
+ "showAxisTicks": {
2359
+ "type": "boolean"
2360
+ },
2361
+ "axisName": {
2362
+ "type": "string",
2363
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2364
+ }
2365
+ },
2366
+ "required": ["axisName"],
2367
+ "additionalProperties": false
2368
+ }
2369
+ ```
2370
+
2371
+ ## `setShowAxisTitle`
2372
+
2373
+ Show axis title
2374
+
2375
+ Show or hide axis titles on the chart
2376
+
2377
+ **Payload schema**
2378
+
2379
+ ```json
2380
+ {
2381
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2382
+ "title": "Axis title schema",
2383
+ "type": "object",
2384
+ "properties": {
2385
+ "showAxisName": {
2386
+ "type": "boolean"
2387
+ },
2388
+ "axisName": {
2389
+ "type": "string",
2390
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2391
+ }
2392
+ },
2393
+ "required": ["axisName"],
2394
+ "additionalProperties": false
2395
+ }
2396
+ ```
2397
+
2398
+ ## `setShowAxisTooltip`
2399
+
2400
+ Show axis tooltip
2401
+
2402
+ Show or hide tooltips when hovering over axis values
2403
+
2404
+ **Payload schema**
2405
+
2406
+ ```json
2407
+ {
2408
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2409
+ "title": "Show axis tooltip schema",
2410
+ "type": "object",
2411
+ "properties": {
2412
+ "showAxisTooltip": {
2413
+ "type": "boolean"
2414
+ },
2415
+ "axisName": {
2416
+ "type": "string",
2417
+ "enum": ["primaryMeasure", "secondaryMeasure", "dimension"]
2418
+ }
2419
+ },
2420
+ "required": ["axisName"],
2421
+ "additionalProperties": false
2422
+ }
2423
+ ```
2424
+
2425
+ ## `setStaticFilterGroup`
2426
+
2427
+ Set static filter group
2428
+
2429
+ Replace all static filters with a nested AND/OR filter group.
2430
+
2431
+ **Payload schema**
2432
+
2433
+ ```json
2434
+ {
2435
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2436
+ "description": "Replace all static filters with this nested AND/OR filter group.",
2437
+ "title": "Set static filter group schema",
2438
+ "$ref": "#/$defs/__schema0",
2439
+ "$defs": {
2440
+ "__schema0": {
2441
+ "type": "object",
2442
+ "properties": {
2443
+ "operator": {
2444
+ "type": "string",
2445
+ "enum": ["and", "or"]
2446
+ },
2447
+ "filters": {
2448
+ "type": "array",
2449
+ "items": {
2450
+ "anyOf": [
2451
+ {
2452
+ "type": "object",
2453
+ "properties": {
2454
+ "fieldKey": {
2455
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
2456
+ "type": "string"
2457
+ },
2458
+ "operator": {
2459
+ "anyOf": [
2460
+ {
2461
+ "type": "string",
2462
+ "enum": [
2463
+ "equals",
2464
+ "doesNotEqual",
2465
+ "greaterThan",
2466
+ "lessThan",
2467
+ "greaterThanOrEqualTo",
2468
+ "lessThanOrEqualTo",
2469
+ "isBetween",
2470
+ "isNotBetween",
2471
+ "isNull",
2472
+ "notNull",
2473
+ "contains",
2474
+ "excludes",
2475
+ "like",
2476
+ "notLike",
2477
+ "startsWith",
2478
+ "endsWith",
2479
+ "predefined_date_range",
2480
+ "previous",
2481
+ "current",
2482
+ "before",
2483
+ "after",
2484
+ "inList",
2485
+ "excludedFromList",
2486
+ "divider"
2487
+ ]
2488
+ },
2489
+ {
2490
+ "type": "string",
2491
+ "enum": [
2492
+ "ytd",
2493
+ "mtd",
2494
+ "qtd",
2495
+ "wtd",
2496
+ "pytd",
2497
+ "pmtd",
2498
+ "pqtd",
2499
+ "pwtd",
2500
+ "l12m",
2501
+ "l90d",
2502
+ "l30d",
2503
+ "l7d",
2504
+ "cy",
2505
+ "cq",
2506
+ "cm",
2507
+ "py",
2508
+ "pm",
2509
+ "pq",
2510
+ "pw",
2511
+ "today",
2512
+ "yesterday",
2513
+ "mindate",
2514
+ "maxdate"
2515
+ ]
2516
+ }
2517
+ ]
2518
+ },
2519
+ "values": {
2520
+ "type": "object",
2521
+ "properties": {
2522
+ "value": {
2523
+ "anyOf": [
2524
+ {
2525
+ "type": "string"
2526
+ },
2527
+ {
2528
+ "type": "object",
2529
+ "properties": {
2530
+ "type": {
2531
+ "type": "string",
2532
+ "const": "variable"
2533
+ },
2534
+ "variableName": {
2535
+ "type": "string"
2536
+ }
2537
+ },
2538
+ "required": ["type", "variableName"],
2539
+ "additionalProperties": false
2540
+ }
2541
+ ]
2542
+ },
2543
+ "valueFrom": {
2544
+ "anyOf": [
2545
+ {
2546
+ "type": "string"
2547
+ },
2548
+ {
2549
+ "type": "object",
2550
+ "properties": {
2551
+ "type": {
2552
+ "type": "string",
2553
+ "const": "variable"
2554
+ },
2555
+ "variableName": {
2556
+ "type": "string"
2557
+ }
2558
+ },
2559
+ "required": ["type", "variableName"],
2560
+ "additionalProperties": false
2561
+ }
2562
+ ]
2563
+ },
2564
+ "valueTo": {
2565
+ "anyOf": [
2566
+ {
2567
+ "type": "string"
2568
+ },
2569
+ {
2570
+ "type": "object",
2571
+ "properties": {
2572
+ "type": {
2573
+ "type": "string",
2574
+ "const": "variable"
2575
+ },
2576
+ "variableName": {
2577
+ "type": "string"
2578
+ }
2579
+ },
2580
+ "required": ["type", "variableName"],
2581
+ "additionalProperties": false
2582
+ }
2583
+ ]
2584
+ },
2585
+ "secondValue": {
2586
+ "anyOf": [
2587
+ {
2588
+ "type": "string"
2589
+ },
2590
+ {
2591
+ "type": "object",
2592
+ "properties": {
2593
+ "type": {
2594
+ "type": "string",
2595
+ "const": "variable"
2596
+ },
2597
+ "variableName": {
2598
+ "type": "string"
2599
+ }
2600
+ },
2601
+ "required": ["type", "variableName"],
2602
+ "additionalProperties": false
2603
+ }
2604
+ ]
2605
+ }
2606
+ },
2607
+ "additionalProperties": false
2608
+ },
2609
+ "dateFilter": {
2610
+ "anyOf": [
2611
+ {
2612
+ "type": "string",
2613
+ "enum": [
2614
+ "ytd",
2615
+ "mtd",
2616
+ "qtd",
2617
+ "wtd",
2618
+ "pytd",
2619
+ "pmtd",
2620
+ "pqtd",
2621
+ "pwtd",
2622
+ "l12m",
2623
+ "l90d",
2624
+ "l30d",
2625
+ "l7d",
2626
+ "cy",
2627
+ "cq",
2628
+ "cm",
2629
+ "py",
2630
+ "pm",
2631
+ "pq",
2632
+ "pw",
2633
+ "today",
2634
+ "yesterday",
2635
+ "mindate",
2636
+ "maxdate"
2637
+ ]
2638
+ },
2639
+ {
2640
+ "type": "null"
2641
+ }
2642
+ ]
2643
+ }
2644
+ },
2645
+ "required": ["fieldKey", "operator", "values"],
2646
+ "additionalProperties": false
2647
+ },
2648
+ {
2649
+ "$ref": "#/$defs/__schema0"
2650
+ }
2651
+ ]
2652
+ }
2653
+ }
2654
+ },
2655
+ "required": ["operator", "filters"],
2656
+ "additionalProperties": false
2657
+ }
2658
+ }
2659
+ }
2660
+ ```
2661
+
2662
+ ## `setSupportingMeasureEnabled`
2663
+
2664
+ Supporting measure enabled
2665
+
2666
+ Enable or disable all matching supporting measures by name
2667
+
2668
+ **Payload schema**
2669
+
2670
+ ```json
2671
+ {
2672
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2673
+ "title": "Supporting measure enabled by name schema",
2674
+ "type": "object",
2675
+ "properties": {
2676
+ "name": {
2677
+ "type": "string",
2678
+ "minLength": 1
2679
+ },
2680
+ "enabled": {
2681
+ "type": "boolean"
2682
+ }
2683
+ },
2684
+ "required": ["name", "enabled"],
2685
+ "additionalProperties": false
2686
+ }
2687
+ ```
2688
+
2689
+ ## `setWaterfallTotalDataLabelFontSize`
2690
+
2691
+ Total data label font size
2692
+
2693
+ Set the font size of the total data label
2694
+
2695
+ **Payload schema**
2696
+
2697
+ ```json
2698
+ {
2699
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2700
+ "title": "Waterfall total data label font size schema",
2701
+ "anyOf": [
2702
+ {
2703
+ "type": "number"
2704
+ },
2705
+ {
2706
+ "type": "object",
2707
+ "properties": {
2708
+ "type": {
2709
+ "type": "string",
2710
+ "const": "variable"
2711
+ },
2712
+ "variableName": {
2713
+ "type": "string"
2714
+ }
2715
+ },
2716
+ "required": ["type", "variableName"],
2717
+ "additionalProperties": false
2718
+ }
2719
+ ]
2720
+ }
2721
+ ```
2722
+
2723
+ ## `setWaterfallTotalDataLabelShow`
2724
+
2725
+ Show total data label
2726
+
2727
+ Show or hide the total data label
2728
+
2729
+ **Payload schema**
2730
+
2731
+ ```json
2732
+ {
2733
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2734
+ "title": "Waterfall total data label show schema",
2735
+ "type": "boolean"
2736
+ }
2737
+ ```
2738
+
2739
+ ## `setWaterfallTotalDataLabelShowBackdrop`
2740
+
2741
+ Total data label backdrop
2742
+
2743
+ Show or hide the backdrop behind the total data label
2744
+
2745
+ **Payload schema**
2746
+
2747
+ ```json
2748
+ {
2749
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2750
+ "title": "Waterfall total data label backdrop schema",
2751
+ "type": "boolean"
2752
+ }
2753
+ ```
2754
+
2755
+ ## `toggleDimension`
2756
+
2757
+ Toggle dimension
2758
+
2759
+ Enable or disable a dimension in the chart
2760
+
2761
+ **Payload schema**
2762
+
2763
+ ```json
2764
+ {
2765
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2766
+ "title": "Toggle dimension schema",
2767
+ "type": "object",
2768
+ "properties": {
2769
+ "dataItemInternalKey": {
2770
+ "description": "Internal key of the data item of the dimension to be toggled",
2771
+ "type": "string"
2772
+ },
2773
+ "dataItemUniqueSignature": {
2774
+ "description": "Unique signature of the data item of the dimension to be toggled",
2775
+ "type": "string"
2776
+ },
2777
+ "enabled": {
2778
+ "description": "Whether the dimension should be enabled or disabled",
2779
+ "type": "boolean"
2780
+ }
2781
+ },
2782
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
2783
+ "additionalProperties": false
2784
+ }
2785
+ ```
2786
+
2787
+ ## `toggleDimensionOrMeasureByName`
2788
+
2789
+ Toggle dimension/measure by name
2790
+
2791
+ Enable, disable, or toggle a dimension or measure by its name
2792
+
2793
+ **Payload schema**
2794
+
2795
+ ```json
2796
+ {
2797
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2798
+ "title": "Toggle dimension or measure by name schema",
2799
+ "type": "object",
2800
+ "properties": {
2801
+ "name": {
2802
+ "type": "string"
2803
+ },
2804
+ "operation": {
2805
+ "type": "string",
2806
+ "enum": ["enable", "disable", "toggle"]
2807
+ }
2808
+ },
2809
+ "required": ["name", "operation"],
2810
+ "additionalProperties": false
2811
+ }
2812
+ ```
2813
+
2814
+ ## `toggleMeasure`
2815
+
2816
+ Toggle measure
2817
+
2818
+ Enable or disable a measure in the chart
2819
+
2820
+ **Payload schema**
2821
+
2822
+ ```json
2823
+ {
2824
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2825
+ "title": "Toggle measure schema",
2826
+ "type": "object",
2827
+ "properties": {
2828
+ "dataItemInternalKey": {
2829
+ "description": "Internal key of the data item of the measure to be toggled",
2830
+ "type": "string"
2831
+ },
2832
+ "dataItemUniqueSignature": {
2833
+ "description": "Unique signature of the data item of the measure to be toggled",
2834
+ "type": "string"
2835
+ }
2836
+ },
2837
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
2838
+ "additionalProperties": false
2839
+ }
2840
+ ```
2841
+
2842
+ ## `updateDimension`
2843
+
2844
+ Update dimension
2845
+
2846
+ Modify properties of an existing dimension
2847
+
2848
+ **Payload schema**
2849
+
2850
+ ```json
2851
+ {
2852
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2853
+ "title": "Update dimension schema",
2854
+ "type": "object",
2855
+ "properties": {
2856
+ "dataItemInternalKey": {
2857
+ "description": "Internal key of the data item of the dimension to be updated",
2858
+ "type": "string"
2859
+ },
2860
+ "dataItemUniqueSignature": {
2861
+ "description": "Unique signature of the data item of the dimension to be updated",
2862
+ "type": "string"
2863
+ },
2864
+ "changes": {
2865
+ "type": "object",
2866
+ "properties": {
2867
+ "customLabel": {
2868
+ "type": "object",
2869
+ "properties": {
2870
+ "enabled": {
2871
+ "type": "boolean"
2872
+ },
2873
+ "value": {
2874
+ "type": "string"
2875
+ }
2876
+ },
2877
+ "required": ["enabled"],
2878
+ "additionalProperties": false
2879
+ },
2880
+ "showNullValues": {
2881
+ "type": "boolean"
2882
+ }
2883
+ },
2884
+ "additionalProperties": false
2885
+ }
2886
+ },
2887
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
2888
+ "additionalProperties": false
2889
+ }
2890
+ ```
2891
+
2892
+ ## `updateMeasure`
2893
+
2894
+ Update measure
2895
+
2896
+ Modify properties of an existing measure
2897
+
2898
+ **Payload schema**
2899
+
2900
+ ```json
2901
+ {
2902
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2903
+ "title": "Update measure schema",
2904
+ "type": "object",
2905
+ "properties": {
2906
+ "dataItemInternalKey": {
2907
+ "description": "Internal key of the data item of the measure to be updated",
2908
+ "type": "string"
2909
+ },
2910
+ "dataItemUniqueSignature": {
2911
+ "description": "Unique signature of the data item of the measure to be updated",
2912
+ "type": "string"
2913
+ },
2914
+ "changes": {
2915
+ "type": "object",
2916
+ "properties": {
2917
+ "customLabel": {
2918
+ "type": "object",
2919
+ "properties": {
2920
+ "enabled": {
2921
+ "type": "boolean"
2922
+ },
2923
+ "value": {
2924
+ "type": "string"
2925
+ }
2926
+ },
2927
+ "required": ["enabled"],
2928
+ "additionalProperties": false
2929
+ }
2930
+ },
2931
+ "required": ["customLabel"],
2932
+ "additionalProperties": false
2933
+ }
2934
+ },
2935
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
2936
+ "additionalProperties": false
2937
+ }
2938
+ ```