@astrato-io/visualizations 0.0.0-stage → 0.6.5

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