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