@astrato-io/visualizations 0.0.0-stage → 0.6.5

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