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