@astrato-io/visualizations 0.0.0-stage → 0.6.5

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