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