@nebula.js/sn-pivot-table 7.65.0 → 7.67.0
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/api-specifications/properties.json +1 -1
- package/api-specifications/sn-pivot-table.json +4419 -0
- package/core/esm/index.js +6 -6
- package/dist/sn-pivot-table.js +9 -9
- package/dist/sn-pivot-table.systemjs.js +8 -8
- package/package.json +7 -7
- package/sn-pivot-table-ext/dist/sn-pivot-table.js +9 -9
- package/sn-pivot-table-ext/sn-pivot-table.qext +1 -1
|
@@ -0,0 +1,4419 @@
|
|
|
1
|
+
{
|
|
2
|
+
"x-schema-version": "7.67.0",
|
|
3
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4
|
+
"$id": "sn-pivot-table.json",
|
|
5
|
+
"$defs": {
|
|
6
|
+
"/schemas/PivotTableProperties": {
|
|
7
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8
|
+
"$id": "/schemas/PivotTableProperties",
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"version": {
|
|
12
|
+
"type": "string",
|
|
13
|
+
"description": "Object-definition version set by the runtime; preserve during updates."
|
|
14
|
+
},
|
|
15
|
+
"qInfo": {
|
|
16
|
+
"$ref": "NxInfo.json",
|
|
17
|
+
"default": {
|
|
18
|
+
"qType": "sn-pivot-table"
|
|
19
|
+
},
|
|
20
|
+
"description": "Generic object identity. qId is assigned by the engine if omitted; qType should be sn-pivot-table."
|
|
21
|
+
},
|
|
22
|
+
"qHyperCubeDef": {
|
|
23
|
+
"$ref": "SnPivotTableHyperCubeDef.json",
|
|
24
|
+
"default": {
|
|
25
|
+
"qDimensions": [],
|
|
26
|
+
"qMeasures": [],
|
|
27
|
+
"qInterColumnSortOrder": [],
|
|
28
|
+
"qMode": "P",
|
|
29
|
+
"qAlwaysFullyExpanded": false,
|
|
30
|
+
"qSuppressMissing": true,
|
|
31
|
+
"qSuppressZero": false,
|
|
32
|
+
"qShowTotalsAbove": true,
|
|
33
|
+
"qInitialDataFetch": [
|
|
34
|
+
{
|
|
35
|
+
"qLeft": 0,
|
|
36
|
+
"qTop": 0,
|
|
37
|
+
"qWidth": 50,
|
|
38
|
+
"qHeight": 50
|
|
39
|
+
}
|
|
40
|
+
],
|
|
41
|
+
"qIndentMode": false
|
|
42
|
+
},
|
|
43
|
+
"description": "Hypercube definition and pivot-specific column metadata."
|
|
44
|
+
},
|
|
45
|
+
"showTitles": {
|
|
46
|
+
"type": "boolean",
|
|
47
|
+
"default": true,
|
|
48
|
+
"description": "Whether title, subtitle, and footnote should be rendered. Set title/subtitle/footnote separately for their content."
|
|
49
|
+
},
|
|
50
|
+
"title": {
|
|
51
|
+
"$ref": "ClientStringExpression.json",
|
|
52
|
+
"default": "",
|
|
53
|
+
"description": "Main chart title. Used only when showTitles is true; may be a plain string or expression value."
|
|
54
|
+
},
|
|
55
|
+
"subtitle": {
|
|
56
|
+
"$ref": "ClientStringExpression.json",
|
|
57
|
+
"default": "",
|
|
58
|
+
"description": "Chart subtitle. Used only when showTitles is true; may be a plain string or expression value."
|
|
59
|
+
},
|
|
60
|
+
"footnote": {
|
|
61
|
+
"$ref": "ClientStringExpression.json",
|
|
62
|
+
"default": "",
|
|
63
|
+
"description": "Chart footnote. Used only when showTitles is true; may be a plain string or expression value."
|
|
64
|
+
},
|
|
65
|
+
"disableNavMenu": {
|
|
66
|
+
"type": "boolean",
|
|
67
|
+
"default": false,
|
|
68
|
+
"description": "Navigation menu toggle. Newly created table objects start with navigation enabled."
|
|
69
|
+
},
|
|
70
|
+
"showDetails": {
|
|
71
|
+
"type": "boolean",
|
|
72
|
+
"default": true,
|
|
73
|
+
"description": "Details toggle. Newly created table objects start with details enabled."
|
|
74
|
+
},
|
|
75
|
+
"showDetailsExpression": {
|
|
76
|
+
"type": "boolean",
|
|
77
|
+
"default": false,
|
|
78
|
+
"description": "Expression-backed details toggle. Newly created table objects start with expression details disabled."
|
|
79
|
+
},
|
|
80
|
+
"enableChartExploration": {
|
|
81
|
+
"anyOf": [
|
|
82
|
+
{
|
|
83
|
+
"type": "boolean"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"type": "null"
|
|
87
|
+
}
|
|
88
|
+
],
|
|
89
|
+
"default": false,
|
|
90
|
+
"description": "Enable exploration UI/state; legacy objects may use `null`. Enabled state may be stored in `qHyperCubeDef.qLayoutExclude`."
|
|
91
|
+
},
|
|
92
|
+
"chartExploration": {
|
|
93
|
+
"$ref": "ChartExplorationProperties.json",
|
|
94
|
+
"description": "Chart exploration menu settings. Used with `enableChartExploration`."
|
|
95
|
+
},
|
|
96
|
+
"nullValueRepresentation": {
|
|
97
|
+
"$ref": "NullValueRepresentationDef.json",
|
|
98
|
+
"default": {
|
|
99
|
+
"text": "-"
|
|
100
|
+
},
|
|
101
|
+
"description": "Null display: `text` for measures; `dimensionText` for dimensions when separate null styling is enabled."
|
|
102
|
+
},
|
|
103
|
+
"components": {
|
|
104
|
+
"type": "array",
|
|
105
|
+
"items": {
|
|
106
|
+
"$ref": "Component.json"
|
|
107
|
+
},
|
|
108
|
+
"default": [],
|
|
109
|
+
"description": "General table styling; dimension/measure column styling takes precedence."
|
|
110
|
+
},
|
|
111
|
+
"visualization": {
|
|
112
|
+
"type": "string",
|
|
113
|
+
"const": "sn-pivot-table",
|
|
114
|
+
"default": "sn-pivot-table",
|
|
115
|
+
"description": "Visualization type marker used by migration and Sense-client compatibility flows."
|
|
116
|
+
},
|
|
117
|
+
"filters": {
|
|
118
|
+
"type": "array",
|
|
119
|
+
"items": {
|
|
120
|
+
"$ref": "Filter.json"
|
|
121
|
+
},
|
|
122
|
+
"description": "Filter definitions applied through `qHyperCubeDef.qContextSetExpression`. Keep this list synchronized with that expression when mutating filters directly."
|
|
123
|
+
},
|
|
124
|
+
"search": {
|
|
125
|
+
"$ref": "SearchProperties.json",
|
|
126
|
+
"description": "Search behavior exposed by the pivot table layout."
|
|
127
|
+
},
|
|
128
|
+
"qLayoutExclude": {
|
|
129
|
+
"$ref": "PropertiesLayoutExclude.json",
|
|
130
|
+
"description": "Object-level excluded/quarantined metadata preserved by legacy pivot table conversion flows."
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"required": [
|
|
134
|
+
"qHyperCubeDef",
|
|
135
|
+
"visualization"
|
|
136
|
+
],
|
|
137
|
+
"allOf": [
|
|
138
|
+
{
|
|
139
|
+
"$ref": "GenericObjectProperties.json"
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"description": "Persisted properties for an sn-pivot-table generic object."
|
|
143
|
+
},
|
|
144
|
+
"NxInfo": {
|
|
145
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
146
|
+
"$id": "NxInfo.json",
|
|
147
|
+
"type": "object",
|
|
148
|
+
"properties": {
|
|
149
|
+
"qId": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"description": "Identifier of the object. If the chosen identifier is already in use, the engine automatically sets another one. If an identifier is not set, the engine automatically sets one. This parameter is optional."
|
|
152
|
+
},
|
|
153
|
+
"qType": {
|
|
154
|
+
"type": "string",
|
|
155
|
+
"description": "Type of the object. This parameter is mandatory."
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
"description": "NxInfo"
|
|
159
|
+
},
|
|
160
|
+
"SnPivotTableHyperCubeDef": {
|
|
161
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
162
|
+
"$id": "SnPivotTableHyperCubeDef.json",
|
|
163
|
+
"type": "object",
|
|
164
|
+
"properties": {
|
|
165
|
+
"qStateName": {
|
|
166
|
+
"type": "string",
|
|
167
|
+
"description": "Name of the alternate state. Default is current selections _$_ ."
|
|
168
|
+
},
|
|
169
|
+
"qReductionMode": {
|
|
170
|
+
"$ref": "NxDataReductionMode.json",
|
|
171
|
+
"description": "One of: * N or DATA_REDUCTION_NONE * D1 or DATA_REDUCTION_ONEDIM * S or DATA_REDUCTION_SCATTERED * C or DATA_REDUCTION_CLUSTERED * ST or DATA_REDUCTION_STACKED"
|
|
172
|
+
},
|
|
173
|
+
"qMaxStackedCells": {
|
|
174
|
+
"type": "integer",
|
|
175
|
+
"minimum": -2147483648,
|
|
176
|
+
"maximum": 2147483647,
|
|
177
|
+
"description": "Maximum number of cells for an initial data fetch (set in _qInitialDataFetch_ ) when in stacked mode ( _qMode_ is K). The default value is 5000."
|
|
178
|
+
},
|
|
179
|
+
"qPopulateMissing": {
|
|
180
|
+
"type": "boolean",
|
|
181
|
+
"description": "If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false."
|
|
182
|
+
},
|
|
183
|
+
"qCalcCond": {
|
|
184
|
+
"$ref": "ValueExpr.json",
|
|
185
|
+
"description": "Specifies a calculation condition, which must be fulfilled for the hypercube to be (re)calculated. As long as the condition is not met, the engine does not perform a new calculation. This property is optional. By default, there is no calculation condition."
|
|
186
|
+
},
|
|
187
|
+
"qSortbyYValue": {
|
|
188
|
+
"type": "integer",
|
|
189
|
+
"minimum": -2147483648,
|
|
190
|
+
"maximum": 2147483647,
|
|
191
|
+
"description": "To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table."
|
|
192
|
+
},
|
|
193
|
+
"qTitle": {
|
|
194
|
+
"$ref": "StringExpr.json",
|
|
195
|
+
"description": "Title of the hypercube, for example the title of a chart."
|
|
196
|
+
},
|
|
197
|
+
"qCalcCondition": {
|
|
198
|
+
"$ref": "NxCalcCond.json",
|
|
199
|
+
"description": "Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the hypercube is not calculated and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional."
|
|
200
|
+
},
|
|
201
|
+
"qColumnOrder": {
|
|
202
|
+
"type": "array",
|
|
203
|
+
"items": {
|
|
204
|
+
"type": "integer",
|
|
205
|
+
"minimum": -2147483648,
|
|
206
|
+
"maximum": 2147483647
|
|
207
|
+
},
|
|
208
|
+
"description": "The order of the columns."
|
|
209
|
+
},
|
|
210
|
+
"qExpansionState": {
|
|
211
|
+
"type": "array",
|
|
212
|
+
"items": {
|
|
213
|
+
"$ref": "ExpansionData.json"
|
|
214
|
+
},
|
|
215
|
+
"description": "Expansion state per dimension for pivot mode ( _qMode_ is P)."
|
|
216
|
+
},
|
|
217
|
+
"qDynamicScript": {
|
|
218
|
+
"type": "array",
|
|
219
|
+
"items": {
|
|
220
|
+
"type": "string"
|
|
221
|
+
},
|
|
222
|
+
"description": "Hypercube Modifier Dynamic script string"
|
|
223
|
+
},
|
|
224
|
+
"qContextSetExpression": {
|
|
225
|
+
"type": "string",
|
|
226
|
+
"description": "Set expression valid for the whole cube, limiting computations to the specified set."
|
|
227
|
+
},
|
|
228
|
+
"qSuppressMeasureTotals": {
|
|
229
|
+
"type": "boolean",
|
|
230
|
+
"description": "When true, suppresses any grand totals for measures, regardless of the AggrFunc setting."
|
|
231
|
+
},
|
|
232
|
+
"qDimensions": {
|
|
233
|
+
"type": "array",
|
|
234
|
+
"items": {
|
|
235
|
+
"$ref": "DimensionProperties.json"
|
|
236
|
+
},
|
|
237
|
+
"description": "Active dimensions. Reorder the array, `qInterColumnSortOrder`, and matching `rankedList` section together.\nRow/column moves also update `qNoOfLeftDims` and transfer the `cId` between `rankedList.rows`/`columns`;\npartial updates corrupt state."
|
|
238
|
+
},
|
|
239
|
+
"qMeasures": {
|
|
240
|
+
"type": "array",
|
|
241
|
+
"items": {
|
|
242
|
+
"$ref": "MeasureProperties.json"
|
|
243
|
+
},
|
|
244
|
+
"description": "Active measures; sync reorders with `qInterColumnSortOrder` and `rankedList.measures`, as for `qDimensions`.\nCrossing the 1/2-measure boundary adds/removes `-1` in `qInterColumnSortOrder` and the matching `rankedList.rows`/`columns`."
|
|
245
|
+
},
|
|
246
|
+
"qInterColumnSortOrder": {
|
|
247
|
+
"type": "array",
|
|
248
|
+
"items": {
|
|
249
|
+
"type": "integer",
|
|
250
|
+
"minimum": -2147483648,
|
|
251
|
+
"maximum": 2147483647
|
|
252
|
+
},
|
|
253
|
+
"description": "Sort-priority indexes into `qDimensions` followed by `qMeasures`; sync with dimension order and `rankedList`.\nInclude the `-1` pseudo-dimension only with 2+ measures."
|
|
254
|
+
},
|
|
255
|
+
"qNoOfLeftDims": {
|
|
256
|
+
"type": "integer",
|
|
257
|
+
"minimum": -2147483648,
|
|
258
|
+
"maximum": 2147483647,
|
|
259
|
+
"description": "Row-dimension count in `qInterColumnSortOrder`; remaining dimensions are columns.\nIncrement/decrement when moving a dimension into/out of rows; see `qDimensions`."
|
|
260
|
+
},
|
|
261
|
+
"qPseudoDimPos": {
|
|
262
|
+
"type": "integer",
|
|
263
|
+
"minimum": -2147483648,
|
|
264
|
+
"maximum": 2147483647,
|
|
265
|
+
"description": "Unused by sn-pivot-table. Actual pseudo-dimension position is the `-1` index in `qInterColumnSortOrder`; `qNoOfLeftDims` determines its row/column placement."
|
|
266
|
+
},
|
|
267
|
+
"qMode": {
|
|
268
|
+
"type": "string",
|
|
269
|
+
"const": "P",
|
|
270
|
+
"default": "P",
|
|
271
|
+
"description": "Hypercube mode. sn-pivot-table uses pivot mode."
|
|
272
|
+
},
|
|
273
|
+
"customErrorMessage": {
|
|
274
|
+
"$ref": "CustomErrorMessage.json",
|
|
275
|
+
"description": "Client-side custom calculation-condition error message."
|
|
276
|
+
},
|
|
277
|
+
"qAlwaysFullyExpanded": {
|
|
278
|
+
"type": "boolean",
|
|
279
|
+
"default": false,
|
|
280
|
+
"description": "Whether cells are always expanded, disabling manual expand/collapse of dimension groups."
|
|
281
|
+
},
|
|
282
|
+
"qSuppressMissing": {
|
|
283
|
+
"type": "boolean",
|
|
284
|
+
"default": true,
|
|
285
|
+
"description": "Remove rows with missing dimension values."
|
|
286
|
+
},
|
|
287
|
+
"qSuppressZero": {
|
|
288
|
+
"type": "boolean",
|
|
289
|
+
"default": false,
|
|
290
|
+
"description": "Remove rows where all measure values are zero."
|
|
291
|
+
},
|
|
292
|
+
"qShowTotalsAbove": {
|
|
293
|
+
"type": "boolean",
|
|
294
|
+
"default": true,
|
|
295
|
+
"description": "Totals above rather than below groups; treated as true in `qIndentMode`."
|
|
296
|
+
},
|
|
297
|
+
"qInitialDataFetch": {
|
|
298
|
+
"type": "array",
|
|
299
|
+
"items": {
|
|
300
|
+
"$ref": "NxPage.json"
|
|
301
|
+
},
|
|
302
|
+
"default": [
|
|
303
|
+
{
|
|
304
|
+
"qLeft": 0,
|
|
305
|
+
"qTop": 0,
|
|
306
|
+
"qWidth": 50,
|
|
307
|
+
"qHeight": 50
|
|
308
|
+
}
|
|
309
|
+
],
|
|
310
|
+
"description": "Initial data fetch window. qLeft/qTop should start at 0 for a newly created pivot table."
|
|
311
|
+
},
|
|
312
|
+
"qIndentMode": {
|
|
313
|
+
"type": "boolean",
|
|
314
|
+
"default": false,
|
|
315
|
+
"description": "Indent row dimensions in one column instead of separate columns; forces panel `qShowTotalsAbove` true."
|
|
316
|
+
},
|
|
317
|
+
"indentModeColumnWidth": {
|
|
318
|
+
"$ref": "ColumnWidth.json",
|
|
319
|
+
"description": "Column width used for the single indented dimension column when `qIndentMode` is true."
|
|
320
|
+
},
|
|
321
|
+
"excludedNoOfLeftDims": {
|
|
322
|
+
"type": "integer",
|
|
323
|
+
"minimum": -2147483648,
|
|
324
|
+
"maximum": 2147483647,
|
|
325
|
+
"description": "Row count in `qLayoutExclude.qHyperCubeDef.qDimensions`, analogous to `qNoOfLeftDims`. Increment/decrement on excluded row additions/removals; columns do not affect it."
|
|
326
|
+
},
|
|
327
|
+
"columnWidths": {
|
|
328
|
+
"type": "array",
|
|
329
|
+
"items": {
|
|
330
|
+
"type": "number"
|
|
331
|
+
},
|
|
332
|
+
"description": "Legacy per-column widths by active column index. Prefer qDef.columnWidth on dimensions/measures for new metadata.",
|
|
333
|
+
"deprecated": true
|
|
334
|
+
},
|
|
335
|
+
"rankedList": {
|
|
336
|
+
"$ref": "RankedList.json",
|
|
337
|
+
"description": "Chart-exploration row/column/measure ordering, referencing active or excluded column `cId` values."
|
|
338
|
+
},
|
|
339
|
+
"qLayoutExclude": {
|
|
340
|
+
"$ref": "HyperCubeLayoutExclude.json",
|
|
341
|
+
"description": "Excluded-column metadata used by chart exploration."
|
|
342
|
+
}
|
|
343
|
+
},
|
|
344
|
+
"required": [
|
|
345
|
+
"qDimensions",
|
|
346
|
+
"qMeasures",
|
|
347
|
+
"qInterColumnSortOrder",
|
|
348
|
+
"qMode"
|
|
349
|
+
],
|
|
350
|
+
"description": "sn-pivot-table uses its client-side `indentModeColumnWidth` only while `qIndentMode` is enabled."
|
|
351
|
+
},
|
|
352
|
+
"NxDataReductionMode": {
|
|
353
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
354
|
+
"$id": "NxDataReductionMode.json",
|
|
355
|
+
"anyOf": [
|
|
356
|
+
{
|
|
357
|
+
"type": "string",
|
|
358
|
+
"const": "DATA_REDUCTION_NONE"
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"type": "string",
|
|
362
|
+
"const": "DATA_REDUCTION_ONEDIM"
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"type": "string",
|
|
366
|
+
"const": "DATA_REDUCTION_SCATTERED"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"type": "string",
|
|
370
|
+
"const": "DATA_REDUCTION_CLUSTERED"
|
|
371
|
+
},
|
|
372
|
+
{
|
|
373
|
+
"type": "string",
|
|
374
|
+
"const": "DATA_REDUCTION_STACKED"
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
"type": "string",
|
|
378
|
+
"const": "N"
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"type": "string",
|
|
382
|
+
"const": "D1"
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"type": "string",
|
|
386
|
+
"const": "S"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"type": "string",
|
|
390
|
+
"const": "C"
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"type": "string",
|
|
394
|
+
"const": "ST"
|
|
395
|
+
}
|
|
396
|
+
],
|
|
397
|
+
"description": "NxDataReductionMode"
|
|
398
|
+
},
|
|
399
|
+
"ValueExpr": {
|
|
400
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
401
|
+
"$id": "ValueExpr.json",
|
|
402
|
+
"type": "object",
|
|
403
|
+
"properties": {
|
|
404
|
+
"qv": {
|
|
405
|
+
"type": "string",
|
|
406
|
+
"description": "Expression evaluated to dual."
|
|
407
|
+
}
|
|
408
|
+
},
|
|
409
|
+
"description": "ValueExpr"
|
|
410
|
+
},
|
|
411
|
+
"StringExpr": {
|
|
412
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
413
|
+
"$id": "StringExpr.json",
|
|
414
|
+
"type": "object",
|
|
415
|
+
"properties": {
|
|
416
|
+
"qv": {
|
|
417
|
+
"type": "string",
|
|
418
|
+
"description": "Expression evaluated to string."
|
|
419
|
+
}
|
|
420
|
+
},
|
|
421
|
+
"description": "StringExpr"
|
|
422
|
+
},
|
|
423
|
+
"NxCalcCond": {
|
|
424
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
425
|
+
"$id": "NxCalcCond.json",
|
|
426
|
+
"type": "object",
|
|
427
|
+
"properties": {
|
|
428
|
+
"qCond": {
|
|
429
|
+
"$ref": "ValueExpr.json",
|
|
430
|
+
"description": "Condition for calculating an hypercube, dimension or measure."
|
|
431
|
+
},
|
|
432
|
+
"qMsg": {
|
|
433
|
+
"$ref": "StringExpr.json",
|
|
434
|
+
"description": "Evaluated if Cond is not fullfilled."
|
|
435
|
+
}
|
|
436
|
+
},
|
|
437
|
+
"description": "NxCalcCond"
|
|
438
|
+
},
|
|
439
|
+
"ExpansionData": {
|
|
440
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
441
|
+
"$id": "ExpansionData.json",
|
|
442
|
+
"type": "object",
|
|
443
|
+
"properties": {
|
|
444
|
+
"qExcludeList": {
|
|
445
|
+
"type": "boolean"
|
|
446
|
+
},
|
|
447
|
+
"qPos": {
|
|
448
|
+
"$ref": "PositionMark.json"
|
|
449
|
+
}
|
|
450
|
+
},
|
|
451
|
+
"description": "ExpansionData"
|
|
452
|
+
},
|
|
453
|
+
"PositionMark": {
|
|
454
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
455
|
+
"$id": "PositionMark.json",
|
|
456
|
+
"type": "object",
|
|
457
|
+
"properties": {
|
|
458
|
+
"qDimName": {
|
|
459
|
+
"type": "string"
|
|
460
|
+
},
|
|
461
|
+
"qElemNo": {
|
|
462
|
+
"type": "array",
|
|
463
|
+
"items": {
|
|
464
|
+
"type": "integer",
|
|
465
|
+
"minimum": -2147483648,
|
|
466
|
+
"maximum": 2147483647
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
"qElemValues": {
|
|
470
|
+
"type": "array",
|
|
471
|
+
"items": {
|
|
472
|
+
"type": "string"
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
"description": "PositionMark"
|
|
477
|
+
},
|
|
478
|
+
"DimensionProperties": {
|
|
479
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
480
|
+
"$id": "DimensionProperties.json",
|
|
481
|
+
"type": "object",
|
|
482
|
+
"properties": {
|
|
483
|
+
"qLibraryId": {
|
|
484
|
+
"type": "string",
|
|
485
|
+
"description": "Library dimension id. Omit `qDef.qFieldDefs`/`qDef.qFieldLabels` when set; both are required for field dimensions otherwise."
|
|
486
|
+
},
|
|
487
|
+
"qDef": {
|
|
488
|
+
"$ref": "InlineDimensionDef.json",
|
|
489
|
+
"description": "Dimension definition. Field dimensions require `qFieldDefs`/`qFieldLabels`; all dimensions require `cId`."
|
|
490
|
+
},
|
|
491
|
+
"qAttributeExpressions": {
|
|
492
|
+
"type": "array",
|
|
493
|
+
"items": {
|
|
494
|
+
"$ref": "AttributeExpressionProperties.json"
|
|
495
|
+
},
|
|
496
|
+
"default": [],
|
|
497
|
+
"description": "Required attribute expressions; use `[]` without cell styling expressions."
|
|
498
|
+
}
|
|
499
|
+
},
|
|
500
|
+
"required": [
|
|
501
|
+
"qDef",
|
|
502
|
+
"qAttributeExpressions"
|
|
503
|
+
],
|
|
504
|
+
"allOf": [
|
|
505
|
+
{
|
|
506
|
+
"$ref": "NxDimension.json"
|
|
507
|
+
}
|
|
508
|
+
]
|
|
509
|
+
},
|
|
510
|
+
"InlineDimensionDef": {
|
|
511
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
512
|
+
"$id": "InlineDimensionDef.json",
|
|
513
|
+
"type": "object",
|
|
514
|
+
"properties": {
|
|
515
|
+
"cId": {
|
|
516
|
+
"type": "string",
|
|
517
|
+
"description": "Stable, unique column id. Preserve during edits; replace dimensions by removing and adding, not by changing `cId`."
|
|
518
|
+
},
|
|
519
|
+
"textAlign": {
|
|
520
|
+
"$ref": "TextAlign.json",
|
|
521
|
+
"description": "Dimension cell alignment; `align` applies when `auto` is false."
|
|
522
|
+
},
|
|
523
|
+
"labelTextAlign": {
|
|
524
|
+
"$ref": "TextAlign.json",
|
|
525
|
+
"description": "Dimension header text alignment."
|
|
526
|
+
},
|
|
527
|
+
"columnWidth": {
|
|
528
|
+
"$ref": "ColumnWidth.json",
|
|
529
|
+
"description": "Dimension column width; set the width field matching `type`."
|
|
530
|
+
},
|
|
531
|
+
"representation": {
|
|
532
|
+
"$ref": "RepresentationProperties.json",
|
|
533
|
+
"description": "Client-side value representation; set fields matching `type`."
|
|
534
|
+
},
|
|
535
|
+
"othersLabel": {
|
|
536
|
+
"type": "string",
|
|
537
|
+
"description": "Property-panel label for the `Others` group. Used when `qOtherTotalSpec` enables dimension limits."
|
|
538
|
+
},
|
|
539
|
+
"headerColor": {
|
|
540
|
+
"$ref": "HeaderColorExpression.json",
|
|
541
|
+
"description": "Dimension header color expressions overriding general header styling."
|
|
542
|
+
},
|
|
543
|
+
"autoSort": {
|
|
544
|
+
"type": "boolean",
|
|
545
|
+
"default": true,
|
|
546
|
+
"description": "Automatic sorting. Set false with manual `qSortCriterias` to avoid conflicting property-panel modes. Default: true."
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
"required": [
|
|
550
|
+
"cId"
|
|
551
|
+
],
|
|
552
|
+
"allOf": [
|
|
553
|
+
{
|
|
554
|
+
"$ref": "NxInlineDimensionDef.json"
|
|
555
|
+
}
|
|
556
|
+
]
|
|
557
|
+
},
|
|
558
|
+
"TextAlign": {
|
|
559
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
560
|
+
"$id": "TextAlign.json",
|
|
561
|
+
"type": "object",
|
|
562
|
+
"properties": {
|
|
563
|
+
"auto": {
|
|
564
|
+
"type": "boolean",
|
|
565
|
+
"description": "Whether the table should derive alignment from the cell content. When `false`, the `align` value is used directly."
|
|
566
|
+
},
|
|
567
|
+
"align": {
|
|
568
|
+
"anyOf": [
|
|
569
|
+
{
|
|
570
|
+
"type": "string",
|
|
571
|
+
"const": "left"
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"type": "string",
|
|
575
|
+
"const": "center"
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"type": "string",
|
|
579
|
+
"const": "right"
|
|
580
|
+
}
|
|
581
|
+
],
|
|
582
|
+
"description": "Alignment value used when `auto` is false and as the fallback value when `auto` is true."
|
|
583
|
+
}
|
|
584
|
+
},
|
|
585
|
+
"required": [
|
|
586
|
+
"auto",
|
|
587
|
+
"align"
|
|
588
|
+
]
|
|
589
|
+
},
|
|
590
|
+
"ColumnWidth": {
|
|
591
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
592
|
+
"$id": "ColumnWidth.json",
|
|
593
|
+
"anyOf": [
|
|
594
|
+
{
|
|
595
|
+
"$ref": "AutomaticColumnWidth.json"
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"$ref": "FitToContentColumnWidth.json"
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
"$ref": "PixelColumnWidth.json"
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
"$ref": "PercentageColumnWidth.json"
|
|
605
|
+
}
|
|
606
|
+
]
|
|
607
|
+
},
|
|
608
|
+
"AutomaticColumnWidth": {
|
|
609
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
610
|
+
"$id": "AutomaticColumnWidth.json",
|
|
611
|
+
"type": "object",
|
|
612
|
+
"properties": {
|
|
613
|
+
"type": {
|
|
614
|
+
"type": "string",
|
|
615
|
+
"const": "auto",
|
|
616
|
+
"description": "Automatic column width. The table chooses the width."
|
|
617
|
+
}
|
|
618
|
+
},
|
|
619
|
+
"required": [
|
|
620
|
+
"type"
|
|
621
|
+
]
|
|
622
|
+
},
|
|
623
|
+
"FitToContentColumnWidth": {
|
|
624
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
625
|
+
"$id": "FitToContentColumnWidth.json",
|
|
626
|
+
"type": "object",
|
|
627
|
+
"properties": {
|
|
628
|
+
"type": {
|
|
629
|
+
"type": "string",
|
|
630
|
+
"const": "fitToContent",
|
|
631
|
+
"description": "Content-fitting column width. The table sizes the column from its content."
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
"required": [
|
|
635
|
+
"type"
|
|
636
|
+
]
|
|
637
|
+
},
|
|
638
|
+
"PixelColumnWidth": {
|
|
639
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
640
|
+
"$id": "PixelColumnWidth.json",
|
|
641
|
+
"type": "object",
|
|
642
|
+
"properties": {
|
|
643
|
+
"type": {
|
|
644
|
+
"type": "string",
|
|
645
|
+
"const": "pixels",
|
|
646
|
+
"description": "Pixel-based column width."
|
|
647
|
+
},
|
|
648
|
+
"pixels": {
|
|
649
|
+
"anyOf": [
|
|
650
|
+
{
|
|
651
|
+
"type": "number"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"type": "string"
|
|
655
|
+
}
|
|
656
|
+
],
|
|
657
|
+
"description": "Pixel width value."
|
|
658
|
+
}
|
|
659
|
+
},
|
|
660
|
+
"required": [
|
|
661
|
+
"type",
|
|
662
|
+
"pixels"
|
|
663
|
+
]
|
|
664
|
+
},
|
|
665
|
+
"PercentageColumnWidth": {
|
|
666
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
667
|
+
"$id": "PercentageColumnWidth.json",
|
|
668
|
+
"type": "object",
|
|
669
|
+
"properties": {
|
|
670
|
+
"type": {
|
|
671
|
+
"type": "string",
|
|
672
|
+
"const": "percentage",
|
|
673
|
+
"description": "Percentage-based column width."
|
|
674
|
+
},
|
|
675
|
+
"percentage": {
|
|
676
|
+
"anyOf": [
|
|
677
|
+
{
|
|
678
|
+
"type": "number"
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"type": "string"
|
|
682
|
+
}
|
|
683
|
+
],
|
|
684
|
+
"description": "Percentage width value."
|
|
685
|
+
}
|
|
686
|
+
},
|
|
687
|
+
"required": [
|
|
688
|
+
"type",
|
|
689
|
+
"percentage"
|
|
690
|
+
]
|
|
691
|
+
},
|
|
692
|
+
"RepresentationProperties": {
|
|
693
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
694
|
+
"$id": "RepresentationProperties.json",
|
|
695
|
+
"anyOf": [
|
|
696
|
+
{
|
|
697
|
+
"$ref": "TextRepresentationProperties.json"
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
"$ref": "LinkRepresentationProperties.json"
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"$ref": "ImageRepresentationProperties.json"
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
"$ref": "IndicatorRepresentationProperties.json"
|
|
707
|
+
},
|
|
708
|
+
{
|
|
709
|
+
"$ref": "MiniChartRepresentationProperties.json"
|
|
710
|
+
}
|
|
711
|
+
]
|
|
712
|
+
},
|
|
713
|
+
"TextRepresentationProperties": {
|
|
714
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
715
|
+
"$id": "TextRepresentationProperties.json",
|
|
716
|
+
"type": "object",
|
|
717
|
+
"properties": {
|
|
718
|
+
"type": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"const": "text",
|
|
721
|
+
"description": "Text representation. This branch has no representation-specific properties."
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
"required": [
|
|
725
|
+
"type"
|
|
726
|
+
]
|
|
727
|
+
},
|
|
728
|
+
"LinkRepresentationProperties": {
|
|
729
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
730
|
+
"$id": "LinkRepresentationProperties.json",
|
|
731
|
+
"type": "object",
|
|
732
|
+
"properties": {
|
|
733
|
+
"type": {
|
|
734
|
+
"type": "string",
|
|
735
|
+
"const": "url",
|
|
736
|
+
"description": "URL representation."
|
|
737
|
+
},
|
|
738
|
+
"urlPosition": {
|
|
739
|
+
"$ref": "UrlPosition.json",
|
|
740
|
+
"description": "`dimension`: cell URL with `urlLabel`; `attribute`: `linkUrl` with cell value as label."
|
|
741
|
+
},
|
|
742
|
+
"urlLabel": {
|
|
743
|
+
"$ref": "ClientStringExpression.json",
|
|
744
|
+
"description": "Link label or expression result."
|
|
745
|
+
},
|
|
746
|
+
"linkUrl": {
|
|
747
|
+
"$ref": "ClientStringExpression.json",
|
|
748
|
+
"description": "Link URL or expression result."
|
|
749
|
+
}
|
|
750
|
+
},
|
|
751
|
+
"required": [
|
|
752
|
+
"type"
|
|
753
|
+
]
|
|
754
|
+
},
|
|
755
|
+
"UrlPosition": {
|
|
756
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
757
|
+
"$id": "UrlPosition.json",
|
|
758
|
+
"anyOf": [
|
|
759
|
+
{
|
|
760
|
+
"type": "string",
|
|
761
|
+
"const": "dimension"
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"type": "string",
|
|
765
|
+
"const": "attribute"
|
|
766
|
+
}
|
|
767
|
+
]
|
|
768
|
+
},
|
|
769
|
+
"ClientStringExpression": {
|
|
770
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
771
|
+
"$id": "ClientStringExpression.json",
|
|
772
|
+
"anyOf": [
|
|
773
|
+
{
|
|
774
|
+
"type": "string"
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
"$ref": "StringExpression.json"
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"$ref": "ClientStringExpressionValue.json"
|
|
781
|
+
}
|
|
782
|
+
]
|
|
783
|
+
},
|
|
784
|
+
"StringExpression": {
|
|
785
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
786
|
+
"$id": "StringExpression.json",
|
|
787
|
+
"type": "object",
|
|
788
|
+
"properties": {
|
|
789
|
+
"qExpr": {
|
|
790
|
+
"type": "string"
|
|
791
|
+
}
|
|
792
|
+
},
|
|
793
|
+
"description": "### Properties\nAbbreviated syntax:\n\"qStringExpression\":\"=<expression>\"\nExtended object syntax:\n\"qStringExpression\":{\"qExpr\":\"=<expression>\"}\nWhere:\n< **expression** > is a string\n\n<div class=note>The \"=\" sign in the string expression is not mandatory. Even if the \"=\" sign is not given, the expression is evaluated.</div> <div class=note>A string expression is not evaluated, if the expression is surrounded by simple quotes.</div>\nThe result of the evaluation of the expression can be of any type, as it is returned as a JSON (quoted) string."
|
|
794
|
+
},
|
|
795
|
+
"ClientStringExpressionValue": {
|
|
796
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
797
|
+
"$id": "ClientStringExpressionValue.json",
|
|
798
|
+
"type": "object",
|
|
799
|
+
"properties": {
|
|
800
|
+
"qStringExpression": {
|
|
801
|
+
"$ref": "StringExpression.json",
|
|
802
|
+
"description": "Engine string expression wrapped by the client property format."
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
"required": [
|
|
806
|
+
"qStringExpression"
|
|
807
|
+
]
|
|
808
|
+
},
|
|
809
|
+
"ImageRepresentationProperties": {
|
|
810
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
811
|
+
"$id": "ImageRepresentationProperties.json",
|
|
812
|
+
"type": "object",
|
|
813
|
+
"properties": {
|
|
814
|
+
"type": {
|
|
815
|
+
"type": "string",
|
|
816
|
+
"const": "image",
|
|
817
|
+
"description": "Image representation."
|
|
818
|
+
},
|
|
819
|
+
"imageSetting": {
|
|
820
|
+
"anyOf": [
|
|
821
|
+
{
|
|
822
|
+
"type": "string",
|
|
823
|
+
"const": "url"
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"type": "string",
|
|
827
|
+
"const": "label"
|
|
828
|
+
}
|
|
829
|
+
],
|
|
830
|
+
"description": "Whether an image uses `imageUrl` or `imageLabel` as its source."
|
|
831
|
+
},
|
|
832
|
+
"imageLabel": {
|
|
833
|
+
"$ref": "ClientStringExpression.json",
|
|
834
|
+
"description": "Image label or expression result. Used when `imageSetting` is `label`."
|
|
835
|
+
},
|
|
836
|
+
"imageUrl": {
|
|
837
|
+
"$ref": "ClientStringExpression.json",
|
|
838
|
+
"description": "Image URL or expression result. Used when `imageSetting` is `url`."
|
|
839
|
+
},
|
|
840
|
+
"imageSize": {
|
|
841
|
+
"$ref": "ImageSize.json",
|
|
842
|
+
"description": "Image sizing mode."
|
|
843
|
+
},
|
|
844
|
+
"imagePosition": {
|
|
845
|
+
"$ref": "RepresentationImagePosition.json",
|
|
846
|
+
"description": "Image placement within the cell."
|
|
847
|
+
},
|
|
848
|
+
"imageBox": {
|
|
849
|
+
"$ref": "ImageBox.json",
|
|
850
|
+
"description": "Maximum image width when an explicit box is required."
|
|
851
|
+
}
|
|
852
|
+
},
|
|
853
|
+
"required": [
|
|
854
|
+
"type"
|
|
855
|
+
]
|
|
856
|
+
},
|
|
857
|
+
"ImageSize": {
|
|
858
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
859
|
+
"$id": "ImageSize.json",
|
|
860
|
+
"anyOf": [
|
|
861
|
+
{
|
|
862
|
+
"type": "string",
|
|
863
|
+
"const": "fitHeight"
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"type": "string",
|
|
867
|
+
"const": "fitWidth"
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
"type": "string",
|
|
871
|
+
"const": "alwaysFit"
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"type": "string",
|
|
875
|
+
"const": "fill"
|
|
876
|
+
},
|
|
877
|
+
{
|
|
878
|
+
"type": "string",
|
|
879
|
+
"const": "originalSize"
|
|
880
|
+
}
|
|
881
|
+
]
|
|
882
|
+
},
|
|
883
|
+
"RepresentationImagePosition": {
|
|
884
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
885
|
+
"$id": "RepresentationImagePosition.json",
|
|
886
|
+
"anyOf": [
|
|
887
|
+
{
|
|
888
|
+
"type": "string",
|
|
889
|
+
"const": "centerLeft"
|
|
890
|
+
},
|
|
891
|
+
{
|
|
892
|
+
"type": "string",
|
|
893
|
+
"const": "centerCenter"
|
|
894
|
+
},
|
|
895
|
+
{
|
|
896
|
+
"type": "string",
|
|
897
|
+
"const": "centerRight"
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
"type": "string",
|
|
901
|
+
"const": "topCenter"
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"type": "string",
|
|
905
|
+
"const": "bottomCenter"
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"type": "string",
|
|
909
|
+
"const": "topLeft"
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"type": "string",
|
|
913
|
+
"const": "bottomLeft"
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
"type": "string",
|
|
917
|
+
"const": "topRight"
|
|
918
|
+
},
|
|
919
|
+
{
|
|
920
|
+
"type": "string",
|
|
921
|
+
"const": "bottomRight"
|
|
922
|
+
}
|
|
923
|
+
]
|
|
924
|
+
},
|
|
925
|
+
"ImageBox": {
|
|
926
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
927
|
+
"$id": "ImageBox.json",
|
|
928
|
+
"type": "object",
|
|
929
|
+
"properties": {
|
|
930
|
+
"width": {
|
|
931
|
+
"type": "number",
|
|
932
|
+
"description": "Maximum image width in pixels. Used when the representation type is `image`."
|
|
933
|
+
}
|
|
934
|
+
},
|
|
935
|
+
"required": [
|
|
936
|
+
"width"
|
|
937
|
+
]
|
|
938
|
+
},
|
|
939
|
+
"IndicatorRepresentationProperties": {
|
|
940
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
941
|
+
"$id": "IndicatorRepresentationProperties.json",
|
|
942
|
+
"type": "object",
|
|
943
|
+
"properties": {
|
|
944
|
+
"type": {
|
|
945
|
+
"type": "string",
|
|
946
|
+
"const": "indicator",
|
|
947
|
+
"description": "Indicator representation."
|
|
948
|
+
},
|
|
949
|
+
"indicator": {
|
|
950
|
+
"$ref": "IndicatorRepresentation.json",
|
|
951
|
+
"description": "Indicator options for `type: \"indicator\"`; set parent measure `conditionalColoring` when `applySegmentColors` is true."
|
|
952
|
+
}
|
|
953
|
+
},
|
|
954
|
+
"required": [
|
|
955
|
+
"type"
|
|
956
|
+
]
|
|
957
|
+
},
|
|
958
|
+
"IndicatorRepresentation": {
|
|
959
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
960
|
+
"$id": "IndicatorRepresentation.json",
|
|
961
|
+
"type": "object",
|
|
962
|
+
"properties": {
|
|
963
|
+
"applySegmentColors": {
|
|
964
|
+
"type": "boolean",
|
|
965
|
+
"description": "Whether the indicator uses the measure `conditionalColoring` segments. Set `conditionalColoring` on the same measure when this is true."
|
|
966
|
+
},
|
|
967
|
+
"position": {
|
|
968
|
+
"anyOf": [
|
|
969
|
+
{
|
|
970
|
+
"type": "string",
|
|
971
|
+
"const": "right"
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"type": "string",
|
|
975
|
+
"const": "left"
|
|
976
|
+
}
|
|
977
|
+
],
|
|
978
|
+
"description": "Side on which the indicator is rendered."
|
|
979
|
+
},
|
|
980
|
+
"showTextValues": {
|
|
981
|
+
"type": "boolean",
|
|
982
|
+
"description": "Whether the numeric or text value is rendered alongside the indicator."
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
},
|
|
986
|
+
"MiniChartRepresentationProperties": {
|
|
987
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
988
|
+
"$id": "MiniChartRepresentationProperties.json",
|
|
989
|
+
"type": "object",
|
|
990
|
+
"properties": {
|
|
991
|
+
"type": {
|
|
992
|
+
"type": "string",
|
|
993
|
+
"const": "miniChart",
|
|
994
|
+
"description": "Mini-chart representation."
|
|
995
|
+
},
|
|
996
|
+
"miniChart": {
|
|
997
|
+
"$ref": "MiniChartRepresentation.json",
|
|
998
|
+
"description": "Mini-chart options for `type: \"miniChart\"`; sync with `qMiniChartDef`, which controls engine calculation."
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
1001
|
+
"required": [
|
|
1002
|
+
"type"
|
|
1003
|
+
]
|
|
1004
|
+
},
|
|
1005
|
+
"MiniChartRepresentation": {
|
|
1006
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1007
|
+
"$id": "MiniChartRepresentation.json",
|
|
1008
|
+
"type": "object",
|
|
1009
|
+
"properties": {
|
|
1010
|
+
"type": {
|
|
1011
|
+
"$ref": "MiniChartType.json",
|
|
1012
|
+
"description": "Mini-chart visualization type. Used when the parent representation type is `miniChart`."
|
|
1013
|
+
},
|
|
1014
|
+
"colors": {
|
|
1015
|
+
"$ref": "MiniChartColors.json",
|
|
1016
|
+
"description": "Optional colors for the mini-chart. `positive` and `negative` are relevant to the `posNeg` type."
|
|
1017
|
+
},
|
|
1018
|
+
"showDots": {
|
|
1019
|
+
"type": "boolean",
|
|
1020
|
+
"description": "Whether point markers are shown. Primarily used by sparkline mini charts."
|
|
1021
|
+
},
|
|
1022
|
+
"yAxis": {
|
|
1023
|
+
"$ref": "MiniChartYAxis.json",
|
|
1024
|
+
"description": "Optional y-axis scaling and zero-position settings."
|
|
1025
|
+
},
|
|
1026
|
+
"dimension": {
|
|
1027
|
+
"$ref": "MiniChartDimension.json",
|
|
1028
|
+
"description": "Panel dimension backup; sync with `qMiniChartDef`, which generates mini-chart data."
|
|
1029
|
+
}
|
|
1030
|
+
},
|
|
1031
|
+
"required": [
|
|
1032
|
+
"type"
|
|
1033
|
+
]
|
|
1034
|
+
},
|
|
1035
|
+
"MiniChartType": {
|
|
1036
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1037
|
+
"$id": "MiniChartType.json",
|
|
1038
|
+
"anyOf": [
|
|
1039
|
+
{
|
|
1040
|
+
"type": "string",
|
|
1041
|
+
"const": "bars"
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
"type": "string",
|
|
1045
|
+
"const": "sparkline"
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"type": "string",
|
|
1049
|
+
"const": "dots"
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
"type": "string",
|
|
1053
|
+
"const": "posNeg"
|
|
1054
|
+
}
|
|
1055
|
+
]
|
|
1056
|
+
},
|
|
1057
|
+
"MiniChartColors": {
|
|
1058
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1059
|
+
"$id": "MiniChartColors.json",
|
|
1060
|
+
"type": "object",
|
|
1061
|
+
"properties": {
|
|
1062
|
+
"main": {
|
|
1063
|
+
"$ref": "PaletteColor.json",
|
|
1064
|
+
"description": "Main mini-chart color. Used when the representation type is `miniChart`."
|
|
1065
|
+
},
|
|
1066
|
+
"max": {
|
|
1067
|
+
"$ref": "PaletteColor.json",
|
|
1068
|
+
"description": "Maximum-value mini-chart color."
|
|
1069
|
+
},
|
|
1070
|
+
"min": {
|
|
1071
|
+
"$ref": "PaletteColor.json",
|
|
1072
|
+
"description": "Minimum-value mini-chart color."
|
|
1073
|
+
},
|
|
1074
|
+
"first": {
|
|
1075
|
+
"$ref": "PaletteColor.json",
|
|
1076
|
+
"description": "First-value mini-chart color."
|
|
1077
|
+
},
|
|
1078
|
+
"last": {
|
|
1079
|
+
"$ref": "PaletteColor.json",
|
|
1080
|
+
"description": "Last-value mini-chart color."
|
|
1081
|
+
},
|
|
1082
|
+
"positive": {
|
|
1083
|
+
"$ref": "PaletteColor.json",
|
|
1084
|
+
"description": "Positive-value mini-chart color. Used by the `posNeg` mini-chart type."
|
|
1085
|
+
},
|
|
1086
|
+
"negative": {
|
|
1087
|
+
"$ref": "PaletteColor.json",
|
|
1088
|
+
"description": "Negative-value mini-chart color. Used by the `posNeg` mini-chart type."
|
|
1089
|
+
}
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
"PaletteColor": {
|
|
1093
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1094
|
+
"$id": "PaletteColor.json",
|
|
1095
|
+
"type": "object",
|
|
1096
|
+
"properties": {
|
|
1097
|
+
"color": {
|
|
1098
|
+
"type": "string",
|
|
1099
|
+
"description": "Color value, normally a hex string. Required when `index` is `-1` or when a custom color is used."
|
|
1100
|
+
},
|
|
1101
|
+
"index": {
|
|
1102
|
+
"type": "integer",
|
|
1103
|
+
"description": "Theme palette index. Use `-1` when `color` contains a custom color value."
|
|
1104
|
+
},
|
|
1105
|
+
"alpha": {
|
|
1106
|
+
"anyOf": [
|
|
1107
|
+
{
|
|
1108
|
+
"type": "number"
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"type": "string"
|
|
1112
|
+
}
|
|
1113
|
+
],
|
|
1114
|
+
"description": "Color opacity or alpha value. Existing properties may use either a numeric opacity or a string representation."
|
|
1115
|
+
},
|
|
1116
|
+
"icon": {
|
|
1117
|
+
"type": "string",
|
|
1118
|
+
"description": "Optional palette icon name for configuration UIs. This does not replace `color` or `index`."
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
},
|
|
1122
|
+
"MiniChartYAxis": {
|
|
1123
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1124
|
+
"$id": "MiniChartYAxis.json",
|
|
1125
|
+
"type": "object",
|
|
1126
|
+
"properties": {
|
|
1127
|
+
"scale": {
|
|
1128
|
+
"anyOf": [
|
|
1129
|
+
{
|
|
1130
|
+
"type": "string",
|
|
1131
|
+
"const": "local"
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
"type": "string",
|
|
1135
|
+
"const": "global"
|
|
1136
|
+
}
|
|
1137
|
+
],
|
|
1138
|
+
"description": "Scale scope for the mini-chart. `local` scales each row independently; `global` shares the scale across rows."
|
|
1139
|
+
},
|
|
1140
|
+
"position": {
|
|
1141
|
+
"anyOf": [
|
|
1142
|
+
{
|
|
1143
|
+
"type": "string",
|
|
1144
|
+
"const": "auto"
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"type": "string",
|
|
1148
|
+
"const": "zeroBaseline"
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"type": "string",
|
|
1152
|
+
"const": "zeroCenter"
|
|
1153
|
+
}
|
|
1154
|
+
],
|
|
1155
|
+
"description": "Zero-baseline behavior for the mini-chart. `auto` lets the table choose the position."
|
|
1156
|
+
}
|
|
1157
|
+
},
|
|
1158
|
+
"required": [
|
|
1159
|
+
"scale",
|
|
1160
|
+
"position"
|
|
1161
|
+
]
|
|
1162
|
+
},
|
|
1163
|
+
"MiniChartDimension": {
|
|
1164
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1165
|
+
"$id": "MiniChartDimension.json",
|
|
1166
|
+
"type": "object",
|
|
1167
|
+
"properties": {
|
|
1168
|
+
"type": {
|
|
1169
|
+
"anyOf": [
|
|
1170
|
+
{
|
|
1171
|
+
"type": "string",
|
|
1172
|
+
"const": "libraryItem"
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"type": "string",
|
|
1176
|
+
"const": "expression"
|
|
1177
|
+
}
|
|
1178
|
+
],
|
|
1179
|
+
"description": "Dimension backup type: `libraryItem` for a library id, `expression` for an expression."
|
|
1180
|
+
},
|
|
1181
|
+
"key": {
|
|
1182
|
+
"type": "string",
|
|
1183
|
+
"description": "Dimension backup for panel editing; sync with `qMiniChartDef.qLibraryId` or `qMiniChartDef.qDef` according to `type`."
|
|
1184
|
+
}
|
|
1185
|
+
},
|
|
1186
|
+
"required": [
|
|
1187
|
+
"type",
|
|
1188
|
+
"key"
|
|
1189
|
+
]
|
|
1190
|
+
},
|
|
1191
|
+
"HeaderColorExpression": {
|
|
1192
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1193
|
+
"$id": "HeaderColorExpression.json",
|
|
1194
|
+
"type": "object",
|
|
1195
|
+
"properties": {
|
|
1196
|
+
"background": {
|
|
1197
|
+
"$ref": "ClientStringExpression.json",
|
|
1198
|
+
"description": "Header background color expression. Persisted properties may use either a string or an engine `StringExpression` wrapper."
|
|
1199
|
+
},
|
|
1200
|
+
"foreground": {
|
|
1201
|
+
"$ref": "ClientStringExpression.json",
|
|
1202
|
+
"description": "Header foreground or text color expression. Persisted properties may use either a string or an engine `StringExpression` wrapper."
|
|
1203
|
+
}
|
|
1204
|
+
}
|
|
1205
|
+
},
|
|
1206
|
+
"NxInlineDimensionDef": {
|
|
1207
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1208
|
+
"$id": "NxInlineDimensionDef.json",
|
|
1209
|
+
"type": "object",
|
|
1210
|
+
"properties": {
|
|
1211
|
+
"qGrouping": {
|
|
1212
|
+
"$ref": "NxGrpType.json",
|
|
1213
|
+
"description": "Used to define a cyclic group or drill-down group. Default value is no grouping. This parameter is optional. One of: * N or GRP_NX_NONE * H or GRP_NX_HIEARCHY * C or GRP_NX_COLLECTION"
|
|
1214
|
+
},
|
|
1215
|
+
"qFieldDefs": {
|
|
1216
|
+
"type": "array",
|
|
1217
|
+
"items": {
|
|
1218
|
+
"type": "string"
|
|
1219
|
+
},
|
|
1220
|
+
"description": "Array of field names. When creating a grouped dimension, more than one field name is defined. This parameter is optional."
|
|
1221
|
+
},
|
|
1222
|
+
"qFieldLabels": {
|
|
1223
|
+
"type": "array",
|
|
1224
|
+
"items": {
|
|
1225
|
+
"type": "string"
|
|
1226
|
+
},
|
|
1227
|
+
"description": "Array of field labels. This parameter is optional."
|
|
1228
|
+
},
|
|
1229
|
+
"qSortCriterias": {
|
|
1230
|
+
"type": "array",
|
|
1231
|
+
"items": {
|
|
1232
|
+
"$ref": "SortCriteria.json"
|
|
1233
|
+
},
|
|
1234
|
+
"description": "Defines the sorting criteria in the field. Default is to sort by alphabetical order, ascending. This parameter is optional."
|
|
1235
|
+
},
|
|
1236
|
+
"qNumberPresentations": {
|
|
1237
|
+
"type": "array",
|
|
1238
|
+
"items": {
|
|
1239
|
+
"$ref": "FieldAttributes.json"
|
|
1240
|
+
},
|
|
1241
|
+
"description": "Defines the format of the value. This parameter is optional."
|
|
1242
|
+
},
|
|
1243
|
+
"qReverseSort": {
|
|
1244
|
+
"type": "boolean",
|
|
1245
|
+
"description": "If set to true, it inverts the sort criteria in the field."
|
|
1246
|
+
},
|
|
1247
|
+
"qActiveField": {
|
|
1248
|
+
"type": "integer",
|
|
1249
|
+
"minimum": -2147483648,
|
|
1250
|
+
"maximum": 2147483647,
|
|
1251
|
+
"description": "Index of the active field in a cyclic dimension. This parameter is optional. The default value is 0. This parameter is used in case of cyclic dimensions ( _qGrouping_ is C)."
|
|
1252
|
+
},
|
|
1253
|
+
"qLabelExpression": {
|
|
1254
|
+
"type": "string",
|
|
1255
|
+
"description": "Label expression. This parameter is optional."
|
|
1256
|
+
},
|
|
1257
|
+
"qAlias": {
|
|
1258
|
+
"type": "string",
|
|
1259
|
+
"description": "Alias of the dimension."
|
|
1260
|
+
}
|
|
1261
|
+
},
|
|
1262
|
+
"description": "NxInlineDimensionDef"
|
|
1263
|
+
},
|
|
1264
|
+
"NxGrpType": {
|
|
1265
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1266
|
+
"$id": "NxGrpType.json",
|
|
1267
|
+
"anyOf": [
|
|
1268
|
+
{
|
|
1269
|
+
"type": "string",
|
|
1270
|
+
"const": "GRP_NX_NONE"
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"type": "string",
|
|
1274
|
+
"const": "GRP_NX_HIEARCHY"
|
|
1275
|
+
},
|
|
1276
|
+
{
|
|
1277
|
+
"type": "string",
|
|
1278
|
+
"const": "GRP_NX_COLLECTION"
|
|
1279
|
+
},
|
|
1280
|
+
{
|
|
1281
|
+
"type": "string",
|
|
1282
|
+
"const": "N"
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"type": "string",
|
|
1286
|
+
"const": "H"
|
|
1287
|
+
},
|
|
1288
|
+
{
|
|
1289
|
+
"type": "string",
|
|
1290
|
+
"const": "C"
|
|
1291
|
+
}
|
|
1292
|
+
],
|
|
1293
|
+
"description": "NxGrpType"
|
|
1294
|
+
},
|
|
1295
|
+
"SortCriteria": {
|
|
1296
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1297
|
+
"$id": "SortCriteria.json",
|
|
1298
|
+
"type": "object",
|
|
1299
|
+
"properties": {
|
|
1300
|
+
"qSortByState": {
|
|
1301
|
+
"type": "integer",
|
|
1302
|
+
"minimum": -2147483648,
|
|
1303
|
+
"maximum": 2147483647,
|
|
1304
|
+
"description": "Sorts the field values according to their logical state (selected, optional, alternative or excluded)."
|
|
1305
|
+
},
|
|
1306
|
+
"qSortByFrequency": {
|
|
1307
|
+
"type": "integer",
|
|
1308
|
+
"minimum": -2147483648,
|
|
1309
|
+
"maximum": 2147483647,
|
|
1310
|
+
"description": "Sorts the field values by frequency (number of occurrences in the field)."
|
|
1311
|
+
},
|
|
1312
|
+
"qSortByNumeric": {
|
|
1313
|
+
"type": "integer",
|
|
1314
|
+
"minimum": -2147483648,
|
|
1315
|
+
"maximum": 2147483647,
|
|
1316
|
+
"description": "Sorts the field values by numeric value."
|
|
1317
|
+
},
|
|
1318
|
+
"qSortByAscii": {
|
|
1319
|
+
"type": "integer",
|
|
1320
|
+
"minimum": -2147483648,
|
|
1321
|
+
"maximum": 2147483647,
|
|
1322
|
+
"description": "Sorts the field by alphabetical order."
|
|
1323
|
+
},
|
|
1324
|
+
"qSortByLoadOrder": {
|
|
1325
|
+
"type": "integer",
|
|
1326
|
+
"minimum": -2147483648,
|
|
1327
|
+
"maximum": 2147483647,
|
|
1328
|
+
"description": "Sorts the field values by the initial load order."
|
|
1329
|
+
},
|
|
1330
|
+
"qSortByExpression": {
|
|
1331
|
+
"type": "integer",
|
|
1332
|
+
"minimum": -2147483648,
|
|
1333
|
+
"maximum": 2147483647,
|
|
1334
|
+
"description": "Sorts the field by expression."
|
|
1335
|
+
},
|
|
1336
|
+
"qExpression": {
|
|
1337
|
+
"$ref": "ValueExpr.json",
|
|
1338
|
+
"description": "Sort by expression."
|
|
1339
|
+
},
|
|
1340
|
+
"qSortByGreyness": {
|
|
1341
|
+
"type": "integer",
|
|
1342
|
+
"minimum": -2147483648,
|
|
1343
|
+
"maximum": 2147483647
|
|
1344
|
+
}
|
|
1345
|
+
},
|
|
1346
|
+
"description": "SortCriteria"
|
|
1347
|
+
},
|
|
1348
|
+
"FieldAttributes": {
|
|
1349
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1350
|
+
"$id": "FieldAttributes.json",
|
|
1351
|
+
"type": "object",
|
|
1352
|
+
"properties": {
|
|
1353
|
+
"qType": {
|
|
1354
|
+
"$ref": "FieldAttrType.json",
|
|
1355
|
+
"description": "Type of the field. Default is U. One of: * U or UNKNOWN * A or ASCII * I or INTEGER * R or REAL * F or FIX * M or MONEY * D or DATE * T or TIME * TS or TIMESTAMP * IV or INTERVAL"
|
|
1356
|
+
},
|
|
1357
|
+
"qnDec": {
|
|
1358
|
+
"type": "integer",
|
|
1359
|
+
"minimum": -2147483648,
|
|
1360
|
+
"maximum": 2147483647,
|
|
1361
|
+
"description": "Number of decimals. Default is 10."
|
|
1362
|
+
},
|
|
1363
|
+
"qUseThou": {
|
|
1364
|
+
"type": "integer",
|
|
1365
|
+
"minimum": -2147483648,
|
|
1366
|
+
"maximum": 2147483647,
|
|
1367
|
+
"description": "Defines whether or not a thousands separator must be used. Default is 0."
|
|
1368
|
+
},
|
|
1369
|
+
"qFmt": {
|
|
1370
|
+
"type": "string",
|
|
1371
|
+
"description": "Defines the format pattern that applies to _qText_ . Is used in connection to the type of the field (parameter **qType** ). For more information, see _Formatting mechanism_. Example: _YYYY-MM-DD_ for a date."
|
|
1372
|
+
},
|
|
1373
|
+
"qDec": {
|
|
1374
|
+
"type": "string",
|
|
1375
|
+
"description": "Defines the decimal separator. Example: **.**"
|
|
1376
|
+
},
|
|
1377
|
+
"qThou": {
|
|
1378
|
+
"type": "string",
|
|
1379
|
+
"description": "Defines the thousand separator (if any). Is used if **qUseThou** is set to 1. Example: **,**"
|
|
1380
|
+
}
|
|
1381
|
+
},
|
|
1382
|
+
"description": "Sets the formatting of a field.\nThe properties of _qFieldAttributes_ and the formatting mechanism are described below.\n\n### Formatting mechanism\nThe formatting mechanism depends on the type set in _qType,_ as shown below:\n<div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>\n\n### Type is DATE, TIME, TIMESTAMP or INTERVAL\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the formatting is as defined in _qFmt_ .\nIf _qFmt_ is empty, the formatting is defined by the number interpretation variables included at the top of the script ( _TimeFormat_ , _DateFormat_ , _TimeStampFormat_ ).\nThe properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.\n\n### Type is INTEGER\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).\nIf no format pattern is defined in _qFmt_ , no formatting is applied. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ and the number interpretation variables defined in the script are not used .\n\n### Type is REAL\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).\nIf no format pattern is defined in _qFmt_ , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties _qDec_ , _qThou_ , _qnDec_ , _qUseThou_ are not used.\nIf no format pattern is defined in _qFmt_ , and if _qnDec_ is defined and not 0, the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.\nIf no format pattern is defined in _qFmt_ , and if _qnDec_ is 0, the number of decimals is 14 and the property _qDec_ is used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.\n\n### Type is FIX\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( _DecimalSep_ and _ThousandSep_ ).\nIf no format pattern is defined in _qFmt_ , the properties _qDec_ and _qnDec_ are used. If _qDec_ is not defined, the variable _DecimalSep_ defined at the top of the script is used.\n\n### Type is MONEY\nThe following applies:\nIf a format pattern is defined in _qFmt_ , the engine looks at the values set in _qDec_ and _qThou_ . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).\nIf no format pattern is defined in _qFmt_ , the engine uses the number interpretation variables included at the top of the script ( _MoneyDecimalSep_ and _MoneyThousandSep_ ).\n\n### Type is ASCII\nNo formatting, _qFmt_ is ignored."
|
|
1383
|
+
},
|
|
1384
|
+
"FieldAttrType": {
|
|
1385
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1386
|
+
"$id": "FieldAttrType.json",
|
|
1387
|
+
"anyOf": [
|
|
1388
|
+
{
|
|
1389
|
+
"type": "string",
|
|
1390
|
+
"const": "UNKNOWN"
|
|
1391
|
+
},
|
|
1392
|
+
{
|
|
1393
|
+
"type": "string",
|
|
1394
|
+
"const": "ASCII"
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"const": "INTEGER"
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
"type": "string",
|
|
1402
|
+
"const": "REAL"
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"type": "string",
|
|
1406
|
+
"const": "FIX"
|
|
1407
|
+
},
|
|
1408
|
+
{
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"const": "MONEY"
|
|
1411
|
+
},
|
|
1412
|
+
{
|
|
1413
|
+
"type": "string",
|
|
1414
|
+
"const": "DATE"
|
|
1415
|
+
},
|
|
1416
|
+
{
|
|
1417
|
+
"type": "string",
|
|
1418
|
+
"const": "TIME"
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
"type": "string",
|
|
1422
|
+
"const": "TIMESTAMP"
|
|
1423
|
+
},
|
|
1424
|
+
{
|
|
1425
|
+
"type": "string",
|
|
1426
|
+
"const": "INTERVAL"
|
|
1427
|
+
},
|
|
1428
|
+
{
|
|
1429
|
+
"type": "string",
|
|
1430
|
+
"const": "U"
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"type": "string",
|
|
1434
|
+
"const": "A"
|
|
1435
|
+
},
|
|
1436
|
+
{
|
|
1437
|
+
"type": "string",
|
|
1438
|
+
"const": "I"
|
|
1439
|
+
},
|
|
1440
|
+
{
|
|
1441
|
+
"type": "string",
|
|
1442
|
+
"const": "R"
|
|
1443
|
+
},
|
|
1444
|
+
{
|
|
1445
|
+
"type": "string",
|
|
1446
|
+
"const": "F"
|
|
1447
|
+
},
|
|
1448
|
+
{
|
|
1449
|
+
"type": "string",
|
|
1450
|
+
"const": "M"
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"type": "string",
|
|
1454
|
+
"const": "D"
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
"type": "string",
|
|
1458
|
+
"const": "T"
|
|
1459
|
+
},
|
|
1460
|
+
{
|
|
1461
|
+
"type": "string",
|
|
1462
|
+
"const": "TS"
|
|
1463
|
+
},
|
|
1464
|
+
{
|
|
1465
|
+
"type": "string",
|
|
1466
|
+
"const": "IV"
|
|
1467
|
+
}
|
|
1468
|
+
],
|
|
1469
|
+
"description": "FieldAttrType"
|
|
1470
|
+
},
|
|
1471
|
+
"AttributeExpressionProperties": {
|
|
1472
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1473
|
+
"$id": "AttributeExpressionProperties.json",
|
|
1474
|
+
"type": "object",
|
|
1475
|
+
"properties": {
|
|
1476
|
+
"id": {
|
|
1477
|
+
"type": "string",
|
|
1478
|
+
"description": "Expression target: `cellForegroundColor`, `cellBackgroundColor`, `url`, `urlLabel`, `imageLabel`, `imageUrl`;\nbars also use `barColor`, `barLabelColor`, `barWidth`, `barOffset`, `barLabel`. Other ids are preserved for compatibility."
|
|
1479
|
+
}
|
|
1480
|
+
},
|
|
1481
|
+
"allOf": [
|
|
1482
|
+
{
|
|
1483
|
+
"$ref": "NxAttrExprDef.json"
|
|
1484
|
+
}
|
|
1485
|
+
]
|
|
1486
|
+
},
|
|
1487
|
+
"NxAttrExprDef": {
|
|
1488
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1489
|
+
"$id": "NxAttrExprDef.json",
|
|
1490
|
+
"type": "object",
|
|
1491
|
+
"properties": {
|
|
1492
|
+
"qExpression": {
|
|
1493
|
+
"type": "string",
|
|
1494
|
+
"description": "Definition of the attribute expression. Example: _\\\"Max(OrderID)\\\"_"
|
|
1495
|
+
},
|
|
1496
|
+
"qLibraryId": {
|
|
1497
|
+
"type": "string",
|
|
1498
|
+
"description": "Definition of the attribute expression stored in the library. Example: _\\\"MyGenericMeasure\\\"_"
|
|
1499
|
+
},
|
|
1500
|
+
"qAttribute": {
|
|
1501
|
+
"type": "boolean",
|
|
1502
|
+
"description": "If set to true, this measure will not affect the number of rows in the cube."
|
|
1503
|
+
},
|
|
1504
|
+
"qNumFormat": {
|
|
1505
|
+
"$ref": "FieldAttributes.json",
|
|
1506
|
+
"description": "Format of the field. This parameter is optional."
|
|
1507
|
+
},
|
|
1508
|
+
"qLabel": {
|
|
1509
|
+
"type": "string",
|
|
1510
|
+
"description": "Label of the attribute expression."
|
|
1511
|
+
},
|
|
1512
|
+
"qLabelExpression": {
|
|
1513
|
+
"type": "string",
|
|
1514
|
+
"description": "Optional expression used for dynamic label."
|
|
1515
|
+
}
|
|
1516
|
+
},
|
|
1517
|
+
"description": "NxAttrExprDef"
|
|
1518
|
+
},
|
|
1519
|
+
"NxDimension": {
|
|
1520
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1521
|
+
"$id": "NxDimension.json",
|
|
1522
|
+
"type": "object",
|
|
1523
|
+
"properties": {
|
|
1524
|
+
"qLibraryId": {
|
|
1525
|
+
"type": "string",
|
|
1526
|
+
"description": "Refers to a dimension stored in the library."
|
|
1527
|
+
},
|
|
1528
|
+
"qDef": {
|
|
1529
|
+
"$ref": "NxInlineDimensionDef.json",
|
|
1530
|
+
"description": "Refers to a dimension stored in the hypercube."
|
|
1531
|
+
},
|
|
1532
|
+
"qNullSuppression": {
|
|
1533
|
+
"type": "boolean",
|
|
1534
|
+
"description": "If set to true, no null values are returned."
|
|
1535
|
+
},
|
|
1536
|
+
"qIncludeElemValue": {
|
|
1537
|
+
"type": "boolean"
|
|
1538
|
+
},
|
|
1539
|
+
"qOtherTotalSpec": {
|
|
1540
|
+
"$ref": "OtherTotalSpecProp.json",
|
|
1541
|
+
"description": "Sets the dimension limits. Each dimension of a hypercube is configured separately. Defines if some values (grouped as _Others_ ) should be grouped together in the visualization. For example in a pie chart all values lower than 200 could be grouped together."
|
|
1542
|
+
},
|
|
1543
|
+
"qShowTotal": {
|
|
1544
|
+
"type": "boolean"
|
|
1545
|
+
},
|
|
1546
|
+
"qShowAll": {
|
|
1547
|
+
"type": "boolean",
|
|
1548
|
+
"description": "If set to true, all dimension values are shown."
|
|
1549
|
+
},
|
|
1550
|
+
"qOtherLabel": {
|
|
1551
|
+
"$ref": "StringExpr.json",
|
|
1552
|
+
"description": "This property is used when some dimension limits are set. Label of the _Others_ group. The default label is _Others_ . Example: _\\\"qOtherLabel\\\":\\\"= <label>\\\"_ or _\\\"qOtherLabel\\\":{\\\"qExpr\\\":\\\"= <label>\\\"}_ Where: * < _label_ > is the label of the _Others_ group."
|
|
1553
|
+
},
|
|
1554
|
+
"qTotalLabel": {
|
|
1555
|
+
"$ref": "StringExpr.json",
|
|
1556
|
+
"description": "If this property is set, the total of the calculated values is returned. The default label is _Total_ . Example: _\\\"qTotalLabel\\\":\\\"= <label>\\\"_ or _\\\"qTotalLabel\\\":{\\\"qExpr\\\":\\\"= <label>\\\"}_ Where: * < _label_ > is the label of the _Total_ group."
|
|
1557
|
+
},
|
|
1558
|
+
"qCalcCond": {
|
|
1559
|
+
"$ref": "ValueExpr.json",
|
|
1560
|
+
"description": "Specifies a calculation condition, which must be fulfilled for the dimension to be calculated. If the calculation condition is not met, the dimension is excluded from the calculation. By default, there is no calculation condition. This property is optional."
|
|
1561
|
+
},
|
|
1562
|
+
"qAttributeExpressions": {
|
|
1563
|
+
"type": "array",
|
|
1564
|
+
"items": {
|
|
1565
|
+
"$ref": "NxAttrExprDef.json"
|
|
1566
|
+
},
|
|
1567
|
+
"description": "List of attribute expressions."
|
|
1568
|
+
},
|
|
1569
|
+
"qAttributeDimensions": {
|
|
1570
|
+
"type": "array",
|
|
1571
|
+
"items": {
|
|
1572
|
+
"$ref": "NxAttrDimDef.json"
|
|
1573
|
+
},
|
|
1574
|
+
"description": "List of attribute dimensions."
|
|
1575
|
+
},
|
|
1576
|
+
"qCalcCondition": {
|
|
1577
|
+
"$ref": "NxCalcCond.json",
|
|
1578
|
+
"description": "Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the dimension is excluded from the calculation and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional."
|
|
1579
|
+
}
|
|
1580
|
+
},
|
|
1581
|
+
"description": "<div class=note>The fields or expressions in the dimension are either defined in **qDef** or in the master dimension referred to by **qLibraryId**. If **qLibraryId** is set then the qFieldDefs, qFieldLabels, qGrouping, qLabelExpression and qAlias of the master dimension will be used. </div> <div class=note>If the dimension is set in the hypercube and not in the library, this dimension cannot be shared with other objects.</div> <div class=note>A dimension that is set in the library can be used by many objects.</div>"
|
|
1582
|
+
},
|
|
1583
|
+
"OtherTotalSpecProp": {
|
|
1584
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1585
|
+
"$id": "OtherTotalSpecProp.json",
|
|
1586
|
+
"type": "object",
|
|
1587
|
+
"properties": {
|
|
1588
|
+
"qOtherMode": {
|
|
1589
|
+
"$ref": "OtherMode.json",
|
|
1590
|
+
"description": "Determines how many dimension values are displayed. The default value is _OTHER_OFF_ . One of: * OTHER_OFF * OTHER_COUNTED * OTHER_ABS_LIMITED * OTHER_ABS_ACC_TARGET * OTHER_REL_LIMITED * OTHER_REL_ACC_TARGET"
|
|
1591
|
+
},
|
|
1592
|
+
"qOtherCounted": {
|
|
1593
|
+
"$ref": "ValueExpr.json",
|
|
1594
|
+
"description": "Number of values to display. The number of values can be entered as a calculated formula. This parameter is used when _qOtherMode_ is set to _OTHER_COUNTED_ ."
|
|
1595
|
+
},
|
|
1596
|
+
"qOtherLimit": {
|
|
1597
|
+
"$ref": "ValueExpr.json",
|
|
1598
|
+
"description": "Value used to limit the dimension values. The limit can be entered as a calculated formula. This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET"
|
|
1599
|
+
},
|
|
1600
|
+
"qOtherLimitMode": {
|
|
1601
|
+
"$ref": "OtherLimitMode.json",
|
|
1602
|
+
"description": "Sets the limit for the _Others_ mode. This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET One of: * OTHER_GE_LIMIT * OTHER_LE_LIMIT * OTHER_GT_LIMIT * OTHER_LT_LIMIT"
|
|
1603
|
+
},
|
|
1604
|
+
"qSuppressOther": {
|
|
1605
|
+
"type": "boolean",
|
|
1606
|
+
"description": "If set to true, the group _Others_ is not displayed as a dimension value. The default value is false."
|
|
1607
|
+
},
|
|
1608
|
+
"qForceBadValueKeeping": {
|
|
1609
|
+
"type": "boolean",
|
|
1610
|
+
"description": "This parameter is used when _qOtherMode_ is set to: * OTHER_ABS_LIMITED * OTHER_REL_LIMITED * OTHER_ABS_ACC_TARGET OTHER_REL_ACC_TARGET and when the dimension values include not numeric values. Set this parameter to true to include text values in the returned values. The default value is true."
|
|
1611
|
+
},
|
|
1612
|
+
"qApplyEvenWhenPossiblyWrongResult": {
|
|
1613
|
+
"type": "boolean",
|
|
1614
|
+
"description": "Set this parameter to true to allow the calculation of _Others_ even if the engine detects some potential mistakes. For example the country Russia is part of the continent Europe and Asia. If you have an hypercube with two dimensions Country and Continent and one measure Population, the engine can detect that the population of Russia is included in both the continent Asia and Europe. The default value is true."
|
|
1615
|
+
},
|
|
1616
|
+
"qGlobalOtherGrouping": {
|
|
1617
|
+
"type": "boolean",
|
|
1618
|
+
"description": "This parameter applies to inner dimensions. If this parameter is set to true, the restrictions are calculated on the selected dimension only. All previous dimensions are ignored. The default value is false."
|
|
1619
|
+
},
|
|
1620
|
+
"qOtherCollapseInnerDimensions": {
|
|
1621
|
+
"type": "boolean",
|
|
1622
|
+
"description": "If set to true, it collapses the inner dimensions (if any) in the group _Others_ . The default value is false."
|
|
1623
|
+
},
|
|
1624
|
+
"qOtherSortMode": {
|
|
1625
|
+
"$ref": "OtherSortMode.json",
|
|
1626
|
+
"description": "Defines the sort order of the dimension values. The default value is _OTHER_SORT_DESCENDING_ . One of: * OTHER_SORT_DEFAULT * OTHER_SORT_DESCENDING * OTHER_SORT_ASCENDING"
|
|
1627
|
+
},
|
|
1628
|
+
"qTotalMode": {
|
|
1629
|
+
"$ref": "TotalMode.json",
|
|
1630
|
+
"description": "If set to _TOTAL_EXPR_ , the total of the dimension values is returned. The default value is _TOTAL_OFF_ . One of: * TOTAL_OFF * TOTAL_EXPR"
|
|
1631
|
+
},
|
|
1632
|
+
"qReferencedExpression": {
|
|
1633
|
+
"$ref": "StringExpr.json",
|
|
1634
|
+
"description": "This parameter applies when there are several measures. Name of the measure to use for the calculation of _Others_ for a specific dimension."
|
|
1635
|
+
}
|
|
1636
|
+
},
|
|
1637
|
+
"description": "OtherTotalSpecProp"
|
|
1638
|
+
},
|
|
1639
|
+
"OtherMode": {
|
|
1640
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1641
|
+
"$id": "OtherMode.json",
|
|
1642
|
+
"anyOf": [
|
|
1643
|
+
{
|
|
1644
|
+
"type": "string",
|
|
1645
|
+
"const": "OTHER_OFF"
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"type": "string",
|
|
1649
|
+
"const": "OTHER_COUNTED"
|
|
1650
|
+
},
|
|
1651
|
+
{
|
|
1652
|
+
"type": "string",
|
|
1653
|
+
"const": "OTHER_ABS_LIMITED"
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"type": "string",
|
|
1657
|
+
"const": "OTHER_ABS_ACC_TARGET"
|
|
1658
|
+
},
|
|
1659
|
+
{
|
|
1660
|
+
"type": "string",
|
|
1661
|
+
"const": "OTHER_REL_LIMITED"
|
|
1662
|
+
},
|
|
1663
|
+
{
|
|
1664
|
+
"type": "string",
|
|
1665
|
+
"const": "OTHER_REL_ACC_TARGET"
|
|
1666
|
+
}
|
|
1667
|
+
],
|
|
1668
|
+
"description": "OtherMode"
|
|
1669
|
+
},
|
|
1670
|
+
"OtherLimitMode": {
|
|
1671
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1672
|
+
"$id": "OtherLimitMode.json",
|
|
1673
|
+
"anyOf": [
|
|
1674
|
+
{
|
|
1675
|
+
"type": "string",
|
|
1676
|
+
"const": "OTHER_GE_LIMIT"
|
|
1677
|
+
},
|
|
1678
|
+
{
|
|
1679
|
+
"type": "string",
|
|
1680
|
+
"const": "OTHER_LE_LIMIT"
|
|
1681
|
+
},
|
|
1682
|
+
{
|
|
1683
|
+
"type": "string",
|
|
1684
|
+
"const": "OTHER_GT_LIMIT"
|
|
1685
|
+
},
|
|
1686
|
+
{
|
|
1687
|
+
"type": "string",
|
|
1688
|
+
"const": "OTHER_LT_LIMIT"
|
|
1689
|
+
}
|
|
1690
|
+
],
|
|
1691
|
+
"description": "OtherLimitMode"
|
|
1692
|
+
},
|
|
1693
|
+
"OtherSortMode": {
|
|
1694
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1695
|
+
"$id": "OtherSortMode.json",
|
|
1696
|
+
"anyOf": [
|
|
1697
|
+
{
|
|
1698
|
+
"type": "string",
|
|
1699
|
+
"const": "OTHER_SORT_DEFAULT"
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
"type": "string",
|
|
1703
|
+
"const": "OTHER_SORT_DESCENDING"
|
|
1704
|
+
},
|
|
1705
|
+
{
|
|
1706
|
+
"type": "string",
|
|
1707
|
+
"const": "OTHER_SORT_ASCENDING"
|
|
1708
|
+
}
|
|
1709
|
+
],
|
|
1710
|
+
"description": "OtherSortMode"
|
|
1711
|
+
},
|
|
1712
|
+
"TotalMode": {
|
|
1713
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1714
|
+
"$id": "TotalMode.json",
|
|
1715
|
+
"anyOf": [
|
|
1716
|
+
{
|
|
1717
|
+
"type": "string",
|
|
1718
|
+
"const": "TOTAL_OFF"
|
|
1719
|
+
},
|
|
1720
|
+
{
|
|
1721
|
+
"type": "string",
|
|
1722
|
+
"const": "TOTAL_EXPR"
|
|
1723
|
+
}
|
|
1724
|
+
],
|
|
1725
|
+
"description": "TotalMode"
|
|
1726
|
+
},
|
|
1727
|
+
"NxAttrDimDef": {
|
|
1728
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1729
|
+
"$id": "NxAttrDimDef.json",
|
|
1730
|
+
"type": "object",
|
|
1731
|
+
"properties": {
|
|
1732
|
+
"qDef": {
|
|
1733
|
+
"type": "string",
|
|
1734
|
+
"description": "Expression or field name."
|
|
1735
|
+
},
|
|
1736
|
+
"qLibraryId": {
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"description": "LibraryId for dimension."
|
|
1739
|
+
},
|
|
1740
|
+
"qSortBy": {
|
|
1741
|
+
"$ref": "SortCriteria.json",
|
|
1742
|
+
"description": "Sorting."
|
|
1743
|
+
},
|
|
1744
|
+
"qAttribute": {
|
|
1745
|
+
"type": "boolean",
|
|
1746
|
+
"description": "If set to true, this attribute will not affect the number of rows in the cube."
|
|
1747
|
+
}
|
|
1748
|
+
},
|
|
1749
|
+
"description": "Layout for _NxAttrDimDef_."
|
|
1750
|
+
},
|
|
1751
|
+
"MeasureProperties": {
|
|
1752
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1753
|
+
"$id": "MeasureProperties.json",
|
|
1754
|
+
"type": "object",
|
|
1755
|
+
"properties": {
|
|
1756
|
+
"qLibraryId": {
|
|
1757
|
+
"type": "string",
|
|
1758
|
+
"description": "Library measure id. Usually omit `qDef.qDef`/`qDef.qLabel` when set; otherwise `qDef.qDef` must contain an inline expression."
|
|
1759
|
+
},
|
|
1760
|
+
"qDef": {
|
|
1761
|
+
"$ref": "InlineMeasureDef.json",
|
|
1762
|
+
"description": "Measure definition. Inline measures require an expression in `qDef`; all measures require `cId`."
|
|
1763
|
+
},
|
|
1764
|
+
"qAttributeExpressions": {
|
|
1765
|
+
"type": "array",
|
|
1766
|
+
"items": {
|
|
1767
|
+
"$ref": "AttributeExpressionProperties.json"
|
|
1768
|
+
},
|
|
1769
|
+
"default": [],
|
|
1770
|
+
"description": "Required attribute expressions; use `[]` without cell styling expressions."
|
|
1771
|
+
},
|
|
1772
|
+
"conditionalColoring": {
|
|
1773
|
+
"$ref": "ConditionalColoring.json",
|
|
1774
|
+
"description": "Indicator color segments; requires `qDef.representation.type: \"indicator\"` and `indicator.applySegmentColors: true`."
|
|
1775
|
+
}
|
|
1776
|
+
},
|
|
1777
|
+
"required": [
|
|
1778
|
+
"qDef",
|
|
1779
|
+
"qAttributeExpressions"
|
|
1780
|
+
],
|
|
1781
|
+
"allOf": [
|
|
1782
|
+
{
|
|
1783
|
+
"$ref": "NxMeasure.json"
|
|
1784
|
+
}
|
|
1785
|
+
]
|
|
1786
|
+
},
|
|
1787
|
+
"InlineMeasureDef": {
|
|
1788
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1789
|
+
"$id": "InlineMeasureDef.json",
|
|
1790
|
+
"type": "object",
|
|
1791
|
+
"properties": {
|
|
1792
|
+
"cId": {
|
|
1793
|
+
"type": "string",
|
|
1794
|
+
"description": "Stable, unique column id. Preserve during edits; replace measures by removing and adding, not by changing `cId`."
|
|
1795
|
+
},
|
|
1796
|
+
"textAlign": {
|
|
1797
|
+
"$ref": "TextAlign.json",
|
|
1798
|
+
"description": "Measure cell alignment; `align` applies when `auto` is false."
|
|
1799
|
+
},
|
|
1800
|
+
"labelTextAlign": {
|
|
1801
|
+
"$ref": "TextAlign.json",
|
|
1802
|
+
"description": "Measure header text alignment."
|
|
1803
|
+
},
|
|
1804
|
+
"columnWidth": {
|
|
1805
|
+
"$ref": "ColumnWidth.json",
|
|
1806
|
+
"description": "Measure column width; set the width field matching `type`."
|
|
1807
|
+
},
|
|
1808
|
+
"representation": {
|
|
1809
|
+
"$ref": "MeasureRepresentationProperties.json",
|
|
1810
|
+
"description": "Client-side value representation; set fields matching `type`. Legacy `miniChart` falls back to text."
|
|
1811
|
+
},
|
|
1812
|
+
"headerColor": {
|
|
1813
|
+
"$ref": "HeaderColorExpression.json",
|
|
1814
|
+
"description": "Measure header color expressions overriding general header styling."
|
|
1815
|
+
},
|
|
1816
|
+
"groupName": {
|
|
1817
|
+
"anyOf": [
|
|
1818
|
+
{
|
|
1819
|
+
"type": "string"
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"$ref": "ClientStringExpressionValue.json"
|
|
1823
|
+
}
|
|
1824
|
+
],
|
|
1825
|
+
"description": "Adjacent-measure group header when measures are the only column field. Optional; panel initializes to `\"\"`. Plain text is a string; `=` input uses engine-evaluated `qStringExpression.qExpr`."
|
|
1826
|
+
},
|
|
1827
|
+
"autoSort": {
|
|
1828
|
+
"type": "boolean",
|
|
1829
|
+
"default": true,
|
|
1830
|
+
"description": "Whether automatic sorting is enabled in the property panel. Default: true."
|
|
1831
|
+
},
|
|
1832
|
+
"isCustomFormatted": {
|
|
1833
|
+
"type": "boolean",
|
|
1834
|
+
"description": "Whether custom or expression-formatted text should be used instead of standard numeric formatting."
|
|
1835
|
+
},
|
|
1836
|
+
"numFormatFromTemplate": {
|
|
1837
|
+
"type": "boolean",
|
|
1838
|
+
"description": "Whether the selected number-format template should be used instead of custom numeric formatting."
|
|
1839
|
+
},
|
|
1840
|
+
"conditionalColoring": {
|
|
1841
|
+
"$ref": "ConditionalColoring.json",
|
|
1842
|
+
"description": "Conditional-coloring configuration used by indicator representations."
|
|
1843
|
+
}
|
|
1844
|
+
},
|
|
1845
|
+
"required": [
|
|
1846
|
+
"cId"
|
|
1847
|
+
],
|
|
1848
|
+
"allOf": [
|
|
1849
|
+
{
|
|
1850
|
+
"$ref": "NxInlineMeasureDef.json"
|
|
1851
|
+
}
|
|
1852
|
+
]
|
|
1853
|
+
},
|
|
1854
|
+
"MeasureRepresentationProperties": {
|
|
1855
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1856
|
+
"$id": "MeasureRepresentationProperties.json",
|
|
1857
|
+
"anyOf": [
|
|
1858
|
+
{
|
|
1859
|
+
"$ref": "TextRepresentationProperties.json"
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"$ref": "LinkRepresentationProperties.json"
|
|
1863
|
+
},
|
|
1864
|
+
{
|
|
1865
|
+
"$ref": "ImageRepresentationProperties.json"
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"$ref": "IndicatorRepresentationProperties.json"
|
|
1869
|
+
},
|
|
1870
|
+
{
|
|
1871
|
+
"$ref": "MiniChartRepresentationProperties.json"
|
|
1872
|
+
},
|
|
1873
|
+
{
|
|
1874
|
+
"$ref": "BarRepresentationProperties.json"
|
|
1875
|
+
}
|
|
1876
|
+
]
|
|
1877
|
+
},
|
|
1878
|
+
"BarRepresentationProperties": {
|
|
1879
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1880
|
+
"$id": "BarRepresentationProperties.json",
|
|
1881
|
+
"type": "object",
|
|
1882
|
+
"properties": {
|
|
1883
|
+
"type": {
|
|
1884
|
+
"type": "string",
|
|
1885
|
+
"const": "bar",
|
|
1886
|
+
"description": "Bar representation."
|
|
1887
|
+
},
|
|
1888
|
+
"barColorMode": {
|
|
1889
|
+
"anyOf": [
|
|
1890
|
+
{
|
|
1891
|
+
"type": "string",
|
|
1892
|
+
"const": "solid"
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"type": "string",
|
|
1896
|
+
"const": "expression"
|
|
1897
|
+
}
|
|
1898
|
+
],
|
|
1899
|
+
"description": "Bar color source: `solid` uses `barColor`; `expression` uses its attribute expression. Panel initializes to `solid`."
|
|
1900
|
+
},
|
|
1901
|
+
"barColor": {
|
|
1902
|
+
"$ref": "PaletteColor.json",
|
|
1903
|
+
"description": "Solid bar color and fallback when a row's `barColor` attribute expression has no color."
|
|
1904
|
+
},
|
|
1905
|
+
"barLabelColorMode": {
|
|
1906
|
+
"anyOf": [
|
|
1907
|
+
{
|
|
1908
|
+
"type": "string",
|
|
1909
|
+
"const": "solid"
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"type": "string",
|
|
1913
|
+
"const": "expression"
|
|
1914
|
+
}
|
|
1915
|
+
],
|
|
1916
|
+
"description": "Label color source: `solid` uses `barLabelColor`; `expression` uses its attribute expression. Panel initializes to `solid`."
|
|
1917
|
+
},
|
|
1918
|
+
"barLabelColor": {
|
|
1919
|
+
"$ref": "PaletteColor.json",
|
|
1920
|
+
"description": "Solid label color and fallback when a row's `barLabelColor` attribute expression has no color."
|
|
1921
|
+
},
|
|
1922
|
+
"barRangeMode": {
|
|
1923
|
+
"anyOf": [
|
|
1924
|
+
{
|
|
1925
|
+
"type": "string",
|
|
1926
|
+
"const": "auto"
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"type": "string",
|
|
1930
|
+
"const": "manual"
|
|
1931
|
+
}
|
|
1932
|
+
],
|
|
1933
|
+
"description": "Bar scale: `auto` uses the measure range including zero; `manual` uses `barRangeMin`/`barRangeMax`, clipping overflow with markers. Panel initializes to `auto`."
|
|
1934
|
+
},
|
|
1935
|
+
"barRangeMin": {
|
|
1936
|
+
"anyOf": [
|
|
1937
|
+
{
|
|
1938
|
+
"type": "number"
|
|
1939
|
+
},
|
|
1940
|
+
{
|
|
1941
|
+
"$ref": "BarRangeValueExpression.json"
|
|
1942
|
+
}
|
|
1943
|
+
],
|
|
1944
|
+
"description": "Manual range minimum, numeric or expression; nonnumeric results fall back to the automatic lower bound including `barOffset`."
|
|
1945
|
+
},
|
|
1946
|
+
"barRangeMax": {
|
|
1947
|
+
"anyOf": [
|
|
1948
|
+
{
|
|
1949
|
+
"type": "number"
|
|
1950
|
+
},
|
|
1951
|
+
{
|
|
1952
|
+
"$ref": "BarRangeValueExpression.json"
|
|
1953
|
+
}
|
|
1954
|
+
],
|
|
1955
|
+
"description": "Manual range maximum, numeric or expression; nonnumeric results fall back to the automatic upper bound including `barOffset`."
|
|
1956
|
+
},
|
|
1957
|
+
"barEnd": {
|
|
1958
|
+
"$ref": "BarEnd.json",
|
|
1959
|
+
"description": "Shape at the end of the bar. `none` is a plain bar."
|
|
1960
|
+
}
|
|
1961
|
+
},
|
|
1962
|
+
"required": [
|
|
1963
|
+
"type"
|
|
1964
|
+
]
|
|
1965
|
+
},
|
|
1966
|
+
"BarRangeValueExpression": {
|
|
1967
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1968
|
+
"$id": "BarRangeValueExpression.json",
|
|
1969
|
+
"type": "object",
|
|
1970
|
+
"properties": {
|
|
1971
|
+
"qValueExpression": {
|
|
1972
|
+
"$ref": "ValueExpression.json",
|
|
1973
|
+
"description": "Expression for the range bound. The engine evaluates it to a number in the layout."
|
|
1974
|
+
}
|
|
1975
|
+
},
|
|
1976
|
+
"required": [
|
|
1977
|
+
"qValueExpression"
|
|
1978
|
+
]
|
|
1979
|
+
},
|
|
1980
|
+
"ValueExpression": {
|
|
1981
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1982
|
+
"$id": "ValueExpression.json",
|
|
1983
|
+
"type": "object",
|
|
1984
|
+
"properties": {
|
|
1985
|
+
"qExpr": {
|
|
1986
|
+
"type": "string"
|
|
1987
|
+
}
|
|
1988
|
+
},
|
|
1989
|
+
"description": "### Properties\nAbbreviated syntax:\n\"qValueExpression\":\"=<expression>\"\nExtended object syntax:\n\"qValueExpression\":{\"qExpr\":\"=<expression>\"}\nWhere:\n< **expression** > is a string.\n\n<div class=note>The \"=\" sign in the value expression is not mandatory. Even if the \"=\" sign is not given, the expression is evaluated.</div>\nThe expression is evaluated as a numeric."
|
|
1990
|
+
},
|
|
1991
|
+
"BarEnd": {
|
|
1992
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1993
|
+
"$id": "BarEnd.json",
|
|
1994
|
+
"anyOf": [
|
|
1995
|
+
{
|
|
1996
|
+
"type": "string",
|
|
1997
|
+
"const": "none"
|
|
1998
|
+
},
|
|
1999
|
+
{
|
|
2000
|
+
"type": "string",
|
|
2001
|
+
"const": "circle"
|
|
2002
|
+
},
|
|
2003
|
+
{
|
|
2004
|
+
"type": "string",
|
|
2005
|
+
"const": "box"
|
|
2006
|
+
}
|
|
2007
|
+
]
|
|
2008
|
+
},
|
|
2009
|
+
"ConditionalColoring": {
|
|
2010
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2011
|
+
"$id": "ConditionalColoring.json",
|
|
2012
|
+
"type": "object",
|
|
2013
|
+
"properties": {
|
|
2014
|
+
"segments": {
|
|
2015
|
+
"$ref": "ConditionalColoringSegments.json",
|
|
2016
|
+
"description": "Conditional-coloring segments for a measure. Used by indicator rendering when `indicator.applySegmentColors` is true."
|
|
2017
|
+
}
|
|
2018
|
+
},
|
|
2019
|
+
"required": [
|
|
2020
|
+
"segments"
|
|
2021
|
+
]
|
|
2022
|
+
},
|
|
2023
|
+
"ConditionalColoringSegments": {
|
|
2024
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2025
|
+
"$id": "ConditionalColoringSegments.json",
|
|
2026
|
+
"type": "object",
|
|
2027
|
+
"properties": {
|
|
2028
|
+
"limits": {
|
|
2029
|
+
"type": "array",
|
|
2030
|
+
"items": {
|
|
2031
|
+
"$ref": "Limit.json"
|
|
2032
|
+
},
|
|
2033
|
+
"description": "Optional numeric boundaries. When present, keep the order aligned with `paletteColors`."
|
|
2034
|
+
},
|
|
2035
|
+
"paletteColors": {
|
|
2036
|
+
"type": "array",
|
|
2037
|
+
"items": {
|
|
2038
|
+
"$ref": "PaletteColor.json"
|
|
2039
|
+
},
|
|
2040
|
+
"description": "Palette colors used by the conditional-coloring ranges."
|
|
2041
|
+
},
|
|
2042
|
+
"localPaletteColors": {
|
|
2043
|
+
"type": "array",
|
|
2044
|
+
"items": {
|
|
2045
|
+
"$ref": "PaletteColor.json"
|
|
2046
|
+
},
|
|
2047
|
+
"description": "Locally resolved palette colors produced during rendering. Usually omitted from persisted properties; when present, keep this aligned with `paletteColors`."
|
|
2048
|
+
}
|
|
2049
|
+
},
|
|
2050
|
+
"required": [
|
|
2051
|
+
"paletteColors"
|
|
2052
|
+
]
|
|
2053
|
+
},
|
|
2054
|
+
"Limit": {
|
|
2055
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2056
|
+
"$id": "Limit.json",
|
|
2057
|
+
"type": "object",
|
|
2058
|
+
"properties": {
|
|
2059
|
+
"value": {
|
|
2060
|
+
"type": "number",
|
|
2061
|
+
"description": "Numeric boundary used by conditional coloring."
|
|
2062
|
+
},
|
|
2063
|
+
"gradient": {
|
|
2064
|
+
"type": "boolean",
|
|
2065
|
+
"description": "Whether the color transition toward this boundary is a gradient."
|
|
2066
|
+
}
|
|
2067
|
+
},
|
|
2068
|
+
"required": [
|
|
2069
|
+
"value",
|
|
2070
|
+
"gradient"
|
|
2071
|
+
]
|
|
2072
|
+
},
|
|
2073
|
+
"NxInlineMeasureDef": {
|
|
2074
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2075
|
+
"$id": "NxInlineMeasureDef.json",
|
|
2076
|
+
"type": "object",
|
|
2077
|
+
"properties": {
|
|
2078
|
+
"qLabel": {
|
|
2079
|
+
"type": "string",
|
|
2080
|
+
"description": "Name of the measure. An empty string is returned as a default value. This parameter is optional."
|
|
2081
|
+
},
|
|
2082
|
+
"qDescription": {
|
|
2083
|
+
"type": "string",
|
|
2084
|
+
"description": "Description of the measure. An empty string is returned as a default value. This parameter is optional."
|
|
2085
|
+
},
|
|
2086
|
+
"qTags": {
|
|
2087
|
+
"type": "array",
|
|
2088
|
+
"items": {
|
|
2089
|
+
"type": "string"
|
|
2090
|
+
},
|
|
2091
|
+
"description": "Name connected to the measure that is used for search purposes. A measure can have several tags. This parameter is optional."
|
|
2092
|
+
},
|
|
2093
|
+
"qGrouping": {
|
|
2094
|
+
"$ref": "NxGrpType.json",
|
|
2095
|
+
"description": "Default value is no grouping. This parameter is optional. One of: * N or GRP_NX_NONE * H or GRP_NX_HIEARCHY * C or GRP_NX_COLLECTION"
|
|
2096
|
+
},
|
|
2097
|
+
"qDef": {
|
|
2098
|
+
"type": "string",
|
|
2099
|
+
"description": "Definition of the expression in the measure. Example: _Sum (OrderTotal)_ This parameter is mandatory."
|
|
2100
|
+
},
|
|
2101
|
+
"qNumFormat": {
|
|
2102
|
+
"$ref": "FieldAttributes.json",
|
|
2103
|
+
"description": "Format of the field. This parameter is optional."
|
|
2104
|
+
},
|
|
2105
|
+
"qRelative": {
|
|
2106
|
+
"type": "boolean",
|
|
2107
|
+
"description": "If set to true, percentage values are returned instead of absolute numbers. Default value is false. This parameter is optional."
|
|
2108
|
+
},
|
|
2109
|
+
"qBrutalSum": {
|
|
2110
|
+
"type": "boolean",
|
|
2111
|
+
"description": "If set to true, the sum of rows total should be used rather than real expression total. This parameter is optional and applies to straight tables. Default value is false. If using the Qlik Sense interface, it means that the total mode is set to **Expression Total** ."
|
|
2112
|
+
},
|
|
2113
|
+
"qAggrFunc": {
|
|
2114
|
+
"type": "string",
|
|
2115
|
+
"description": "Indicates how to aggregate the measure to create a grand total. \\\"None\\\" - No total calculation is performed. \\\"Expr\\\" - Total is calculated based on the measure expression. The default value is an empty string, which has the same effect as \\\"Expr\\\". This parameter is optional."
|
|
2116
|
+
},
|
|
2117
|
+
"qAccumulate": {
|
|
2118
|
+
"type": "integer",
|
|
2119
|
+
"minimum": -2147483648,
|
|
2120
|
+
"maximum": 2147483647,
|
|
2121
|
+
"description": "* 0 means no accumulation * 1 means full accumulation (each y-value accumulates all previous y-values of the expression) * ≥ 2 means accumulate as many steps as the _qAccumulate_ value Default value is 0. This parameter is optional."
|
|
2122
|
+
},
|
|
2123
|
+
"qReverseSort": {
|
|
2124
|
+
"type": "boolean",
|
|
2125
|
+
"description": "If set to true, it inverts the sort criteria in the field."
|
|
2126
|
+
},
|
|
2127
|
+
"qActiveExpression": {
|
|
2128
|
+
"type": "integer",
|
|
2129
|
+
"minimum": -2147483648,
|
|
2130
|
+
"maximum": 2147483647,
|
|
2131
|
+
"description": "Index of the active expression in a cyclic measure. The indexing starts from 0. The default value is 0. This parameter is optional."
|
|
2132
|
+
},
|
|
2133
|
+
"qExpressions": {
|
|
2134
|
+
"type": "array",
|
|
2135
|
+
"items": {
|
|
2136
|
+
"type": "string"
|
|
2137
|
+
},
|
|
2138
|
+
"description": "Array of expressions. This parameter is used in case of cyclic measures ( _qGrouping_ is C). List of the expressions in the cyclic group."
|
|
2139
|
+
},
|
|
2140
|
+
"qLabelExpression": {
|
|
2141
|
+
"type": "string",
|
|
2142
|
+
"description": "Label expression. This parameter is optional."
|
|
2143
|
+
}
|
|
2144
|
+
},
|
|
2145
|
+
"description": "NxInlineMeasureDef"
|
|
2146
|
+
},
|
|
2147
|
+
"NxMeasure": {
|
|
2148
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2149
|
+
"$id": "NxMeasure.json",
|
|
2150
|
+
"type": "object",
|
|
2151
|
+
"properties": {
|
|
2152
|
+
"qLibraryId": {
|
|
2153
|
+
"type": "string",
|
|
2154
|
+
"description": "Refers to a measure stored in the library."
|
|
2155
|
+
},
|
|
2156
|
+
"qDef": {
|
|
2157
|
+
"$ref": "NxInlineMeasureDef.json",
|
|
2158
|
+
"description": "Refers to a measure stored in the hypercube."
|
|
2159
|
+
},
|
|
2160
|
+
"qSortBy": {
|
|
2161
|
+
"$ref": "SortCriteria.json",
|
|
2162
|
+
"description": "Defines the sort criteria. The default value is sort by ascending alphabetic order. This property is optional."
|
|
2163
|
+
},
|
|
2164
|
+
"qAttributeExpressions": {
|
|
2165
|
+
"type": "array",
|
|
2166
|
+
"items": {
|
|
2167
|
+
"$ref": "NxAttrExprDef.json"
|
|
2168
|
+
},
|
|
2169
|
+
"description": "List of attribute expressions."
|
|
2170
|
+
},
|
|
2171
|
+
"qAttributeDimensions": {
|
|
2172
|
+
"type": "array",
|
|
2173
|
+
"items": {
|
|
2174
|
+
"$ref": "NxAttrDimDef.json"
|
|
2175
|
+
},
|
|
2176
|
+
"description": "List of attribute dimensions."
|
|
2177
|
+
},
|
|
2178
|
+
"qCalcCond": {
|
|
2179
|
+
"$ref": "ValueExpr.json",
|
|
2180
|
+
"description": "Specifies a calculation condition, which must be fulfilled for the measure to be calculated. If the calculation condition is not met, the measure is excluded from the calculation. By default, there is no calculation condition. This property is optional."
|
|
2181
|
+
},
|
|
2182
|
+
"qCalcCondition": {
|
|
2183
|
+
"$ref": "NxCalcCond.json",
|
|
2184
|
+
"description": "Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the measure is excluded from the calculation and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional."
|
|
2185
|
+
},
|
|
2186
|
+
"qTrendLines": {
|
|
2187
|
+
"type": "array",
|
|
2188
|
+
"items": {
|
|
2189
|
+
"$ref": "NxTrendlineDef.json"
|
|
2190
|
+
},
|
|
2191
|
+
"description": "Specifies trendlines for this measure."
|
|
2192
|
+
},
|
|
2193
|
+
"qMiniChartDef": {
|
|
2194
|
+
"$ref": "NxMiniChartDef.json"
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
"description": "<div class=note>Either **qDef** or **qLibraryId** must be set, but not both. If both are set, the library measure's qDef and qLabel will be used. </div> <div class=note>If the measure is set in the hypercube and not in the library, this measure cannot be shared with other objects.</div> <div class=note>A measure that is set in the library can be used by many objects.</div> <div class=note>\nexpressions are complementary expressions associated to a measure. For example, you can decide to change the background color of a visualization depending on the values of the measure.\nAttribute expressions do not affect the layout of an object. The sorting order is unchanged.\n</div>"
|
|
2198
|
+
},
|
|
2199
|
+
"NxTrendlineDef": {
|
|
2200
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2201
|
+
"$id": "NxTrendlineDef.json",
|
|
2202
|
+
"type": "object",
|
|
2203
|
+
"properties": {
|
|
2204
|
+
"qType": {
|
|
2205
|
+
"$ref": "NxLTrendlineType.json",
|
|
2206
|
+
"description": "The type of trendline to calculate One of: * AVERAGE or Average * LINEAR or Linear * POLYNOMIAL2 or Polynomial2 * POLYNOMIAL3 or Polynomial3 * POLYNOMIAL4 or Polynomial4 * EXPONENTIAL or Exponential * POWER or Power * LOG or Logarithmic"
|
|
2207
|
+
},
|
|
2208
|
+
"qXColIx": {
|
|
2209
|
+
"type": "integer",
|
|
2210
|
+
"minimum": -2147483648,
|
|
2211
|
+
"maximum": 2147483647,
|
|
2212
|
+
"description": "The column in the hypercube to be used as x axis. Can point to either a dimension (numeric or text) or a measure"
|
|
2213
|
+
},
|
|
2214
|
+
"qCalcR2": {
|
|
2215
|
+
"type": "boolean",
|
|
2216
|
+
"description": "Set to true to calulatate the R2 score"
|
|
2217
|
+
},
|
|
2218
|
+
"qContinuousXAxis": {
|
|
2219
|
+
"$ref": "NxContinuousMode.json",
|
|
2220
|
+
"description": "Set if the numerical value of x axis dimension should be used One of: * Never or CONTINUOUS_NEVER * Possible or CONTINUOUS_IF_POSSIBLE * Time or CONTINUOUS_IF_TIME"
|
|
2221
|
+
},
|
|
2222
|
+
"qMultiDimMode": {
|
|
2223
|
+
"$ref": "NxTrendlineMode.json",
|
|
2224
|
+
"description": "If you have a hypercube with two dimensions and qXColIx refers to a dimension This determines if you get one trendline of each value in the other dimension or Or trendline based on the sum of the value in the other dimension The sum variant is only supported when qXColIx is 0 and qMode (on the hypercube) is K or T One of: * Multi or TRENDLINE_MULTILINE * Sum or TRENDLINE_SUM"
|
|
2225
|
+
}
|
|
2226
|
+
},
|
|
2227
|
+
"description": "Trendline input definition"
|
|
2228
|
+
},
|
|
2229
|
+
"NxLTrendlineType": {
|
|
2230
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2231
|
+
"$id": "NxLTrendlineType.json",
|
|
2232
|
+
"anyOf": [
|
|
2233
|
+
{
|
|
2234
|
+
"type": "string",
|
|
2235
|
+
"const": "AVERAGE"
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"type": "string",
|
|
2239
|
+
"const": "LINEAR"
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"type": "string",
|
|
2243
|
+
"const": "POLYNOMIAL2"
|
|
2244
|
+
},
|
|
2245
|
+
{
|
|
2246
|
+
"type": "string",
|
|
2247
|
+
"const": "POLYNOMIAL3"
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"type": "string",
|
|
2251
|
+
"const": "POLYNOMIAL4"
|
|
2252
|
+
},
|
|
2253
|
+
{
|
|
2254
|
+
"type": "string",
|
|
2255
|
+
"const": "EXPONENTIAL"
|
|
2256
|
+
},
|
|
2257
|
+
{
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"const": "POWER"
|
|
2260
|
+
},
|
|
2261
|
+
{
|
|
2262
|
+
"type": "string",
|
|
2263
|
+
"const": "LOG"
|
|
2264
|
+
}
|
|
2265
|
+
],
|
|
2266
|
+
"description": "NxLTrendlineType"
|
|
2267
|
+
},
|
|
2268
|
+
"NxContinuousMode": {
|
|
2269
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2270
|
+
"$id": "NxContinuousMode.json",
|
|
2271
|
+
"anyOf": [
|
|
2272
|
+
{
|
|
2273
|
+
"type": "string",
|
|
2274
|
+
"const": "CONTINUOUS_NEVER"
|
|
2275
|
+
},
|
|
2276
|
+
{
|
|
2277
|
+
"type": "string",
|
|
2278
|
+
"const": "CONTINUOUS_IF_POSSIBLE"
|
|
2279
|
+
},
|
|
2280
|
+
{
|
|
2281
|
+
"type": "string",
|
|
2282
|
+
"const": "CONTINUOUS_IF_TIME"
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"type": "string",
|
|
2286
|
+
"const": "Never"
|
|
2287
|
+
},
|
|
2288
|
+
{
|
|
2289
|
+
"type": "string",
|
|
2290
|
+
"const": "Possible"
|
|
2291
|
+
},
|
|
2292
|
+
{
|
|
2293
|
+
"type": "string",
|
|
2294
|
+
"const": "Time"
|
|
2295
|
+
}
|
|
2296
|
+
],
|
|
2297
|
+
"description": "NxContinuousMode"
|
|
2298
|
+
},
|
|
2299
|
+
"NxTrendlineMode": {
|
|
2300
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2301
|
+
"$id": "NxTrendlineMode.json",
|
|
2302
|
+
"anyOf": [
|
|
2303
|
+
{
|
|
2304
|
+
"type": "string",
|
|
2305
|
+
"const": "TRENDLINE_MULTILINE"
|
|
2306
|
+
},
|
|
2307
|
+
{
|
|
2308
|
+
"type": "string",
|
|
2309
|
+
"const": "TRENDLINE_SUM"
|
|
2310
|
+
},
|
|
2311
|
+
{
|
|
2312
|
+
"type": "string",
|
|
2313
|
+
"const": "Multi"
|
|
2314
|
+
},
|
|
2315
|
+
{
|
|
2316
|
+
"type": "string",
|
|
2317
|
+
"const": "Sum"
|
|
2318
|
+
}
|
|
2319
|
+
],
|
|
2320
|
+
"description": "NxTrendlineMode"
|
|
2321
|
+
},
|
|
2322
|
+
"NxMiniChartDef": {
|
|
2323
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2324
|
+
"$id": "NxMiniChartDef.json",
|
|
2325
|
+
"type": "object",
|
|
2326
|
+
"properties": {
|
|
2327
|
+
"qDef": {
|
|
2328
|
+
"type": "string",
|
|
2329
|
+
"description": "Expression or field name."
|
|
2330
|
+
},
|
|
2331
|
+
"qLibraryId": {
|
|
2332
|
+
"type": "string",
|
|
2333
|
+
"description": "LibraryId for dimension."
|
|
2334
|
+
},
|
|
2335
|
+
"qSortBy": {
|
|
2336
|
+
"$ref": "SortCriteria.json",
|
|
2337
|
+
"description": "Sorting."
|
|
2338
|
+
},
|
|
2339
|
+
"qOtherTotalSpec": {
|
|
2340
|
+
"$ref": "OtherTotalSpecProp.json"
|
|
2341
|
+
},
|
|
2342
|
+
"qMaxNumberPoints": {
|
|
2343
|
+
"type": "integer",
|
|
2344
|
+
"minimum": -2147483648,
|
|
2345
|
+
"maximum": 2147483647
|
|
2346
|
+
},
|
|
2347
|
+
"qAttributeExpressions": {
|
|
2348
|
+
"type": "array",
|
|
2349
|
+
"items": {
|
|
2350
|
+
"$ref": "NxAttrExprDef.json"
|
|
2351
|
+
},
|
|
2352
|
+
"description": "List of attribute expressions."
|
|
2353
|
+
},
|
|
2354
|
+
"qNullSuppression": {
|
|
2355
|
+
"type": "boolean",
|
|
2356
|
+
"description": "If set to true, no null values are returned."
|
|
2357
|
+
}
|
|
2358
|
+
},
|
|
2359
|
+
"description": "NxMiniChartDef"
|
|
2360
|
+
},
|
|
2361
|
+
"CustomErrorMessage": {
|
|
2362
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2363
|
+
"$id": "CustomErrorMessage.json",
|
|
2364
|
+
"type": "object",
|
|
2365
|
+
"properties": {
|
|
2366
|
+
"calcCond": {
|
|
2367
|
+
"type": "string",
|
|
2368
|
+
"description": "Custom message shown when the hypercube calculation condition is not met. Used with `qCalcCondition.qCond`."
|
|
2369
|
+
}
|
|
2370
|
+
}
|
|
2371
|
+
},
|
|
2372
|
+
"NxPage": {
|
|
2373
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2374
|
+
"$id": "NxPage.json",
|
|
2375
|
+
"type": "object",
|
|
2376
|
+
"properties": {
|
|
2377
|
+
"qLeft": {
|
|
2378
|
+
"type": "integer",
|
|
2379
|
+
"minimum": -2147483648,
|
|
2380
|
+
"maximum": 2147483647,
|
|
2381
|
+
"description": "Position from the left. Corresponds to the first column."
|
|
2382
|
+
},
|
|
2383
|
+
"qTop": {
|
|
2384
|
+
"type": "integer",
|
|
2385
|
+
"minimum": -2147483648,
|
|
2386
|
+
"maximum": 2147483647,
|
|
2387
|
+
"description": "Position from the top. Corresponds to the first row."
|
|
2388
|
+
},
|
|
2389
|
+
"qWidth": {
|
|
2390
|
+
"type": "integer",
|
|
2391
|
+
"minimum": -2147483648,
|
|
2392
|
+
"maximum": 2147483647,
|
|
2393
|
+
"description": "Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ )."
|
|
2394
|
+
},
|
|
2395
|
+
"qHeight": {
|
|
2396
|
+
"type": "integer",
|
|
2397
|
+
"minimum": -2147483648,
|
|
2398
|
+
"maximum": 2147483647,
|
|
2399
|
+
"description": "Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ )."
|
|
2400
|
+
}
|
|
2401
|
+
},
|
|
2402
|
+
"description": "NxPage"
|
|
2403
|
+
},
|
|
2404
|
+
"RankedList": {
|
|
2405
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2406
|
+
"$id": "RankedList.json",
|
|
2407
|
+
"type": "object",
|
|
2408
|
+
"properties": {
|
|
2409
|
+
"rows": {
|
|
2410
|
+
"type": "array",
|
|
2411
|
+
"items": {
|
|
2412
|
+
"anyOf": [
|
|
2413
|
+
{
|
|
2414
|
+
"type": "string"
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"type": "number",
|
|
2418
|
+
"const": -1
|
|
2419
|
+
}
|
|
2420
|
+
]
|
|
2421
|
+
},
|
|
2422
|
+
"description": "Row order used by chart exploration, referencing dimension `cId` values. Use `-1` for a pseudo-dimension slot."
|
|
2423
|
+
},
|
|
2424
|
+
"columns": {
|
|
2425
|
+
"type": "array",
|
|
2426
|
+
"items": {
|
|
2427
|
+
"anyOf": [
|
|
2428
|
+
{
|
|
2429
|
+
"type": "string"
|
|
2430
|
+
},
|
|
2431
|
+
{
|
|
2432
|
+
"type": "number",
|
|
2433
|
+
"const": -1
|
|
2434
|
+
}
|
|
2435
|
+
]
|
|
2436
|
+
},
|
|
2437
|
+
"description": "Column order used by chart exploration, referencing dimension `cId` values. Use `-1` for a pseudo-dimension slot."
|
|
2438
|
+
},
|
|
2439
|
+
"measures": {
|
|
2440
|
+
"type": "array",
|
|
2441
|
+
"items": {
|
|
2442
|
+
"type": "string"
|
|
2443
|
+
},
|
|
2444
|
+
"description": "Measure order used by chart exploration, referencing measure `cId` values."
|
|
2445
|
+
}
|
|
2446
|
+
},
|
|
2447
|
+
"description": "Row/column/measure `cId` lists mirroring `qDimensions`/`qMeasures` and `qInterColumnSortOrder`.\nSync reorders and row/column moves with the matching section and `qNoOfLeftDims`; mismatched ids/orders corrupt the list.\nRows/columns contain active dimensions in active order, then excluded dimensions from `qLayoutExclude.qHyperCubeDef.qDimensions`\n(excluded order is unrestricted; ids must match). Include `-1` only with 2+ measures."
|
|
2448
|
+
},
|
|
2449
|
+
"HyperCubeLayoutExclude": {
|
|
2450
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2451
|
+
"$id": "HyperCubeLayoutExclude.json",
|
|
2452
|
+
"type": "object",
|
|
2453
|
+
"properties": {
|
|
2454
|
+
"qHyperCubeDef": {
|
|
2455
|
+
"$ref": "ExcludedHyperCubeDef.json",
|
|
2456
|
+
"description": "Excluded columns that can be restored later."
|
|
2457
|
+
}
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"ExcludedHyperCubeDef": {
|
|
2461
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2462
|
+
"$id": "ExcludedHyperCubeDef.json",
|
|
2463
|
+
"type": "object",
|
|
2464
|
+
"properties": {
|
|
2465
|
+
"qDimensions": {
|
|
2466
|
+
"type": "array",
|
|
2467
|
+
"items": {
|
|
2468
|
+
"$ref": "DimensionProperties.json"
|
|
2469
|
+
},
|
|
2470
|
+
"description": "Excluded dimensions, split into rows/columns by `excludedNoOfLeftDims`, like active dimensions by `qNoOfLeftDims`."
|
|
2471
|
+
},
|
|
2472
|
+
"qMeasures": {
|
|
2473
|
+
"type": "array",
|
|
2474
|
+
"items": {
|
|
2475
|
+
"$ref": "MeasureProperties.json"
|
|
2476
|
+
},
|
|
2477
|
+
"description": "Measures hidden from the active hypercube, typically by chart exploration."
|
|
2478
|
+
}
|
|
2479
|
+
}
|
|
2480
|
+
},
|
|
2481
|
+
"ChartExplorationProperties": {
|
|
2482
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2483
|
+
"$id": "ChartExplorationProperties.json",
|
|
2484
|
+
"type": "object",
|
|
2485
|
+
"properties": {
|
|
2486
|
+
"menuVisibility": {
|
|
2487
|
+
"anyOf": [
|
|
2488
|
+
{
|
|
2489
|
+
"type": "string",
|
|
2490
|
+
"const": "auto"
|
|
2491
|
+
},
|
|
2492
|
+
{
|
|
2493
|
+
"type": "string",
|
|
2494
|
+
"const": "visible"
|
|
2495
|
+
},
|
|
2496
|
+
{
|
|
2497
|
+
"type": "string",
|
|
2498
|
+
"const": "hidden"
|
|
2499
|
+
},
|
|
2500
|
+
{
|
|
2501
|
+
"type": "string",
|
|
2502
|
+
"const": "minimized"
|
|
2503
|
+
}
|
|
2504
|
+
],
|
|
2505
|
+
"description": "Exploration menu visibility; panel initializes to `auto` on edit. Omit for new objects unless specifying visibility."
|
|
2506
|
+
}
|
|
2507
|
+
},
|
|
2508
|
+
"required": [
|
|
2509
|
+
"menuVisibility"
|
|
2510
|
+
]
|
|
2511
|
+
},
|
|
2512
|
+
"NullValueRepresentationDef": {
|
|
2513
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2514
|
+
"$id": "NullValueRepresentationDef.json",
|
|
2515
|
+
"type": "object",
|
|
2516
|
+
"properties": {
|
|
2517
|
+
"text": {
|
|
2518
|
+
"type": "string",
|
|
2519
|
+
"description": "Text shown for null measure values. Falls back to the engine cell text when omitted."
|
|
2520
|
+
},
|
|
2521
|
+
"dimensionText": {
|
|
2522
|
+
"type": "string",
|
|
2523
|
+
"description": "Text shown for null dimension values when separate null styling is enabled. Falls back to the engine cell text when omitted."
|
|
2524
|
+
}
|
|
2525
|
+
}
|
|
2526
|
+
},
|
|
2527
|
+
"Component": {
|
|
2528
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2529
|
+
"$id": "Component.json",
|
|
2530
|
+
"anyOf": [
|
|
2531
|
+
{
|
|
2532
|
+
"$ref": "GeneralStyleComponentProperties.json"
|
|
2533
|
+
},
|
|
2534
|
+
{
|
|
2535
|
+
"$ref": "ThemeComponent.json"
|
|
2536
|
+
}
|
|
2537
|
+
]
|
|
2538
|
+
},
|
|
2539
|
+
"GeneralStyleComponentProperties": {
|
|
2540
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2541
|
+
"$id": "GeneralStyleComponentProperties.json",
|
|
2542
|
+
"type": "object",
|
|
2543
|
+
"properties": {
|
|
2544
|
+
"bgColor": {
|
|
2545
|
+
"$ref": "BackgroundColorProperties.json",
|
|
2546
|
+
"description": "Background color definition."
|
|
2547
|
+
},
|
|
2548
|
+
"bgImage": {
|
|
2549
|
+
"anyOf": [
|
|
2550
|
+
{
|
|
2551
|
+
"$ref": "BackgroundImageProperties.json"
|
|
2552
|
+
},
|
|
2553
|
+
{
|
|
2554
|
+
"type": "object",
|
|
2555
|
+
"properties": {}
|
|
2556
|
+
}
|
|
2557
|
+
],
|
|
2558
|
+
"description": "Background image definition. Can transiently be an empty object before a mode\n(media/expression/none) is chosen in the styling panel."
|
|
2559
|
+
}
|
|
2560
|
+
},
|
|
2561
|
+
"allOf": [
|
|
2562
|
+
{
|
|
2563
|
+
"$ref": "GeneralStyleComponentBase.json"
|
|
2564
|
+
}
|
|
2565
|
+
],
|
|
2566
|
+
"description": "Titles, background, border and shadow styling. Set key to \"general\"."
|
|
2567
|
+
},
|
|
2568
|
+
"BackgroundColorProperties": {
|
|
2569
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2570
|
+
"$id": "BackgroundColorProperties.json",
|
|
2571
|
+
"type": "object",
|
|
2572
|
+
"properties": {
|
|
2573
|
+
"color": {
|
|
2574
|
+
"$ref": "Color.json",
|
|
2575
|
+
"description": "Background color. Used when `useColorExpression` is false."
|
|
2576
|
+
},
|
|
2577
|
+
"useColorExpression": {
|
|
2578
|
+
"type": "boolean",
|
|
2579
|
+
"description": "When true, `colorExpression` is used instead of `color`."
|
|
2580
|
+
},
|
|
2581
|
+
"colorExpression": {
|
|
2582
|
+
"anyOf": [
|
|
2583
|
+
{
|
|
2584
|
+
"type": "string"
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
"$ref": "StringExpressionWrapper.json"
|
|
2588
|
+
}
|
|
2589
|
+
],
|
|
2590
|
+
"description": "Expression-based background color. Used when `useColorExpression` is true."
|
|
2591
|
+
}
|
|
2592
|
+
}
|
|
2593
|
+
},
|
|
2594
|
+
"Color": {
|
|
2595
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2596
|
+
"$id": "Color.json",
|
|
2597
|
+
"anyOf": [
|
|
2598
|
+
{
|
|
2599
|
+
"$ref": "CustomColor.json"
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
"$ref": "IndexedColor.json"
|
|
2603
|
+
}
|
|
2604
|
+
]
|
|
2605
|
+
},
|
|
2606
|
+
"CustomColor": {
|
|
2607
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2608
|
+
"$id": "CustomColor.json",
|
|
2609
|
+
"type": "object",
|
|
2610
|
+
"properties": {
|
|
2611
|
+
"index": {
|
|
2612
|
+
"type": "number",
|
|
2613
|
+
"const": -1,
|
|
2614
|
+
"description": "Use the custom color instead of a palette color. Omit, or set to -1."
|
|
2615
|
+
},
|
|
2616
|
+
"color": {
|
|
2617
|
+
"type": "string",
|
|
2618
|
+
"description": "Hex color string, e.g. \"#4477aa\"."
|
|
2619
|
+
}
|
|
2620
|
+
},
|
|
2621
|
+
"required": [
|
|
2622
|
+
"color"
|
|
2623
|
+
],
|
|
2624
|
+
"allOf": [
|
|
2625
|
+
{
|
|
2626
|
+
"$ref": "ColorProperties.json"
|
|
2627
|
+
}
|
|
2628
|
+
]
|
|
2629
|
+
},
|
|
2630
|
+
"ColorProperties": {
|
|
2631
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2632
|
+
"$id": "ColorProperties.json",
|
|
2633
|
+
"type": "object",
|
|
2634
|
+
"properties": {
|
|
2635
|
+
"alpha": {
|
|
2636
|
+
"type": "number",
|
|
2637
|
+
"default": 1,
|
|
2638
|
+
"minimum": 0,
|
|
2639
|
+
"maximum": 1,
|
|
2640
|
+
"description": "Opacity from 0 (transparent) to 1 (opaque)."
|
|
2641
|
+
}
|
|
2642
|
+
}
|
|
2643
|
+
},
|
|
2644
|
+
"IndexedColor": {
|
|
2645
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2646
|
+
"$id": "IndexedColor.json",
|
|
2647
|
+
"type": "object",
|
|
2648
|
+
"properties": {
|
|
2649
|
+
"index": {
|
|
2650
|
+
"type": "integer",
|
|
2651
|
+
"default": 6,
|
|
2652
|
+
"minimum": 0,
|
|
2653
|
+
"description": "Zero-based index into the theme palette."
|
|
2654
|
+
},
|
|
2655
|
+
"color": {
|
|
2656
|
+
"type": "string",
|
|
2657
|
+
"description": "Hex color to use when the theme palette does not contain the requested index."
|
|
2658
|
+
}
|
|
2659
|
+
},
|
|
2660
|
+
"required": [
|
|
2661
|
+
"index"
|
|
2662
|
+
],
|
|
2663
|
+
"allOf": [
|
|
2664
|
+
{
|
|
2665
|
+
"$ref": "ColorProperties.json"
|
|
2666
|
+
}
|
|
2667
|
+
]
|
|
2668
|
+
},
|
|
2669
|
+
"StringExpressionWrapper": {
|
|
2670
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2671
|
+
"$id": "StringExpressionWrapper.json",
|
|
2672
|
+
"type": "object",
|
|
2673
|
+
"properties": {
|
|
2674
|
+
"qStringExpression": {
|
|
2675
|
+
"$ref": "StringExpression.json"
|
|
2676
|
+
}
|
|
2677
|
+
},
|
|
2678
|
+
"required": [
|
|
2679
|
+
"qStringExpression"
|
|
2680
|
+
],
|
|
2681
|
+
"description": "String expression."
|
|
2682
|
+
},
|
|
2683
|
+
"BackgroundImageProperties": {
|
|
2684
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2685
|
+
"$id": "BackgroundImageProperties.json",
|
|
2686
|
+
"type": "object",
|
|
2687
|
+
"properties": {
|
|
2688
|
+
"mode": {
|
|
2689
|
+
"anyOf": [
|
|
2690
|
+
{
|
|
2691
|
+
"type": "string",
|
|
2692
|
+
"const": "none"
|
|
2693
|
+
},
|
|
2694
|
+
{
|
|
2695
|
+
"type": "string",
|
|
2696
|
+
"const": "media"
|
|
2697
|
+
},
|
|
2698
|
+
{
|
|
2699
|
+
"type": "string",
|
|
2700
|
+
"const": "expression"
|
|
2701
|
+
}
|
|
2702
|
+
]
|
|
2703
|
+
},
|
|
2704
|
+
"mediaUrl": {
|
|
2705
|
+
"$ref": "MediaUrlProperties.json",
|
|
2706
|
+
"description": "Media library image reference. Used when `mode` is \"media\"."
|
|
2707
|
+
},
|
|
2708
|
+
"expressionUrl": {
|
|
2709
|
+
"anyOf": [
|
|
2710
|
+
{
|
|
2711
|
+
"type": "string"
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
"$ref": "StringExpressionWrapper.json"
|
|
2715
|
+
}
|
|
2716
|
+
],
|
|
2717
|
+
"description": "Image URL (plain string or expression). Used when `mode` is \"expression\"."
|
|
2718
|
+
},
|
|
2719
|
+
"position": {
|
|
2720
|
+
"$ref": "ImagePosition.json",
|
|
2721
|
+
"description": "Image position. Used when `mode` is \"media\" or \"expression\"."
|
|
2722
|
+
},
|
|
2723
|
+
"sizing": {
|
|
2724
|
+
"$ref": "ImageScaling.json",
|
|
2725
|
+
"description": "Image sizing mode. Used when `mode` is \"media\" or \"expression\"."
|
|
2726
|
+
}
|
|
2727
|
+
}
|
|
2728
|
+
},
|
|
2729
|
+
"MediaUrlProperties": {
|
|
2730
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2731
|
+
"$id": "MediaUrlProperties.json",
|
|
2732
|
+
"type": "object",
|
|
2733
|
+
"properties": {
|
|
2734
|
+
"qStaticContentUrlDef": {
|
|
2735
|
+
"$ref": "StaticContentUrlDef.json"
|
|
2736
|
+
}
|
|
2737
|
+
}
|
|
2738
|
+
},
|
|
2739
|
+
"StaticContentUrlDef": {
|
|
2740
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2741
|
+
"$id": "StaticContentUrlDef.json",
|
|
2742
|
+
"type": "object",
|
|
2743
|
+
"properties": {
|
|
2744
|
+
"qUrl": {
|
|
2745
|
+
"type": "string",
|
|
2746
|
+
"description": "Relative path of the thumbnail."
|
|
2747
|
+
}
|
|
2748
|
+
},
|
|
2749
|
+
"description": "<div class=note>In addition, this structure can contain dynamic properties.</div>"
|
|
2750
|
+
},
|
|
2751
|
+
"ImagePosition": {
|
|
2752
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2753
|
+
"$id": "ImagePosition.json",
|
|
2754
|
+
"anyOf": [
|
|
2755
|
+
{
|
|
2756
|
+
"type": "string",
|
|
2757
|
+
"const": "top-left"
|
|
2758
|
+
},
|
|
2759
|
+
{
|
|
2760
|
+
"type": "string",
|
|
2761
|
+
"const": "top-center"
|
|
2762
|
+
},
|
|
2763
|
+
{
|
|
2764
|
+
"type": "string",
|
|
2765
|
+
"const": "top-right"
|
|
2766
|
+
},
|
|
2767
|
+
{
|
|
2768
|
+
"type": "string",
|
|
2769
|
+
"const": "center-left"
|
|
2770
|
+
},
|
|
2771
|
+
{
|
|
2772
|
+
"type": "string",
|
|
2773
|
+
"const": "center-center"
|
|
2774
|
+
},
|
|
2775
|
+
{
|
|
2776
|
+
"type": "string",
|
|
2777
|
+
"const": "center-right"
|
|
2778
|
+
},
|
|
2779
|
+
{
|
|
2780
|
+
"type": "string",
|
|
2781
|
+
"const": "bottom-left"
|
|
2782
|
+
},
|
|
2783
|
+
{
|
|
2784
|
+
"type": "string",
|
|
2785
|
+
"const": "bottom-center"
|
|
2786
|
+
},
|
|
2787
|
+
{
|
|
2788
|
+
"type": "string",
|
|
2789
|
+
"const": "bottom-right"
|
|
2790
|
+
}
|
|
2791
|
+
]
|
|
2792
|
+
},
|
|
2793
|
+
"ImageScaling": {
|
|
2794
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2795
|
+
"$id": "ImageScaling.json",
|
|
2796
|
+
"anyOf": [
|
|
2797
|
+
{
|
|
2798
|
+
"type": "string",
|
|
2799
|
+
"const": "originalSize"
|
|
2800
|
+
},
|
|
2801
|
+
{
|
|
2802
|
+
"type": "string",
|
|
2803
|
+
"const": "alwaysFit"
|
|
2804
|
+
},
|
|
2805
|
+
{
|
|
2806
|
+
"type": "string",
|
|
2807
|
+
"const": "fitWidth"
|
|
2808
|
+
},
|
|
2809
|
+
{
|
|
2810
|
+
"type": "string",
|
|
2811
|
+
"const": "fitHeight"
|
|
2812
|
+
},
|
|
2813
|
+
{
|
|
2814
|
+
"type": "string",
|
|
2815
|
+
"const": "stretchFit"
|
|
2816
|
+
},
|
|
2817
|
+
{
|
|
2818
|
+
"type": "string",
|
|
2819
|
+
"const": "alwaysFill"
|
|
2820
|
+
}
|
|
2821
|
+
]
|
|
2822
|
+
},
|
|
2823
|
+
"GeneralStyleComponentBase": {
|
|
2824
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2825
|
+
"$id": "GeneralStyleComponentBase.json",
|
|
2826
|
+
"type": "object",
|
|
2827
|
+
"properties": {
|
|
2828
|
+
"key": {
|
|
2829
|
+
"type": "string",
|
|
2830
|
+
"const": "general"
|
|
2831
|
+
},
|
|
2832
|
+
"title": {
|
|
2833
|
+
"$ref": "TitleStyles.json",
|
|
2834
|
+
"description": "Title, subtitle, and footer text styles."
|
|
2835
|
+
},
|
|
2836
|
+
"borderWidth": {
|
|
2837
|
+
"type": "string",
|
|
2838
|
+
"description": "Border width as a CSS value, e.g. '1px'."
|
|
2839
|
+
},
|
|
2840
|
+
"borderColor": {
|
|
2841
|
+
"$ref": "Color.json",
|
|
2842
|
+
"description": "Border color."
|
|
2843
|
+
},
|
|
2844
|
+
"borderRadius": {
|
|
2845
|
+
"type": "string",
|
|
2846
|
+
"description": "Border corner radius as a CSS value, e.g. '4px'."
|
|
2847
|
+
},
|
|
2848
|
+
"shadow": {
|
|
2849
|
+
"$ref": "Shadow.json",
|
|
2850
|
+
"description": "Box shadow"
|
|
2851
|
+
}
|
|
2852
|
+
},
|
|
2853
|
+
"required": [
|
|
2854
|
+
"key"
|
|
2855
|
+
],
|
|
2856
|
+
"allOf": [
|
|
2857
|
+
{
|
|
2858
|
+
"$ref": "StyleComponent.json"
|
|
2859
|
+
}
|
|
2860
|
+
]
|
|
2861
|
+
},
|
|
2862
|
+
"TitleStyles": {
|
|
2863
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2864
|
+
"$id": "TitleStyles.json",
|
|
2865
|
+
"type": "object",
|
|
2866
|
+
"properties": {
|
|
2867
|
+
"main": {
|
|
2868
|
+
"$ref": "FontStyling.json",
|
|
2869
|
+
"description": "Style for the main title."
|
|
2870
|
+
},
|
|
2871
|
+
"subTitle": {
|
|
2872
|
+
"$ref": "FontStyling.json",
|
|
2873
|
+
"description": "Style for the subtitle."
|
|
2874
|
+
},
|
|
2875
|
+
"footer": {
|
|
2876
|
+
"$ref": "FontStyling.json",
|
|
2877
|
+
"description": "Style for the footer text."
|
|
2878
|
+
}
|
|
2879
|
+
}
|
|
2880
|
+
},
|
|
2881
|
+
"FontStyling": {
|
|
2882
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2883
|
+
"$id": "FontStyling.json",
|
|
2884
|
+
"type": "object",
|
|
2885
|
+
"properties": {
|
|
2886
|
+
"fontStyle": {
|
|
2887
|
+
"type": "array",
|
|
2888
|
+
"items": {
|
|
2889
|
+
"$ref": "TextStyleModifier.json"
|
|
2890
|
+
},
|
|
2891
|
+
"description": "Active font style modifiers."
|
|
2892
|
+
}
|
|
2893
|
+
},
|
|
2894
|
+
"allOf": [
|
|
2895
|
+
{
|
|
2896
|
+
"$ref": "FontBaseStyling.json"
|
|
2897
|
+
}
|
|
2898
|
+
]
|
|
2899
|
+
},
|
|
2900
|
+
"TextStyleModifier": {
|
|
2901
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2902
|
+
"$id": "TextStyleModifier.json",
|
|
2903
|
+
"anyOf": [
|
|
2904
|
+
{
|
|
2905
|
+
"type": "string",
|
|
2906
|
+
"const": ""
|
|
2907
|
+
},
|
|
2908
|
+
{
|
|
2909
|
+
"type": "string",
|
|
2910
|
+
"const": "bold"
|
|
2911
|
+
},
|
|
2912
|
+
{
|
|
2913
|
+
"type": "string",
|
|
2914
|
+
"const": "italic"
|
|
2915
|
+
},
|
|
2916
|
+
{
|
|
2917
|
+
"type": "string",
|
|
2918
|
+
"const": "underline"
|
|
2919
|
+
}
|
|
2920
|
+
]
|
|
2921
|
+
},
|
|
2922
|
+
"FontBaseStyling": {
|
|
2923
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2924
|
+
"$id": "FontBaseStyling.json",
|
|
2925
|
+
"type": "object",
|
|
2926
|
+
"properties": {
|
|
2927
|
+
"color": {
|
|
2928
|
+
"$ref": "Color.json",
|
|
2929
|
+
"description": "Text color."
|
|
2930
|
+
},
|
|
2931
|
+
"fontFamily": {
|
|
2932
|
+
"type": "string",
|
|
2933
|
+
"description": "Font family name, e.g. 'Source Sans Pro'."
|
|
2934
|
+
},
|
|
2935
|
+
"fontSize": {
|
|
2936
|
+
"type": "string",
|
|
2937
|
+
"description": "Font size as a CSS value, e.g. '14px'."
|
|
2938
|
+
}
|
|
2939
|
+
}
|
|
2940
|
+
},
|
|
2941
|
+
"Shadow": {
|
|
2942
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2943
|
+
"$id": "Shadow.json",
|
|
2944
|
+
"type": "object",
|
|
2945
|
+
"properties": {
|
|
2946
|
+
"boxShadow": {
|
|
2947
|
+
"type": "string",
|
|
2948
|
+
"description": "CSS box-shadow value, e.g. '2px 2px 4px 0px'."
|
|
2949
|
+
},
|
|
2950
|
+
"boxShadowColor": {
|
|
2951
|
+
"$ref": "Color.json",
|
|
2952
|
+
"description": "Shadow color."
|
|
2953
|
+
}
|
|
2954
|
+
}
|
|
2955
|
+
},
|
|
2956
|
+
"StyleComponent": {
|
|
2957
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2958
|
+
"$id": "StyleComponent.json",
|
|
2959
|
+
"type": "object",
|
|
2960
|
+
"properties": {
|
|
2961
|
+
"key": {
|
|
2962
|
+
"type": "string",
|
|
2963
|
+
"description": "Identifies the style component type."
|
|
2964
|
+
}
|
|
2965
|
+
},
|
|
2966
|
+
"required": [
|
|
2967
|
+
"key"
|
|
2968
|
+
]
|
|
2969
|
+
},
|
|
2970
|
+
"ThemeComponent": {
|
|
2971
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2972
|
+
"$id": "ThemeComponent.json",
|
|
2973
|
+
"type": "object",
|
|
2974
|
+
"properties": {
|
|
2975
|
+
"key": {
|
|
2976
|
+
"type": "string",
|
|
2977
|
+
"const": "theme",
|
|
2978
|
+
"description": "Chart styling target."
|
|
2979
|
+
},
|
|
2980
|
+
"header": {
|
|
2981
|
+
"$ref": "StyleValues.json",
|
|
2982
|
+
"description": "Header styling."
|
|
2983
|
+
},
|
|
2984
|
+
"dimensionValues": {
|
|
2985
|
+
"$ref": "StyleValues.json",
|
|
2986
|
+
"description": "Styling for dimension values. Dimension-specific styling overrides this when both are present."
|
|
2987
|
+
},
|
|
2988
|
+
"measureValues": {
|
|
2989
|
+
"$ref": "StyleValues.json",
|
|
2990
|
+
"description": "Styling for measure values. When omitted, the theme/default measure styling is used."
|
|
2991
|
+
},
|
|
2992
|
+
"measureLabels": {
|
|
2993
|
+
"$ref": "NullOrTotalStyleValues.json",
|
|
2994
|
+
"description": "Styling for measure header labels."
|
|
2995
|
+
},
|
|
2996
|
+
"totalValues": {
|
|
2997
|
+
"$ref": "NullOrTotalStyleValues.json",
|
|
2998
|
+
"description": "Styling for totals row values."
|
|
2999
|
+
},
|
|
3000
|
+
"nullValues": {
|
|
3001
|
+
"$ref": "NullOrTotalStyleValues.json",
|
|
3002
|
+
"description": "Styling for measure null values."
|
|
3003
|
+
},
|
|
3004
|
+
"dimensionNullValues": {
|
|
3005
|
+
"$ref": "NullOrTotalStyleValues.json",
|
|
3006
|
+
"description": "Styling for dimension null values."
|
|
3007
|
+
},
|
|
3008
|
+
"grid": {
|
|
3009
|
+
"$ref": "GridStyling.json",
|
|
3010
|
+
"description": "Grid, divider, border, and line-clamp styling."
|
|
3011
|
+
}
|
|
3012
|
+
},
|
|
3013
|
+
"required": [
|
|
3014
|
+
"key"
|
|
3015
|
+
],
|
|
3016
|
+
"description": "Table-wide theme styling in `components`; non-theme formatting belongs in `GeneralStyleComponentProperties`."
|
|
3017
|
+
},
|
|
3018
|
+
"StyleValues": {
|
|
3019
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3020
|
+
"$id": "StyleValues.json",
|
|
3021
|
+
"type": "object",
|
|
3022
|
+
"properties": {
|
|
3023
|
+
"fontFamily": {
|
|
3024
|
+
"type": "string",
|
|
3025
|
+
"description": "Font family. Omit to inherit the table or theme font family."
|
|
3026
|
+
},
|
|
3027
|
+
"fontSize": {
|
|
3028
|
+
"type": "string",
|
|
3029
|
+
"description": "Font size."
|
|
3030
|
+
},
|
|
3031
|
+
"fontColor": {
|
|
3032
|
+
"$ref": "PaletteColor.json",
|
|
3033
|
+
"description": "Text color."
|
|
3034
|
+
},
|
|
3035
|
+
"fontStyle": {
|
|
3036
|
+
"type": "array",
|
|
3037
|
+
"items": {
|
|
3038
|
+
"$ref": "FontStyle.json"
|
|
3039
|
+
},
|
|
3040
|
+
"description": "Font style decorations applied to the text."
|
|
3041
|
+
},
|
|
3042
|
+
"background": {
|
|
3043
|
+
"$ref": "PaletteColor.json",
|
|
3044
|
+
"description": "Background color."
|
|
3045
|
+
}
|
|
3046
|
+
}
|
|
3047
|
+
},
|
|
3048
|
+
"FontStyle": {
|
|
3049
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3050
|
+
"$id": "FontStyle.json",
|
|
3051
|
+
"anyOf": [
|
|
3052
|
+
{
|
|
3053
|
+
"type": "string",
|
|
3054
|
+
"const": "bold"
|
|
3055
|
+
},
|
|
3056
|
+
{
|
|
3057
|
+
"type": "string",
|
|
3058
|
+
"const": "italic"
|
|
3059
|
+
},
|
|
3060
|
+
{
|
|
3061
|
+
"type": "string",
|
|
3062
|
+
"const": "underline"
|
|
3063
|
+
}
|
|
3064
|
+
]
|
|
3065
|
+
},
|
|
3066
|
+
"NullOrTotalStyleValues": {
|
|
3067
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3068
|
+
"$id": "NullOrTotalStyleValues.json",
|
|
3069
|
+
"type": "object",
|
|
3070
|
+
"properties": {
|
|
3071
|
+
"fontStyle": {
|
|
3072
|
+
"type": "array",
|
|
3073
|
+
"items": {
|
|
3074
|
+
"$ref": "FontStyle.json"
|
|
3075
|
+
},
|
|
3076
|
+
"description": "Font style decorations applied to the text."
|
|
3077
|
+
},
|
|
3078
|
+
"fontColor": {
|
|
3079
|
+
"$ref": "PaletteColor.json",
|
|
3080
|
+
"description": "Text color."
|
|
3081
|
+
},
|
|
3082
|
+
"background": {
|
|
3083
|
+
"$ref": "PaletteColor.json",
|
|
3084
|
+
"description": "Background color."
|
|
3085
|
+
}
|
|
3086
|
+
}
|
|
3087
|
+
},
|
|
3088
|
+
"GridStyling": {
|
|
3089
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3090
|
+
"$id": "GridStyling.json",
|
|
3091
|
+
"type": "object",
|
|
3092
|
+
"properties": {
|
|
3093
|
+
"columnLineClamp": {
|
|
3094
|
+
"type": "integer",
|
|
3095
|
+
"description": "Maximum header-column text lines; inherits theme/default limit if omitted."
|
|
3096
|
+
},
|
|
3097
|
+
"lineClamp": {
|
|
3098
|
+
"type": "integer",
|
|
3099
|
+
"description": "Maximum cell text lines; inherits theme/default limit if omitted."
|
|
3100
|
+
},
|
|
3101
|
+
"border": {
|
|
3102
|
+
"$ref": "PaletteColor.json",
|
|
3103
|
+
"description": "Outer border color; inherits from theme if omitted."
|
|
3104
|
+
},
|
|
3105
|
+
"divider": {
|
|
3106
|
+
"$ref": "PaletteColor.json",
|
|
3107
|
+
"description": "Row/column divider color; inherits from theme if omitted."
|
|
3108
|
+
},
|
|
3109
|
+
"background": {
|
|
3110
|
+
"$ref": "PaletteColor.json",
|
|
3111
|
+
"description": "Optional grid background color."
|
|
3112
|
+
}
|
|
3113
|
+
}
|
|
3114
|
+
},
|
|
3115
|
+
"Filter": {
|
|
3116
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3117
|
+
"$id": "Filter.json",
|
|
3118
|
+
"type": "object",
|
|
3119
|
+
"properties": {
|
|
3120
|
+
"type": {
|
|
3121
|
+
"$ref": "FilterType.json",
|
|
3122
|
+
"description": "The filter strategy applied to this filter."
|
|
3123
|
+
},
|
|
3124
|
+
"exclude": {
|
|
3125
|
+
"type": "boolean",
|
|
3126
|
+
"description": "When true, matching values are excluded rather than included."
|
|
3127
|
+
},
|
|
3128
|
+
"field": {
|
|
3129
|
+
"type": "string",
|
|
3130
|
+
"description": "The field this filter applies to."
|
|
3131
|
+
},
|
|
3132
|
+
"id": {
|
|
3133
|
+
"type": "string",
|
|
3134
|
+
"description": "Unique identifier for this filter."
|
|
3135
|
+
},
|
|
3136
|
+
"options": {
|
|
3137
|
+
"$ref": "FilterOptions.json",
|
|
3138
|
+
"description": "Filter-type-specific configuration."
|
|
3139
|
+
},
|
|
3140
|
+
"name": {
|
|
3141
|
+
"type": "string",
|
|
3142
|
+
"description": "Short display name of the field. For derived fields, the last segment of the qualified name."
|
|
3143
|
+
},
|
|
3144
|
+
"fullname": {
|
|
3145
|
+
"type": "string",
|
|
3146
|
+
"description": "Fully qualified field name. For derived fields, includes the table prefix (e.g. 'Table.FieldName')."
|
|
3147
|
+
},
|
|
3148
|
+
"label": {
|
|
3149
|
+
"type": "string",
|
|
3150
|
+
"description": "Display label shown for this filter in the UI."
|
|
3151
|
+
},
|
|
3152
|
+
"value": {
|
|
3153
|
+
"type": "string",
|
|
3154
|
+
"description": "Optional pre-populated value. Set when a filter is created from a field-value drag operation."
|
|
3155
|
+
},
|
|
3156
|
+
"isDerived": {
|
|
3157
|
+
"type": "boolean",
|
|
3158
|
+
"description": "Whether this filter is applied to a derived field."
|
|
3159
|
+
},
|
|
3160
|
+
"qTags": {
|
|
3161
|
+
"type": "array",
|
|
3162
|
+
"items": {
|
|
3163
|
+
"type": "string"
|
|
3164
|
+
},
|
|
3165
|
+
"description": "Engine field tags, e.g. ['$numeric', '$date']. Used for feature detection."
|
|
3166
|
+
},
|
|
3167
|
+
"tags": {
|
|
3168
|
+
"type": "string",
|
|
3169
|
+
"description": "Engine field tags as a string. Fallback alternative to `qTags`."
|
|
3170
|
+
},
|
|
3171
|
+
"isNumeric": {
|
|
3172
|
+
"type": "boolean",
|
|
3173
|
+
"description": "Whether the field contains numeric data. Derived from `qTags` containing '$numeric'."
|
|
3174
|
+
},
|
|
3175
|
+
"showInFooter": {
|
|
3176
|
+
"type": "boolean",
|
|
3177
|
+
"description": "When true, the active filter is shown in the chart footer."
|
|
3178
|
+
}
|
|
3179
|
+
},
|
|
3180
|
+
"required": [
|
|
3181
|
+
"type",
|
|
3182
|
+
"exclude",
|
|
3183
|
+
"id",
|
|
3184
|
+
"options"
|
|
3185
|
+
]
|
|
3186
|
+
},
|
|
3187
|
+
"FilterType": {
|
|
3188
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3189
|
+
"$id": "FilterType.json",
|
|
3190
|
+
"anyOf": [
|
|
3191
|
+
{
|
|
3192
|
+
"type": "string",
|
|
3193
|
+
"const": "values"
|
|
3194
|
+
},
|
|
3195
|
+
{
|
|
3196
|
+
"type": "string",
|
|
3197
|
+
"const": "condition"
|
|
3198
|
+
},
|
|
3199
|
+
{
|
|
3200
|
+
"type": "string",
|
|
3201
|
+
"const": "search"
|
|
3202
|
+
},
|
|
3203
|
+
{
|
|
3204
|
+
"type": "string",
|
|
3205
|
+
"const": "clear_selection"
|
|
3206
|
+
},
|
|
3207
|
+
{
|
|
3208
|
+
"type": "string",
|
|
3209
|
+
"const": "top_bottom"
|
|
3210
|
+
}
|
|
3211
|
+
],
|
|
3212
|
+
"description": "The filter strategy applied to the visualization.\n- `values`: include or exclude specific field values.\n- `condition`: filter by a numeric condition or aggregation threshold.\n- `search`: filter by a text search pattern.\n- `clear_selection`: ignore external selections for the field in this visualization.\n- `top_bottom`: keep only the top or bottom N values (by count or percentage)."
|
|
3213
|
+
},
|
|
3214
|
+
"FilterOptions": {
|
|
3215
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3216
|
+
"$id": "FilterOptions.json",
|
|
3217
|
+
"type": "object",
|
|
3218
|
+
"properties": {
|
|
3219
|
+
"mode": {
|
|
3220
|
+
"anyOf": [
|
|
3221
|
+
{
|
|
3222
|
+
"$ref": "ConditionMode.json"
|
|
3223
|
+
},
|
|
3224
|
+
{
|
|
3225
|
+
"$ref": "SearchMode.json"
|
|
3226
|
+
}
|
|
3227
|
+
],
|
|
3228
|
+
"description": "The condition mode (`compare`/`general`) or search mode (`contains`, `starts_with`, etc.) for this filter."
|
|
3229
|
+
},
|
|
3230
|
+
"modifier": {
|
|
3231
|
+
"$ref": "FilterModifier.json",
|
|
3232
|
+
"description": "Comparison operator and value type for condition filters."
|
|
3233
|
+
},
|
|
3234
|
+
"conditionField": {
|
|
3235
|
+
"$ref": "FieldRow.json",
|
|
3236
|
+
"description": "The field or aggregation being evaluated in a condition filter."
|
|
3237
|
+
},
|
|
3238
|
+
"firstValue": {
|
|
3239
|
+
"$ref": "FieldRow.json",
|
|
3240
|
+
"description": "First (or only) condition bound. For range operators (`\"> <\"`, `\">= <=\"`), this is the lower bound."
|
|
3241
|
+
},
|
|
3242
|
+
"secondValue": {
|
|
3243
|
+
"$ref": "FieldRow.json",
|
|
3244
|
+
"description": "Second (upper) bound for range condition operators (`\"> <\"`, `\">= <=\"`)."
|
|
3245
|
+
},
|
|
3246
|
+
"topBottomMode": {
|
|
3247
|
+
"$ref": "TopBottomMode.json",
|
|
3248
|
+
"description": "Whether to keep the top or bottom values in a top/bottom filter."
|
|
3249
|
+
},
|
|
3250
|
+
"topBottomValueType": {
|
|
3251
|
+
"$ref": "TopBottomValueTypes.json",
|
|
3252
|
+
"description": "Whether `topBottomValue` is a fixed row count or a percentage of total rows."
|
|
3253
|
+
},
|
|
3254
|
+
"topBottomValue": {
|
|
3255
|
+
"type": "string",
|
|
3256
|
+
"description": "The N count or percentage threshold for a top/bottom filter."
|
|
3257
|
+
},
|
|
3258
|
+
"values": {
|
|
3259
|
+
"type": "array",
|
|
3260
|
+
"items": {
|
|
3261
|
+
"type": "string"
|
|
3262
|
+
},
|
|
3263
|
+
"description": "Selected field values for a `values` filter."
|
|
3264
|
+
}
|
|
3265
|
+
}
|
|
3266
|
+
},
|
|
3267
|
+
"ConditionMode": {
|
|
3268
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3269
|
+
"$id": "ConditionMode.json",
|
|
3270
|
+
"anyOf": [
|
|
3271
|
+
{
|
|
3272
|
+
"type": "string",
|
|
3273
|
+
"const": "compare"
|
|
3274
|
+
},
|
|
3275
|
+
{
|
|
3276
|
+
"type": "string",
|
|
3277
|
+
"const": "general"
|
|
3278
|
+
}
|
|
3279
|
+
],
|
|
3280
|
+
"description": "Evaluation strategy for a condition filter.\n- `compare`: compares raw field values directly against the condition threshold.\n- `general`: evaluates an aggregation (measure) for each field value against the condition."
|
|
3281
|
+
},
|
|
3282
|
+
"SearchMode": {
|
|
3283
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3284
|
+
"$id": "SearchMode.json",
|
|
3285
|
+
"anyOf": [
|
|
3286
|
+
{
|
|
3287
|
+
"type": "string",
|
|
3288
|
+
"const": "contains"
|
|
3289
|
+
},
|
|
3290
|
+
{
|
|
3291
|
+
"type": "string",
|
|
3292
|
+
"const": "matches_exactly"
|
|
3293
|
+
},
|
|
3294
|
+
{
|
|
3295
|
+
"type": "string",
|
|
3296
|
+
"const": "starts_with"
|
|
3297
|
+
},
|
|
3298
|
+
{
|
|
3299
|
+
"type": "string",
|
|
3300
|
+
"const": "ends_with"
|
|
3301
|
+
},
|
|
3302
|
+
{
|
|
3303
|
+
"type": "string",
|
|
3304
|
+
"const": "beginning_of_word"
|
|
3305
|
+
}
|
|
3306
|
+
],
|
|
3307
|
+
"description": "Text matching strategy for a search filter.\n- `contains`: field value contains the search term anywhere.\n- `matches_exactly`: field value is identical to the search term.\n- `starts_with`: field value begins with the search term.\n- `ends_with`: field value ends with the search term.\n- `beginning_of_word`: any word within the field value starts with the search term."
|
|
3308
|
+
},
|
|
3309
|
+
"FilterModifier": {
|
|
3310
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3311
|
+
"$id": "FilterModifier.json",
|
|
3312
|
+
"type": "object",
|
|
3313
|
+
"properties": {
|
|
3314
|
+
"operator": {
|
|
3315
|
+
"$ref": "ModifierOperator.json",
|
|
3316
|
+
"description": "Comparison operator used to evaluate the condition."
|
|
3317
|
+
},
|
|
3318
|
+
"type": {
|
|
3319
|
+
"$ref": "ModifierType.json",
|
|
3320
|
+
"description": "Whether the comparison threshold is a fixed literal or a calculated expression."
|
|
3321
|
+
}
|
|
3322
|
+
},
|
|
3323
|
+
"required": [
|
|
3324
|
+
"operator",
|
|
3325
|
+
"type"
|
|
3326
|
+
]
|
|
3327
|
+
},
|
|
3328
|
+
"ModifierOperator": {
|
|
3329
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3330
|
+
"$id": "ModifierOperator.json",
|
|
3331
|
+
"anyOf": [
|
|
3332
|
+
{
|
|
3333
|
+
"type": "string",
|
|
3334
|
+
"const": ">"
|
|
3335
|
+
},
|
|
3336
|
+
{
|
|
3337
|
+
"type": "string",
|
|
3338
|
+
"const": ">="
|
|
3339
|
+
},
|
|
3340
|
+
{
|
|
3341
|
+
"type": "string",
|
|
3342
|
+
"const": "<"
|
|
3343
|
+
},
|
|
3344
|
+
{
|
|
3345
|
+
"type": "string",
|
|
3346
|
+
"const": "<="
|
|
3347
|
+
},
|
|
3348
|
+
{
|
|
3349
|
+
"type": "string",
|
|
3350
|
+
"const": "> <"
|
|
3351
|
+
},
|
|
3352
|
+
{
|
|
3353
|
+
"type": "string",
|
|
3354
|
+
"const": ">= <="
|
|
3355
|
+
}
|
|
3356
|
+
],
|
|
3357
|
+
"description": "Comparison operator applied in a condition filter.\n`\"> <\"` and `\">= <=\"` are range operators that require both `firstValue` and `secondValue`."
|
|
3358
|
+
},
|
|
3359
|
+
"ModifierType": {
|
|
3360
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3361
|
+
"$id": "ModifierType.json",
|
|
3362
|
+
"anyOf": [
|
|
3363
|
+
{
|
|
3364
|
+
"type": "string",
|
|
3365
|
+
"const": "fixed_value"
|
|
3366
|
+
},
|
|
3367
|
+
{
|
|
3368
|
+
"type": "string",
|
|
3369
|
+
"const": "calculated_value"
|
|
3370
|
+
}
|
|
3371
|
+
],
|
|
3372
|
+
"description": "Whether the condition threshold is a literal value or a calculated expression."
|
|
3373
|
+
},
|
|
3374
|
+
"FieldRow": {
|
|
3375
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3376
|
+
"$id": "FieldRow.json",
|
|
3377
|
+
"type": "object",
|
|
3378
|
+
"properties": {
|
|
3379
|
+
"aggregator": {
|
|
3380
|
+
"type": "string",
|
|
3381
|
+
"description": "Aggregation function applied to the field, e.g. 'Sum' or 'Avg'. Used in `general` condition mode."
|
|
3382
|
+
},
|
|
3383
|
+
"field": {
|
|
3384
|
+
"type": "string",
|
|
3385
|
+
"description": "Field name to aggregate or compare against."
|
|
3386
|
+
},
|
|
3387
|
+
"fixedValue": {
|
|
3388
|
+
"type": "string",
|
|
3389
|
+
"description": "Literal threshold value. Used when `ModifierType` is `fixed_value`."
|
|
3390
|
+
}
|
|
3391
|
+
}
|
|
3392
|
+
},
|
|
3393
|
+
"TopBottomMode": {
|
|
3394
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3395
|
+
"$id": "TopBottomMode.json",
|
|
3396
|
+
"anyOf": [
|
|
3397
|
+
{
|
|
3398
|
+
"type": "string",
|
|
3399
|
+
"const": "top"
|
|
3400
|
+
},
|
|
3401
|
+
{
|
|
3402
|
+
"type": "string",
|
|
3403
|
+
"const": "bottom"
|
|
3404
|
+
}
|
|
3405
|
+
],
|
|
3406
|
+
"description": "Whether the top/bottom filter selects the highest or lowest values."
|
|
3407
|
+
},
|
|
3408
|
+
"TopBottomValueTypes": {
|
|
3409
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3410
|
+
"$id": "TopBottomValueTypes.json",
|
|
3411
|
+
"anyOf": [
|
|
3412
|
+
{
|
|
3413
|
+
"type": "string",
|
|
3414
|
+
"const": "numeric"
|
|
3415
|
+
},
|
|
3416
|
+
{
|
|
3417
|
+
"type": "string",
|
|
3418
|
+
"const": "percentage"
|
|
3419
|
+
}
|
|
3420
|
+
],
|
|
3421
|
+
"description": "Whether the top/bottom count is a fixed number of rows or a percentage of total rows."
|
|
3422
|
+
},
|
|
3423
|
+
"SearchProperties": {
|
|
3424
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3425
|
+
"$id": "SearchProperties.json",
|
|
3426
|
+
"type": "object",
|
|
3427
|
+
"properties": {
|
|
3428
|
+
"sorting": {
|
|
3429
|
+
"anyOf": [
|
|
3430
|
+
{
|
|
3431
|
+
"type": "string",
|
|
3432
|
+
"const": "auto"
|
|
3433
|
+
},
|
|
3434
|
+
{
|
|
3435
|
+
"type": "string",
|
|
3436
|
+
"const": "inherit"
|
|
3437
|
+
}
|
|
3438
|
+
],
|
|
3439
|
+
"description": "Search sorting mode. `inherit` uses the dimension sorting; `auto` uses the default search order."
|
|
3440
|
+
}
|
|
3441
|
+
},
|
|
3442
|
+
"required": [
|
|
3443
|
+
"sorting"
|
|
3444
|
+
]
|
|
3445
|
+
},
|
|
3446
|
+
"PropertiesLayoutExclude": {
|
|
3447
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3448
|
+
"$id": "PropertiesLayoutExclude.json",
|
|
3449
|
+
"type": "object",
|
|
3450
|
+
"properties": {
|
|
3451
|
+
"quarantine": {
|
|
3452
|
+
"$ref": "PropertiesLayoutExcludeQuarantine.json",
|
|
3453
|
+
"description": "Internal quarantined properties restored by migration/conversion flows."
|
|
3454
|
+
}
|
|
3455
|
+
}
|
|
3456
|
+
},
|
|
3457
|
+
"PropertiesLayoutExcludeQuarantine": {
|
|
3458
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3459
|
+
"$id": "PropertiesLayoutExcludeQuarantine.json",
|
|
3460
|
+
"type": "object",
|
|
3461
|
+
"properties": {
|
|
3462
|
+
"pivotInterColSortOrder": {
|
|
3463
|
+
"type": "array",
|
|
3464
|
+
"items": {
|
|
3465
|
+
"type": "integer",
|
|
3466
|
+
"minimum": -2147483648,
|
|
3467
|
+
"maximum": 2147483647
|
|
3468
|
+
},
|
|
3469
|
+
"description": "Legacy pivot conversion sort order; only add entries to preserve existing unknown properties."
|
|
3470
|
+
},
|
|
3471
|
+
"interColSortOrder": {
|
|
3472
|
+
"type": "array",
|
|
3473
|
+
"items": {
|
|
3474
|
+
"type": "integer",
|
|
3475
|
+
"minimum": -2147483648,
|
|
3476
|
+
"maximum": 2147483647
|
|
3477
|
+
},
|
|
3478
|
+
"description": "Legacy straight/pivot conversion sort order; only add entries to preserve existing unknown properties."
|
|
3479
|
+
}
|
|
3480
|
+
}
|
|
3481
|
+
},
|
|
3482
|
+
"GenericObjectProperties": {
|
|
3483
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3484
|
+
"$id": "GenericObjectProperties.json",
|
|
3485
|
+
"type": "object",
|
|
3486
|
+
"properties": {
|
|
3487
|
+
"qInfo": {
|
|
3488
|
+
"$ref": "NxInfo.json",
|
|
3489
|
+
"description": "Identifier and type of the object. This parameter is mandatory."
|
|
3490
|
+
},
|
|
3491
|
+
"qExtendsId": {
|
|
3492
|
+
"type": "string",
|
|
3493
|
+
"description": "Should be set to create an object that is linked to another object. Enter the identifier of the linking object (i.e the object you want to link to). If you do not want to link your object, set this parameter to an empty string."
|
|
3494
|
+
},
|
|
3495
|
+
"qMetaDef": {
|
|
3496
|
+
"$ref": "NxMetaDef.json",
|
|
3497
|
+
"description": "Definition of the dynamic properties."
|
|
3498
|
+
},
|
|
3499
|
+
"qStateName": {
|
|
3500
|
+
"type": "string",
|
|
3501
|
+
"description": "Name of the alternate state. Default is current selections _$_ ."
|
|
3502
|
+
},
|
|
3503
|
+
"qAppObjectListDef": {
|
|
3504
|
+
"$ref": "AppObjectListDef.json"
|
|
3505
|
+
},
|
|
3506
|
+
"qBookmarkListDef": {
|
|
3507
|
+
"$ref": "BookmarkListDef.json"
|
|
3508
|
+
},
|
|
3509
|
+
"qChildListDef": {
|
|
3510
|
+
"$ref": "ChildListDef.json"
|
|
3511
|
+
},
|
|
3512
|
+
"qDimensionListDef": {
|
|
3513
|
+
"$ref": "DimensionListDef.json"
|
|
3514
|
+
},
|
|
3515
|
+
"qEmbeddedSnapshotDef": {
|
|
3516
|
+
"$ref": "EmbeddedSnapshotDef.json"
|
|
3517
|
+
},
|
|
3518
|
+
"qExtensionListDef": {
|
|
3519
|
+
"$ref": "ExtensionListDef.json"
|
|
3520
|
+
},
|
|
3521
|
+
"qFieldListDef": {
|
|
3522
|
+
"$ref": "FieldListDef.json"
|
|
3523
|
+
},
|
|
3524
|
+
"qHyperCubeDef": {
|
|
3525
|
+
"$ref": "HyperCubeDef.json"
|
|
3526
|
+
},
|
|
3527
|
+
"qLayoutExclude": {
|
|
3528
|
+
"$ref": "LayoutExclude.json"
|
|
3529
|
+
},
|
|
3530
|
+
"qListObjectDef": {
|
|
3531
|
+
"$ref": "ListObjectDef.json"
|
|
3532
|
+
},
|
|
3533
|
+
"qMeasureListDef": {
|
|
3534
|
+
"$ref": "MeasureListDef.json"
|
|
3535
|
+
},
|
|
3536
|
+
"qMediaListDef": {
|
|
3537
|
+
"$ref": "MediaListDef.json"
|
|
3538
|
+
},
|
|
3539
|
+
"qNxLibraryDimensionDef": {
|
|
3540
|
+
"$ref": "NxLibraryDimensionDef.json"
|
|
3541
|
+
},
|
|
3542
|
+
"qNxLibraryMeasureDef": {
|
|
3543
|
+
"$ref": "NxLibraryMeasureDef.json"
|
|
3544
|
+
},
|
|
3545
|
+
"qSelectionObjectDef": {
|
|
3546
|
+
"$ref": "SelectionObjectDef.json"
|
|
3547
|
+
},
|
|
3548
|
+
"qStaticContentUrlDef": {
|
|
3549
|
+
"$ref": "StaticContentUrlDef.json"
|
|
3550
|
+
},
|
|
3551
|
+
"qStringExpression": {
|
|
3552
|
+
"$ref": "StringExpression.json"
|
|
3553
|
+
},
|
|
3554
|
+
"qTreeDataDef": {
|
|
3555
|
+
"$ref": "TreeDataDef.json"
|
|
3556
|
+
},
|
|
3557
|
+
"qUndoInfoDef": {
|
|
3558
|
+
"$ref": "UndoInfoDef.json"
|
|
3559
|
+
},
|
|
3560
|
+
"qValueExpression": {
|
|
3561
|
+
"$ref": "ValueExpression.json"
|
|
3562
|
+
},
|
|
3563
|
+
"qVariableListDef": {
|
|
3564
|
+
"$ref": "VariableListDef.json"
|
|
3565
|
+
}
|
|
3566
|
+
},
|
|
3567
|
+
"description": "GenericObjectProperties"
|
|
3568
|
+
},
|
|
3569
|
+
"NxMetaDef": {
|
|
3570
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3571
|
+
"$id": "NxMetaDef.json",
|
|
3572
|
+
"type": "object",
|
|
3573
|
+
"properties": {},
|
|
3574
|
+
"description": "Used to collect metadata.\n\n### Properties\nSemantic type with an empty structure."
|
|
3575
|
+
},
|
|
3576
|
+
"AppObjectListDef": {
|
|
3577
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3578
|
+
"$id": "AppObjectListDef.json",
|
|
3579
|
+
"type": "object",
|
|
3580
|
+
"properties": {
|
|
3581
|
+
"qType": {
|
|
3582
|
+
"type": "string",
|
|
3583
|
+
"description": "Type of the app list."
|
|
3584
|
+
},
|
|
3585
|
+
"qData": {
|
|
3586
|
+
"$ref": "JsonObject.json",
|
|
3587
|
+
"description": "Data that you want to include in the app list definition. You need to enter the paths to the information you want to retrieve."
|
|
3588
|
+
}
|
|
3589
|
+
},
|
|
3590
|
+
"description": "Defines the list of objects in an app.\n<div class=note>An app object is a generic object created at app level.</div>"
|
|
3591
|
+
},
|
|
3592
|
+
"JsonObject": {
|
|
3593
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3594
|
+
"$id": "JsonObject.json",
|
|
3595
|
+
"type": "object",
|
|
3596
|
+
"properties": {},
|
|
3597
|
+
"description": "Contains dynamic JSON data specified by the client."
|
|
3598
|
+
},
|
|
3599
|
+
"BookmarkListDef": {
|
|
3600
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3601
|
+
"$id": "BookmarkListDef.json",
|
|
3602
|
+
"type": "object",
|
|
3603
|
+
"properties": {
|
|
3604
|
+
"qType": {
|
|
3605
|
+
"type": "string",
|
|
3606
|
+
"description": "Type of the list."
|
|
3607
|
+
},
|
|
3608
|
+
"qData": {
|
|
3609
|
+
"$ref": "JsonObject.json",
|
|
3610
|
+
"description": "Data"
|
|
3611
|
+
},
|
|
3612
|
+
"qIncludePatches": {
|
|
3613
|
+
"type": "boolean",
|
|
3614
|
+
"description": "Include the bookmark patches. Patches can be very large and may make the list result unmanageable."
|
|
3615
|
+
}
|
|
3616
|
+
},
|
|
3617
|
+
"description": "Defines the list of bookmarks."
|
|
3618
|
+
},
|
|
3619
|
+
"ChildListDef": {
|
|
3620
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3621
|
+
"$id": "ChildListDef.json",
|
|
3622
|
+
"type": "object",
|
|
3623
|
+
"properties": {
|
|
3624
|
+
"qData": {
|
|
3625
|
+
"$ref": "JsonObject.json",
|
|
3626
|
+
"description": "Data that you want to include in the child list definition. You need to enter the paths to the information you want to retrieve."
|
|
3627
|
+
}
|
|
3628
|
+
},
|
|
3629
|
+
"description": "Defines the list of children of a generic object.\nWhat is defined in _ChildListDef_ has an impact on what the _GetLayout_ method returns. See _Example_ for more information."
|
|
3630
|
+
},
|
|
3631
|
+
"DimensionListDef": {
|
|
3632
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3633
|
+
"$id": "DimensionListDef.json",
|
|
3634
|
+
"type": "object",
|
|
3635
|
+
"properties": {
|
|
3636
|
+
"qType": {
|
|
3637
|
+
"type": "string",
|
|
3638
|
+
"description": "Type of the list."
|
|
3639
|
+
},
|
|
3640
|
+
"qData": {
|
|
3641
|
+
"$ref": "JsonObject.json",
|
|
3642
|
+
"description": "Data"
|
|
3643
|
+
}
|
|
3644
|
+
},
|
|
3645
|
+
"description": "Defines the lists of dimensions."
|
|
3646
|
+
},
|
|
3647
|
+
"EmbeddedSnapshotDef": {
|
|
3648
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3649
|
+
"$id": "EmbeddedSnapshotDef.json",
|
|
3650
|
+
"type": "object",
|
|
3651
|
+
"properties": {},
|
|
3652
|
+
"description": "Defines the embedded snapshot in a generic object.\n\n### Properties\n\"EmbeddedSnapshotDef\": {}"
|
|
3653
|
+
},
|
|
3654
|
+
"ExtensionListDef": {
|
|
3655
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3656
|
+
"$id": "ExtensionListDef.json",
|
|
3657
|
+
"type": "object",
|
|
3658
|
+
"properties": {},
|
|
3659
|
+
"description": "Obsolete, use qrs API's to fetch extensions."
|
|
3660
|
+
},
|
|
3661
|
+
"FieldListDef": {
|
|
3662
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3663
|
+
"$id": "FieldListDef.json",
|
|
3664
|
+
"type": "object",
|
|
3665
|
+
"properties": {
|
|
3666
|
+
"qShowSystem": {
|
|
3667
|
+
"type": "boolean",
|
|
3668
|
+
"description": "Shows the system tables if set to true. Default is false."
|
|
3669
|
+
},
|
|
3670
|
+
"qShowHidden": {
|
|
3671
|
+
"type": "boolean",
|
|
3672
|
+
"description": "Shows the hidden fields if set to true. Default is false."
|
|
3673
|
+
},
|
|
3674
|
+
"qShowSemantic": {
|
|
3675
|
+
"type": "boolean",
|
|
3676
|
+
"description": "Show the semantic fields if set to true. Default is false."
|
|
3677
|
+
},
|
|
3678
|
+
"qShowSrcTables": {
|
|
3679
|
+
"type": "boolean",
|
|
3680
|
+
"description": "Shows the tables and fields present in the data model viewer if set to true. Default is false."
|
|
3681
|
+
},
|
|
3682
|
+
"qShowDefinitionOnly": {
|
|
3683
|
+
"type": "boolean",
|
|
3684
|
+
"description": "Shows the fields defined on the fly if set to true. Default is false."
|
|
3685
|
+
},
|
|
3686
|
+
"qShowDerivedFields": {
|
|
3687
|
+
"type": "boolean",
|
|
3688
|
+
"description": "Shows the fields and derived fields if set to true. Default is false."
|
|
3689
|
+
},
|
|
3690
|
+
"qShowImplicit": {
|
|
3691
|
+
"type": "boolean",
|
|
3692
|
+
"description": "Shows the Direct Discovery measure fields if set to true. Default is false."
|
|
3693
|
+
}
|
|
3694
|
+
},
|
|
3695
|
+
"description": "Defines the fields to show."
|
|
3696
|
+
},
|
|
3697
|
+
"HyperCubeDef": {
|
|
3698
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3699
|
+
"$id": "HyperCubeDef.json",
|
|
3700
|
+
"type": "object",
|
|
3701
|
+
"properties": {
|
|
3702
|
+
"qStateName": {
|
|
3703
|
+
"type": "string",
|
|
3704
|
+
"description": "Name of the alternate state. Default is current selections _$_ ."
|
|
3705
|
+
},
|
|
3706
|
+
"qDimensions": {
|
|
3707
|
+
"type": "array",
|
|
3708
|
+
"items": {
|
|
3709
|
+
"$ref": "NxDimension.json"
|
|
3710
|
+
},
|
|
3711
|
+
"description": "Array of dimensions."
|
|
3712
|
+
},
|
|
3713
|
+
"qMeasures": {
|
|
3714
|
+
"type": "array",
|
|
3715
|
+
"items": {
|
|
3716
|
+
"$ref": "NxMeasure.json"
|
|
3717
|
+
},
|
|
3718
|
+
"description": "Array of measures."
|
|
3719
|
+
},
|
|
3720
|
+
"qInterColumnSortOrder": {
|
|
3721
|
+
"type": "array",
|
|
3722
|
+
"items": {
|
|
3723
|
+
"type": "integer",
|
|
3724
|
+
"minimum": -2147483648,
|
|
3725
|
+
"maximum": 2147483647
|
|
3726
|
+
},
|
|
3727
|
+
"description": "Defines the sort order of the columns in the hypercube. Column numbers are separated by a comma. Example: [1,0,2] means that the first column to be sorted should be the column 1, followed by the column 0 and the column 2. The default sort order is the order in which the dimensions and measures have been defined in the hypercube. By default, the pseudo-dimension (if any) is the most to the right in the array. The index of the pseudo-dimension (if any) is -1. Pseudo dimensions only apply for pivot tables with more than one measure. A pseudo dimension groups together the measures defined in a pivot table. You can neither collapse/expand a pseudo dimension nor make any selections in it. Stacked pivot tables can only contain one measure."
|
|
3728
|
+
},
|
|
3729
|
+
"qSuppressZero": {
|
|
3730
|
+
"type": "boolean",
|
|
3731
|
+
"description": "Removes zero values."
|
|
3732
|
+
},
|
|
3733
|
+
"qSuppressMissing": {
|
|
3734
|
+
"type": "boolean",
|
|
3735
|
+
"description": "Removes missing values."
|
|
3736
|
+
},
|
|
3737
|
+
"qInitialDataFetch": {
|
|
3738
|
+
"type": "array",
|
|
3739
|
+
"items": {
|
|
3740
|
+
"$ref": "NxPage.json"
|
|
3741
|
+
},
|
|
3742
|
+
"description": "Initial data set."
|
|
3743
|
+
},
|
|
3744
|
+
"qReductionMode": {
|
|
3745
|
+
"$ref": "NxDataReductionMode.json",
|
|
3746
|
+
"description": "One of: * N or DATA_REDUCTION_NONE * D1 or DATA_REDUCTION_ONEDIM * S or DATA_REDUCTION_SCATTERED * C or DATA_REDUCTION_CLUSTERED * ST or DATA_REDUCTION_STACKED"
|
|
3747
|
+
},
|
|
3748
|
+
"qMode": {
|
|
3749
|
+
"$ref": "NxHypercubeMode.json",
|
|
3750
|
+
"description": "Defines the way the data are handled internally by the engine. Default value is _DATA_MODE_STRAIGHT_ . A pivot table can contain several dimensions and measures whereas a stacked pivot table can contain several dimensions but only one measure. One of: * S or DATA_MODE_STRAIGHT * P or DATA_MODE_PIVOT * K or DATA_MODE_PIVOT_STACK * T or DATA_MODE_TREE * D or DATA_MODE_DYNAMIC"
|
|
3751
|
+
},
|
|
3752
|
+
"qPseudoDimPos": {
|
|
3753
|
+
"type": "integer",
|
|
3754
|
+
"minimum": -2147483648,
|
|
3755
|
+
"maximum": 2147483647
|
|
3756
|
+
},
|
|
3757
|
+
"qNoOfLeftDims": {
|
|
3758
|
+
"type": "integer",
|
|
3759
|
+
"minimum": -2147483648,
|
|
3760
|
+
"maximum": 2147483647,
|
|
3761
|
+
"description": "Number of left dimensions. Default value is -1. In that case, all dimensions are left dimensions. Hidden dimensions (e.g. due to unfulfilled calc condition on dimension level) is still counted in this context. The index related to each left dimension depends on the position of the pseudo dimension (if any). For example, a pivot table with: * Four dimensions in the following order: Country, City, Product and Category. * One pseudo dimension in position 1 (the position is defined in _qInterColumnSortOrder_ ) _qInterColumnSortOrder_ is (0,-1,1,2,3). * Three left dimensions ( _qNoOfLeftDims_ is set to 3). implies that: * The index 0 corresponds to the left dimension Country. * The index 1 corresponds to the pseudo dimension. * The index 2 corresponds to the left dimension City. * Product and Category are top dimensions. Another example: * Four dimensions in the following order: Country, City, Product and Category. * Three left dimensions ( _qNoOfLeftDims_ is set to 3). * One pseudo dimension. * The property _qInterColumnSortOrder_ is left empty. Implies that: * The index 0 corresponds to the left dimension Country. * The index 1 corresponds to the left dimension City. * The index 2 corresponds to the left dimension Product. * Category is a top dimension. * The pseudo dimension is a top dimension."
|
|
3762
|
+
},
|
|
3763
|
+
"qAlwaysFullyExpanded": {
|
|
3764
|
+
"type": "boolean",
|
|
3765
|
+
"description": "If this property is set to true, the cells are always expanded. It implies that it is not possible to collapse any cells. The default value is false."
|
|
3766
|
+
},
|
|
3767
|
+
"qMaxStackedCells": {
|
|
3768
|
+
"type": "integer",
|
|
3769
|
+
"minimum": -2147483648,
|
|
3770
|
+
"maximum": 2147483647,
|
|
3771
|
+
"description": "Maximum number of cells for an initial data fetch (set in _qInitialDataFetch_ ) when in stacked mode ( _qMode_ is K). The default value is 5000."
|
|
3772
|
+
},
|
|
3773
|
+
"qPopulateMissing": {
|
|
3774
|
+
"type": "boolean",
|
|
3775
|
+
"description": "If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false."
|
|
3776
|
+
},
|
|
3777
|
+
"qShowTotalsAbove": {
|
|
3778
|
+
"type": "boolean",
|
|
3779
|
+
"description": "If set to true, the total (if any) is shown on the first row. The default value is false."
|
|
3780
|
+
},
|
|
3781
|
+
"qIndentMode": {
|
|
3782
|
+
"type": "boolean",
|
|
3783
|
+
"description": "This property applies for pivot tables and allows to change the layout of the table. An indentation is added to the beginning of each row. The default value is false."
|
|
3784
|
+
},
|
|
3785
|
+
"qCalcCond": {
|
|
3786
|
+
"$ref": "ValueExpr.json",
|
|
3787
|
+
"description": "Specifies a calculation condition, which must be fulfilled for the hypercube to be (re)calculated. As long as the condition is not met, the engine does not perform a new calculation. This property is optional. By default, there is no calculation condition."
|
|
3788
|
+
},
|
|
3789
|
+
"qSortbyYValue": {
|
|
3790
|
+
"type": "integer",
|
|
3791
|
+
"minimum": -2147483648,
|
|
3792
|
+
"maximum": 2147483647,
|
|
3793
|
+
"description": "To enable the sorting by ascending or descending order in the values of a measure. This property applies to pivot tables and stacked pivot tables. In the case of a pivot table, the measure or pseudo dimension should be defined as a top dimension. The sorting is restricted to the values of the first measure in a pivot table."
|
|
3794
|
+
},
|
|
3795
|
+
"qTitle": {
|
|
3796
|
+
"$ref": "StringExpr.json",
|
|
3797
|
+
"description": "Title of the hypercube, for example the title of a chart."
|
|
3798
|
+
},
|
|
3799
|
+
"qCalcCondition": {
|
|
3800
|
+
"$ref": "NxCalcCond.json",
|
|
3801
|
+
"description": "Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the hypercube is not calculated and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional."
|
|
3802
|
+
},
|
|
3803
|
+
"qColumnOrder": {
|
|
3804
|
+
"type": "array",
|
|
3805
|
+
"items": {
|
|
3806
|
+
"type": "integer",
|
|
3807
|
+
"minimum": -2147483648,
|
|
3808
|
+
"maximum": 2147483647
|
|
3809
|
+
},
|
|
3810
|
+
"description": "The order of the columns."
|
|
3811
|
+
},
|
|
3812
|
+
"qExpansionState": {
|
|
3813
|
+
"type": "array",
|
|
3814
|
+
"items": {
|
|
3815
|
+
"$ref": "ExpansionData.json"
|
|
3816
|
+
},
|
|
3817
|
+
"description": "Expansion state per dimension for pivot mode ( _qMode_ is P)."
|
|
3818
|
+
},
|
|
3819
|
+
"qDynamicScript": {
|
|
3820
|
+
"type": "array",
|
|
3821
|
+
"items": {
|
|
3822
|
+
"type": "string"
|
|
3823
|
+
},
|
|
3824
|
+
"description": "Hypercube Modifier Dynamic script string"
|
|
3825
|
+
},
|
|
3826
|
+
"qContextSetExpression": {
|
|
3827
|
+
"type": "string",
|
|
3828
|
+
"description": "Set expression valid for the whole cube, limiting computations to the specified set."
|
|
3829
|
+
},
|
|
3830
|
+
"qSuppressMeasureTotals": {
|
|
3831
|
+
"type": "boolean",
|
|
3832
|
+
"description": "When true, suppresses any grand totals for measures, regardless of the AggrFunc setting."
|
|
3833
|
+
}
|
|
3834
|
+
},
|
|
3835
|
+
"description": "Defines the properties of a hypercube.\nFor more information about the definition of a hypercube, see _Generic object_."
|
|
3836
|
+
},
|
|
3837
|
+
"NxHypercubeMode": {
|
|
3838
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3839
|
+
"$id": "NxHypercubeMode.json",
|
|
3840
|
+
"anyOf": [
|
|
3841
|
+
{
|
|
3842
|
+
"type": "string",
|
|
3843
|
+
"const": "DATA_MODE_STRAIGHT"
|
|
3844
|
+
},
|
|
3845
|
+
{
|
|
3846
|
+
"type": "string",
|
|
3847
|
+
"const": "DATA_MODE_PIVOT"
|
|
3848
|
+
},
|
|
3849
|
+
{
|
|
3850
|
+
"type": "string",
|
|
3851
|
+
"const": "DATA_MODE_PIVOT_STACK"
|
|
3852
|
+
},
|
|
3853
|
+
{
|
|
3854
|
+
"type": "string",
|
|
3855
|
+
"const": "DATA_MODE_TREE"
|
|
3856
|
+
},
|
|
3857
|
+
{
|
|
3858
|
+
"type": "string",
|
|
3859
|
+
"const": "DATA_MODE_DYNAMIC"
|
|
3860
|
+
},
|
|
3861
|
+
{
|
|
3862
|
+
"type": "string",
|
|
3863
|
+
"const": "S"
|
|
3864
|
+
},
|
|
3865
|
+
{
|
|
3866
|
+
"type": "string",
|
|
3867
|
+
"const": "P"
|
|
3868
|
+
},
|
|
3869
|
+
{
|
|
3870
|
+
"type": "string",
|
|
3871
|
+
"const": "K"
|
|
3872
|
+
},
|
|
3873
|
+
{
|
|
3874
|
+
"type": "string",
|
|
3875
|
+
"const": "T"
|
|
3876
|
+
},
|
|
3877
|
+
{
|
|
3878
|
+
"type": "string",
|
|
3879
|
+
"const": "D"
|
|
3880
|
+
}
|
|
3881
|
+
],
|
|
3882
|
+
"description": "NxHypercubeMode"
|
|
3883
|
+
},
|
|
3884
|
+
"LayoutExclude": {
|
|
3885
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3886
|
+
"$id": "LayoutExclude.json",
|
|
3887
|
+
"type": "object",
|
|
3888
|
+
"properties": {},
|
|
3889
|
+
"description": "Contains JSON to be excluded from validation."
|
|
3890
|
+
},
|
|
3891
|
+
"ListObjectDef": {
|
|
3892
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3893
|
+
"$id": "ListObjectDef.json",
|
|
3894
|
+
"type": "object",
|
|
3895
|
+
"properties": {
|
|
3896
|
+
"qStateName": {
|
|
3897
|
+
"type": "string",
|
|
3898
|
+
"description": "Name of the alternate state. Default is current selections _$_ ."
|
|
3899
|
+
},
|
|
3900
|
+
"qLibraryId": {
|
|
3901
|
+
"type": "string",
|
|
3902
|
+
"description": "Refers to a dimension stored in the library."
|
|
3903
|
+
},
|
|
3904
|
+
"qDef": {
|
|
3905
|
+
"$ref": "NxInlineDimensionDef.json",
|
|
3906
|
+
"description": "Refers to a dimension stored in the list object."
|
|
3907
|
+
},
|
|
3908
|
+
"qAutoSortByState": {
|
|
3909
|
+
"$ref": "NxAutoSortByStateDef.json",
|
|
3910
|
+
"description": "Defines the sorting by state."
|
|
3911
|
+
},
|
|
3912
|
+
"qFrequencyMode": {
|
|
3913
|
+
"$ref": "NxFrequencyMode.json",
|
|
3914
|
+
"description": "Defines the frequency mode. The frequency mode is used to calculate the frequency of a value in a list object. Default is _NX_FREQUENCY_NONE_ . This parameter is optional. One of: * N or NX_FREQUENCY_NONE * V or NX_FREQUENCY_VALUE * P or NX_FREQUENCY_PERCENT * R or NX_FREQUENCY_RELATIVE"
|
|
3915
|
+
},
|
|
3916
|
+
"qShowAlternatives": {
|
|
3917
|
+
"type": "boolean",
|
|
3918
|
+
"description": "If set to true, alternative values are allowed in _qData_ . If set to false, no alternative values are displayed in _qData_ . Values are excluded instead. The default value is false. Note that on the contrary, the _qStateCounts_ parameter counts the excluded values as alternative values. This parameter is optional."
|
|
3919
|
+
},
|
|
3920
|
+
"qInitialDataFetch": {
|
|
3921
|
+
"type": "array",
|
|
3922
|
+
"items": {
|
|
3923
|
+
"$ref": "NxPage.json"
|
|
3924
|
+
},
|
|
3925
|
+
"description": "Fetches an initial data set."
|
|
3926
|
+
},
|
|
3927
|
+
"qExpressions": {
|
|
3928
|
+
"type": "array",
|
|
3929
|
+
"items": {
|
|
3930
|
+
"$ref": "NxListObjectExpressionDef.json"
|
|
3931
|
+
},
|
|
3932
|
+
"description": "Lists the expressions in the list object. This parameter is optional."
|
|
3933
|
+
},
|
|
3934
|
+
"qDirectQuerySimplifiedView": {
|
|
3935
|
+
"type": "boolean",
|
|
3936
|
+
"description": "If set to true, reduces the set of states returned. Supported for Direct Query mode only. Default is false."
|
|
3937
|
+
}
|
|
3938
|
+
},
|
|
3939
|
+
"description": "Defines the properties of a list object.\nFor more information about the definition of a list object, see _Generic object_."
|
|
3940
|
+
},
|
|
3941
|
+
"NxAutoSortByStateDef": {
|
|
3942
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3943
|
+
"$id": "NxAutoSortByStateDef.json",
|
|
3944
|
+
"type": "object",
|
|
3945
|
+
"properties": {
|
|
3946
|
+
"qDisplayNumberOfRows": {
|
|
3947
|
+
"type": "integer",
|
|
3948
|
+
"minimum": -2147483648,
|
|
3949
|
+
"maximum": 2147483647,
|
|
3950
|
+
"description": "This parameter applies to list objects. If the total number of values in the list object exceeds the value set in _qDisplayNumberOfRows_ , the selected lines are promoted to the top of the list object. If _qDisplayNumberOfRows_ is set to a negative value or to 0, the sort by state is disabled."
|
|
3951
|
+
}
|
|
3952
|
+
},
|
|
3953
|
+
"description": "NxAutoSortByStateDef"
|
|
3954
|
+
},
|
|
3955
|
+
"NxFrequencyMode": {
|
|
3956
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3957
|
+
"$id": "NxFrequencyMode.json",
|
|
3958
|
+
"anyOf": [
|
|
3959
|
+
{
|
|
3960
|
+
"type": "string",
|
|
3961
|
+
"const": "NX_FREQUENCY_NONE"
|
|
3962
|
+
},
|
|
3963
|
+
{
|
|
3964
|
+
"type": "string",
|
|
3965
|
+
"const": "NX_FREQUENCY_VALUE"
|
|
3966
|
+
},
|
|
3967
|
+
{
|
|
3968
|
+
"type": "string",
|
|
3969
|
+
"const": "NX_FREQUENCY_PERCENT"
|
|
3970
|
+
},
|
|
3971
|
+
{
|
|
3972
|
+
"type": "string",
|
|
3973
|
+
"const": "NX_FREQUENCY_RELATIVE"
|
|
3974
|
+
},
|
|
3975
|
+
{
|
|
3976
|
+
"type": "string",
|
|
3977
|
+
"const": "N"
|
|
3978
|
+
},
|
|
3979
|
+
{
|
|
3980
|
+
"type": "string",
|
|
3981
|
+
"const": "V"
|
|
3982
|
+
},
|
|
3983
|
+
{
|
|
3984
|
+
"type": "string",
|
|
3985
|
+
"const": "P"
|
|
3986
|
+
},
|
|
3987
|
+
{
|
|
3988
|
+
"type": "string",
|
|
3989
|
+
"const": "R"
|
|
3990
|
+
}
|
|
3991
|
+
],
|
|
3992
|
+
"description": "NxFrequencyMode"
|
|
3993
|
+
},
|
|
3994
|
+
"NxListObjectExpressionDef": {
|
|
3995
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3996
|
+
"$id": "NxListObjectExpressionDef.json",
|
|
3997
|
+
"type": "object",
|
|
3998
|
+
"properties": {
|
|
3999
|
+
"qExpr": {
|
|
4000
|
+
"type": "string",
|
|
4001
|
+
"description": "Value of the expression."
|
|
4002
|
+
},
|
|
4003
|
+
"qLibraryId": {
|
|
4004
|
+
"type": "string",
|
|
4005
|
+
"description": "Refers to an expression stored in the library."
|
|
4006
|
+
}
|
|
4007
|
+
},
|
|
4008
|
+
"description": "NxListObjectExpressionDef"
|
|
4009
|
+
},
|
|
4010
|
+
"MeasureListDef": {
|
|
4011
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4012
|
+
"$id": "MeasureListDef.json",
|
|
4013
|
+
"type": "object",
|
|
4014
|
+
"properties": {
|
|
4015
|
+
"qType": {
|
|
4016
|
+
"type": "string",
|
|
4017
|
+
"description": "Type of the list."
|
|
4018
|
+
},
|
|
4019
|
+
"qData": {
|
|
4020
|
+
"$ref": "JsonObject.json",
|
|
4021
|
+
"description": "Data"
|
|
4022
|
+
}
|
|
4023
|
+
},
|
|
4024
|
+
"description": "Defines the list of measures."
|
|
4025
|
+
},
|
|
4026
|
+
"MediaListDef": {
|
|
4027
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4028
|
+
"$id": "MediaListDef.json",
|
|
4029
|
+
"type": "object",
|
|
4030
|
+
"properties": {},
|
|
4031
|
+
"description": "Defines the list of media files.\n<div class=note>This struct is deprecated.</div>\n\n### Properties\n\"qMediaListDef\": {}\n_qMediaListDef_ has an empty structure. No properties need to be set."
|
|
4032
|
+
},
|
|
4033
|
+
"NxLibraryDimensionDef": {
|
|
4034
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4035
|
+
"$id": "NxLibraryDimensionDef.json",
|
|
4036
|
+
"type": "object",
|
|
4037
|
+
"properties": {
|
|
4038
|
+
"qGrouping": {
|
|
4039
|
+
"$ref": "NxGrpType.json",
|
|
4040
|
+
"description": "Information about the grouping. One of: * N or GRP_NX_NONE * H or GRP_NX_HIEARCHY * C or GRP_NX_COLLECTION"
|
|
4041
|
+
},
|
|
4042
|
+
"qFieldDefs": {
|
|
4043
|
+
"type": "array",
|
|
4044
|
+
"items": {
|
|
4045
|
+
"type": "string"
|
|
4046
|
+
},
|
|
4047
|
+
"description": "Array of dimension names."
|
|
4048
|
+
},
|
|
4049
|
+
"qFieldLabels": {
|
|
4050
|
+
"type": "array",
|
|
4051
|
+
"items": {
|
|
4052
|
+
"type": "string"
|
|
4053
|
+
},
|
|
4054
|
+
"description": "Array of dimension labels."
|
|
4055
|
+
},
|
|
4056
|
+
"qLabelExpression": {
|
|
4057
|
+
"type": "string"
|
|
4058
|
+
},
|
|
4059
|
+
"qAlias": {
|
|
4060
|
+
"type": "string",
|
|
4061
|
+
"description": "Alias of the dimension."
|
|
4062
|
+
},
|
|
4063
|
+
"qScriptGenerated": {
|
|
4064
|
+
"type": "boolean"
|
|
4065
|
+
},
|
|
4066
|
+
"qOrigin": {
|
|
4067
|
+
"$ref": "NxOrigin.json",
|
|
4068
|
+
"description": "## NxOrigin With the introduction of Data Products, there will be a need to describe the origin of objects other than just being generated by a loading script or not. This enum contains: * PROGRAM: Object is created via ui or api call * SCRIPT: Object is created from load script * DATA_PRODUCT: Object is created from a data product One of: * PROGRAM * SCRIPT * DATA_PRODUCT"
|
|
4069
|
+
}
|
|
4070
|
+
},
|
|
4071
|
+
"description": "NxLibraryDimensionDef"
|
|
4072
|
+
},
|
|
4073
|
+
"NxOrigin": {
|
|
4074
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4075
|
+
"$id": "NxOrigin.json",
|
|
4076
|
+
"anyOf": [
|
|
4077
|
+
{
|
|
4078
|
+
"type": "string",
|
|
4079
|
+
"const": "PROGRAM"
|
|
4080
|
+
},
|
|
4081
|
+
{
|
|
4082
|
+
"type": "string",
|
|
4083
|
+
"const": "SCRIPT"
|
|
4084
|
+
},
|
|
4085
|
+
{
|
|
4086
|
+
"type": "string",
|
|
4087
|
+
"const": "DATA_PRODUCT"
|
|
4088
|
+
}
|
|
4089
|
+
],
|
|
4090
|
+
"description": "NxOrigin"
|
|
4091
|
+
},
|
|
4092
|
+
"NxLibraryMeasureDef": {
|
|
4093
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4094
|
+
"$id": "NxLibraryMeasureDef.json",
|
|
4095
|
+
"type": "object",
|
|
4096
|
+
"properties": {
|
|
4097
|
+
"qLabel": {
|
|
4098
|
+
"type": "string",
|
|
4099
|
+
"description": "Label of the measure."
|
|
4100
|
+
},
|
|
4101
|
+
"qDef": {
|
|
4102
|
+
"type": "string",
|
|
4103
|
+
"description": "Definition of the measure."
|
|
4104
|
+
},
|
|
4105
|
+
"qGrouping": {
|
|
4106
|
+
"$ref": "NxGrpType.json",
|
|
4107
|
+
"description": "Used to define a cyclic group or drill-down group. Default value is no grouping. This parameter is optional. One of: * N or GRP_NX_NONE * H or GRP_NX_HIEARCHY * C or GRP_NX_COLLECTION"
|
|
4108
|
+
},
|
|
4109
|
+
"qExpressions": {
|
|
4110
|
+
"type": "array",
|
|
4111
|
+
"items": {
|
|
4112
|
+
"type": "string"
|
|
4113
|
+
},
|
|
4114
|
+
"description": "Array of expressions."
|
|
4115
|
+
},
|
|
4116
|
+
"qActiveExpression": {
|
|
4117
|
+
"type": "integer",
|
|
4118
|
+
"minimum": -2147483648,
|
|
4119
|
+
"maximum": 2147483647,
|
|
4120
|
+
"description": "Index to the active expression in a measure."
|
|
4121
|
+
},
|
|
4122
|
+
"qLabelExpression": {
|
|
4123
|
+
"type": "string",
|
|
4124
|
+
"description": "Optional expression used for dynamic label."
|
|
4125
|
+
},
|
|
4126
|
+
"qNumFormat": {
|
|
4127
|
+
"$ref": "FieldAttributes.json",
|
|
4128
|
+
"description": "Format of the field. This parameter is optional."
|
|
4129
|
+
},
|
|
4130
|
+
"qScriptGenerated": {
|
|
4131
|
+
"type": "boolean"
|
|
4132
|
+
},
|
|
4133
|
+
"qOrigin": {
|
|
4134
|
+
"$ref": "NxOrigin.json",
|
|
4135
|
+
"description": "## NxOrigin With the introduction of Data Products, there will be a need to describe the origin of objects other than just being generated by a loading script or not. This enum contains: * PROGRAM: Object is created via ui or api call * SCRIPT: Object is created from load script * DATA_PRODUCT: Object is created from a data product One of: * PROGRAM * SCRIPT * DATA_PRODUCT"
|
|
4136
|
+
}
|
|
4137
|
+
},
|
|
4138
|
+
"description": "NxLibraryMeasureDef"
|
|
4139
|
+
},
|
|
4140
|
+
"SelectionObjectDef": {
|
|
4141
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4142
|
+
"$id": "SelectionObjectDef.json",
|
|
4143
|
+
"type": "object",
|
|
4144
|
+
"properties": {
|
|
4145
|
+
"qStateName": {
|
|
4146
|
+
"type": "string",
|
|
4147
|
+
"description": "Name of the alternate state. Default is current selections _$_ ."
|
|
4148
|
+
}
|
|
4149
|
+
},
|
|
4150
|
+
"description": "To display the current selections.\nCan be added to any generic object but is particularly meaningful when using session objects to monitor an app.\n\n### Properties\n\"qSelectionObjectDef\": {}"
|
|
4151
|
+
},
|
|
4152
|
+
"TreeDataDef": {
|
|
4153
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4154
|
+
"$id": "TreeDataDef.json",
|
|
4155
|
+
"type": "object",
|
|
4156
|
+
"properties": {
|
|
4157
|
+
"qStateName": {
|
|
4158
|
+
"type": "string",
|
|
4159
|
+
"description": "Name of the alternate state. Default is current selections _$_ ."
|
|
4160
|
+
},
|
|
4161
|
+
"qDimensions": {
|
|
4162
|
+
"type": "array",
|
|
4163
|
+
"items": {
|
|
4164
|
+
"$ref": "NxTreeDimensionDef.json"
|
|
4165
|
+
},
|
|
4166
|
+
"description": "Array of dimensions."
|
|
4167
|
+
},
|
|
4168
|
+
"qInterColumnSortOrder": {
|
|
4169
|
+
"type": "array",
|
|
4170
|
+
"items": {
|
|
4171
|
+
"type": "integer",
|
|
4172
|
+
"minimum": -2147483648,
|
|
4173
|
+
"maximum": 2147483647
|
|
4174
|
+
},
|
|
4175
|
+
"description": "Defines the order of the dimension levels/columns in the TreeData object. Column numbers are separated by a comma. Example: [1,0,2] means that the first level in the tree structure is dimension 1, followed by dimension 0 and dimension 2. The default sort order is the order in which the dimensions and measures have been defined in the TreeDataDef."
|
|
4176
|
+
},
|
|
4177
|
+
"qSuppressZero": {
|
|
4178
|
+
"type": "boolean",
|
|
4179
|
+
"description": "Removes zero values."
|
|
4180
|
+
},
|
|
4181
|
+
"qSuppressMissing": {
|
|
4182
|
+
"type": "boolean",
|
|
4183
|
+
"description": "Removes missing values."
|
|
4184
|
+
},
|
|
4185
|
+
"qOpenFullyExpanded": {
|
|
4186
|
+
"type": "boolean",
|
|
4187
|
+
"description": "If this property is set to true, the cells are opened expanded. The default value is false."
|
|
4188
|
+
},
|
|
4189
|
+
"qPopulateMissing": {
|
|
4190
|
+
"type": "boolean",
|
|
4191
|
+
"description": "If this property is set to true, the missing symbols (if any) are replaced by 0 if the value is a numeric and by an empty string if the value is a string. The default value is false."
|
|
4192
|
+
},
|
|
4193
|
+
"qCalcCondition": {
|
|
4194
|
+
"$ref": "NxCalcCond.json",
|
|
4195
|
+
"description": "Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the TreeData is excluded from the calculation and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional."
|
|
4196
|
+
},
|
|
4197
|
+
"qTitle": {
|
|
4198
|
+
"$ref": "StringExpr.json",
|
|
4199
|
+
"description": "Title of the TreeData object, for example the title of a chart."
|
|
4200
|
+
},
|
|
4201
|
+
"qInitialDataFetch": {
|
|
4202
|
+
"type": "array",
|
|
4203
|
+
"items": {
|
|
4204
|
+
"$ref": "NxTreeDataOption.json"
|
|
4205
|
+
},
|
|
4206
|
+
"description": "Initial data set. This property is optional."
|
|
4207
|
+
},
|
|
4208
|
+
"qExpansionState": {
|
|
4209
|
+
"type": "array",
|
|
4210
|
+
"items": {
|
|
4211
|
+
"$ref": "ExpansionData.json"
|
|
4212
|
+
},
|
|
4213
|
+
"description": "Expansion state per dimension."
|
|
4214
|
+
},
|
|
4215
|
+
"qValueExprs": {
|
|
4216
|
+
"type": "array",
|
|
4217
|
+
"items": {
|
|
4218
|
+
"$ref": "NxMeasure.json"
|
|
4219
|
+
},
|
|
4220
|
+
"description": "List of measures to calculate on the whole tree."
|
|
4221
|
+
},
|
|
4222
|
+
"qContextSetExpression": {
|
|
4223
|
+
"type": "string",
|
|
4224
|
+
"description": "Set expression valid for the whole cube, limiting computations to the specified set."
|
|
4225
|
+
}
|
|
4226
|
+
},
|
|
4227
|
+
"description": "Defines the properties of a TreeData object.\nFor more information about the definition of a TreeData object, see _Generic object_."
|
|
4228
|
+
},
|
|
4229
|
+
"NxTreeDimensionDef": {
|
|
4230
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4231
|
+
"$id": "NxTreeDimensionDef.json",
|
|
4232
|
+
"type": "object",
|
|
4233
|
+
"properties": {
|
|
4234
|
+
"qLibraryId": {
|
|
4235
|
+
"type": "string",
|
|
4236
|
+
"description": "Refers to a dimension stored in the library."
|
|
4237
|
+
},
|
|
4238
|
+
"qDef": {
|
|
4239
|
+
"$ref": "NxInlineDimensionDef.json",
|
|
4240
|
+
"description": "Refers to a dimension."
|
|
4241
|
+
},
|
|
4242
|
+
"qValueExprs": {
|
|
4243
|
+
"type": "array",
|
|
4244
|
+
"items": {
|
|
4245
|
+
"$ref": "NxMeasure.json"
|
|
4246
|
+
},
|
|
4247
|
+
"description": "List of measures."
|
|
4248
|
+
},
|
|
4249
|
+
"qNullSuppression": {
|
|
4250
|
+
"type": "boolean",
|
|
4251
|
+
"description": "If set to true, no null values are returned."
|
|
4252
|
+
},
|
|
4253
|
+
"qOtherTotalSpec": {
|
|
4254
|
+
"$ref": "OtherTotalSpecProp.json",
|
|
4255
|
+
"description": "Sets the dimension limits. Each dimension of a hypercube is configured separately. Defines if some values (grouped as _Others_ ) should be grouped together in the visualization. For example in a pie chart all values lower than 200 could be grouped together."
|
|
4256
|
+
},
|
|
4257
|
+
"qShowAll": {
|
|
4258
|
+
"type": "boolean",
|
|
4259
|
+
"description": "If set to true, all dimension values are shown."
|
|
4260
|
+
},
|
|
4261
|
+
"qOtherLabel": {
|
|
4262
|
+
"$ref": "StringExpr.json",
|
|
4263
|
+
"description": "This property is used when some dimension limits are set. Label of the _Others_ group. The default label is _Others_ . Example: _\\\"qOtherLabel\\\":\\\"= <label>\\\"_ or _\\\"qOtherLabel\\\":{\\\"qExpr\\\":\\\"= <label>\\\"}_ Where: * < _label_ > is the label of the _Others_ group."
|
|
4264
|
+
},
|
|
4265
|
+
"qTotalLabel": {
|
|
4266
|
+
"$ref": "StringExpr.json",
|
|
4267
|
+
"description": "If this property is set, the total of the calculated values is returned. The default label is _Total_ . Example: _\\\"qTotalLabel\\\":\\\"= <label>\\\"_ or _\\\"qTotalLabel\\\":{\\\"qExpr\\\":\\\"= <label>\\\"}_ Where: * < _label_ > is the label of the _Total_ group."
|
|
4268
|
+
},
|
|
4269
|
+
"qCalcCondition": {
|
|
4270
|
+
"$ref": "NxCalcCond.json",
|
|
4271
|
+
"description": "Specifies a calculation condition object. If CalcCondition.Cond is not fulfilled, the dimension is excluded from the calculation and CalcCondition.Msg is evaluated. By default, there is no calculation condition. This property is optional."
|
|
4272
|
+
},
|
|
4273
|
+
"qAttributeExpressions": {
|
|
4274
|
+
"type": "array",
|
|
4275
|
+
"items": {
|
|
4276
|
+
"$ref": "NxAttrExprDef.json"
|
|
4277
|
+
},
|
|
4278
|
+
"description": "List of attribute expressions."
|
|
4279
|
+
},
|
|
4280
|
+
"qAttributeDimensions": {
|
|
4281
|
+
"type": "array",
|
|
4282
|
+
"items": {
|
|
4283
|
+
"$ref": "NxAttrDimDef.json"
|
|
4284
|
+
},
|
|
4285
|
+
"description": "List of attribute dimensions."
|
|
4286
|
+
}
|
|
4287
|
+
},
|
|
4288
|
+
"description": "NxTreeDimensionDef"
|
|
4289
|
+
},
|
|
4290
|
+
"NxTreeDataOption": {
|
|
4291
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4292
|
+
"$id": "NxTreeDataOption.json",
|
|
4293
|
+
"type": "object",
|
|
4294
|
+
"properties": {
|
|
4295
|
+
"qMaxNbrOfNodes": {
|
|
4296
|
+
"type": "integer",
|
|
4297
|
+
"minimum": -2147483648,
|
|
4298
|
+
"maximum": 2147483647,
|
|
4299
|
+
"description": "Maximum number of nodes in the tree. If this limit is exceeded, no nodes are returned. All nodes are counted."
|
|
4300
|
+
},
|
|
4301
|
+
"qTreeNodes": {
|
|
4302
|
+
"type": "array",
|
|
4303
|
+
"items": {
|
|
4304
|
+
"$ref": "NxPageTreeNode.json"
|
|
4305
|
+
},
|
|
4306
|
+
"description": "Defines areas of the tree to be fetched. Areas must be defined left to right."
|
|
4307
|
+
},
|
|
4308
|
+
"qTreeLevels": {
|
|
4309
|
+
"$ref": "NxPageTreeLevel.json",
|
|
4310
|
+
"description": "Filters out complete dimensions from the fetched tree."
|
|
4311
|
+
}
|
|
4312
|
+
},
|
|
4313
|
+
"description": "Specifies all the paging filters needed to define the tree to be fetched."
|
|
4314
|
+
},
|
|
4315
|
+
"NxPageTreeNode": {
|
|
4316
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4317
|
+
"$id": "NxPageTreeNode.json",
|
|
4318
|
+
"type": "object",
|
|
4319
|
+
"properties": {
|
|
4320
|
+
"qArea": {
|
|
4321
|
+
"$ref": "Rect.json",
|
|
4322
|
+
"description": "The area of the tree to be fetched. If no area is defined on a dimension, all existing nodes are included."
|
|
4323
|
+
},
|
|
4324
|
+
"qAllValues": {
|
|
4325
|
+
"type": "boolean",
|
|
4326
|
+
"description": "When set to true, generated nodes (based on current selection) will be inserted into the returned tree even when there is no actual value. For example, suppose you are looking for hybrid car sales at all car dealerships. Normally, only dealerships where hybrid cars are sold would be part of the returned tree but with qAllValues set to true, all available dealerships will be included regardless if they sold any hybrid cars or not."
|
|
4327
|
+
}
|
|
4328
|
+
},
|
|
4329
|
+
"description": "Defines an area of the tree to be fetched."
|
|
4330
|
+
},
|
|
4331
|
+
"Rect": {
|
|
4332
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4333
|
+
"$id": "Rect.json",
|
|
4334
|
+
"type": "object",
|
|
4335
|
+
"properties": {
|
|
4336
|
+
"qLeft": {
|
|
4337
|
+
"type": "integer",
|
|
4338
|
+
"minimum": -2147483648,
|
|
4339
|
+
"maximum": 2147483647,
|
|
4340
|
+
"description": "Position from the left. Corresponds to the first column."
|
|
4341
|
+
},
|
|
4342
|
+
"qTop": {
|
|
4343
|
+
"type": "integer",
|
|
4344
|
+
"minimum": -2147483648,
|
|
4345
|
+
"maximum": 2147483647,
|
|
4346
|
+
"description": "Position from the top. Corresponds to the first row."
|
|
4347
|
+
},
|
|
4348
|
+
"qWidth": {
|
|
4349
|
+
"type": "integer",
|
|
4350
|
+
"minimum": -2147483648,
|
|
4351
|
+
"maximum": 2147483647,
|
|
4352
|
+
"description": "Number of columns in the page. The indexing of the columns may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ )."
|
|
4353
|
+
},
|
|
4354
|
+
"qHeight": {
|
|
4355
|
+
"type": "integer",
|
|
4356
|
+
"minimum": -2147483648,
|
|
4357
|
+
"maximum": 2147483647,
|
|
4358
|
+
"description": "Number of rows or elements in the page. The indexing of the rows may vary depending on whether the cells are expanded or not (parameter _qAlwaysFullyExpanded_ in _HyperCubeDef_ )."
|
|
4359
|
+
}
|
|
4360
|
+
},
|
|
4361
|
+
"description": "Rect"
|
|
4362
|
+
},
|
|
4363
|
+
"NxPageTreeLevel": {
|
|
4364
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4365
|
+
"$id": "NxPageTreeLevel.json",
|
|
4366
|
+
"type": "object",
|
|
4367
|
+
"properties": {
|
|
4368
|
+
"qLeft": {
|
|
4369
|
+
"type": "integer",
|
|
4370
|
+
"minimum": -2147483648,
|
|
4371
|
+
"maximum": 2147483647,
|
|
4372
|
+
"description": "The first dimension that is to be part of the tree, counted from the left. For example, if qLeft is equal to 1, omit nodes from the first dimension in the current sort order."
|
|
4373
|
+
},
|
|
4374
|
+
"qDepth": {
|
|
4375
|
+
"type": "integer",
|
|
4376
|
+
"minimum": -2147483648,
|
|
4377
|
+
"maximum": 2147483647,
|
|
4378
|
+
"description": "Number of dimensions to include in the tree."
|
|
4379
|
+
}
|
|
4380
|
+
},
|
|
4381
|
+
"description": "NxPageTreeLevel"
|
|
4382
|
+
},
|
|
4383
|
+
"UndoInfoDef": {
|
|
4384
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4385
|
+
"$id": "UndoInfoDef.json",
|
|
4386
|
+
"type": "object",
|
|
4387
|
+
"properties": {},
|
|
4388
|
+
"description": "Defines if an object should contain information on the number of possible undo and redo.\n\n### Properties\n\"qUndoInfoDef\": {}\nThe numbers of undos and redos are empty when an object is created. The number of possible undos is increased every time an action (for example, create a child, set some properties) on the object is performed. The number of possible redos is increased every time an undo action is performed."
|
|
4389
|
+
},
|
|
4390
|
+
"VariableListDef": {
|
|
4391
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4392
|
+
"$id": "VariableListDef.json",
|
|
4393
|
+
"type": "object",
|
|
4394
|
+
"properties": {
|
|
4395
|
+
"qType": {
|
|
4396
|
+
"type": "string",
|
|
4397
|
+
"description": "Type of variables to include in the list."
|
|
4398
|
+
},
|
|
4399
|
+
"qShowReserved": {
|
|
4400
|
+
"type": "boolean",
|
|
4401
|
+
"description": "Shows the reserved variables if set to true."
|
|
4402
|
+
},
|
|
4403
|
+
"qShowConfig": {
|
|
4404
|
+
"type": "boolean",
|
|
4405
|
+
"description": "Shows the system variables if set to true."
|
|
4406
|
+
},
|
|
4407
|
+
"qData": {
|
|
4408
|
+
"$ref": "JsonObject.json",
|
|
4409
|
+
"description": "Data"
|
|
4410
|
+
},
|
|
4411
|
+
"qShowSession": {
|
|
4412
|
+
"type": "boolean",
|
|
4413
|
+
"description": "Shows the session variables if set to true."
|
|
4414
|
+
}
|
|
4415
|
+
},
|
|
4416
|
+
"description": "Defines the list of variables in an app."
|
|
4417
|
+
}
|
|
4418
|
+
}
|
|
4419
|
+
}
|