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