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