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