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