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