@astrato-io/visualizations 0.0.0-stage → 0.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/LICENSE +93 -0
  3. package/README.md +843 -2
  4. package/THIRD_PARTY_NOTICES.md +8387 -0
  5. package/VISUALIZATION_DEFINITIONS.md +2378 -0
  6. package/chunks/LinearProgress-CUZ0D8_t.js +253 -0
  7. package/chunks/Radio-Ciu-F4CU.js +957 -0
  8. package/chunks/ToggleButton-BCJc3Jlc.js +153 -0
  9. package/chunks/_baseFlatten-DPXPOrea.js +7076 -0
  10. package/chunks/accessors-DemrDevR.js +128 -0
  11. package/chunks/app-filter-bar.compiler-j_CVoWTa.js +55 -0
  12. package/chunks/bar.compiler-oqaPzIut.js +370 -0
  13. package/chunks/color-settings-ZIvgNTq1.js +10 -0
  14. package/chunks/coloring-C16AUZEi.js +663 -0
  15. package/chunks/data-item-resolution-1lvYB5ln.js +53 -0
  16. package/chunks/debounce-fn-CUixuz45.js +7 -0
  17. package/chunks/escobar-BGqT1EsE.js +34580 -0
  18. package/chunks/event-bus-KiSiCJrC.js +2683 -0
  19. package/chunks/events-WZut5Ow6.js +4 -0
  20. package/chunks/extend-BKUkc4_i.js +37 -0
  21. package/chunks/filter.compiler-CuLtc_02.js +60 -0
  22. package/chunks/filtering-Yq4DEa0t.js +953 -0
  23. package/chunks/gauge-target-type-BkKXAqkX.js +4 -0
  24. package/chunks/grouping-type-BX_9Ix5q.js +3 -0
  25. package/chunks/interfaces-VUY4_yVO.js +8742 -0
  26. package/chunks/line-settings-DfYTUyPz.js +4 -0
  27. package/chunks/line.compiler-BpA_6Tc7.js +188 -0
  28. package/chunks/metadata-CPXdYoln.js +28 -0
  29. package/chunks/number.compiler-DbkWcG4S.js +44 -0
  30. package/chunks/pie-uv42Eqal.js +10 -0
  31. package/chunks/range-DrzdfBX4.js +22 -0
  32. package/chunks/registry-CExpGJ1N.js +920 -0
  33. package/chunks/requirements-DNhuShLS.js +6 -0
  34. package/chunks/rolldown-runtime-DleVn1XH.js +28 -0
  35. package/chunks/set-coloring-datafield-B3uIS1Pe.js +8 -0
  36. package/chunks/shared-CKDL4hx9.js +1171 -0
  37. package/chunks/src-BC7cGcJ-.js +2024 -0
  38. package/chunks/src-BOS6SqkZ.js +67 -0
  39. package/chunks/src-C0LgoUWY.js +26105 -0
  40. package/chunks/src-Cum_2NLV.js +12145 -0
  41. package/chunks/src-D9XogOrc.js +422 -0
  42. package/chunks/src-Dun_jXtz.js +10295 -0
  43. package/chunks/src-DvX5LU9T.js +14742 -0
  44. package/chunks/standalone-87YV_m9n.js +687 -0
  45. package/chunks/standalone-BDCwI6Hn.js +4619 -0
  46. package/chunks/standalone-BH5NqDwp.js +1763 -0
  47. package/chunks/standalone-BLVAWLNJ.js +385 -0
  48. package/chunks/standalone-BPomtAVs.js +2 -0
  49. package/chunks/standalone-BXyBcUOQ.js +2 -0
  50. package/chunks/standalone-BYm1UjLr.js +140 -0
  51. package/chunks/standalone-BllF4rDp.js +383 -0
  52. package/chunks/standalone-BmfMt74U.js +726 -0
  53. package/chunks/standalone-BqWyrnZI.js +281 -0
  54. package/chunks/standalone-C85u7U6I.js +340 -0
  55. package/chunks/standalone-CCNtaJ7s.js +741 -0
  56. package/chunks/standalone-CDQnr6qT.js +345 -0
  57. package/chunks/standalone-CNyNHKVx.js +674 -0
  58. package/chunks/standalone-CY57qwZ-.js +1129 -0
  59. package/chunks/standalone-CZynjFG7.js +12979 -0
  60. package/chunks/standalone-D5vnf-9y.js +3943 -0
  61. package/chunks/standalone-DFPva_ku.js +299 -0
  62. package/chunks/standalone-DQxxNwF8.js +675 -0
  63. package/chunks/standalone-DS9T0FZ-.js +830 -0
  64. package/chunks/standalone-Dx3MLlrO.js +512 -0
  65. package/chunks/standalone-DzixzZAL.js +411 -0
  66. package/chunks/standalone-QJ1kKMnO.js +6 -0
  67. package/chunks/standalone-jiz0L2Dg.js +3855 -0
  68. package/chunks/standalone-lBm9hQ-q.js +179 -0
  69. package/chunks/standalone-rJ45Zfl1.js +68 -0
  70. package/chunks/stroke-dash-UgMEcCS4.js +6 -0
  71. package/chunks/table.compiler-BrXkm4Fz.js +213 -0
  72. package/chunks/toInteger-DVZr-D1j.js +11 -0
  73. package/chunks/treemap-x_zmJoG7.js +23 -0
  74. package/chunks/typeof-CJDtcySz.js +13 -0
  75. package/chunks/types-dVVCsDWD.js +4 -0
  76. package/chunks/ui-D1HQNIBy.js +54039 -0
  77. package/chunks/url-utils-B17gj_mr.js +5501 -0
  78. package/chunks/useFieldName-oqQ3bvnO.js +7 -0
  79. package/chunks/utils-Ba9T0TqC.js +31097 -0
  80. package/chunks/view-CLqWMV7Z.js +156 -0
  81. package/definitions.js +3 -0
  82. package/docs/operations/astrato-app-filter-bar.md +161 -0
  83. package/docs/operations/bar.md +7050 -0
  84. package/docs/operations/combo.md +5825 -0
  85. package/docs/operations/date-picker.md +644 -0
  86. package/docs/operations/distribution-gauge.md +3218 -0
  87. package/docs/operations/dot.md +5662 -0
  88. package/docs/operations/filter.md +1507 -0
  89. package/docs/operations/gauge.md +3452 -0
  90. package/docs/operations/heatMap.md +6026 -0
  91. package/docs/operations/histogram.md +1870 -0
  92. package/docs/operations/iframe.md +56 -0
  93. package/docs/operations/image.md +177 -0
  94. package/docs/operations/index.md +46 -0
  95. package/docs/operations/line.md +6468 -0
  96. package/docs/operations/number.md +3969 -0
  97. package/docs/operations/pie.md +6089 -0
  98. package/docs/operations/radar.md +4646 -0
  99. package/docs/operations/sankey.md +3210 -0
  100. package/docs/operations/scatter.md +6075 -0
  101. package/docs/operations/shape.md +315 -0
  102. package/docs/operations/simpleTextObject.md +706 -0
  103. package/docs/operations/slider.md +230 -0
  104. package/docs/operations/table.md +8790 -0
  105. package/docs/operations/tree.md +2874 -0
  106. package/docs/operations/treemap.md +3619 -0
  107. package/docs/operations/waterfall.md +2938 -0
  108. package/docs/operations/word-cloud.md +3071 -0
  109. package/getters.js +18 -0
  110. package/index.js +1183 -0
  111. package/metadata.js +20 -0
  112. package/operations.js +64 -0
  113. package/package.json +191 -4
  114. package/src/definitions/index.d.ts +2 -0
  115. package/src/definitions/shared/index.d.ts +5 -0
  116. package/src/definitions/shared/lib/available-fields.d.ts +36 -0
  117. package/src/definitions/shared/lib/compilers/index.d.ts +7 -0
  118. package/src/definitions/shared/lib/registry/compile.d.ts +2 -0
  119. package/src/definitions/shared/lib/registry/descriptor-registry.d.ts +587 -0
  120. package/src/definitions/shared/lib/registry/index.d.ts +3 -0
  121. package/src/definitions/shared/lib/registry/validation.d.ts +3 -0
  122. package/src/definitions/shared/lib/schemas/app-filter-bar.schema.d.ts +22 -0
  123. package/src/definitions/shared/lib/schemas/bar.schema.d.ts +73 -0
  124. package/src/definitions/shared/lib/schemas/broad-chart.schema.d.ts +68 -0
  125. package/src/definitions/shared/lib/schemas/common.schema.d.ts +304 -0
  126. package/src/definitions/shared/lib/schemas/filter.schema.d.ts +22 -0
  127. package/src/definitions/shared/lib/schemas/index.d.ts +9 -0
  128. package/src/definitions/shared/lib/schemas/line.schema.d.ts +72 -0
  129. package/src/definitions/shared/lib/schemas/number.schema.d.ts +21 -0
  130. package/src/definitions/shared/lib/schemas/object.schema.d.ts +215 -0
  131. package/src/definitions/shared/lib/schemas/table.schema.d.ts +458 -0
  132. package/src/definitions/shared/lib/types/compilation.types.d.ts +36 -0
  133. package/src/definitions/shared/lib/types/definition.types.d.ts +2 -0
  134. package/src/definitions/shared/lib/types/descriptor.types.d.ts +39 -0
  135. package/src/definitions/shared/lib/types/index.d.ts +3 -0
  136. package/src/getters/index.d.ts +30 -0
  137. package/src/index.d.ts +4 -0
  138. package/src/metadata/index.d.ts +4 -0
  139. package/src/operations/index.d.ts +30 -0
  140. package/src/registry/index.d.ts +6 -0
  141. package/src/runtime/index.d.ts +2 -0
  142. package/src/types.d.ts +307 -0
  143. package/src/visualization-catalog.d.ts +82 -0
  144. package/src/web-components/index.d.ts +12 -0
  145. package/styles.css +2 -0
@@ -0,0 +1,4646 @@
1
+ <!-- Generated from operation manifests. Do not edit this file manually. -->
2
+
3
+ # `radar` operations
4
+
5
+ Reference for `@astrato-io/visualizations@0.6.4`.
6
+
7
+ [All visualization types](./index.md)
8
+
9
+ Use each schema below for the request’s `payload`, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
10
+
11
+ ## Available operations
12
+
13
+ - [`addColoringOverwrite`](#addcoloringoverwrite)
14
+ - [`addDimension`](#adddimension)
15
+ - [`addMeasure`](#addmeasure)
16
+ - [`addMeasureAdvancedAdditionalDimensionDataField`](#addmeasureadvancedadditionaldimensiondatafield)
17
+ - [`addMeasureAdvancedDimensionDataField`](#addmeasureadvanceddimensiondatafield)
18
+ - [`addMeasureFilter`](#addmeasurefilter)
19
+ - [`addResultFilter`](#addresultfilter)
20
+ - [`changeMeasureAggregation`](#changemeasureaggregation)
21
+ - [`clearMeasureFilter`](#clearmeasurefilter)
22
+ - [`clearResultFilter`](#clearresultfilter)
23
+ - [`duplicateDimension`](#duplicatedimension)
24
+ - [`duplicateMeasure`](#duplicatemeasure)
25
+ - [`removeColoringOverwrite`](#removecoloringoverwrite)
26
+ - [`removeDimension`](#removedimension)
27
+ - [`removeMeasure`](#removemeasure)
28
+ - [`removeMeasureAdvancedAdditionalDimensionDataField`](#removemeasureadvancedadditionaldimensiondatafield)
29
+ - [`removeMeasureAdvancedCompareMeasure`](#removemeasureadvancedcomparemeasure)
30
+ - [`removeMeasureAdvancedDimensionDataField`](#removemeasureadvanceddimensiondatafield)
31
+ - [`resetChartPaletteToThemeDefault`](#resetchartpalettetothemedefault)
32
+ - [`setAnimationEnabled`](#setanimationenabled)
33
+ - [`setChartPalette`](#setchartpalette)
34
+ - [`setColoringColor`](#setcoloringcolor)
35
+ - [`setColoringOverwrites`](#setcoloringoverwrites)
36
+ - [`setColoringPersistentColors`](#setcoloringpersistentcolors)
37
+ - [`setColoringSortOrder`](#setcoloringsortorder)
38
+ - [`setColoringType`](#setcoloringtype)
39
+ - [`setCustomPaletteColors`](#setcustompalettecolors)
40
+ - [`setDimensionFormatString`](#setdimensionformatstring)
41
+ - [`setDimensionFormatType`](#setdimensionformattype)
42
+ - [`setDimensionTemporalGrouping`](#setdimensiontemporalgrouping)
43
+ - [`setLegendEnabled`](#setlegendenabled)
44
+ - [`setLegendItemLabelFill`](#setlegenditemlabelfill)
45
+ - [`setLegendItemLabelFontSize`](#setlegenditemlabelfontsize)
46
+ - [`setLegendItemLabelLimitCharacters`](#setlegenditemlabellimitcharacters)
47
+ - [`setLegendItemLabelMaxGlyphCount`](#setlegenditemlabelmaxglyphcount)
48
+ - [`setLegendPosition`](#setlegendposition)
49
+ - [`setLegendTitle`](#setlegendtitle)
50
+ - [`setMeasureAdvancedAdditionalAggregation`](#setmeasureadvancedadditionalaggregation)
51
+ - [`setMeasureAdvancedAggregation`](#setmeasureadvancedaggregation)
52
+ - [`setMeasureAdvancedCalculationType`](#setmeasureadvancedcalculationtype)
53
+ - [`setMeasureAdvancedCompareMeasure`](#setmeasureadvancedcomparemeasure)
54
+ - [`setMeasureAdvancedComparisonType`](#setmeasureadvancedcomparisontype)
55
+ - [`setMeasureAdvancedDense`](#setmeasureadvanceddense)
56
+ - [`setMeasureAdvancedDimensionsIds`](#setmeasureadvanceddimensionsids)
57
+ - [`setMeasureAdvancedGroupType`](#setmeasureadvancedgrouptype)
58
+ - [`setMeasureAdvancedNonTimePeriod`](#setmeasureadvancednontimeperiod)
59
+ - [`setMeasureAdvancedNonTimePeriodGranularity`](#setmeasureadvancednontimeperiodgranularity)
60
+ - [`setMeasureAdvancedNullIfNotEnoughValues`](#setmeasureadvancednullifnotenoughvalues)
61
+ - [`setMeasureAdvancedOffset`](#setmeasureadvancedoffset)
62
+ - [`setMeasureAdvancedParameter`](#setmeasureadvancedparameter)
63
+ - [`setMeasureAdvancedPercentileApprox`](#setmeasureadvancedpercentileapprox)
64
+ - [`setMeasureAdvancedPercentileContinuous`](#setmeasureadvancedpercentilecontinuous)
65
+ - [`setMeasureAdvancedPercentileValue`](#setmeasureadvancedpercentilevalue)
66
+ - [`setMeasureAdvancedPeriodsPerYear`](#setmeasureadvancedperiodsperyear)
67
+ - [`setMeasureAdvancedRangesComparisonEnabled`](#setmeasureadvancedrangescomparisonenabled)
68
+ - [`setMeasureAdvancedRangesComparisonFirstRangeEnd`](#setmeasureadvancedrangescomparisonfirstrangeend)
69
+ - [`setMeasureAdvancedRangesComparisonFirstRangeStart`](#setmeasureadvancedrangescomparisonfirstrangestart)
70
+ - [`setMeasureAdvancedRangesComparisonSecondRangeEnd`](#setmeasureadvancedrangescomparisonsecondrangeend)
71
+ - [`setMeasureAdvancedRangesComparisonSecondRangeStart`](#setmeasureadvancedrangescomparisonsecondrangestart)
72
+ - [`setMeasureAdvancedRangesComparisonType`](#setmeasureadvancedrangescomparisontype)
73
+ - [`setMeasureAdvancedRankSortDirection`](#setmeasureadvancedranksortdirection)
74
+ - [`setMeasureAdvancedSortingOrder`](#setmeasureadvancedsortingorder)
75
+ - [`setMeasureAdvancedStandardDeviations`](#setmeasureadvancedstandarddeviations)
76
+ - [`setMeasureAdvancedWindowBegin`](#setmeasureadvancedwindowbegin)
77
+ - [`setMeasureAdvancedWindowEnd`](#setmeasureadvancedwindowend)
78
+ - [`setMeasureCurrency`](#setmeasurecurrency)
79
+ - [`setMeasureCurrencyIsPrefix`](#setmeasurecurrencyisprefix)
80
+ - [`setMeasureDefinedParameter`](#setmeasuredefinedparameter)
81
+ - [`setMeasureFilter`](#setmeasurefilter)
82
+ - [`setMeasureFormatString`](#setmeasureformatstring)
83
+ - [`setMeasureFormatType`](#setmeasureformattype)
84
+ - [`setMeasureNegativeType`](#setmeasurenegativetype)
85
+ - [`setResultFilter`](#setresultfilter)
86
+ - [`setSortingDirection`](#setsortingdirection)
87
+ - [`setSortingEnabled`](#setsortingenabled)
88
+ - [`setStaticFilterGroup`](#setstaticfiltergroup)
89
+ - [`toggleDimension`](#toggledimension)
90
+ - [`toggleDimensionOrMeasureByName`](#toggledimensionormeasurebyname)
91
+ - [`toggleMeasure`](#togglemeasure)
92
+ - [`updateDimension`](#updatedimension)
93
+ - [`updateMeasure`](#updatemeasure)
94
+
95
+ ## `addColoringOverwrite`
96
+
97
+ Add value color
98
+
99
+ 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. Requires at least two enabled dimensions; with fewer, only removing value colors (including an empty list) is accepted.
100
+
101
+ **Payload schema**
102
+
103
+ ```json
104
+ {
105
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
106
+ "title": "Add coloring overwrite schema",
107
+ "anyOf": [
108
+ {
109
+ "type": "object",
110
+ "properties": {
111
+ "dimension": {
112
+ "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",
113
+ "type": "object",
114
+ "properties": {
115
+ "dataItemInternalKey": {
116
+ "description": "Internal key of the data item of the dimension to be updated",
117
+ "type": "string"
118
+ },
119
+ "dataItemUniqueSignature": {
120
+ "description": "Unique signature of the data item of the dimension to be updated",
121
+ "type": "string"
122
+ }
123
+ },
124
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
125
+ "additionalProperties": false
126
+ },
127
+ "color": {
128
+ "description": "Color applied when the condition matches, eg. \"#0F766E\"",
129
+ "type": "string",
130
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
131
+ },
132
+ "operator": {
133
+ "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
134
+ "type": "string",
135
+ "enum": ["equals", "contains", "startsWith", "endsWith", "greater", "less", "greater-equals", "less-equals"]
136
+ },
137
+ "value": {
138
+ "description": "Value to compare against",
139
+ "anyOf": [
140
+ {
141
+ "type": "string"
142
+ },
143
+ {
144
+ "type": "number"
145
+ }
146
+ ]
147
+ }
148
+ },
149
+ "required": ["color", "value"],
150
+ "additionalProperties": false
151
+ },
152
+ {
153
+ "type": "object",
154
+ "properties": {
155
+ "dimension": {
156
+ "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",
157
+ "type": "object",
158
+ "properties": {
159
+ "dataItemInternalKey": {
160
+ "description": "Internal key of the data item of the dimension to be updated",
161
+ "type": "string"
162
+ },
163
+ "dataItemUniqueSignature": {
164
+ "description": "Unique signature of the data item of the dimension to be updated",
165
+ "type": "string"
166
+ }
167
+ },
168
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
169
+ "additionalProperties": false
170
+ },
171
+ "color": {
172
+ "description": "Color applied when the condition matches, eg. \"#0F766E\"",
173
+ "type": "string",
174
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
175
+ },
176
+ "operator": {
177
+ "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)",
178
+ "type": "string",
179
+ "const": "between"
180
+ },
181
+ "value": {
182
+ "description": "Lower bound of the range",
183
+ "anyOf": [
184
+ {
185
+ "type": "string"
186
+ },
187
+ {
188
+ "type": "number"
189
+ }
190
+ ]
191
+ },
192
+ "secondValue": {
193
+ "description": "Upper bound of the range",
194
+ "anyOf": [
195
+ {
196
+ "type": "string"
197
+ },
198
+ {
199
+ "type": "number"
200
+ }
201
+ ]
202
+ }
203
+ },
204
+ "required": ["color", "operator", "value", "secondValue"],
205
+ "additionalProperties": false
206
+ },
207
+ {
208
+ "type": "object",
209
+ "properties": {
210
+ "dimension": {
211
+ "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",
212
+ "type": "object",
213
+ "properties": {
214
+ "dataItemInternalKey": {
215
+ "description": "Internal key of the data item of the dimension to be updated",
216
+ "type": "string"
217
+ },
218
+ "dataItemUniqueSignature": {
219
+ "description": "Unique signature of the data item of the dimension to be updated",
220
+ "type": "string"
221
+ }
222
+ },
223
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
224
+ "additionalProperties": false
225
+ },
226
+ "color": {
227
+ "description": "Color applied when the condition matches, eg. \"#0F766E\"",
228
+ "type": "string",
229
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
230
+ },
231
+ "operator": {
232
+ "description": "Match (inList) or exclude (notInList) every value in values",
233
+ "type": "string",
234
+ "enum": ["inList", "notInList"]
235
+ },
236
+ "values": {
237
+ "description": "Values to match",
238
+ "minItems": 1,
239
+ "type": "array",
240
+ "items": {
241
+ "anyOf": [
242
+ {
243
+ "type": "string"
244
+ },
245
+ {
246
+ "type": "number"
247
+ }
248
+ ]
249
+ }
250
+ },
251
+ "delimiter": {
252
+ "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
253
+ "type": "string",
254
+ "minLength": 1
255
+ }
256
+ },
257
+ "required": ["color", "operator", "values"],
258
+ "additionalProperties": false
259
+ }
260
+ ]
261
+ }
262
+ ```
263
+
264
+ ## `addDimension`
265
+
266
+ Add dimension
267
+
268
+ Add a new dimension to the chart
269
+
270
+ **Payload schema**
271
+
272
+ ```json
273
+ {
274
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
275
+ "title": "Add dimension schema",
276
+ "type": "object",
277
+ "properties": {
278
+ "key": {
279
+ "description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\"",
280
+ "type": "string"
281
+ }
282
+ },
283
+ "required": ["key"],
284
+ "additionalProperties": false
285
+ }
286
+ ```
287
+
288
+ ## `addMeasure`
289
+
290
+ Add measure
291
+
292
+ Add a new measure to the chart
293
+
294
+ **Payload schema**
295
+
296
+ ```json
297
+ {
298
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
299
+ "title": "Add measure schema",
300
+ "anyOf": [
301
+ {
302
+ "type": "object",
303
+ "properties": {
304
+ "sourceKind": {
305
+ "description": "Raw database field from available data `fields`.",
306
+ "type": "string",
307
+ "const": "field"
308
+ },
309
+ "key": {
310
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
311
+ "type": "string"
312
+ },
313
+ "aggregation": {
314
+ "description": "Required for raw database fields. Use one of the aggregation names returned for that field.",
315
+ "type": "string"
316
+ }
317
+ },
318
+ "required": ["sourceKind", "key", "aggregation"],
319
+ "additionalProperties": false
320
+ },
321
+ {
322
+ "type": "object",
323
+ "properties": {
324
+ "sourceKind": {
325
+ "description": "Predefined/user-defined measure from available data `measures`.",
326
+ "type": "string",
327
+ "const": "measure"
328
+ },
329
+ "key": {
330
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
331
+ "type": "string"
332
+ }
333
+ },
334
+ "required": ["sourceKind", "key"],
335
+ "additionalProperties": false
336
+ },
337
+ {
338
+ "type": "object",
339
+ "properties": {
340
+ "sourceKind": {
341
+ "description": "Predefined calculation from available data `measures`.",
342
+ "type": "string",
343
+ "const": "calculation"
344
+ },
345
+ "key": {
346
+ "description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\"",
347
+ "type": "string"
348
+ }
349
+ },
350
+ "required": ["sourceKind", "key"],
351
+ "additionalProperties": false
352
+ }
353
+ ]
354
+ }
355
+ ```
356
+
357
+ ## `addMeasureAdvancedAdditionalDimensionDataField`
358
+
359
+ Add advanced bottom dimension
360
+
361
+ Add bottom dimension field for nested ratio advanced calculation
362
+
363
+ **Payload schema**
364
+
365
+ ```json
366
+ {
367
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
368
+ "title": "Add measure advanced additional dimension field schema",
369
+ "type": "object",
370
+ "properties": {
371
+ "dataItemInternalKey": {
372
+ "description": "Internal key of the data item of the measure to be updated",
373
+ "type": "string"
374
+ },
375
+ "dataItemUniqueSignature": {
376
+ "description": "Unique signature of the data item of the measure to be updated",
377
+ "type": "string"
378
+ },
379
+ "collectionKey": {
380
+ "description": "Measure collection key",
381
+ "type": "string",
382
+ "enum": ["measures", "supportingMeasures"]
383
+ },
384
+ "advancedOperationKey": {
385
+ "description": "Advanced operation key",
386
+ "type": "string",
387
+ "enum": ["advancedCalculation", "nestedCalculation"]
388
+ },
389
+ "key": {
390
+ "description": "Engine key of the bottom dimension field to be added",
391
+ "type": "string"
392
+ }
393
+ },
394
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
395
+ "additionalProperties": false
396
+ }
397
+ ```
398
+
399
+ ## `addMeasureAdvancedDimensionDataField`
400
+
401
+ Add advanced additional dimension
402
+
403
+ Add additional dimension field for nested advanced calculations
404
+
405
+ **Payload schema**
406
+
407
+ ```json
408
+ {
409
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
410
+ "title": "Add measure advanced dimension field schema",
411
+ "type": "object",
412
+ "properties": {
413
+ "dataItemInternalKey": {
414
+ "description": "Internal key of the data item of the measure to be updated",
415
+ "type": "string"
416
+ },
417
+ "dataItemUniqueSignature": {
418
+ "description": "Unique signature of the data item of the measure to be updated",
419
+ "type": "string"
420
+ },
421
+ "collectionKey": {
422
+ "description": "Measure collection key",
423
+ "type": "string",
424
+ "enum": ["measures", "supportingMeasures"]
425
+ },
426
+ "advancedOperationKey": {
427
+ "description": "Advanced operation key",
428
+ "type": "string",
429
+ "enum": ["advancedCalculation", "nestedCalculation"]
430
+ },
431
+ "key": {
432
+ "description": "Engine key of the dimension field to be added",
433
+ "type": "string"
434
+ }
435
+ },
436
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
437
+ "additionalProperties": false
438
+ }
439
+ ```
440
+
441
+ ## `addMeasureFilter`
442
+
443
+ Add measure filter
444
+
445
+ Add another measure filter before aggregation. Keeps existing filters.
446
+
447
+ **Payload schema**
448
+
449
+ ```json
450
+ {
451
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
452
+ "description": "Add another measure filter before aggregation. Keeps existing filters.",
453
+ "title": "Add measure filter schema",
454
+ "anyOf": [
455
+ {
456
+ "type": "object",
457
+ "properties": {
458
+ "measureName": {
459
+ "description": "Visible measure name or label",
460
+ "type": "string"
461
+ },
462
+ "fieldKey": {
463
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
464
+ "type": "string"
465
+ },
466
+ "operator": {
467
+ "description": "Filter operator that requires a value",
468
+ "type": "string",
469
+ "enum": [
470
+ "equals",
471
+ "doesNotEqual",
472
+ "greaterThan",
473
+ "lessThan",
474
+ "greaterThanOrEqualTo",
475
+ "lessThanOrEqualTo",
476
+ "contains",
477
+ "excludes",
478
+ "like",
479
+ "notLike",
480
+ "startsWith",
481
+ "endsWith"
482
+ ]
483
+ },
484
+ "value": {
485
+ "description": "Filter value",
486
+ "anyOf": [
487
+ {
488
+ "type": "string"
489
+ },
490
+ {
491
+ "type": "object",
492
+ "properties": {
493
+ "type": {
494
+ "type": "string",
495
+ "const": "variable"
496
+ },
497
+ "variableName": {
498
+ "type": "string"
499
+ }
500
+ },
501
+ "required": ["type", "variableName"],
502
+ "additionalProperties": false
503
+ }
504
+ ]
505
+ }
506
+ },
507
+ "required": ["measureName", "fieldKey", "operator", "value"],
508
+ "additionalProperties": false
509
+ },
510
+ {
511
+ "type": "object",
512
+ "properties": {
513
+ "measureName": {
514
+ "description": "Visible measure name or label",
515
+ "type": "string"
516
+ },
517
+ "fieldKey": {
518
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
519
+ "type": "string"
520
+ },
521
+ "operator": {
522
+ "description": "Filter operator that requires valueFrom and valueTo",
523
+ "type": "string",
524
+ "enum": ["isBetween", "isNotBetween"]
525
+ },
526
+ "valueFrom": {
527
+ "description": "Lower filter value",
528
+ "anyOf": [
529
+ {
530
+ "type": "string"
531
+ },
532
+ {
533
+ "type": "object",
534
+ "properties": {
535
+ "type": {
536
+ "type": "string",
537
+ "const": "variable"
538
+ },
539
+ "variableName": {
540
+ "type": "string"
541
+ }
542
+ },
543
+ "required": ["type", "variableName"],
544
+ "additionalProperties": false
545
+ }
546
+ ]
547
+ },
548
+ "valueTo": {
549
+ "description": "Upper filter value",
550
+ "anyOf": [
551
+ {
552
+ "type": "string"
553
+ },
554
+ {
555
+ "type": "object",
556
+ "properties": {
557
+ "type": {
558
+ "type": "string",
559
+ "const": "variable"
560
+ },
561
+ "variableName": {
562
+ "type": "string"
563
+ }
564
+ },
565
+ "required": ["type", "variableName"],
566
+ "additionalProperties": false
567
+ }
568
+ ]
569
+ }
570
+ },
571
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
572
+ "additionalProperties": false
573
+ },
574
+ {
575
+ "type": "object",
576
+ "properties": {
577
+ "measureName": {
578
+ "description": "Visible measure name or label",
579
+ "type": "string"
580
+ },
581
+ "fieldKey": {
582
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
583
+ "type": "string"
584
+ },
585
+ "operator": {
586
+ "description": "Filter operator that requires a list of values",
587
+ "type": "string",
588
+ "enum": ["inList", "excludedFromList"]
589
+ },
590
+ "values": {
591
+ "description": "Filter values",
592
+ "minItems": 1,
593
+ "type": "array",
594
+ "items": {
595
+ "type": "string"
596
+ }
597
+ }
598
+ },
599
+ "required": ["measureName", "fieldKey", "operator", "values"],
600
+ "additionalProperties": false
601
+ },
602
+ {
603
+ "type": "object",
604
+ "properties": {
605
+ "measureName": {
606
+ "description": "Visible measure name or label",
607
+ "type": "string"
608
+ },
609
+ "fieldKey": {
610
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
611
+ "type": "string"
612
+ },
613
+ "operator": {
614
+ "description": "Filter operator that does not require values",
615
+ "type": "string",
616
+ "enum": ["isNull", "notNull"]
617
+ }
618
+ },
619
+ "required": ["measureName", "fieldKey", "operator"],
620
+ "additionalProperties": false
621
+ }
622
+ ]
623
+ }
624
+ ```
625
+
626
+ ## `addResultFilter`
627
+
628
+ Add result filter
629
+
630
+ Add another result filter after aggregation. Keeps existing result filters.
631
+
632
+ **Payload schema**
633
+
634
+ ```json
635
+ {
636
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
637
+ "description": "Add another result filter after aggregation. Keeps existing result filters.",
638
+ "title": "Add result filter schema",
639
+ "anyOf": [
640
+ {
641
+ "type": "object",
642
+ "properties": {
643
+ "measureName": {
644
+ "description": "Visible measure name or label",
645
+ "type": "string"
646
+ },
647
+ "operator": {
648
+ "description": "Filter operator that requires a value",
649
+ "type": "string",
650
+ "enum": [
651
+ "equals",
652
+ "doesNotEqual",
653
+ "greaterThan",
654
+ "lessThan",
655
+ "greaterThanOrEqualTo",
656
+ "lessThanOrEqualTo",
657
+ "contains",
658
+ "excludes",
659
+ "like",
660
+ "notLike",
661
+ "startsWith",
662
+ "endsWith"
663
+ ]
664
+ },
665
+ "value": {
666
+ "description": "Filter value",
667
+ "anyOf": [
668
+ {
669
+ "type": "string"
670
+ },
671
+ {
672
+ "type": "object",
673
+ "properties": {
674
+ "type": {
675
+ "type": "string",
676
+ "const": "variable"
677
+ },
678
+ "variableName": {
679
+ "type": "string"
680
+ }
681
+ },
682
+ "required": ["type", "variableName"],
683
+ "additionalProperties": false
684
+ }
685
+ ]
686
+ }
687
+ },
688
+ "required": ["measureName", "operator", "value"],
689
+ "additionalProperties": false
690
+ },
691
+ {
692
+ "type": "object",
693
+ "properties": {
694
+ "measureName": {
695
+ "description": "Visible measure name or label",
696
+ "type": "string"
697
+ },
698
+ "operator": {
699
+ "description": "Filter operator that requires valueFrom and valueTo",
700
+ "type": "string",
701
+ "enum": ["isBetween", "isNotBetween"]
702
+ },
703
+ "valueFrom": {
704
+ "description": "Lower filter value",
705
+ "anyOf": [
706
+ {
707
+ "type": "string"
708
+ },
709
+ {
710
+ "type": "object",
711
+ "properties": {
712
+ "type": {
713
+ "type": "string",
714
+ "const": "variable"
715
+ },
716
+ "variableName": {
717
+ "type": "string"
718
+ }
719
+ },
720
+ "required": ["type", "variableName"],
721
+ "additionalProperties": false
722
+ }
723
+ ]
724
+ },
725
+ "valueTo": {
726
+ "description": "Upper filter value",
727
+ "anyOf": [
728
+ {
729
+ "type": "string"
730
+ },
731
+ {
732
+ "type": "object",
733
+ "properties": {
734
+ "type": {
735
+ "type": "string",
736
+ "const": "variable"
737
+ },
738
+ "variableName": {
739
+ "type": "string"
740
+ }
741
+ },
742
+ "required": ["type", "variableName"],
743
+ "additionalProperties": false
744
+ }
745
+ ]
746
+ }
747
+ },
748
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
749
+ "additionalProperties": false
750
+ },
751
+ {
752
+ "type": "object",
753
+ "properties": {
754
+ "measureName": {
755
+ "description": "Visible measure name or label",
756
+ "type": "string"
757
+ },
758
+ "operator": {
759
+ "description": "Filter operator that requires a list of values",
760
+ "type": "string",
761
+ "enum": ["inList", "excludedFromList"]
762
+ },
763
+ "values": {
764
+ "description": "Filter values",
765
+ "minItems": 1,
766
+ "type": "array",
767
+ "items": {
768
+ "type": "string"
769
+ }
770
+ }
771
+ },
772
+ "required": ["measureName", "operator", "values"],
773
+ "additionalProperties": false
774
+ },
775
+ {
776
+ "type": "object",
777
+ "properties": {
778
+ "measureName": {
779
+ "description": "Visible measure name or label",
780
+ "type": "string"
781
+ },
782
+ "operator": {
783
+ "description": "Filter operator that does not require values",
784
+ "type": "string",
785
+ "enum": ["isNull", "notNull"]
786
+ }
787
+ },
788
+ "required": ["measureName", "operator"],
789
+ "additionalProperties": false
790
+ }
791
+ ]
792
+ }
793
+ ```
794
+
795
+ ## `changeMeasureAggregation`
796
+
797
+ Measure aggregation
798
+
799
+ Change how a measure is aggregated
800
+
801
+ **Payload schema**
802
+
803
+ ```json
804
+ {
805
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
806
+ "title": "Change measure aggregation schema",
807
+ "type": "object",
808
+ "properties": {
809
+ "dataItemInternalKey": {
810
+ "description": "Internal key of the data item of the measure to be updated",
811
+ "type": "string"
812
+ },
813
+ "dataItemUniqueSignature": {
814
+ "description": "Unique signature of the data item of the measure to be updated",
815
+ "type": "string"
816
+ },
817
+ "aggregation": {
818
+ "description": "Aggregation function to be used for the measure",
819
+ "type": "string",
820
+ "minLength": 1
821
+ }
822
+ },
823
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
824
+ "additionalProperties": false
825
+ }
826
+ ```
827
+
828
+ ## `clearMeasureFilter`
829
+
830
+ Clear measure filter
831
+
832
+ Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.
833
+
834
+ **Payload schema**
835
+
836
+ ```json
837
+ {
838
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
839
+ "description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
840
+ "title": "Clear measure filter schema",
841
+ "type": "object",
842
+ "properties": {
843
+ "measureName": {
844
+ "description": "Visible measure name or label",
845
+ "type": "string"
846
+ },
847
+ "fieldKey": {
848
+ "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.",
849
+ "type": "string"
850
+ }
851
+ },
852
+ "required": ["measureName"],
853
+ "additionalProperties": false
854
+ }
855
+ ```
856
+
857
+ ## `clearResultFilter`
858
+
859
+ Clear result filter
860
+
861
+ Clear all result filters for one measure.
862
+
863
+ **Payload schema**
864
+
865
+ ```json
866
+ {
867
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
868
+ "description": "Clear all result filters for one measure.",
869
+ "title": "Clear result filter schema",
870
+ "type": "object",
871
+ "properties": {
872
+ "measureName": {
873
+ "description": "Visible measure name or label",
874
+ "type": "string"
875
+ }
876
+ },
877
+ "required": ["measureName"],
878
+ "additionalProperties": false
879
+ }
880
+ ```
881
+
882
+ ## `duplicateDimension`
883
+
884
+ Duplicate dimension
885
+
886
+ Create a copy of an existing dimension
887
+
888
+ **Payload schema**
889
+
890
+ ```json
891
+ {
892
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
893
+ "title": "Duplicate dimension schema",
894
+ "type": "object",
895
+ "properties": {
896
+ "dataItemInternalKey": {
897
+ "description": "Internal key of the data item of the dimension to be duplicated",
898
+ "type": "string"
899
+ },
900
+ "dataItemUniqueSignature": {
901
+ "description": "Unique signature of the data item of the dimension to be duplicated",
902
+ "type": "string"
903
+ }
904
+ },
905
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
906
+ "additionalProperties": false
907
+ }
908
+ ```
909
+
910
+ ## `duplicateMeasure`
911
+
912
+ Duplicate measure
913
+
914
+ Create a copy of an existing measure
915
+
916
+ **Payload schema**
917
+
918
+ ```json
919
+ {
920
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
921
+ "title": "Duplicate measure schema",
922
+ "type": "object",
923
+ "properties": {
924
+ "dataItemInternalKey": {
925
+ "description": "Internal key of the data item of the measure to be duplicated",
926
+ "type": "string"
927
+ },
928
+ "dataItemUniqueSignature": {
929
+ "description": "Unique signature of the data item of the measure to be duplicated",
930
+ "type": "string"
931
+ }
932
+ },
933
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
934
+ "additionalProperties": false
935
+ }
936
+ ```
937
+
938
+ ## `removeColoringOverwrite`
939
+
940
+ Remove value color
941
+
942
+ Remove one value color by its position, as returned by getColoringOverwrites
943
+
944
+ **Payload schema**
945
+
946
+ ```json
947
+ {
948
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
949
+ "title": "Remove coloring overwrite schema",
950
+ "type": "object",
951
+ "properties": {
952
+ "index": {
953
+ "description": "Zero-based position of the entry to remove",
954
+ "type": "integer",
955
+ "minimum": 0,
956
+ "maximum": 9007199254740991
957
+ }
958
+ },
959
+ "required": ["index"],
960
+ "additionalProperties": false
961
+ }
962
+ ```
963
+
964
+ ## `removeDimension`
965
+
966
+ Remove dimension
967
+
968
+ Remove a dimension from the chart
969
+
970
+ **Payload schema**
971
+
972
+ ```json
973
+ {
974
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
975
+ "title": "Remove dimension schema",
976
+ "type": "object",
977
+ "properties": {
978
+ "dataItemInternalKey": {
979
+ "description": "Internal key of the data item of the dimension to be removed",
980
+ "type": "string"
981
+ },
982
+ "dataItemUniqueSignature": {
983
+ "description": "Unique signature of the data item of the dimension to be removed",
984
+ "type": "string"
985
+ }
986
+ },
987
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
988
+ "additionalProperties": false
989
+ }
990
+ ```
991
+
992
+ ## `removeMeasure`
993
+
994
+ Remove measure
995
+
996
+ Remove a measure from the chart
997
+
998
+ **Payload schema**
999
+
1000
+ ```json
1001
+ {
1002
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1003
+ "title": "Remove measure schema",
1004
+ "type": "object",
1005
+ "properties": {
1006
+ "dataItemInternalKey": {
1007
+ "description": "Internal key of the data item of the measure to be removed",
1008
+ "type": "string"
1009
+ },
1010
+ "dataItemUniqueSignature": {
1011
+ "description": "Unique signature of the data item of the measure to be removed",
1012
+ "type": "string"
1013
+ }
1014
+ },
1015
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1016
+ "additionalProperties": false
1017
+ }
1018
+ ```
1019
+
1020
+ ## `removeMeasureAdvancedAdditionalDimensionDataField`
1021
+
1022
+ Remove advanced bottom dimension
1023
+
1024
+ Remove bottom dimension field from nested ratio advanced calculation
1025
+
1026
+ **Payload schema**
1027
+
1028
+ ```json
1029
+ {
1030
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1031
+ "title": "Remove measure advanced additional dimension field schema",
1032
+ "type": "object",
1033
+ "properties": {
1034
+ "dataItemInternalKey": {
1035
+ "description": "Internal key of the data item of the measure to be updated",
1036
+ "type": "string"
1037
+ },
1038
+ "dataItemUniqueSignature": {
1039
+ "description": "Unique signature of the data item of the measure to be updated",
1040
+ "type": "string"
1041
+ },
1042
+ "collectionKey": {
1043
+ "description": "Measure collection key",
1044
+ "type": "string",
1045
+ "enum": ["measures", "supportingMeasures"]
1046
+ },
1047
+ "advancedOperationKey": {
1048
+ "description": "Advanced operation key",
1049
+ "type": "string",
1050
+ "enum": ["advancedCalculation", "nestedCalculation"]
1051
+ },
1052
+ "internalKey": {
1053
+ "description": "Internal key of the bottom dimension field to be removed",
1054
+ "type": "string"
1055
+ }
1056
+ },
1057
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
1058
+ "additionalProperties": false
1059
+ }
1060
+ ```
1061
+
1062
+ ## `removeMeasureAdvancedCompareMeasure`
1063
+
1064
+ Remove advanced compare measure
1065
+
1066
+ Remove compare measure from advanced calculation
1067
+
1068
+ **Payload schema**
1069
+
1070
+ ```json
1071
+ {
1072
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1073
+ "title": "Remove measure advanced compare measure schema",
1074
+ "type": "object",
1075
+ "properties": {
1076
+ "dataItemInternalKey": {
1077
+ "description": "Internal key of the data item of the measure to be updated",
1078
+ "type": "string"
1079
+ },
1080
+ "dataItemUniqueSignature": {
1081
+ "description": "Unique signature of the data item of the measure to be updated",
1082
+ "type": "string"
1083
+ },
1084
+ "collectionKey": {
1085
+ "description": "Measure collection key",
1086
+ "type": "string",
1087
+ "enum": ["measures", "supportingMeasures"]
1088
+ },
1089
+ "advancedOperationKey": {
1090
+ "description": "Advanced operation key",
1091
+ "type": "string",
1092
+ "enum": ["advancedCalculation", "nestedCalculation"]
1093
+ }
1094
+ },
1095
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1096
+ "additionalProperties": false
1097
+ }
1098
+ ```
1099
+
1100
+ ## `removeMeasureAdvancedDimensionDataField`
1101
+
1102
+ Remove advanced additional dimension
1103
+
1104
+ Remove additional dimension field from nested advanced calculations
1105
+
1106
+ **Payload schema**
1107
+
1108
+ ```json
1109
+ {
1110
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1111
+ "title": "Remove measure advanced dimension field schema",
1112
+ "type": "object",
1113
+ "properties": {
1114
+ "dataItemInternalKey": {
1115
+ "description": "Internal key of the data item of the measure to be updated",
1116
+ "type": "string"
1117
+ },
1118
+ "dataItemUniqueSignature": {
1119
+ "description": "Unique signature of the data item of the measure to be updated",
1120
+ "type": "string"
1121
+ },
1122
+ "collectionKey": {
1123
+ "description": "Measure collection key",
1124
+ "type": "string",
1125
+ "enum": ["measures", "supportingMeasures"]
1126
+ },
1127
+ "advancedOperationKey": {
1128
+ "description": "Advanced operation key",
1129
+ "type": "string",
1130
+ "enum": ["advancedCalculation", "nestedCalculation"]
1131
+ },
1132
+ "internalKey": {
1133
+ "description": "Internal key of the dimension field to be removed",
1134
+ "type": "string"
1135
+ }
1136
+ },
1137
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
1138
+ "additionalProperties": false
1139
+ }
1140
+ ```
1141
+
1142
+ ## `resetChartPaletteToThemeDefault`
1143
+
1144
+ Reset chart palette
1145
+
1146
+ Reset the chart palette back to the workbook theme default
1147
+
1148
+ **Payload schema**
1149
+
1150
+ ```json
1151
+ {
1152
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1153
+ "title": "Reset chart palette schema",
1154
+ "type": "object",
1155
+ "properties": {},
1156
+ "additionalProperties": false
1157
+ }
1158
+ ```
1159
+
1160
+ ## `setAnimationEnabled`
1161
+
1162
+ Animations
1163
+
1164
+ Turn the chart animations on or off. They are on by default; the host can still disable them regardless of this setting
1165
+
1166
+ **Payload schema**
1167
+
1168
+ ```json
1169
+ {
1170
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1171
+ "title": "Set animation enabled schema",
1172
+ "type": "object",
1173
+ "properties": {
1174
+ "enabled": {
1175
+ "description": "Whether the chart animates when it first renders and when its data changes",
1176
+ "type": "boolean"
1177
+ }
1178
+ },
1179
+ "required": ["enabled"],
1180
+ "additionalProperties": false
1181
+ }
1182
+ ```
1183
+
1184
+ ## `setChartPalette`
1185
+
1186
+ Chart palette
1187
+
1188
+ 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
1189
+
1190
+ **Payload schema**
1191
+
1192
+ ```json
1193
+ {
1194
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1195
+ "title": "Chart palette schema",
1196
+ "type": "string",
1197
+ "minLength": 1
1198
+ }
1199
+ ```
1200
+
1201
+ ## `setColoringColor`
1202
+
1203
+ Coloring color
1204
+
1205
+ Set the single color used by the chart
1206
+
1207
+ **Payload schema**
1208
+
1209
+ ```json
1210
+ {
1211
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1212
+ "title": "Coloring color schema",
1213
+ "type": "string",
1214
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1215
+ }
1216
+ ```
1217
+
1218
+ ## `setColoringOverwrites`
1219
+
1220
+ Value colors
1221
+
1222
+ 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. Requires at least two enabled dimensions; with fewer, only removing value colors (including an empty list) is accepted.
1223
+
1224
+ **Payload schema**
1225
+
1226
+ ```json
1227
+ {
1228
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1229
+ "title": "Set coloring overwrites schema",
1230
+ "type": "object",
1231
+ "properties": {
1232
+ "overwrites": {
1233
+ "description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all",
1234
+ "type": "array",
1235
+ "items": {
1236
+ "anyOf": [
1237
+ {
1238
+ "type": "object",
1239
+ "properties": {
1240
+ "dimension": {
1241
+ "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",
1242
+ "type": "object",
1243
+ "properties": {
1244
+ "dataItemInternalKey": {
1245
+ "description": "Internal key of the data item of the dimension to be updated",
1246
+ "type": "string"
1247
+ },
1248
+ "dataItemUniqueSignature": {
1249
+ "description": "Unique signature of the data item of the dimension to be updated",
1250
+ "type": "string"
1251
+ }
1252
+ },
1253
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1254
+ "additionalProperties": false
1255
+ },
1256
+ "color": {
1257
+ "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1258
+ "type": "string",
1259
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1260
+ },
1261
+ "operator": {
1262
+ "description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
1263
+ "type": "string",
1264
+ "enum": [
1265
+ "equals",
1266
+ "contains",
1267
+ "startsWith",
1268
+ "endsWith",
1269
+ "greater",
1270
+ "less",
1271
+ "greater-equals",
1272
+ "less-equals"
1273
+ ]
1274
+ },
1275
+ "value": {
1276
+ "description": "Value to compare against",
1277
+ "anyOf": [
1278
+ {
1279
+ "type": "string"
1280
+ },
1281
+ {
1282
+ "type": "number"
1283
+ }
1284
+ ]
1285
+ }
1286
+ },
1287
+ "required": ["color", "value"],
1288
+ "additionalProperties": false
1289
+ },
1290
+ {
1291
+ "type": "object",
1292
+ "properties": {
1293
+ "dimension": {
1294
+ "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",
1295
+ "type": "object",
1296
+ "properties": {
1297
+ "dataItemInternalKey": {
1298
+ "description": "Internal key of the data item of the dimension to be updated",
1299
+ "type": "string"
1300
+ },
1301
+ "dataItemUniqueSignature": {
1302
+ "description": "Unique signature of the data item of the dimension to be updated",
1303
+ "type": "string"
1304
+ }
1305
+ },
1306
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1307
+ "additionalProperties": false
1308
+ },
1309
+ "color": {
1310
+ "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1311
+ "type": "string",
1312
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1313
+ },
1314
+ "operator": {
1315
+ "description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)",
1316
+ "type": "string",
1317
+ "const": "between"
1318
+ },
1319
+ "value": {
1320
+ "description": "Lower bound of the range",
1321
+ "anyOf": [
1322
+ {
1323
+ "type": "string"
1324
+ },
1325
+ {
1326
+ "type": "number"
1327
+ }
1328
+ ]
1329
+ },
1330
+ "secondValue": {
1331
+ "description": "Upper bound of the range",
1332
+ "anyOf": [
1333
+ {
1334
+ "type": "string"
1335
+ },
1336
+ {
1337
+ "type": "number"
1338
+ }
1339
+ ]
1340
+ }
1341
+ },
1342
+ "required": ["color", "operator", "value", "secondValue"],
1343
+ "additionalProperties": false
1344
+ },
1345
+ {
1346
+ "type": "object",
1347
+ "properties": {
1348
+ "dimension": {
1349
+ "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",
1350
+ "type": "object",
1351
+ "properties": {
1352
+ "dataItemInternalKey": {
1353
+ "description": "Internal key of the data item of the dimension to be updated",
1354
+ "type": "string"
1355
+ },
1356
+ "dataItemUniqueSignature": {
1357
+ "description": "Unique signature of the data item of the dimension to be updated",
1358
+ "type": "string"
1359
+ }
1360
+ },
1361
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1362
+ "additionalProperties": false
1363
+ },
1364
+ "color": {
1365
+ "description": "Color applied when the condition matches, eg. \"#0F766E\"",
1366
+ "type": "string",
1367
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1368
+ },
1369
+ "operator": {
1370
+ "description": "Match (inList) or exclude (notInList) every value in values",
1371
+ "type": "string",
1372
+ "enum": ["inList", "notInList"]
1373
+ },
1374
+ "values": {
1375
+ "description": "Values to match",
1376
+ "minItems": 1,
1377
+ "type": "array",
1378
+ "items": {
1379
+ "anyOf": [
1380
+ {
1381
+ "type": "string"
1382
+ },
1383
+ {
1384
+ "type": "number"
1385
+ }
1386
+ ]
1387
+ }
1388
+ },
1389
+ "delimiter": {
1390
+ "description": "Separator the values are stored with; defaults to \",\". No value may contain it",
1391
+ "type": "string",
1392
+ "minLength": 1
1393
+ }
1394
+ },
1395
+ "required": ["color", "operator", "values"],
1396
+ "additionalProperties": false
1397
+ }
1398
+ ]
1399
+ }
1400
+ }
1401
+ },
1402
+ "required": ["overwrites"],
1403
+ "additionalProperties": false
1404
+ }
1405
+ ```
1406
+
1407
+ ## `setColoringPersistentColors`
1408
+
1409
+ Persistent colors
1410
+
1411
+ Enable or disable persistent categorical coloring
1412
+
1413
+ **Payload schema**
1414
+
1415
+ ```json
1416
+ {
1417
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1418
+ "description": "Enable persistent colors",
1419
+ "title": "Persistent colors schema",
1420
+ "type": "boolean"
1421
+ }
1422
+ ```
1423
+
1424
+ ## `setColoringSortOrder`
1425
+
1426
+ Coloring sort order
1427
+
1428
+ Set the order categorical colors and legend items follow: "alpha-asc" sorts ascending by value (numbers numerically, text A to Z), "data" keeps the order of the data. Fails when the chart cannot use categorical coloring with its current dimensions and measures
1429
+
1430
+ **Payload schema**
1431
+
1432
+ ```json
1433
+ {
1434
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1435
+ "title": "Coloring sort order schema",
1436
+ "type": "string",
1437
+ "enum": ["alpha-asc", "data"]
1438
+ }
1439
+ ```
1440
+
1441
+ ## `setColoringType`
1442
+
1443
+ Coloring type
1444
+
1445
+ Set how colors are applied to the chart
1446
+
1447
+ **Payload schema**
1448
+
1449
+ ```json
1450
+ {
1451
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1452
+ "title": "Coloring type schema",
1453
+ "type": "string",
1454
+ "enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"]
1455
+ }
1456
+ ```
1457
+
1458
+ ## `setCustomPaletteColors`
1459
+
1460
+ Custom palette colors
1461
+
1462
+ Replace the whole custom categorical palette with a provided list of colors and switch the chart to the custom palette in the same step, so setChartPalette does not need to be called first. Requires categorical or perEachMeasure or perEachDimension coloring; set the coloring type first if the chart uses single coloring. For gradient coloring use setCustomGradientColors instead
1463
+
1464
+ **Payload schema**
1465
+
1466
+ ```json
1467
+ {
1468
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1469
+ "title": "Custom palette colors schema",
1470
+ "type": "object",
1471
+ "properties": {
1472
+ "colors": {
1473
+ "minItems": 1,
1474
+ "type": "array",
1475
+ "items": {
1476
+ "type": "string",
1477
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1478
+ }
1479
+ }
1480
+ },
1481
+ "required": ["colors"],
1482
+ "additionalProperties": false
1483
+ }
1484
+ ```
1485
+
1486
+ ## `setDimensionFormatString`
1487
+
1488
+ Dimension format string
1489
+
1490
+ Set the custom display format string for a dimension. This changes label formatting only and does not change temporal grouping.
1491
+
1492
+ **Payload schema**
1493
+
1494
+ ```json
1495
+ {
1496
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1497
+ "title": "Dimension format string schema",
1498
+ "type": "object",
1499
+ "properties": {
1500
+ "dataItemInternalKey": {
1501
+ "description": "Internal key of the data item of the dimension to be updated",
1502
+ "type": "string"
1503
+ },
1504
+ "dataItemUniqueSignature": {
1505
+ "description": "Unique signature of the data item of the dimension to be updated",
1506
+ "type": "string"
1507
+ },
1508
+ "formatString": {
1509
+ "anyOf": [
1510
+ {
1511
+ "type": "string"
1512
+ },
1513
+ {
1514
+ "type": "object",
1515
+ "properties": {
1516
+ "type": {
1517
+ "type": "string",
1518
+ "const": "variable"
1519
+ },
1520
+ "variableName": {
1521
+ "type": "string"
1522
+ }
1523
+ },
1524
+ "required": ["type", "variableName"],
1525
+ "additionalProperties": false
1526
+ }
1527
+ ]
1528
+ }
1529
+ },
1530
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
1531
+ "additionalProperties": false
1532
+ }
1533
+ ```
1534
+
1535
+ ## `setDimensionFormatType`
1536
+
1537
+ Dimension format type
1538
+
1539
+ Set the display format type used by a dimension. This changes label formatting only and does not change temporal grouping.
1540
+
1541
+ **Payload schema**
1542
+
1543
+ ```json
1544
+ {
1545
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1546
+ "title": "Dimension format type schema",
1547
+ "type": "object",
1548
+ "properties": {
1549
+ "dataItemInternalKey": {
1550
+ "description": "Internal key of the data item of the dimension to be updated",
1551
+ "type": "string"
1552
+ },
1553
+ "dataItemUniqueSignature": {
1554
+ "description": "Unique signature of the data item of the dimension to be updated",
1555
+ "type": "string"
1556
+ },
1557
+ "formatType": {
1558
+ "anyOf": [
1559
+ {
1560
+ "type": "string",
1561
+ "enum": [
1562
+ "custom",
1563
+ "inherit",
1564
+ "none",
1565
+ "defaultNumber",
1566
+ "defaultMoney",
1567
+ "numberNoDecimal",
1568
+ "number1Decimal",
1569
+ "number2Decimal",
1570
+ "abbreviationAuto",
1571
+ "abbreviationNoDecimal",
1572
+ "abbreviation1Decimal",
1573
+ "abbreviation2Decimal",
1574
+ "percentageNoDecimal",
1575
+ "percentage1Decimal",
1576
+ "percentage2Decimal",
1577
+ "money0Decimal",
1578
+ "money2Decimal",
1579
+ "durationDays",
1580
+ "durationHours",
1581
+ "durationMinutes",
1582
+ "durationSeconds"
1583
+ ]
1584
+ },
1585
+ {
1586
+ "type": "string",
1587
+ "enum": [
1588
+ "defaultDate",
1589
+ "defaultDatetime",
1590
+ "defaultTime",
1591
+ "ddmmyyyy",
1592
+ "ddmmyyyy2",
1593
+ "ddmmyyyy3",
1594
+ "yyyymmdd",
1595
+ "mmddyyyy",
1596
+ "mmddyyyy2",
1597
+ "ddmmmmyyyy",
1598
+ "ddmmmyyyy",
1599
+ "ddmmmyy",
1600
+ "mmmmddyyyy",
1601
+ "yyyy",
1602
+ "yy",
1603
+ "mmmyyyy",
1604
+ "yyyymmm",
1605
+ "yyyymmmm",
1606
+ "mmyyyy",
1607
+ "yyyymm",
1608
+ "mmmmyyyy",
1609
+ "yyyywn",
1610
+ "wnyyyy",
1611
+ "yywn",
1612
+ "yyyyq",
1613
+ "qyyyy",
1614
+ "yyyymmddhhmmss",
1615
+ "yyyymmddhmmss",
1616
+ "yyyymmddhhmm",
1617
+ "yyyymmddhh",
1618
+ "yyyymmddhmm",
1619
+ "yyyymmddh",
1620
+ "ddmmmyyyyhhmmss",
1621
+ "ddmmmyyyyhmmss",
1622
+ "ddmmmyyyyhhmm",
1623
+ "ddmmmyyyyhmm",
1624
+ "ddmmmyyyyh",
1625
+ "hhmmss",
1626
+ "hhmm",
1627
+ "hmm",
1628
+ "h",
1629
+ "hh",
1630
+ "hmmss",
1631
+ "month",
1632
+ "month2",
1633
+ "monthn",
1634
+ "month3",
1635
+ "quarter",
1636
+ "quarter2",
1637
+ "week1",
1638
+ "week2",
1639
+ "week3",
1640
+ "day",
1641
+ "dayOfWeek",
1642
+ "hhn",
1643
+ "hn"
1644
+ ]
1645
+ }
1646
+ ]
1647
+ }
1648
+ },
1649
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
1650
+ "additionalProperties": false
1651
+ }
1652
+ ```
1653
+
1654
+ ## `setDimensionTemporalGrouping`
1655
+
1656
+ Dimension temporal grouping
1657
+
1658
+ 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.
1659
+
1660
+ **Payload schema**
1661
+
1662
+ ```json
1663
+ {
1664
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1665
+ "title": "Dimension temporal grouping schema",
1666
+ "anyOf": [
1667
+ {
1668
+ "type": "object",
1669
+ "properties": {
1670
+ "dataItemInternalKey": {
1671
+ "description": "Internal key of the data item of the dimension to be updated",
1672
+ "type": "string"
1673
+ },
1674
+ "dataItemUniqueSignature": {
1675
+ "description": "Unique signature of the data item of the dimension to be updated",
1676
+ "type": "string"
1677
+ },
1678
+ "mode": {
1679
+ "type": "string",
1680
+ "const": "none"
1681
+ }
1682
+ },
1683
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"],
1684
+ "additionalProperties": false
1685
+ },
1686
+ {
1687
+ "type": "object",
1688
+ "properties": {
1689
+ "dataItemInternalKey": {
1690
+ "description": "Internal key of the data item of the dimension to be updated",
1691
+ "type": "string"
1692
+ },
1693
+ "dataItemUniqueSignature": {
1694
+ "description": "Unique signature of the data item of the dimension to be updated",
1695
+ "type": "string"
1696
+ },
1697
+ "mode": {
1698
+ "type": "string",
1699
+ "const": "level"
1700
+ },
1701
+ "dateLevel": {
1702
+ "type": "string",
1703
+ "enum": [
1704
+ "year",
1705
+ "year-end",
1706
+ "quarter",
1707
+ "quarter-end",
1708
+ "month",
1709
+ "month-end",
1710
+ "week",
1711
+ "week-end",
1712
+ "day",
1713
+ "hour",
1714
+ "minute",
1715
+ "second"
1716
+ ]
1717
+ }
1718
+ },
1719
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"],
1720
+ "additionalProperties": false
1721
+ },
1722
+ {
1723
+ "type": "object",
1724
+ "properties": {
1725
+ "dataItemInternalKey": {
1726
+ "description": "Internal key of the data item of the dimension to be updated",
1727
+ "type": "string"
1728
+ },
1729
+ "dataItemUniqueSignature": {
1730
+ "description": "Unique signature of the data item of the dimension to be updated",
1731
+ "type": "string"
1732
+ },
1733
+ "mode": {
1734
+ "type": "string",
1735
+ "const": "part"
1736
+ },
1737
+ "datePart": {
1738
+ "type": "string",
1739
+ "enum": [
1740
+ "year",
1741
+ "month",
1742
+ "day",
1743
+ "dayofweekiso",
1744
+ "dayofyear",
1745
+ "weekiso",
1746
+ "quarter",
1747
+ "yearofweekiso",
1748
+ "hour",
1749
+ "minute",
1750
+ "second"
1751
+ ]
1752
+ }
1753
+ },
1754
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
1755
+ "additionalProperties": false
1756
+ }
1757
+ ]
1758
+ }
1759
+ ```
1760
+
1761
+ ## `setLegendEnabled`
1762
+
1763
+ Legend enabled
1764
+
1765
+ Show or hide the chart legend
1766
+
1767
+ **Payload schema**
1768
+
1769
+ ```json
1770
+ {
1771
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1772
+ "description": "Enable legend",
1773
+ "title": "Legend enabled schema",
1774
+ "type": "boolean"
1775
+ }
1776
+ ```
1777
+
1778
+ ## `setLegendItemLabelFill`
1779
+
1780
+ Legend label color
1781
+
1782
+ Change the color of legend text labels
1783
+
1784
+ **Payload schema**
1785
+
1786
+ ```json
1787
+ {
1788
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1789
+ "description": "Legend item label font color (hexadecimal color code)",
1790
+ "title": "Legend item label fill schema",
1791
+ "anyOf": [
1792
+ {
1793
+ "type": "string",
1794
+ "pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
1795
+ },
1796
+ {
1797
+ "type": "null"
1798
+ }
1799
+ ]
1800
+ }
1801
+ ```
1802
+
1803
+ ## `setLegendItemLabelFontSize`
1804
+
1805
+ Legend label font size
1806
+
1807
+ Adjust the font size of legend labels
1808
+
1809
+ **Payload schema**
1810
+
1811
+ ```json
1812
+ {
1813
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1814
+ "title": "Legend item label font size schema",
1815
+ "type": "number"
1816
+ }
1817
+ ```
1818
+
1819
+ ## `setLegendItemLabelLimitCharacters`
1820
+
1821
+ Enable legend label characters limit
1822
+
1823
+ Enable or disable character limit for legend labels
1824
+
1825
+ **Payload schema**
1826
+
1827
+ ```json
1828
+ {
1829
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1830
+ "description": "Limit characters by maxGlyphCount",
1831
+ "title": "Legend item label limit characters schema",
1832
+ "type": "boolean"
1833
+ }
1834
+ ```
1835
+
1836
+ ## `setLegendItemLabelMaxGlyphCount`
1837
+
1838
+ Legend label characters limit
1839
+
1840
+ Set the maximum number of characters shown in legend labels
1841
+
1842
+ **Payload schema**
1843
+
1844
+ ```json
1845
+ {
1846
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1847
+ "description": "Maximum number of glyphs in the legend item label",
1848
+ "title": "Legend item label max glyph count schema",
1849
+ "anyOf": [
1850
+ {
1851
+ "type": "number"
1852
+ },
1853
+ {
1854
+ "type": "null"
1855
+ }
1856
+ ]
1857
+ }
1858
+ ```
1859
+
1860
+ ## `setLegendPosition`
1861
+
1862
+ Legend position
1863
+
1864
+ Change where the legend appears on the chart
1865
+
1866
+ **Payload schema**
1867
+
1868
+ ```json
1869
+ {
1870
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1871
+ "description": "Legend position",
1872
+ "title": "Legend position schema",
1873
+ "type": "string",
1874
+ "enum": ["left", "right", "top", "bottom"]
1875
+ }
1876
+ ```
1877
+
1878
+ ## `setLegendTitle`
1879
+
1880
+ Legend title
1881
+
1882
+ Set a custom title for the legend
1883
+
1884
+ **Payload schema**
1885
+
1886
+ ```json
1887
+ {
1888
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1889
+ "description": "Legend title text",
1890
+ "title": "Legend title schema",
1891
+ "anyOf": [
1892
+ {
1893
+ "type": "string"
1894
+ },
1895
+ {
1896
+ "type": "null"
1897
+ }
1898
+ ]
1899
+ }
1900
+ ```
1901
+
1902
+ ## `setMeasureAdvancedAdditionalAggregation`
1903
+
1904
+ Advanced additional aggregation
1905
+
1906
+ Set additional aggregation used by nested ratio advanced calculation
1907
+
1908
+ **Payload schema**
1909
+
1910
+ ```json
1911
+ {
1912
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1913
+ "title": "Measure advanced additional aggregation schema",
1914
+ "type": "object",
1915
+ "properties": {
1916
+ "dataItemInternalKey": {
1917
+ "description": "Internal key of the data item of the measure to be updated",
1918
+ "type": "string"
1919
+ },
1920
+ "dataItemUniqueSignature": {
1921
+ "description": "Unique signature of the data item of the measure to be updated",
1922
+ "type": "string"
1923
+ },
1924
+ "collectionKey": {
1925
+ "description": "Measure collection key",
1926
+ "type": "string",
1927
+ "enum": ["measures", "supportingMeasures"]
1928
+ },
1929
+ "advancedOperationKey": {
1930
+ "description": "Advanced operation key",
1931
+ "type": "string",
1932
+ "enum": ["advancedCalculation", "nestedCalculation"]
1933
+ },
1934
+ "additionalAggregation": {
1935
+ "type": "string",
1936
+ "enum": ["SUM", "AVG", "MIN", "MAX"]
1937
+ }
1938
+ },
1939
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "additionalAggregation"],
1940
+ "additionalProperties": false
1941
+ }
1942
+ ```
1943
+
1944
+ ## `setMeasureAdvancedAggregation`
1945
+
1946
+ Advanced aggregation
1947
+
1948
+ Set aggregation used by advanced calculation for a measure
1949
+
1950
+ **Payload schema**
1951
+
1952
+ ```json
1953
+ {
1954
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1955
+ "title": "Measure advanced aggregation schema",
1956
+ "type": "object",
1957
+ "properties": {
1958
+ "dataItemInternalKey": {
1959
+ "description": "Internal key of the data item of the measure to be updated",
1960
+ "type": "string"
1961
+ },
1962
+ "dataItemUniqueSignature": {
1963
+ "description": "Unique signature of the data item of the measure to be updated",
1964
+ "type": "string"
1965
+ },
1966
+ "collectionKey": {
1967
+ "description": "Measure collection key",
1968
+ "type": "string",
1969
+ "enum": ["measures", "supportingMeasures"]
1970
+ },
1971
+ "advancedOperationKey": {
1972
+ "description": "Advanced operation key",
1973
+ "type": "string",
1974
+ "enum": ["advancedCalculation", "nestedCalculation"]
1975
+ },
1976
+ "aggregation": {
1977
+ "type": "string",
1978
+ "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
1979
+ }
1980
+ },
1981
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
1982
+ "additionalProperties": false
1983
+ }
1984
+ ```
1985
+
1986
+ ## `setMeasureAdvancedCalculationType`
1987
+
1988
+ Advanced calculation type
1989
+
1990
+ Set advanced calculation type for a measure
1991
+
1992
+ **Payload schema**
1993
+
1994
+ ```json
1995
+ {
1996
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1997
+ "title": "Measure advanced calculation type schema",
1998
+ "type": "object",
1999
+ "properties": {
2000
+ "dataItemInternalKey": {
2001
+ "description": "Internal key of the data item of the measure to be updated",
2002
+ "type": "string"
2003
+ },
2004
+ "dataItemUniqueSignature": {
2005
+ "description": "Unique signature of the data item of the measure to be updated",
2006
+ "type": "string"
2007
+ },
2008
+ "collectionKey": {
2009
+ "description": "Measure collection key",
2010
+ "type": "string",
2011
+ "enum": ["measures", "supportingMeasures"]
2012
+ },
2013
+ "advancedOperationKey": {
2014
+ "description": "Advanced operation key",
2015
+ "type": "string",
2016
+ "enum": ["advancedCalculation", "nestedCalculation"]
2017
+ },
2018
+ "advancedCalculationType": {
2019
+ "type": "string",
2020
+ "enum": [
2021
+ "none",
2022
+ "movingCalculation",
2023
+ "runningTotal",
2024
+ "runningRate",
2025
+ "accumulatedGrowth",
2026
+ "rank",
2027
+ "total",
2028
+ "shareTotal",
2029
+ "nestedCalculation",
2030
+ "nestedRatio",
2031
+ "nestedCorrelation",
2032
+ "value",
2033
+ "diff",
2034
+ "ratio",
2035
+ "growth",
2036
+ "apg",
2037
+ "cagr",
2038
+ "periodOverCorrelation",
2039
+ "udf",
2040
+ "customUdf"
2041
+ ]
2042
+ }
2043
+ },
2044
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "advancedCalculationType"],
2045
+ "additionalProperties": false
2046
+ }
2047
+ ```
2048
+
2049
+ ## `setMeasureAdvancedCompareMeasure`
2050
+
2051
+ Advanced compare measure
2052
+
2053
+ Set compare measure used by accumulated growth or nested correlation
2054
+
2055
+ **Payload schema**
2056
+
2057
+ ```json
2058
+ {
2059
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2060
+ "title": "Set measure advanced compare measure schema",
2061
+ "type": "object",
2062
+ "properties": {
2063
+ "dataItemInternalKey": {
2064
+ "description": "Internal key of the data item of the measure to be updated",
2065
+ "type": "string"
2066
+ },
2067
+ "dataItemUniqueSignature": {
2068
+ "description": "Unique signature of the data item of the measure to be updated",
2069
+ "type": "string"
2070
+ },
2071
+ "collectionKey": {
2072
+ "description": "Measure collection key",
2073
+ "type": "string",
2074
+ "enum": ["measures", "supportingMeasures"]
2075
+ },
2076
+ "advancedOperationKey": {
2077
+ "description": "Advanced operation key",
2078
+ "type": "string",
2079
+ "enum": ["advancedCalculation", "nestedCalculation"]
2080
+ },
2081
+ "key": {
2082
+ "description": "Engine key of the compare measure field",
2083
+ "type": "string"
2084
+ },
2085
+ "aggregation": {
2086
+ "type": "string",
2087
+ "enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
2088
+ },
2089
+ "parameters": {
2090
+ "anyOf": [
2091
+ {
2092
+ "type": "object",
2093
+ "propertyNames": {
2094
+ "type": "string"
2095
+ },
2096
+ "additionalProperties": {
2097
+ "type": "object",
2098
+ "properties": {
2099
+ "value": {
2100
+ "anyOf": [
2101
+ {
2102
+ "anyOf": [
2103
+ {
2104
+ "type": "string"
2105
+ },
2106
+ {
2107
+ "type": "object",
2108
+ "properties": {
2109
+ "type": {
2110
+ "type": "string",
2111
+ "const": "variable"
2112
+ },
2113
+ "variableName": {
2114
+ "type": "string"
2115
+ }
2116
+ },
2117
+ "required": ["type", "variableName"],
2118
+ "additionalProperties": false
2119
+ }
2120
+ ]
2121
+ },
2122
+ {
2123
+ "anyOf": [
2124
+ {
2125
+ "type": "number"
2126
+ },
2127
+ {
2128
+ "type": "object",
2129
+ "properties": {
2130
+ "type": {
2131
+ "type": "string",
2132
+ "const": "variable"
2133
+ },
2134
+ "variableName": {
2135
+ "type": "string"
2136
+ }
2137
+ },
2138
+ "required": ["type", "variableName"],
2139
+ "additionalProperties": false
2140
+ }
2141
+ ]
2142
+ },
2143
+ {
2144
+ "anyOf": [
2145
+ {
2146
+ "type": "boolean"
2147
+ },
2148
+ {
2149
+ "type": "object",
2150
+ "properties": {
2151
+ "type": {
2152
+ "type": "string",
2153
+ "const": "variable"
2154
+ },
2155
+ "variableName": {
2156
+ "type": "string"
2157
+ }
2158
+ },
2159
+ "required": ["type", "variableName"],
2160
+ "additionalProperties": false
2161
+ }
2162
+ ]
2163
+ }
2164
+ ]
2165
+ },
2166
+ "dataType": {
2167
+ "type": "string",
2168
+ "enum": [
2169
+ "string",
2170
+ "int",
2171
+ "float",
2172
+ "boolean",
2173
+ "date",
2174
+ "millisec",
2175
+ "millisec_tz",
2176
+ "timestamp",
2177
+ "timestamp_tz"
2178
+ ]
2179
+ }
2180
+ },
2181
+ "required": ["value"],
2182
+ "additionalProperties": false
2183
+ }
2184
+ },
2185
+ {
2186
+ "type": "null"
2187
+ }
2188
+ ]
2189
+ }
2190
+ },
2191
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "key", "aggregation"],
2192
+ "additionalProperties": false
2193
+ }
2194
+ ```
2195
+
2196
+ ## `setMeasureAdvancedComparisonType`
2197
+
2198
+ Advanced comparison type
2199
+
2200
+ Set comparison type for period-over-correlation
2201
+
2202
+ **Payload schema**
2203
+
2204
+ ```json
2205
+ {
2206
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2207
+ "title": "Measure advanced comparison type schema",
2208
+ "type": "object",
2209
+ "properties": {
2210
+ "dataItemInternalKey": {
2211
+ "description": "Internal key of the data item of the measure to be updated",
2212
+ "type": "string"
2213
+ },
2214
+ "dataItemUniqueSignature": {
2215
+ "description": "Unique signature of the data item of the measure to be updated",
2216
+ "type": "string"
2217
+ },
2218
+ "collectionKey": {
2219
+ "description": "Measure collection key",
2220
+ "type": "string",
2221
+ "enum": ["measures", "supportingMeasures"]
2222
+ },
2223
+ "advancedOperationKey": {
2224
+ "description": "Advanced operation key",
2225
+ "type": "string",
2226
+ "enum": ["advancedCalculation", "nestedCalculation"]
2227
+ },
2228
+ "comparisonType": {
2229
+ "type": "string",
2230
+ "enum": ["absolute", "percentage", "naturalLog"]
2231
+ }
2232
+ },
2233
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "comparisonType"],
2234
+ "additionalProperties": false
2235
+ }
2236
+ ```
2237
+
2238
+ ## `setMeasureAdvancedDense`
2239
+
2240
+ Advanced dense rank
2241
+
2242
+ Enable or disable dense rank
2243
+
2244
+ **Payload schema**
2245
+
2246
+ ```json
2247
+ {
2248
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2249
+ "title": "Measure advanced dense schema",
2250
+ "type": "object",
2251
+ "properties": {
2252
+ "dataItemInternalKey": {
2253
+ "description": "Internal key of the data item of the measure to be updated",
2254
+ "type": "string"
2255
+ },
2256
+ "dataItemUniqueSignature": {
2257
+ "description": "Unique signature of the data item of the measure to be updated",
2258
+ "type": "string"
2259
+ },
2260
+ "collectionKey": {
2261
+ "description": "Measure collection key",
2262
+ "type": "string",
2263
+ "enum": ["measures", "supportingMeasures"]
2264
+ },
2265
+ "advancedOperationKey": {
2266
+ "description": "Advanced operation key",
2267
+ "type": "string",
2268
+ "enum": ["advancedCalculation", "nestedCalculation"]
2269
+ },
2270
+ "dense": {
2271
+ "type": "boolean"
2272
+ }
2273
+ },
2274
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dense"],
2275
+ "additionalProperties": false
2276
+ }
2277
+ ```
2278
+
2279
+ ## `setMeasureAdvancedDimensionsIds`
2280
+
2281
+ Advanced dimensions
2282
+
2283
+ Set dimensions used by advanced calculation
2284
+
2285
+ **Payload schema**
2286
+
2287
+ ```json
2288
+ {
2289
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2290
+ "title": "Measure advanced dimensions schema",
2291
+ "type": "object",
2292
+ "properties": {
2293
+ "dataItemInternalKey": {
2294
+ "description": "Internal key of the data item of the measure to be updated",
2295
+ "type": "string"
2296
+ },
2297
+ "dataItemUniqueSignature": {
2298
+ "description": "Unique signature of the data item of the measure to be updated",
2299
+ "type": "string"
2300
+ },
2301
+ "collectionKey": {
2302
+ "description": "Measure collection key",
2303
+ "type": "string",
2304
+ "enum": ["measures", "supportingMeasures"]
2305
+ },
2306
+ "advancedOperationKey": {
2307
+ "description": "Advanced operation key",
2308
+ "type": "string",
2309
+ "enum": ["advancedCalculation", "nestedCalculation"]
2310
+ },
2311
+ "dimensionsIds": {
2312
+ "type": "array",
2313
+ "items": {
2314
+ "type": "string"
2315
+ }
2316
+ }
2317
+ },
2318
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "dimensionsIds"],
2319
+ "additionalProperties": false
2320
+ }
2321
+ ```
2322
+
2323
+ ## `setMeasureAdvancedGroupType`
2324
+
2325
+ Advanced group type
2326
+
2327
+ Set comparison group type for share total advanced calculation
2328
+
2329
+ **Payload schema**
2330
+
2331
+ ```json
2332
+ {
2333
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2334
+ "title": "Measure advanced group type schema",
2335
+ "type": "object",
2336
+ "properties": {
2337
+ "dataItemInternalKey": {
2338
+ "description": "Internal key of the data item of the measure to be updated",
2339
+ "type": "string"
2340
+ },
2341
+ "dataItemUniqueSignature": {
2342
+ "description": "Unique signature of the data item of the measure to be updated",
2343
+ "type": "string"
2344
+ },
2345
+ "collectionKey": {
2346
+ "description": "Measure collection key",
2347
+ "type": "string",
2348
+ "enum": ["measures", "supportingMeasures"]
2349
+ },
2350
+ "advancedOperationKey": {
2351
+ "description": "Advanced operation key",
2352
+ "type": "string",
2353
+ "enum": ["advancedCalculation", "nestedCalculation"]
2354
+ },
2355
+ "groupType": {
2356
+ "type": "string",
2357
+ "enum": ["value", "diff", "ratio", "growth"]
2358
+ }
2359
+ },
2360
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "groupType"],
2361
+ "additionalProperties": false
2362
+ }
2363
+ ```
2364
+
2365
+ ## `setMeasureAdvancedNonTimePeriod`
2366
+
2367
+ Advanced nested time dimension
2368
+
2369
+ Enable or disable nested time dimension
2370
+
2371
+ **Payload schema**
2372
+
2373
+ ```json
2374
+ {
2375
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2376
+ "title": "Measure advanced nested time dimension schema",
2377
+ "type": "object",
2378
+ "properties": {
2379
+ "dataItemInternalKey": {
2380
+ "description": "Internal key of the data item of the measure to be updated",
2381
+ "type": "string"
2382
+ },
2383
+ "dataItemUniqueSignature": {
2384
+ "description": "Unique signature of the data item of the measure to be updated",
2385
+ "type": "string"
2386
+ },
2387
+ "collectionKey": {
2388
+ "description": "Measure collection key",
2389
+ "type": "string",
2390
+ "enum": ["measures", "supportingMeasures"]
2391
+ },
2392
+ "advancedOperationKey": {
2393
+ "description": "Advanced operation key",
2394
+ "type": "string",
2395
+ "enum": ["advancedCalculation", "nestedCalculation"]
2396
+ },
2397
+ "nonTimePeriod": {
2398
+ "type": "boolean"
2399
+ }
2400
+ },
2401
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriod"],
2402
+ "additionalProperties": false
2403
+ }
2404
+ ```
2405
+
2406
+ ## `setMeasureAdvancedNonTimePeriodGranularity`
2407
+
2408
+ Advanced non-time period granularity
2409
+
2410
+ Set non-time period granularity for inter-record calculations
2411
+
2412
+ **Payload schema**
2413
+
2414
+ ```json
2415
+ {
2416
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2417
+ "title": "Measure advanced non-time period granularity schema",
2418
+ "type": "object",
2419
+ "properties": {
2420
+ "dataItemInternalKey": {
2421
+ "description": "Internal key of the data item of the measure to be updated",
2422
+ "type": "string"
2423
+ },
2424
+ "dataItemUniqueSignature": {
2425
+ "description": "Unique signature of the data item of the measure to be updated",
2426
+ "type": "string"
2427
+ },
2428
+ "collectionKey": {
2429
+ "description": "Measure collection key",
2430
+ "type": "string",
2431
+ "enum": ["measures", "supportingMeasures"]
2432
+ },
2433
+ "advancedOperationKey": {
2434
+ "description": "Advanced operation key",
2435
+ "type": "string",
2436
+ "enum": ["advancedCalculation", "nestedCalculation"]
2437
+ },
2438
+ "nonTimePeriodGranularity": {
2439
+ "type": "string",
2440
+ "enum": ["day", "week", "month", "quarter", "year"]
2441
+ }
2442
+ },
2443
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriodGranularity"],
2444
+ "additionalProperties": false
2445
+ }
2446
+ ```
2447
+
2448
+ ## `setMeasureAdvancedNullIfNotEnoughValues`
2449
+
2450
+ Advanced null if not enough values
2451
+
2452
+ Enable or disable null-if-not-enough-values for moving calculation
2453
+
2454
+ **Payload schema**
2455
+
2456
+ ```json
2457
+ {
2458
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2459
+ "title": "Measure advanced null if not enough values schema",
2460
+ "type": "object",
2461
+ "properties": {
2462
+ "dataItemInternalKey": {
2463
+ "description": "Internal key of the data item of the measure to be updated",
2464
+ "type": "string"
2465
+ },
2466
+ "dataItemUniqueSignature": {
2467
+ "description": "Unique signature of the data item of the measure to be updated",
2468
+ "type": "string"
2469
+ },
2470
+ "collectionKey": {
2471
+ "description": "Measure collection key",
2472
+ "type": "string",
2473
+ "enum": ["measures", "supportingMeasures"]
2474
+ },
2475
+ "advancedOperationKey": {
2476
+ "description": "Advanced operation key",
2477
+ "type": "string",
2478
+ "enum": ["advancedCalculation", "nestedCalculation"]
2479
+ },
2480
+ "nullIfNotEnoughValues": {
2481
+ "type": "boolean"
2482
+ }
2483
+ },
2484
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "nullIfNotEnoughValues"],
2485
+ "additionalProperties": false
2486
+ }
2487
+ ```
2488
+
2489
+ ## `setMeasureAdvancedOffset`
2490
+
2491
+ Advanced compare with period offset
2492
+
2493
+ Set compare-with-period offset for advanced calculation
2494
+
2495
+ **Payload schema**
2496
+
2497
+ ```json
2498
+ {
2499
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2500
+ "title": "Measure advanced offset schema",
2501
+ "type": "object",
2502
+ "properties": {
2503
+ "dataItemInternalKey": {
2504
+ "description": "Internal key of the data item of the measure to be updated",
2505
+ "type": "string"
2506
+ },
2507
+ "dataItemUniqueSignature": {
2508
+ "description": "Unique signature of the data item of the measure to be updated",
2509
+ "type": "string"
2510
+ },
2511
+ "collectionKey": {
2512
+ "description": "Measure collection key",
2513
+ "type": "string",
2514
+ "enum": ["measures", "supportingMeasures"]
2515
+ },
2516
+ "advancedOperationKey": {
2517
+ "description": "Advanced operation key",
2518
+ "type": "string",
2519
+ "enum": ["advancedCalculation", "nestedCalculation"]
2520
+ },
2521
+ "offset": {
2522
+ "anyOf": [
2523
+ {
2524
+ "type": "number"
2525
+ },
2526
+ {
2527
+ "type": "object",
2528
+ "properties": {
2529
+ "type": {
2530
+ "type": "string",
2531
+ "const": "variable"
2532
+ },
2533
+ "variableName": {
2534
+ "type": "string"
2535
+ }
2536
+ },
2537
+ "required": ["type", "variableName"],
2538
+ "additionalProperties": false
2539
+ }
2540
+ ]
2541
+ }
2542
+ },
2543
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "offset"],
2544
+ "additionalProperties": false
2545
+ }
2546
+ ```
2547
+
2548
+ ## `setMeasureAdvancedParameter`
2549
+
2550
+ Advanced parameter
2551
+
2552
+ Set value for advanced operation parameter
2553
+
2554
+ **Payload schema**
2555
+
2556
+ ```json
2557
+ {
2558
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2559
+ "title": "Set measure advanced parameter schema",
2560
+ "type": "object",
2561
+ "properties": {
2562
+ "dataItemInternalKey": {
2563
+ "description": "Internal key of the data item of the measure to be updated",
2564
+ "type": "string"
2565
+ },
2566
+ "dataItemUniqueSignature": {
2567
+ "description": "Unique signature of the data item of the measure to be updated",
2568
+ "type": "string"
2569
+ },
2570
+ "collectionKey": {
2571
+ "description": "Measure collection key",
2572
+ "type": "string",
2573
+ "enum": ["measures", "supportingMeasures"]
2574
+ },
2575
+ "advancedOperationKey": {
2576
+ "description": "Advanced operation key",
2577
+ "type": "string",
2578
+ "enum": ["advancedCalculation", "nestedCalculation"]
2579
+ },
2580
+ "variableName": {
2581
+ "description": "Name of advanced operation parameter to update",
2582
+ "type": "string"
2583
+ },
2584
+ "value": {
2585
+ "type": "object",
2586
+ "properties": {
2587
+ "value": {
2588
+ "anyOf": [
2589
+ {
2590
+ "anyOf": [
2591
+ {
2592
+ "type": "string"
2593
+ },
2594
+ {
2595
+ "type": "object",
2596
+ "properties": {
2597
+ "type": {
2598
+ "type": "string",
2599
+ "const": "variable"
2600
+ },
2601
+ "variableName": {
2602
+ "type": "string"
2603
+ }
2604
+ },
2605
+ "required": ["type", "variableName"],
2606
+ "additionalProperties": false
2607
+ }
2608
+ ]
2609
+ },
2610
+ {
2611
+ "anyOf": [
2612
+ {
2613
+ "type": "number"
2614
+ },
2615
+ {
2616
+ "type": "object",
2617
+ "properties": {
2618
+ "type": {
2619
+ "type": "string",
2620
+ "const": "variable"
2621
+ },
2622
+ "variableName": {
2623
+ "type": "string"
2624
+ }
2625
+ },
2626
+ "required": ["type", "variableName"],
2627
+ "additionalProperties": false
2628
+ }
2629
+ ]
2630
+ },
2631
+ {
2632
+ "anyOf": [
2633
+ {
2634
+ "type": "boolean"
2635
+ },
2636
+ {
2637
+ "type": "object",
2638
+ "properties": {
2639
+ "type": {
2640
+ "type": "string",
2641
+ "const": "variable"
2642
+ },
2643
+ "variableName": {
2644
+ "type": "string"
2645
+ }
2646
+ },
2647
+ "required": ["type", "variableName"],
2648
+ "additionalProperties": false
2649
+ }
2650
+ ]
2651
+ }
2652
+ ]
2653
+ },
2654
+ "dataType": {
2655
+ "type": "string",
2656
+ "enum": ["string", "int", "float", "boolean", "date", "millisec", "millisec_tz", "timestamp", "timestamp_tz"]
2657
+ }
2658
+ },
2659
+ "required": ["value"],
2660
+ "additionalProperties": false
2661
+ }
2662
+ },
2663
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "variableName", "value"],
2664
+ "additionalProperties": false
2665
+ }
2666
+ ```
2667
+
2668
+ ## `setMeasureAdvancedPercentileApprox`
2669
+
2670
+ Advanced percentile approx
2671
+
2672
+ Enable or disable approximate percentile mode
2673
+
2674
+ **Payload schema**
2675
+
2676
+ ```json
2677
+ {
2678
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2679
+ "title": "Measure advanced percentile approx schema",
2680
+ "type": "object",
2681
+ "properties": {
2682
+ "dataItemInternalKey": {
2683
+ "description": "Internal key of the data item of the measure to be updated",
2684
+ "type": "string"
2685
+ },
2686
+ "dataItemUniqueSignature": {
2687
+ "description": "Unique signature of the data item of the measure to be updated",
2688
+ "type": "string"
2689
+ },
2690
+ "collectionKey": {
2691
+ "description": "Measure collection key",
2692
+ "type": "string",
2693
+ "enum": ["measures", "supportingMeasures"]
2694
+ },
2695
+ "advancedOperationKey": {
2696
+ "description": "Advanced operation key",
2697
+ "type": "string",
2698
+ "enum": ["advancedCalculation", "nestedCalculation"]
2699
+ },
2700
+ "percentileApprox": {
2701
+ "type": "boolean"
2702
+ }
2703
+ },
2704
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileApprox"],
2705
+ "additionalProperties": false
2706
+ }
2707
+ ```
2708
+
2709
+ ## `setMeasureAdvancedPercentileContinuous`
2710
+
2711
+ Advanced percentile continuous
2712
+
2713
+ Enable or disable continuous percentile mode
2714
+
2715
+ **Payload schema**
2716
+
2717
+ ```json
2718
+ {
2719
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2720
+ "title": "Measure advanced percentile continuous schema",
2721
+ "type": "object",
2722
+ "properties": {
2723
+ "dataItemInternalKey": {
2724
+ "description": "Internal key of the data item of the measure to be updated",
2725
+ "type": "string"
2726
+ },
2727
+ "dataItemUniqueSignature": {
2728
+ "description": "Unique signature of the data item of the measure to be updated",
2729
+ "type": "string"
2730
+ },
2731
+ "collectionKey": {
2732
+ "description": "Measure collection key",
2733
+ "type": "string",
2734
+ "enum": ["measures", "supportingMeasures"]
2735
+ },
2736
+ "advancedOperationKey": {
2737
+ "description": "Advanced operation key",
2738
+ "type": "string",
2739
+ "enum": ["advancedCalculation", "nestedCalculation"]
2740
+ },
2741
+ "percentileContinuous": {
2742
+ "type": "boolean"
2743
+ }
2744
+ },
2745
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileContinuous"],
2746
+ "additionalProperties": false
2747
+ }
2748
+ ```
2749
+
2750
+ ## `setMeasureAdvancedPercentileValue`
2751
+
2752
+ Advanced percentile value
2753
+
2754
+ Set percentile value for percentile aggregation
2755
+
2756
+ **Payload schema**
2757
+
2758
+ ```json
2759
+ {
2760
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2761
+ "title": "Measure advanced percentile value schema",
2762
+ "type": "object",
2763
+ "properties": {
2764
+ "dataItemInternalKey": {
2765
+ "description": "Internal key of the data item of the measure to be updated",
2766
+ "type": "string"
2767
+ },
2768
+ "dataItemUniqueSignature": {
2769
+ "description": "Unique signature of the data item of the measure to be updated",
2770
+ "type": "string"
2771
+ },
2772
+ "collectionKey": {
2773
+ "description": "Measure collection key",
2774
+ "type": "string",
2775
+ "enum": ["measures", "supportingMeasures"]
2776
+ },
2777
+ "advancedOperationKey": {
2778
+ "description": "Advanced operation key",
2779
+ "type": "string",
2780
+ "enum": ["advancedCalculation", "nestedCalculation"]
2781
+ },
2782
+ "percentileValue": {
2783
+ "anyOf": [
2784
+ {
2785
+ "type": "number"
2786
+ },
2787
+ {
2788
+ "type": "object",
2789
+ "properties": {
2790
+ "type": {
2791
+ "type": "string",
2792
+ "const": "variable"
2793
+ },
2794
+ "variableName": {
2795
+ "type": "string"
2796
+ }
2797
+ },
2798
+ "required": ["type", "variableName"],
2799
+ "additionalProperties": false
2800
+ }
2801
+ ]
2802
+ }
2803
+ },
2804
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileValue"],
2805
+ "additionalProperties": false
2806
+ }
2807
+ ```
2808
+
2809
+ ## `setMeasureAdvancedPeriodsPerYear`
2810
+
2811
+ Advanced periods per year
2812
+
2813
+ Set number of periods in a year for annualized period growth
2814
+
2815
+ **Payload schema**
2816
+
2817
+ ```json
2818
+ {
2819
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2820
+ "title": "Measure advanced periods per year schema",
2821
+ "type": "object",
2822
+ "properties": {
2823
+ "dataItemInternalKey": {
2824
+ "description": "Internal key of the data item of the measure to be updated",
2825
+ "type": "string"
2826
+ },
2827
+ "dataItemUniqueSignature": {
2828
+ "description": "Unique signature of the data item of the measure to be updated",
2829
+ "type": "string"
2830
+ },
2831
+ "collectionKey": {
2832
+ "description": "Measure collection key",
2833
+ "type": "string",
2834
+ "enum": ["measures", "supportingMeasures"]
2835
+ },
2836
+ "advancedOperationKey": {
2837
+ "description": "Advanced operation key",
2838
+ "type": "string",
2839
+ "enum": ["advancedCalculation", "nestedCalculation"]
2840
+ },
2841
+ "periodsPerYear": {
2842
+ "anyOf": [
2843
+ {
2844
+ "type": "number"
2845
+ },
2846
+ {
2847
+ "type": "object",
2848
+ "properties": {
2849
+ "type": {
2850
+ "type": "string",
2851
+ "const": "variable"
2852
+ },
2853
+ "variableName": {
2854
+ "type": "string"
2855
+ }
2856
+ },
2857
+ "required": ["type", "variableName"],
2858
+ "additionalProperties": false
2859
+ }
2860
+ ]
2861
+ }
2862
+ },
2863
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "periodsPerYear"],
2864
+ "additionalProperties": false
2865
+ }
2866
+ ```
2867
+
2868
+ ## `setMeasureAdvancedRangesComparisonEnabled`
2869
+
2870
+ Advanced ranges comparison enabled
2871
+
2872
+ Enable or disable ranges comparison
2873
+
2874
+ **Payload schema**
2875
+
2876
+ ```json
2877
+ {
2878
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2879
+ "title": "Measure advanced ranges comparison enabled schema",
2880
+ "type": "object",
2881
+ "properties": {
2882
+ "dataItemInternalKey": {
2883
+ "description": "Internal key of the data item of the measure to be updated",
2884
+ "type": "string"
2885
+ },
2886
+ "dataItemUniqueSignature": {
2887
+ "description": "Unique signature of the data item of the measure to be updated",
2888
+ "type": "string"
2889
+ },
2890
+ "collectionKey": {
2891
+ "description": "Measure collection key",
2892
+ "type": "string",
2893
+ "enum": ["measures", "supportingMeasures"]
2894
+ },
2895
+ "advancedOperationKey": {
2896
+ "description": "Advanced operation key",
2897
+ "type": "string",
2898
+ "enum": ["advancedCalculation", "nestedCalculation"]
2899
+ },
2900
+ "enabled": {
2901
+ "type": "boolean"
2902
+ }
2903
+ },
2904
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
2905
+ "additionalProperties": false
2906
+ }
2907
+ ```
2908
+
2909
+ ## `setMeasureAdvancedRangesComparisonFirstRangeEnd`
2910
+
2911
+ Advanced ranges first range end
2912
+
2913
+ Set first range end for ranges comparison
2914
+
2915
+ **Payload schema**
2916
+
2917
+ ```json
2918
+ {
2919
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2920
+ "title": "Measure advanced ranges first range end schema",
2921
+ "type": "object",
2922
+ "properties": {
2923
+ "dataItemInternalKey": {
2924
+ "description": "Internal key of the data item of the measure to be updated",
2925
+ "type": "string"
2926
+ },
2927
+ "dataItemUniqueSignature": {
2928
+ "description": "Unique signature of the data item of the measure to be updated",
2929
+ "type": "string"
2930
+ },
2931
+ "collectionKey": {
2932
+ "description": "Measure collection key",
2933
+ "type": "string",
2934
+ "enum": ["measures", "supportingMeasures"]
2935
+ },
2936
+ "advancedOperationKey": {
2937
+ "description": "Advanced operation key",
2938
+ "type": "string",
2939
+ "enum": ["advancedCalculation", "nestedCalculation"]
2940
+ },
2941
+ "firstRangeEnd": {
2942
+ "anyOf": [
2943
+ {
2944
+ "type": "number"
2945
+ },
2946
+ {
2947
+ "type": "object",
2948
+ "properties": {
2949
+ "type": {
2950
+ "type": "string",
2951
+ "const": "variable"
2952
+ },
2953
+ "variableName": {
2954
+ "type": "string"
2955
+ }
2956
+ },
2957
+ "required": ["type", "variableName"],
2958
+ "additionalProperties": false
2959
+ }
2960
+ ]
2961
+ }
2962
+ },
2963
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeEnd"],
2964
+ "additionalProperties": false
2965
+ }
2966
+ ```
2967
+
2968
+ ## `setMeasureAdvancedRangesComparisonFirstRangeStart`
2969
+
2970
+ Advanced ranges first range start
2971
+
2972
+ Set first range start for ranges comparison
2973
+
2974
+ **Payload schema**
2975
+
2976
+ ```json
2977
+ {
2978
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2979
+ "title": "Measure advanced ranges first range start schema",
2980
+ "type": "object",
2981
+ "properties": {
2982
+ "dataItemInternalKey": {
2983
+ "description": "Internal key of the data item of the measure to be updated",
2984
+ "type": "string"
2985
+ },
2986
+ "dataItemUniqueSignature": {
2987
+ "description": "Unique signature of the data item of the measure to be updated",
2988
+ "type": "string"
2989
+ },
2990
+ "collectionKey": {
2991
+ "description": "Measure collection key",
2992
+ "type": "string",
2993
+ "enum": ["measures", "supportingMeasures"]
2994
+ },
2995
+ "advancedOperationKey": {
2996
+ "description": "Advanced operation key",
2997
+ "type": "string",
2998
+ "enum": ["advancedCalculation", "nestedCalculation"]
2999
+ },
3000
+ "firstRangeStart": {
3001
+ "anyOf": [
3002
+ {
3003
+ "type": "number"
3004
+ },
3005
+ {
3006
+ "type": "object",
3007
+ "properties": {
3008
+ "type": {
3009
+ "type": "string",
3010
+ "const": "variable"
3011
+ },
3012
+ "variableName": {
3013
+ "type": "string"
3014
+ }
3015
+ },
3016
+ "required": ["type", "variableName"],
3017
+ "additionalProperties": false
3018
+ }
3019
+ ]
3020
+ }
3021
+ },
3022
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeStart"],
3023
+ "additionalProperties": false
3024
+ }
3025
+ ```
3026
+
3027
+ ## `setMeasureAdvancedRangesComparisonSecondRangeEnd`
3028
+
3029
+ Advanced ranges second range end
3030
+
3031
+ Set second range end for ranges comparison
3032
+
3033
+ **Payload schema**
3034
+
3035
+ ```json
3036
+ {
3037
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3038
+ "title": "Measure advanced ranges second range end schema",
3039
+ "type": "object",
3040
+ "properties": {
3041
+ "dataItemInternalKey": {
3042
+ "description": "Internal key of the data item of the measure to be updated",
3043
+ "type": "string"
3044
+ },
3045
+ "dataItemUniqueSignature": {
3046
+ "description": "Unique signature of the data item of the measure to be updated",
3047
+ "type": "string"
3048
+ },
3049
+ "collectionKey": {
3050
+ "description": "Measure collection key",
3051
+ "type": "string",
3052
+ "enum": ["measures", "supportingMeasures"]
3053
+ },
3054
+ "advancedOperationKey": {
3055
+ "description": "Advanced operation key",
3056
+ "type": "string",
3057
+ "enum": ["advancedCalculation", "nestedCalculation"]
3058
+ },
3059
+ "secondRangeEnd": {
3060
+ "anyOf": [
3061
+ {
3062
+ "type": "number"
3063
+ },
3064
+ {
3065
+ "type": "object",
3066
+ "properties": {
3067
+ "type": {
3068
+ "type": "string",
3069
+ "const": "variable"
3070
+ },
3071
+ "variableName": {
3072
+ "type": "string"
3073
+ }
3074
+ },
3075
+ "required": ["type", "variableName"],
3076
+ "additionalProperties": false
3077
+ }
3078
+ ]
3079
+ }
3080
+ },
3081
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeEnd"],
3082
+ "additionalProperties": false
3083
+ }
3084
+ ```
3085
+
3086
+ ## `setMeasureAdvancedRangesComparisonSecondRangeStart`
3087
+
3088
+ Advanced ranges second range start
3089
+
3090
+ Set second range start for ranges comparison
3091
+
3092
+ **Payload schema**
3093
+
3094
+ ```json
3095
+ {
3096
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3097
+ "title": "Measure advanced ranges second range start schema",
3098
+ "type": "object",
3099
+ "properties": {
3100
+ "dataItemInternalKey": {
3101
+ "description": "Internal key of the data item of the measure to be updated",
3102
+ "type": "string"
3103
+ },
3104
+ "dataItemUniqueSignature": {
3105
+ "description": "Unique signature of the data item of the measure to be updated",
3106
+ "type": "string"
3107
+ },
3108
+ "collectionKey": {
3109
+ "description": "Measure collection key",
3110
+ "type": "string",
3111
+ "enum": ["measures", "supportingMeasures"]
3112
+ },
3113
+ "advancedOperationKey": {
3114
+ "description": "Advanced operation key",
3115
+ "type": "string",
3116
+ "enum": ["advancedCalculation", "nestedCalculation"]
3117
+ },
3118
+ "secondRangeStart": {
3119
+ "anyOf": [
3120
+ {
3121
+ "type": "number"
3122
+ },
3123
+ {
3124
+ "type": "object",
3125
+ "properties": {
3126
+ "type": {
3127
+ "type": "string",
3128
+ "const": "variable"
3129
+ },
3130
+ "variableName": {
3131
+ "type": "string"
3132
+ }
3133
+ },
3134
+ "required": ["type", "variableName"],
3135
+ "additionalProperties": false
3136
+ }
3137
+ ]
3138
+ }
3139
+ },
3140
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeStart"],
3141
+ "additionalProperties": false
3142
+ }
3143
+ ```
3144
+
3145
+ ## `setMeasureAdvancedRangesComparisonType`
3146
+
3147
+ Advanced ranges comparison type
3148
+
3149
+ Set ranges comparison type
3150
+
3151
+ **Payload schema**
3152
+
3153
+ ```json
3154
+ {
3155
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3156
+ "title": "Measure advanced ranges comparison type schema",
3157
+ "type": "object",
3158
+ "properties": {
3159
+ "dataItemInternalKey": {
3160
+ "description": "Internal key of the data item of the measure to be updated",
3161
+ "type": "string"
3162
+ },
3163
+ "dataItemUniqueSignature": {
3164
+ "description": "Unique signature of the data item of the measure to be updated",
3165
+ "type": "string"
3166
+ },
3167
+ "collectionKey": {
3168
+ "description": "Measure collection key",
3169
+ "type": "string",
3170
+ "enum": ["measures", "supportingMeasures"]
3171
+ },
3172
+ "advancedOperationKey": {
3173
+ "description": "Advanced operation key",
3174
+ "type": "string",
3175
+ "enum": ["advancedCalculation", "nestedCalculation"]
3176
+ },
3177
+ "type": {
3178
+ "type": "string",
3179
+ "enum": ["absolute", "percentage"]
3180
+ }
3181
+ },
3182
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "type"],
3183
+ "additionalProperties": false
3184
+ }
3185
+ ```
3186
+
3187
+ ## `setMeasureAdvancedRankSortDirection`
3188
+
3189
+ Advanced rank sort direction
3190
+
3191
+ Set rank sort direction for rank advanced calculation
3192
+
3193
+ **Payload schema**
3194
+
3195
+ ```json
3196
+ {
3197
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3198
+ "title": "Measure advanced rank sort direction schema",
3199
+ "type": "object",
3200
+ "properties": {
3201
+ "dataItemInternalKey": {
3202
+ "description": "Internal key of the data item of the measure to be updated",
3203
+ "type": "string"
3204
+ },
3205
+ "dataItemUniqueSignature": {
3206
+ "description": "Unique signature of the data item of the measure to be updated",
3207
+ "type": "string"
3208
+ },
3209
+ "collectionKey": {
3210
+ "description": "Measure collection key",
3211
+ "type": "string",
3212
+ "enum": ["measures", "supportingMeasures"]
3213
+ },
3214
+ "advancedOperationKey": {
3215
+ "description": "Advanced operation key",
3216
+ "type": "string",
3217
+ "enum": ["advancedCalculation", "nestedCalculation"]
3218
+ },
3219
+ "rankSortDirection": {
3220
+ "type": "string",
3221
+ "enum": ["asc", "desc"]
3222
+ }
3223
+ },
3224
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "rankSortDirection"],
3225
+ "additionalProperties": false
3226
+ }
3227
+ ```
3228
+
3229
+ ## `setMeasureAdvancedSortingOrder`
3230
+
3231
+ Advanced sorting order
3232
+
3233
+ Set sorting order used by advanced calculation
3234
+
3235
+ **Payload schema**
3236
+
3237
+ ```json
3238
+ {
3239
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3240
+ "title": "Measure advanced sorting order schema",
3241
+ "type": "object",
3242
+ "properties": {
3243
+ "dataItemInternalKey": {
3244
+ "description": "Internal key of the data item of the measure to be updated",
3245
+ "type": "string"
3246
+ },
3247
+ "dataItemUniqueSignature": {
3248
+ "description": "Unique signature of the data item of the measure to be updated",
3249
+ "type": "string"
3250
+ },
3251
+ "collectionKey": {
3252
+ "description": "Measure collection key",
3253
+ "type": "string",
3254
+ "enum": ["measures", "supportingMeasures"]
3255
+ },
3256
+ "advancedOperationKey": {
3257
+ "description": "Advanced operation key",
3258
+ "type": "string",
3259
+ "enum": ["advancedCalculation", "nestedCalculation"]
3260
+ },
3261
+ "sortingOrder": {
3262
+ "type": "array",
3263
+ "items": {
3264
+ "type": "object",
3265
+ "properties": {
3266
+ "id": {
3267
+ "type": "string"
3268
+ },
3269
+ "sortDirection": {
3270
+ "type": "string",
3271
+ "enum": ["asc", "desc"]
3272
+ }
3273
+ },
3274
+ "required": ["id", "sortDirection"],
3275
+ "additionalProperties": false
3276
+ }
3277
+ }
3278
+ },
3279
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortingOrder"],
3280
+ "additionalProperties": false
3281
+ }
3282
+ ```
3283
+
3284
+ ## `setMeasureAdvancedStandardDeviations`
3285
+
3286
+ Advanced standard deviations
3287
+
3288
+ Set standard deviations for outliers aggregation
3289
+
3290
+ **Payload schema**
3291
+
3292
+ ```json
3293
+ {
3294
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3295
+ "title": "Measure advanced standard deviations schema",
3296
+ "type": "object",
3297
+ "properties": {
3298
+ "dataItemInternalKey": {
3299
+ "description": "Internal key of the data item of the measure to be updated",
3300
+ "type": "string"
3301
+ },
3302
+ "dataItemUniqueSignature": {
3303
+ "description": "Unique signature of the data item of the measure to be updated",
3304
+ "type": "string"
3305
+ },
3306
+ "collectionKey": {
3307
+ "description": "Measure collection key",
3308
+ "type": "string",
3309
+ "enum": ["measures", "supportingMeasures"]
3310
+ },
3311
+ "advancedOperationKey": {
3312
+ "description": "Advanced operation key",
3313
+ "type": "string",
3314
+ "enum": ["advancedCalculation", "nestedCalculation"]
3315
+ },
3316
+ "standardDeviations": {
3317
+ "anyOf": [
3318
+ {
3319
+ "type": "number"
3320
+ },
3321
+ {
3322
+ "type": "object",
3323
+ "properties": {
3324
+ "type": {
3325
+ "type": "string",
3326
+ "const": "variable"
3327
+ },
3328
+ "variableName": {
3329
+ "type": "string"
3330
+ }
3331
+ },
3332
+ "required": ["type", "variableName"],
3333
+ "additionalProperties": false
3334
+ }
3335
+ ]
3336
+ }
3337
+ },
3338
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "standardDeviations"],
3339
+ "additionalProperties": false
3340
+ }
3341
+ ```
3342
+
3343
+ ## `setMeasureAdvancedWindowBegin`
3344
+
3345
+ Advanced periods before
3346
+
3347
+ Set periods before for moving calculation
3348
+
3349
+ **Payload schema**
3350
+
3351
+ ```json
3352
+ {
3353
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3354
+ "title": "Measure advanced window begin schema",
3355
+ "type": "object",
3356
+ "properties": {
3357
+ "dataItemInternalKey": {
3358
+ "description": "Internal key of the data item of the measure to be updated",
3359
+ "type": "string"
3360
+ },
3361
+ "dataItemUniqueSignature": {
3362
+ "description": "Unique signature of the data item of the measure to be updated",
3363
+ "type": "string"
3364
+ },
3365
+ "collectionKey": {
3366
+ "description": "Measure collection key",
3367
+ "type": "string",
3368
+ "enum": ["measures", "supportingMeasures"]
3369
+ },
3370
+ "advancedOperationKey": {
3371
+ "description": "Advanced operation key",
3372
+ "type": "string",
3373
+ "enum": ["advancedCalculation", "nestedCalculation"]
3374
+ },
3375
+ "windowBegin": {
3376
+ "anyOf": [
3377
+ {
3378
+ "type": "number"
3379
+ },
3380
+ {
3381
+ "type": "object",
3382
+ "properties": {
3383
+ "type": {
3384
+ "type": "string",
3385
+ "const": "variable"
3386
+ },
3387
+ "variableName": {
3388
+ "type": "string"
3389
+ }
3390
+ },
3391
+ "required": ["type", "variableName"],
3392
+ "additionalProperties": false
3393
+ }
3394
+ ]
3395
+ }
3396
+ },
3397
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowBegin"],
3398
+ "additionalProperties": false
3399
+ }
3400
+ ```
3401
+
3402
+ ## `setMeasureAdvancedWindowEnd`
3403
+
3404
+ Advanced periods after
3405
+
3406
+ Set periods after for moving calculation
3407
+
3408
+ **Payload schema**
3409
+
3410
+ ```json
3411
+ {
3412
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3413
+ "title": "Measure advanced window end schema",
3414
+ "type": "object",
3415
+ "properties": {
3416
+ "dataItemInternalKey": {
3417
+ "description": "Internal key of the data item of the measure to be updated",
3418
+ "type": "string"
3419
+ },
3420
+ "dataItemUniqueSignature": {
3421
+ "description": "Unique signature of the data item of the measure to be updated",
3422
+ "type": "string"
3423
+ },
3424
+ "collectionKey": {
3425
+ "description": "Measure collection key",
3426
+ "type": "string",
3427
+ "enum": ["measures", "supportingMeasures"]
3428
+ },
3429
+ "advancedOperationKey": {
3430
+ "description": "Advanced operation key",
3431
+ "type": "string",
3432
+ "enum": ["advancedCalculation", "nestedCalculation"]
3433
+ },
3434
+ "windowEnd": {
3435
+ "anyOf": [
3436
+ {
3437
+ "type": "number"
3438
+ },
3439
+ {
3440
+ "type": "object",
3441
+ "properties": {
3442
+ "type": {
3443
+ "type": "string",
3444
+ "const": "variable"
3445
+ },
3446
+ "variableName": {
3447
+ "type": "string"
3448
+ }
3449
+ },
3450
+ "required": ["type", "variableName"],
3451
+ "additionalProperties": false
3452
+ }
3453
+ ]
3454
+ }
3455
+ },
3456
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowEnd"],
3457
+ "additionalProperties": false
3458
+ }
3459
+ ```
3460
+
3461
+ ## `setMeasureCurrency`
3462
+
3463
+ Measure currency
3464
+
3465
+ Set the currency symbol used by a measure formatter
3466
+
3467
+ **Payload schema**
3468
+
3469
+ ```json
3470
+ {
3471
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3472
+ "title": "Measure currency schema",
3473
+ "type": "object",
3474
+ "properties": {
3475
+ "dataItemInternalKey": {
3476
+ "description": "Internal key of the data item of the measure to be updated",
3477
+ "type": "string"
3478
+ },
3479
+ "dataItemUniqueSignature": {
3480
+ "description": "Unique signature of the data item of the measure to be updated",
3481
+ "type": "string"
3482
+ },
3483
+ "currency": {
3484
+ "type": "string"
3485
+ }
3486
+ },
3487
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3488
+ "additionalProperties": false
3489
+ }
3490
+ ```
3491
+
3492
+ ## `setMeasureCurrencyIsPrefix`
3493
+
3494
+ Measure currency is prefix
3495
+
3496
+ Set whether measure currency symbol is prefixed
3497
+
3498
+ **Payload schema**
3499
+
3500
+ ```json
3501
+ {
3502
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3503
+ "title": "Measure currency is prefix schema",
3504
+ "type": "object",
3505
+ "properties": {
3506
+ "dataItemInternalKey": {
3507
+ "description": "Internal key of the data item of the measure to be updated",
3508
+ "type": "string"
3509
+ },
3510
+ "dataItemUniqueSignature": {
3511
+ "description": "Unique signature of the data item of the measure to be updated",
3512
+ "type": "string"
3513
+ },
3514
+ "currencyIsPrefix": {
3515
+ "type": "boolean"
3516
+ }
3517
+ },
3518
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3519
+ "additionalProperties": false
3520
+ }
3521
+ ```
3522
+
3523
+ ## `setMeasureDefinedParameter`
3524
+
3525
+ Measure defined parameter
3526
+
3527
+ Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
3528
+
3529
+ **Payload schema**
3530
+
3531
+ ```json
3532
+ {
3533
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3534
+ "title": "Set measure defined parameter schema",
3535
+ "type": "object",
3536
+ "properties": {
3537
+ "dataItemInternalKey": {
3538
+ "description": "Internal key of the data item of the measure to be updated",
3539
+ "type": "string"
3540
+ },
3541
+ "dataItemUniqueSignature": {
3542
+ "description": "Unique signature of the data item of the measure to be updated",
3543
+ "type": "string"
3544
+ },
3545
+ "collectionKey": {
3546
+ "description": "Measure collection to update. Defaults to primary measures.",
3547
+ "type": "string",
3548
+ "enum": ["measures", "supportingMeasures"]
3549
+ },
3550
+ "parameterName": {
3551
+ "description": "Exact name of a Defined parameter exposed by the measure",
3552
+ "type": "string",
3553
+ "minLength": 1
3554
+ },
3555
+ "value": {
3556
+ "description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable",
3557
+ "anyOf": [
3558
+ {
3559
+ "type": "object",
3560
+ "properties": {
3561
+ "type": {
3562
+ "type": "string",
3563
+ "const": "default"
3564
+ }
3565
+ },
3566
+ "required": ["type"],
3567
+ "additionalProperties": false
3568
+ },
3569
+ {
3570
+ "type": "object",
3571
+ "properties": {
3572
+ "type": {
3573
+ "type": "string",
3574
+ "const": "static"
3575
+ },
3576
+ "value": {
3577
+ "anyOf": [
3578
+ {
3579
+ "type": "string"
3580
+ },
3581
+ {
3582
+ "type": "number"
3583
+ },
3584
+ {
3585
+ "type": "boolean"
3586
+ }
3587
+ ]
3588
+ }
3589
+ },
3590
+ "required": ["type", "value"],
3591
+ "additionalProperties": false
3592
+ },
3593
+ {
3594
+ "type": "object",
3595
+ "properties": {
3596
+ "type": {
3597
+ "type": "string",
3598
+ "const": "variable"
3599
+ },
3600
+ "variableName": {
3601
+ "description": "Exact name of an existing compatible workbook variable",
3602
+ "type": "string",
3603
+ "minLength": 1
3604
+ }
3605
+ },
3606
+ "required": ["type", "variableName"],
3607
+ "additionalProperties": false
3608
+ }
3609
+ ]
3610
+ }
3611
+ },
3612
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
3613
+ "additionalProperties": false
3614
+ }
3615
+ ```
3616
+
3617
+ ## `setMeasureFilter`
3618
+
3619
+ Set measure filter
3620
+
3621
+ Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
3622
+
3623
+ **Payload schema**
3624
+
3625
+ ```json
3626
+ {
3627
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3628
+ "description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
3629
+ "title": "Set measure filter schema",
3630
+ "anyOf": [
3631
+ {
3632
+ "type": "object",
3633
+ "properties": {
3634
+ "measureName": {
3635
+ "description": "Visible measure name or label",
3636
+ "type": "string"
3637
+ },
3638
+ "fieldKey": {
3639
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3640
+ "type": "string"
3641
+ },
3642
+ "operator": {
3643
+ "description": "Filter operator that requires a value",
3644
+ "type": "string",
3645
+ "enum": [
3646
+ "equals",
3647
+ "doesNotEqual",
3648
+ "greaterThan",
3649
+ "lessThan",
3650
+ "greaterThanOrEqualTo",
3651
+ "lessThanOrEqualTo",
3652
+ "contains",
3653
+ "excludes",
3654
+ "like",
3655
+ "notLike",
3656
+ "startsWith",
3657
+ "endsWith"
3658
+ ]
3659
+ },
3660
+ "value": {
3661
+ "description": "Filter value",
3662
+ "anyOf": [
3663
+ {
3664
+ "type": "string"
3665
+ },
3666
+ {
3667
+ "type": "object",
3668
+ "properties": {
3669
+ "type": {
3670
+ "type": "string",
3671
+ "const": "variable"
3672
+ },
3673
+ "variableName": {
3674
+ "type": "string"
3675
+ }
3676
+ },
3677
+ "required": ["type", "variableName"],
3678
+ "additionalProperties": false
3679
+ }
3680
+ ]
3681
+ }
3682
+ },
3683
+ "required": ["measureName", "fieldKey", "operator", "value"],
3684
+ "additionalProperties": false
3685
+ },
3686
+ {
3687
+ "type": "object",
3688
+ "properties": {
3689
+ "measureName": {
3690
+ "description": "Visible measure name or label",
3691
+ "type": "string"
3692
+ },
3693
+ "fieldKey": {
3694
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3695
+ "type": "string"
3696
+ },
3697
+ "operator": {
3698
+ "description": "Filter operator that requires valueFrom and valueTo",
3699
+ "type": "string",
3700
+ "enum": ["isBetween", "isNotBetween"]
3701
+ },
3702
+ "valueFrom": {
3703
+ "description": "Lower filter value",
3704
+ "anyOf": [
3705
+ {
3706
+ "type": "string"
3707
+ },
3708
+ {
3709
+ "type": "object",
3710
+ "properties": {
3711
+ "type": {
3712
+ "type": "string",
3713
+ "const": "variable"
3714
+ },
3715
+ "variableName": {
3716
+ "type": "string"
3717
+ }
3718
+ },
3719
+ "required": ["type", "variableName"],
3720
+ "additionalProperties": false
3721
+ }
3722
+ ]
3723
+ },
3724
+ "valueTo": {
3725
+ "description": "Upper filter value",
3726
+ "anyOf": [
3727
+ {
3728
+ "type": "string"
3729
+ },
3730
+ {
3731
+ "type": "object",
3732
+ "properties": {
3733
+ "type": {
3734
+ "type": "string",
3735
+ "const": "variable"
3736
+ },
3737
+ "variableName": {
3738
+ "type": "string"
3739
+ }
3740
+ },
3741
+ "required": ["type", "variableName"],
3742
+ "additionalProperties": false
3743
+ }
3744
+ ]
3745
+ }
3746
+ },
3747
+ "required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
3748
+ "additionalProperties": false
3749
+ },
3750
+ {
3751
+ "type": "object",
3752
+ "properties": {
3753
+ "measureName": {
3754
+ "description": "Visible measure name or label",
3755
+ "type": "string"
3756
+ },
3757
+ "fieldKey": {
3758
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3759
+ "type": "string"
3760
+ },
3761
+ "operator": {
3762
+ "description": "Filter operator that requires a list of values",
3763
+ "type": "string",
3764
+ "enum": ["inList", "excludedFromList"]
3765
+ },
3766
+ "values": {
3767
+ "description": "Filter values",
3768
+ "minItems": 1,
3769
+ "type": "array",
3770
+ "items": {
3771
+ "type": "string"
3772
+ }
3773
+ }
3774
+ },
3775
+ "required": ["measureName", "fieldKey", "operator", "values"],
3776
+ "additionalProperties": false
3777
+ },
3778
+ {
3779
+ "type": "object",
3780
+ "properties": {
3781
+ "measureName": {
3782
+ "description": "Visible measure name or label",
3783
+ "type": "string"
3784
+ },
3785
+ "fieldKey": {
3786
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
3787
+ "type": "string"
3788
+ },
3789
+ "operator": {
3790
+ "description": "Filter operator that does not require values",
3791
+ "type": "string",
3792
+ "enum": ["isNull", "notNull"]
3793
+ }
3794
+ },
3795
+ "required": ["measureName", "fieldKey", "operator"],
3796
+ "additionalProperties": false
3797
+ }
3798
+ ]
3799
+ }
3800
+ ```
3801
+
3802
+ ## `setMeasureFormatString`
3803
+
3804
+ Measure format string
3805
+
3806
+ Set the custom format string for a measure
3807
+
3808
+ **Payload schema**
3809
+
3810
+ ```json
3811
+ {
3812
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3813
+ "title": "Measure format string schema",
3814
+ "type": "object",
3815
+ "properties": {
3816
+ "dataItemInternalKey": {
3817
+ "description": "Internal key of the data item of the measure to be updated",
3818
+ "type": "string"
3819
+ },
3820
+ "dataItemUniqueSignature": {
3821
+ "description": "Unique signature of the data item of the measure to be updated",
3822
+ "type": "string"
3823
+ },
3824
+ "formatString": {
3825
+ "anyOf": [
3826
+ {
3827
+ "type": "string"
3828
+ },
3829
+ {
3830
+ "type": "object",
3831
+ "properties": {
3832
+ "type": {
3833
+ "type": "string",
3834
+ "const": "variable"
3835
+ },
3836
+ "variableName": {
3837
+ "type": "string"
3838
+ }
3839
+ },
3840
+ "required": ["type", "variableName"],
3841
+ "additionalProperties": false
3842
+ }
3843
+ ]
3844
+ }
3845
+ },
3846
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3847
+ "additionalProperties": false
3848
+ }
3849
+ ```
3850
+
3851
+ ## `setMeasureFormatType`
3852
+
3853
+ Measure format type
3854
+
3855
+ Set the format type used by a measure
3856
+
3857
+ **Payload schema**
3858
+
3859
+ ```json
3860
+ {
3861
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3862
+ "title": "Measure format type schema",
3863
+ "type": "object",
3864
+ "properties": {
3865
+ "dataItemInternalKey": {
3866
+ "description": "Internal key of the data item of the measure to be updated",
3867
+ "type": "string"
3868
+ },
3869
+ "dataItemUniqueSignature": {
3870
+ "description": "Unique signature of the data item of the measure to be updated",
3871
+ "type": "string"
3872
+ },
3873
+ "formatType": {
3874
+ "anyOf": [
3875
+ {
3876
+ "type": "string",
3877
+ "enum": [
3878
+ "custom",
3879
+ "inherit",
3880
+ "none",
3881
+ "defaultNumber",
3882
+ "defaultMoney",
3883
+ "numberNoDecimal",
3884
+ "number1Decimal",
3885
+ "number2Decimal",
3886
+ "abbreviationAuto",
3887
+ "abbreviationNoDecimal",
3888
+ "abbreviation1Decimal",
3889
+ "abbreviation2Decimal",
3890
+ "percentageNoDecimal",
3891
+ "percentage1Decimal",
3892
+ "percentage2Decimal",
3893
+ "money0Decimal",
3894
+ "money2Decimal",
3895
+ "durationDays",
3896
+ "durationHours",
3897
+ "durationMinutes",
3898
+ "durationSeconds"
3899
+ ]
3900
+ },
3901
+ {
3902
+ "type": "string",
3903
+ "enum": [
3904
+ "defaultDate",
3905
+ "defaultDatetime",
3906
+ "defaultTime",
3907
+ "ddmmyyyy",
3908
+ "ddmmyyyy2",
3909
+ "ddmmyyyy3",
3910
+ "yyyymmdd",
3911
+ "mmddyyyy",
3912
+ "mmddyyyy2",
3913
+ "ddmmmmyyyy",
3914
+ "ddmmmyyyy",
3915
+ "ddmmmyy",
3916
+ "mmmmddyyyy",
3917
+ "yyyy",
3918
+ "yy",
3919
+ "mmmyyyy",
3920
+ "yyyymmm",
3921
+ "yyyymmmm",
3922
+ "mmyyyy",
3923
+ "yyyymm",
3924
+ "mmmmyyyy",
3925
+ "yyyywn",
3926
+ "wnyyyy",
3927
+ "yywn",
3928
+ "yyyyq",
3929
+ "qyyyy",
3930
+ "yyyymmddhhmmss",
3931
+ "yyyymmddhmmss",
3932
+ "yyyymmddhhmm",
3933
+ "yyyymmddhh",
3934
+ "yyyymmddhmm",
3935
+ "yyyymmddh",
3936
+ "ddmmmyyyyhhmmss",
3937
+ "ddmmmyyyyhmmss",
3938
+ "ddmmmyyyyhhmm",
3939
+ "ddmmmyyyyhmm",
3940
+ "ddmmmyyyyh",
3941
+ "hhmmss",
3942
+ "hhmm",
3943
+ "hmm",
3944
+ "h",
3945
+ "hh",
3946
+ "hmmss",
3947
+ "month",
3948
+ "month2",
3949
+ "monthn",
3950
+ "month3",
3951
+ "quarter",
3952
+ "quarter2",
3953
+ "week1",
3954
+ "week2",
3955
+ "week3",
3956
+ "day",
3957
+ "dayOfWeek",
3958
+ "hhn",
3959
+ "hn"
3960
+ ]
3961
+ }
3962
+ ]
3963
+ }
3964
+ },
3965
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
3966
+ "additionalProperties": false
3967
+ }
3968
+ ```
3969
+
3970
+ ## `setMeasureNegativeType`
3971
+
3972
+ Measure negative type
3973
+
3974
+ Set how negative values are displayed for a measure formatter
3975
+
3976
+ **Payload schema**
3977
+
3978
+ ```json
3979
+ {
3980
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3981
+ "title": "Measure negative type schema",
3982
+ "type": "object",
3983
+ "properties": {
3984
+ "dataItemInternalKey": {
3985
+ "description": "Internal key of the data item of the measure to be updated",
3986
+ "type": "string"
3987
+ },
3988
+ "dataItemUniqueSignature": {
3989
+ "description": "Unique signature of the data item of the measure to be updated",
3990
+ "type": "string"
3991
+ },
3992
+ "negativeType": {
3993
+ "type": "string",
3994
+ "enum": ["symbol", "parenthesis"]
3995
+ }
3996
+ },
3997
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
3998
+ "additionalProperties": false
3999
+ }
4000
+ ```
4001
+
4002
+ ## `setResultFilter`
4003
+
4004
+ Set result filter
4005
+
4006
+ Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
4007
+
4008
+ **Payload schema**
4009
+
4010
+ ```json
4011
+ {
4012
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4013
+ "description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
4014
+ "title": "Set result filter schema",
4015
+ "anyOf": [
4016
+ {
4017
+ "type": "object",
4018
+ "properties": {
4019
+ "measureName": {
4020
+ "description": "Visible measure name or label",
4021
+ "type": "string"
4022
+ },
4023
+ "operator": {
4024
+ "description": "Filter operator that requires a value",
4025
+ "type": "string",
4026
+ "enum": [
4027
+ "equals",
4028
+ "doesNotEqual",
4029
+ "greaterThan",
4030
+ "lessThan",
4031
+ "greaterThanOrEqualTo",
4032
+ "lessThanOrEqualTo",
4033
+ "contains",
4034
+ "excludes",
4035
+ "like",
4036
+ "notLike",
4037
+ "startsWith",
4038
+ "endsWith"
4039
+ ]
4040
+ },
4041
+ "value": {
4042
+ "description": "Filter value",
4043
+ "anyOf": [
4044
+ {
4045
+ "type": "string"
4046
+ },
4047
+ {
4048
+ "type": "object",
4049
+ "properties": {
4050
+ "type": {
4051
+ "type": "string",
4052
+ "const": "variable"
4053
+ },
4054
+ "variableName": {
4055
+ "type": "string"
4056
+ }
4057
+ },
4058
+ "required": ["type", "variableName"],
4059
+ "additionalProperties": false
4060
+ }
4061
+ ]
4062
+ }
4063
+ },
4064
+ "required": ["measureName", "operator", "value"],
4065
+ "additionalProperties": false
4066
+ },
4067
+ {
4068
+ "type": "object",
4069
+ "properties": {
4070
+ "measureName": {
4071
+ "description": "Visible measure name or label",
4072
+ "type": "string"
4073
+ },
4074
+ "operator": {
4075
+ "description": "Filter operator that requires valueFrom and valueTo",
4076
+ "type": "string",
4077
+ "enum": ["isBetween", "isNotBetween"]
4078
+ },
4079
+ "valueFrom": {
4080
+ "description": "Lower filter value",
4081
+ "anyOf": [
4082
+ {
4083
+ "type": "string"
4084
+ },
4085
+ {
4086
+ "type": "object",
4087
+ "properties": {
4088
+ "type": {
4089
+ "type": "string",
4090
+ "const": "variable"
4091
+ },
4092
+ "variableName": {
4093
+ "type": "string"
4094
+ }
4095
+ },
4096
+ "required": ["type", "variableName"],
4097
+ "additionalProperties": false
4098
+ }
4099
+ ]
4100
+ },
4101
+ "valueTo": {
4102
+ "description": "Upper filter value",
4103
+ "anyOf": [
4104
+ {
4105
+ "type": "string"
4106
+ },
4107
+ {
4108
+ "type": "object",
4109
+ "properties": {
4110
+ "type": {
4111
+ "type": "string",
4112
+ "const": "variable"
4113
+ },
4114
+ "variableName": {
4115
+ "type": "string"
4116
+ }
4117
+ },
4118
+ "required": ["type", "variableName"],
4119
+ "additionalProperties": false
4120
+ }
4121
+ ]
4122
+ }
4123
+ },
4124
+ "required": ["measureName", "operator", "valueFrom", "valueTo"],
4125
+ "additionalProperties": false
4126
+ },
4127
+ {
4128
+ "type": "object",
4129
+ "properties": {
4130
+ "measureName": {
4131
+ "description": "Visible measure name or label",
4132
+ "type": "string"
4133
+ },
4134
+ "operator": {
4135
+ "description": "Filter operator that requires a list of values",
4136
+ "type": "string",
4137
+ "enum": ["inList", "excludedFromList"]
4138
+ },
4139
+ "values": {
4140
+ "description": "Filter values",
4141
+ "minItems": 1,
4142
+ "type": "array",
4143
+ "items": {
4144
+ "type": "string"
4145
+ }
4146
+ }
4147
+ },
4148
+ "required": ["measureName", "operator", "values"],
4149
+ "additionalProperties": false
4150
+ },
4151
+ {
4152
+ "type": "object",
4153
+ "properties": {
4154
+ "measureName": {
4155
+ "description": "Visible measure name or label",
4156
+ "type": "string"
4157
+ },
4158
+ "operator": {
4159
+ "description": "Filter operator that does not require values",
4160
+ "type": "string",
4161
+ "enum": ["isNull", "notNull"]
4162
+ }
4163
+ },
4164
+ "required": ["measureName", "operator"],
4165
+ "additionalProperties": false
4166
+ }
4167
+ ]
4168
+ }
4169
+ ```
4170
+
4171
+ ## `setSortingDirection`
4172
+
4173
+ Sorting direction
4174
+
4175
+ Set sorting direction for all matching sortable items by name
4176
+
4177
+ **Payload schema**
4178
+
4179
+ ```json
4180
+ {
4181
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4182
+ "title": "Sorting direction by name schema",
4183
+ "type": "object",
4184
+ "properties": {
4185
+ "name": {
4186
+ "type": "string",
4187
+ "minLength": 1
4188
+ },
4189
+ "sortDirection": {
4190
+ "type": "string",
4191
+ "enum": ["ascending", "descending"]
4192
+ }
4193
+ },
4194
+ "required": ["name", "sortDirection"],
4195
+ "additionalProperties": false
4196
+ }
4197
+ ```
4198
+
4199
+ ## `setSortingEnabled`
4200
+
4201
+ Sorting enabled
4202
+
4203
+ Enable or disable sorting for all matching sortable items by name
4204
+
4205
+ **Payload schema**
4206
+
4207
+ ```json
4208
+ {
4209
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4210
+ "title": "Sorting enabled by name schema",
4211
+ "type": "object",
4212
+ "properties": {
4213
+ "name": {
4214
+ "type": "string",
4215
+ "minLength": 1
4216
+ },
4217
+ "enabled": {
4218
+ "type": "boolean"
4219
+ }
4220
+ },
4221
+ "required": ["name"],
4222
+ "additionalProperties": false
4223
+ }
4224
+ ```
4225
+
4226
+ ## `setStaticFilterGroup`
4227
+
4228
+ Set static filter group
4229
+
4230
+ Replace all static filters with a nested AND/OR filter group.
4231
+
4232
+ **Payload schema**
4233
+
4234
+ ```json
4235
+ {
4236
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4237
+ "description": "Replace all static filters with this nested AND/OR filter group.",
4238
+ "title": "Set static filter group schema",
4239
+ "$ref": "#/$defs/__schema0",
4240
+ "$defs": {
4241
+ "__schema0": {
4242
+ "type": "object",
4243
+ "properties": {
4244
+ "operator": {
4245
+ "type": "string",
4246
+ "enum": ["and", "or"]
4247
+ },
4248
+ "filters": {
4249
+ "type": "array",
4250
+ "items": {
4251
+ "anyOf": [
4252
+ {
4253
+ "type": "object",
4254
+ "properties": {
4255
+ "fieldKey": {
4256
+ "description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label.",
4257
+ "type": "string"
4258
+ },
4259
+ "operator": {
4260
+ "anyOf": [
4261
+ {
4262
+ "type": "string",
4263
+ "enum": [
4264
+ "equals",
4265
+ "doesNotEqual",
4266
+ "greaterThan",
4267
+ "lessThan",
4268
+ "greaterThanOrEqualTo",
4269
+ "lessThanOrEqualTo",
4270
+ "isBetween",
4271
+ "isNotBetween",
4272
+ "isNull",
4273
+ "notNull",
4274
+ "contains",
4275
+ "excludes",
4276
+ "like",
4277
+ "notLike",
4278
+ "startsWith",
4279
+ "endsWith",
4280
+ "predefined_date_range",
4281
+ "previous",
4282
+ "current",
4283
+ "before",
4284
+ "after",
4285
+ "inList",
4286
+ "excludedFromList",
4287
+ "divider"
4288
+ ]
4289
+ },
4290
+ {
4291
+ "type": "string",
4292
+ "enum": [
4293
+ "ytd",
4294
+ "mtd",
4295
+ "qtd",
4296
+ "wtd",
4297
+ "pytd",
4298
+ "pmtd",
4299
+ "pqtd",
4300
+ "pwtd",
4301
+ "l12m",
4302
+ "l90d",
4303
+ "l30d",
4304
+ "l7d",
4305
+ "cy",
4306
+ "cq",
4307
+ "cm",
4308
+ "py",
4309
+ "pm",
4310
+ "pq",
4311
+ "pw",
4312
+ "today",
4313
+ "yesterday",
4314
+ "mindate",
4315
+ "maxdate"
4316
+ ]
4317
+ }
4318
+ ]
4319
+ },
4320
+ "values": {
4321
+ "type": "object",
4322
+ "properties": {
4323
+ "value": {
4324
+ "anyOf": [
4325
+ {
4326
+ "type": "string"
4327
+ },
4328
+ {
4329
+ "type": "object",
4330
+ "properties": {
4331
+ "type": {
4332
+ "type": "string",
4333
+ "const": "variable"
4334
+ },
4335
+ "variableName": {
4336
+ "type": "string"
4337
+ }
4338
+ },
4339
+ "required": ["type", "variableName"],
4340
+ "additionalProperties": false
4341
+ }
4342
+ ]
4343
+ },
4344
+ "valueFrom": {
4345
+ "anyOf": [
4346
+ {
4347
+ "type": "string"
4348
+ },
4349
+ {
4350
+ "type": "object",
4351
+ "properties": {
4352
+ "type": {
4353
+ "type": "string",
4354
+ "const": "variable"
4355
+ },
4356
+ "variableName": {
4357
+ "type": "string"
4358
+ }
4359
+ },
4360
+ "required": ["type", "variableName"],
4361
+ "additionalProperties": false
4362
+ }
4363
+ ]
4364
+ },
4365
+ "valueTo": {
4366
+ "anyOf": [
4367
+ {
4368
+ "type": "string"
4369
+ },
4370
+ {
4371
+ "type": "object",
4372
+ "properties": {
4373
+ "type": {
4374
+ "type": "string",
4375
+ "const": "variable"
4376
+ },
4377
+ "variableName": {
4378
+ "type": "string"
4379
+ }
4380
+ },
4381
+ "required": ["type", "variableName"],
4382
+ "additionalProperties": false
4383
+ }
4384
+ ]
4385
+ },
4386
+ "secondValue": {
4387
+ "anyOf": [
4388
+ {
4389
+ "type": "string"
4390
+ },
4391
+ {
4392
+ "type": "object",
4393
+ "properties": {
4394
+ "type": {
4395
+ "type": "string",
4396
+ "const": "variable"
4397
+ },
4398
+ "variableName": {
4399
+ "type": "string"
4400
+ }
4401
+ },
4402
+ "required": ["type", "variableName"],
4403
+ "additionalProperties": false
4404
+ }
4405
+ ]
4406
+ }
4407
+ },
4408
+ "additionalProperties": false
4409
+ },
4410
+ "dateFilter": {
4411
+ "anyOf": [
4412
+ {
4413
+ "type": "string",
4414
+ "enum": [
4415
+ "ytd",
4416
+ "mtd",
4417
+ "qtd",
4418
+ "wtd",
4419
+ "pytd",
4420
+ "pmtd",
4421
+ "pqtd",
4422
+ "pwtd",
4423
+ "l12m",
4424
+ "l90d",
4425
+ "l30d",
4426
+ "l7d",
4427
+ "cy",
4428
+ "cq",
4429
+ "cm",
4430
+ "py",
4431
+ "pm",
4432
+ "pq",
4433
+ "pw",
4434
+ "today",
4435
+ "yesterday",
4436
+ "mindate",
4437
+ "maxdate"
4438
+ ]
4439
+ },
4440
+ {
4441
+ "type": "null"
4442
+ }
4443
+ ]
4444
+ }
4445
+ },
4446
+ "required": ["fieldKey", "operator", "values"],
4447
+ "additionalProperties": false
4448
+ },
4449
+ {
4450
+ "$ref": "#/$defs/__schema0"
4451
+ }
4452
+ ]
4453
+ }
4454
+ }
4455
+ },
4456
+ "required": ["operator", "filters"],
4457
+ "additionalProperties": false
4458
+ }
4459
+ }
4460
+ }
4461
+ ```
4462
+
4463
+ ## `toggleDimension`
4464
+
4465
+ Toggle dimension
4466
+
4467
+ Enable or disable a dimension in the chart
4468
+
4469
+ **Payload schema**
4470
+
4471
+ ```json
4472
+ {
4473
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4474
+ "title": "Toggle dimension schema",
4475
+ "type": "object",
4476
+ "properties": {
4477
+ "dataItemInternalKey": {
4478
+ "description": "Internal key of the data item of the dimension to be toggled",
4479
+ "type": "string"
4480
+ },
4481
+ "dataItemUniqueSignature": {
4482
+ "description": "Unique signature of the data item of the dimension to be toggled",
4483
+ "type": "string"
4484
+ },
4485
+ "enabled": {
4486
+ "description": "Whether the dimension should be enabled or disabled",
4487
+ "type": "boolean"
4488
+ }
4489
+ },
4490
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
4491
+ "additionalProperties": false
4492
+ }
4493
+ ```
4494
+
4495
+ ## `toggleDimensionOrMeasureByName`
4496
+
4497
+ Toggle dimension/measure by name
4498
+
4499
+ Enable, disable, or toggle a dimension or measure by its name
4500
+
4501
+ **Payload schema**
4502
+
4503
+ ```json
4504
+ {
4505
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4506
+ "title": "Toggle dimension or measure by name schema",
4507
+ "type": "object",
4508
+ "properties": {
4509
+ "name": {
4510
+ "type": "string"
4511
+ },
4512
+ "operation": {
4513
+ "type": "string",
4514
+ "enum": ["enable", "disable", "toggle"]
4515
+ }
4516
+ },
4517
+ "required": ["name", "operation"],
4518
+ "additionalProperties": false
4519
+ }
4520
+ ```
4521
+
4522
+ ## `toggleMeasure`
4523
+
4524
+ Toggle measure
4525
+
4526
+ Enable or disable a measure in the chart
4527
+
4528
+ **Payload schema**
4529
+
4530
+ ```json
4531
+ {
4532
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4533
+ "title": "Toggle measure schema",
4534
+ "type": "object",
4535
+ "properties": {
4536
+ "dataItemInternalKey": {
4537
+ "description": "Internal key of the data item of the measure to be toggled",
4538
+ "type": "string"
4539
+ },
4540
+ "dataItemUniqueSignature": {
4541
+ "description": "Unique signature of the data item of the measure to be toggled",
4542
+ "type": "string"
4543
+ }
4544
+ },
4545
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature"],
4546
+ "additionalProperties": false
4547
+ }
4548
+ ```
4549
+
4550
+ ## `updateDimension`
4551
+
4552
+ Update dimension
4553
+
4554
+ Modify properties of an existing dimension
4555
+
4556
+ **Payload schema**
4557
+
4558
+ ```json
4559
+ {
4560
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4561
+ "title": "Update dimension schema",
4562
+ "type": "object",
4563
+ "properties": {
4564
+ "dataItemInternalKey": {
4565
+ "description": "Internal key of the data item of the dimension to be updated",
4566
+ "type": "string"
4567
+ },
4568
+ "dataItemUniqueSignature": {
4569
+ "description": "Unique signature of the data item of the dimension to be updated",
4570
+ "type": "string"
4571
+ },
4572
+ "changes": {
4573
+ "type": "object",
4574
+ "properties": {
4575
+ "customLabel": {
4576
+ "type": "object",
4577
+ "properties": {
4578
+ "enabled": {
4579
+ "type": "boolean"
4580
+ },
4581
+ "value": {
4582
+ "type": "string"
4583
+ }
4584
+ },
4585
+ "required": ["enabled"],
4586
+ "additionalProperties": false
4587
+ },
4588
+ "showNullValues": {
4589
+ "type": "boolean"
4590
+ }
4591
+ },
4592
+ "additionalProperties": false
4593
+ }
4594
+ },
4595
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
4596
+ "additionalProperties": false
4597
+ }
4598
+ ```
4599
+
4600
+ ## `updateMeasure`
4601
+
4602
+ Update measure
4603
+
4604
+ Modify properties of an existing measure
4605
+
4606
+ **Payload schema**
4607
+
4608
+ ```json
4609
+ {
4610
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4611
+ "title": "Update measure schema",
4612
+ "type": "object",
4613
+ "properties": {
4614
+ "dataItemInternalKey": {
4615
+ "description": "Internal key of the data item of the measure to be updated",
4616
+ "type": "string"
4617
+ },
4618
+ "dataItemUniqueSignature": {
4619
+ "description": "Unique signature of the data item of the measure to be updated",
4620
+ "type": "string"
4621
+ },
4622
+ "changes": {
4623
+ "type": "object",
4624
+ "properties": {
4625
+ "customLabel": {
4626
+ "type": "object",
4627
+ "properties": {
4628
+ "enabled": {
4629
+ "type": "boolean"
4630
+ },
4631
+ "value": {
4632
+ "type": "string"
4633
+ }
4634
+ },
4635
+ "required": ["enabled"],
4636
+ "additionalProperties": false
4637
+ }
4638
+ },
4639
+ "required": ["customLabel"],
4640
+ "additionalProperties": false
4641
+ }
4642
+ },
4643
+ "required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
4644
+ "additionalProperties": false
4645
+ }
4646
+ ```