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