@nebula.js/sn-action-button 1.37.0 → 1.38.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.
Files changed (9) hide show
  1. package/README.md +2 -2
  2. package/api-specifications/properties.json +756 -730
  3. package/core/esm/index.js +3 -3
  4. package/core/package.json +1 -1
  5. package/dist/sn-action-button.js +3 -3
  6. package/dist/sn-action-button.systemjs.js +3 -3
  7. package/package.json +26 -26
  8. package/sn-action-button-ext/dist/sn-action-button.js +3 -3
  9. package/sn-action-button-ext/sn-action-button.qext +1 -1
package/api-specifications/properties.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "scriptappy": "1.0.0",
2
+ "scriptappy": "1.1.0",
3
3
  "info": {
4
4
  "name": "@nebula.js/sn-action-button:properties",
5
5
  "description": "Action button generic object definition",
6
- "version": "1.37.0",
6
+ "version": "1.38.0",
7
7
  "license": "MIT",
8
8
  "stability": "stable",
9
9
  "x-qlik-visibility": "public"
@@ -12,51 +12,26 @@
12
12
  "properties": {
13
13
  "extends": [
14
14
  {
15
- "type": "qae.GenericObjectProperties"
15
+ "type": "EngineAPI.GenericObjectProperties"
16
16
  }
17
17
  ],
18
18
  "kind": "object",
19
19
  "entries": {
20
- "actions": {
21
- "description": "List of actions, performed in this order",
22
- "kind": "array",
23
- "items": {
24
- "type": "#/definitions/Action"
25
- }
26
- },
27
- "enabledCondition": {
28
- "description": "Number or expression evaluating to number, 0 means disabling the button",
29
- "defaultValue": 1,
30
- "kind": "union",
31
- "items": [
32
- {
33
- "type": "number"
34
- },
35
- {
36
- "type": "#/definitions/EnabledExpression"
37
- }
38
- ],
39
- "type": "any"
40
- },
41
- "footnote": {
42
- "description": "Visualization footnote",
43
- "optional": true,
44
- "defaultValue": "",
20
+ "version": {
21
+ "description": "Current version of this generic object definition.",
45
22
  "type": "string"
46
23
  },
47
- "navigation": {
48
- "description": "Navigation action to move to new sheet/URL, performed after all other actions",
49
- "type": "#/definitions/NavigationAction"
50
- },
51
24
  "showTitles": {
52
25
  "description": "Show title for the visualization",
53
26
  "optional": true,
54
27
  "defaultValue": true,
55
28
  "type": "boolean"
56
29
  },
57
- "style": {
58
- "description": "All styling options",
59
- "type": "#/definitions/Style"
30
+ "title": {
31
+ "description": "Visualization title",
32
+ "optional": true,
33
+ "defaultValue": "",
34
+ "type": "string"
60
35
  },
61
36
  "subtitle": {
62
37
  "description": "Visualization subtitle",
@@ -64,8 +39,8 @@
64
39
  "defaultValue": "",
65
40
  "type": "string"
66
41
  },
67
- "title": {
68
- "description": "Visualization title",
42
+ "footnote": {
43
+ "description": "Visualization footnote",
69
44
  "optional": true,
70
45
  "defaultValue": "",
71
46
  "type": "string"
@@ -75,746 +50,797 @@
75
50
  "defaultValue": false,
76
51
  "type": "boolean"
77
52
  },
78
- "version": {
79
- "description": "Current version of this generic object definition.",
80
- "type": "string"
81
- }
82
- }
83
- }
84
- },
85
- "definitions": {
86
- "Action": {
87
- "description": "Defines what action to perform and options for that action type.",
88
- "kind": "object",
89
- "entries": {
90
- "actionLabel": {
91
- "description": "Label for reference",
92
- "optional": true,
93
- "defaultValue": "''",
94
- "type": "string"
95
- },
96
- "actionType": {
97
- "description": "The type of action",
98
- "optional": true,
99
- "defaultValue": "''",
53
+ "enabledCondition": {
54
+ "description": "Number or expression evaluating to number, 0 means disabling the button",
55
+ "defaultValue": 1,
100
56
  "kind": "union",
101
57
  "items": [
102
58
  {
103
- "kind": "literal",
104
- "value": "'applyBookmark'"
105
- },
106
- {
107
- "kind": "literal",
108
- "value": "'back'"
109
- },
110
- {
111
- "kind": "literal",
112
- "value": "'forward'"
113
- },
114
- {
115
- "kind": "literal",
116
- "value": "'clearAll'"
117
- },
118
- {
119
- "kind": "literal",
120
- "value": "'clearAllButThis'"
121
- },
122
- {
123
- "kind": "literal",
124
- "value": "'clearField'"
125
- },
126
- {
127
- "kind": "literal",
128
- "value": "'selectAll'"
129
- },
130
- {
131
- "kind": "literal",
132
- "value": "'selectValues'"
133
- },
134
- {
135
- "kind": "literal",
136
- "value": "'selectMatchingValues'"
137
- },
138
- {
139
- "kind": "literal",
140
- "value": "'selectAlternative'"
141
- },
142
- {
143
- "kind": "literal",
144
- "value": "'selectExcluded'"
145
- },
146
- {
147
- "kind": "literal",
148
- "value": "'selectPossible'"
149
- },
150
- {
151
- "kind": "literal",
152
- "value": "'toggleSelect'"
153
- },
154
- {
155
- "kind": "literal",
156
- "value": "'lockAll'"
157
- },
158
- {
159
- "kind": "literal",
160
- "value": "'lockField'"
161
- },
162
- {
163
- "kind": "literal",
164
- "value": "'unlockAll'"
165
- },
166
- {
167
- "kind": "literal",
168
- "value": "'unlockField'"
169
- },
170
- {
171
- "kind": "literal",
172
- "value": "'setVariable'"
173
- },
174
- {
175
- "kind": "literal",
176
- "value": "'doReload'"
177
- },
178
- {
179
- "kind": "literal",
180
- "value": "'executeAutomation'"
59
+ "type": "number"
181
60
  },
182
61
  {
183
- "kind": "literal",
184
- "value": "'refreshDynamicViews'"
62
+ "type": "#/definitions/EnabledExpression"
185
63
  }
186
- ],
187
- "type": "string"
188
- },
189
- "bookmark": {
190
- "description": "ID of bookmark, required for type 'applyBookmark'",
191
- "optional": true,
192
- "defaultValue": "''",
193
- "type": "string"
194
- },
195
- "field": {
196
- "description": "Name of field. Required for types 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible', 'toggleSelect', 'lockField' and 'unlockField'",
197
- "optional": true,
198
- "defaultValue": "''",
199
- "type": "string"
200
- },
201
- "softLock": {
202
- "description": "Set to true to ignore locked field(s). Required for types 'clearAll', 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible' and 'toggleSelect'",
203
- "optional": true,
204
- "defaultValue": "''",
205
- "type": "string"
206
- },
207
- "value": {
208
- "description": "To select certain values in a field or set a variable. Required for types 'selectValues', 'selectMatchingValues', 'toggleSelect' and 'setVariable'",
209
- "optional": true,
210
- "defaultValue": "''",
211
- "type": "string"
64
+ ]
212
65
  },
213
- "variable": {
214
- "description": "Name of variable. Required for type 'setVariable'",
215
- "optional": true,
216
- "defaultValue": "''",
217
- "type": "string"
218
- },
219
- "partial": {
220
- "description": "Set to true if you want to do a partial reload.",
221
- "optional": true,
222
- "defaultValue": false,
223
- "type": "boolean"
224
- },
225
- "automation": {
226
- "description": "Item ID of the automation (the id field returned from /api/v1/items?resourceType=automations)",
227
- "optional": true,
228
- "defaultValue": "''",
229
- "type": "string"
230
- },
231
- "automationId": {
232
- "description": "ID of the automation (the id field from /api/v1/automations OR the id field from /api/v1/automations)",
233
- "optional": true,
234
- "defaultValue": "''",
235
- "type": "string"
236
- },
237
- "automationPostData": {
238
- "description": "Set to true to include the current selections in the automation. Defaults to false",
239
- "optional": true,
240
- "defaultValue": false,
241
- "type": "boolean"
242
- },
243
- "automationTriggered": {
244
- "description": "Set to true when the automation should use the triggered run mode. Defaults to false",
245
- "optional": true,
246
- "defaultValue": false,
247
- "type": "boolean"
248
- },
249
- "automationTriggeredText": {
250
- "description": "Helper text when using the triggered run mode. Defaults to false",
251
- "optional": true,
252
- "defaultValue": "''",
253
- "type": "string"
254
- },
255
- "automationExecutionToken": {
256
- "description": "Token used when using the triggered run mode",
257
- "optional": true,
258
- "defaultValue": "''",
259
- "type": "string"
260
- },
261
- "automationShowNotification": {
262
- "description": "Set to true when an automation should return a notification when finished running. Defaults to false",
263
- "optional": true,
264
- "defaultValue": false,
265
- "type": "boolean"
266
- },
267
- "automationNotificationDuration": {
268
- "description": "The amount of time in seconds that a notification should remain visible after running an automation",
269
- "optional": true,
270
- "defaultValue": "''",
271
- "type": "string"
66
+ "actions": {
67
+ "description": "List of actions, performed in this order",
68
+ "kind": "array",
69
+ "items": {
70
+ "type": "#/definitions/Action"
71
+ }
272
72
  },
273
- "automationNotificationDurationHelp": {
274
- "description": "Helper text when enabling notifications",
275
- "optional": true,
276
- "defaultValue": "''",
277
- "type": "string"
73
+ "navigation": {
74
+ "description": "Navigation action to move to new sheet/URL, performed after all other actions",
75
+ "type": "#/definitions/NavigationAction"
278
76
  },
279
- "automationOpenLinkSameWindow": {
280
- "description": "Set to true if you want links from notifications to be opened in the same tab",
281
- "optional": true,
282
- "defaultValue": false,
283
- "type": "boolean"
77
+ "style": {
78
+ "description": "All styling options",
79
+ "type": "#/definitions/Style"
80
+ }
81
+ }
82
+ }
83
+ },
84
+ "definitions": {
85
+ "Action": {
86
+ "description": "Defines what action to perform and options for that action type.",
87
+ "kind": "alias",
88
+ "items": {
89
+ "kind": "object",
90
+ "entries": {
91
+ "actionLabel": {
92
+ "description": "Label for reference",
93
+ "optional": true,
94
+ "defaultValue": "''",
95
+ "type": "string"
96
+ },
97
+ "actionType": {
98
+ "description": "The type of action",
99
+ "optional": true,
100
+ "defaultValue": "''",
101
+ "kind": "union",
102
+ "items": [
103
+ {
104
+ "kind": "literal",
105
+ "value": "'applyBookmark'"
106
+ },
107
+ {
108
+ "kind": "literal",
109
+ "value": "'back'"
110
+ },
111
+ {
112
+ "kind": "literal",
113
+ "value": "'forward'"
114
+ },
115
+ {
116
+ "kind": "literal",
117
+ "value": "'clearAll'"
118
+ },
119
+ {
120
+ "kind": "literal",
121
+ "value": "'clearAllButThis'"
122
+ },
123
+ {
124
+ "kind": "literal",
125
+ "value": "'clearField'"
126
+ },
127
+ {
128
+ "kind": "literal",
129
+ "value": "'selectAll'"
130
+ },
131
+ {
132
+ "kind": "literal",
133
+ "value": "'selectValues'"
134
+ },
135
+ {
136
+ "kind": "literal",
137
+ "value": "'selectMatchingValues'"
138
+ },
139
+ {
140
+ "kind": "literal",
141
+ "value": "'selectAlternative'"
142
+ },
143
+ {
144
+ "kind": "literal",
145
+ "value": "'selectExcluded'"
146
+ },
147
+ {
148
+ "kind": "literal",
149
+ "value": "'selectPossible'"
150
+ },
151
+ {
152
+ "kind": "literal",
153
+ "value": "'toggleSelect'"
154
+ },
155
+ {
156
+ "kind": "literal",
157
+ "value": "'lockAll'"
158
+ },
159
+ {
160
+ "kind": "literal",
161
+ "value": "'lockField'"
162
+ },
163
+ {
164
+ "kind": "literal",
165
+ "value": "'unlockAll'"
166
+ },
167
+ {
168
+ "kind": "literal",
169
+ "value": "'unlockField'"
170
+ },
171
+ {
172
+ "kind": "literal",
173
+ "value": "'setVariable'"
174
+ },
175
+ {
176
+ "kind": "literal",
177
+ "value": "'doReload'"
178
+ },
179
+ {
180
+ "kind": "literal",
181
+ "value": "'executeAutomation'"
182
+ },
183
+ {
184
+ "kind": "literal",
185
+ "value": "'refreshDynamicViews'"
186
+ }
187
+ ]
188
+ },
189
+ "bookmark": {
190
+ "description": "ID of bookmark, required for type 'applyBookmark'",
191
+ "optional": true,
192
+ "defaultValue": "''",
193
+ "type": "string"
194
+ },
195
+ "field": {
196
+ "description": "Name of field. Required for types 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible', 'toggleSelect', 'lockField' and 'unlockField'",
197
+ "optional": true,
198
+ "defaultValue": "''",
199
+ "type": "string"
200
+ },
201
+ "softLock": {
202
+ "description": "Set to true to ignore locked field(s). Required for types 'clearAll', 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible' and 'toggleSelect'",
203
+ "optional": true,
204
+ "defaultValue": "''",
205
+ "type": "string"
206
+ },
207
+ "value": {
208
+ "description": "To select certain values in a field or set a variable. Required for types 'selectValues', 'selectMatchingValues', 'toggleSelect' and 'setVariable'",
209
+ "optional": true,
210
+ "defaultValue": "''",
211
+ "type": "string"
212
+ },
213
+ "variable": {
214
+ "description": "Name of variable. Required for type 'setVariable'",
215
+ "optional": true,
216
+ "defaultValue": "''",
217
+ "type": "string"
218
+ },
219
+ "partial": {
220
+ "description": "Set to true if you want to do a partial reload.",
221
+ "optional": true,
222
+ "defaultValue": false,
223
+ "type": "boolean"
224
+ },
225
+ "automation": {
226
+ "description": "Item ID of the automation (the id field returned from /api/v1/items?resourceType=automations)",
227
+ "optional": true,
228
+ "defaultValue": "''",
229
+ "type": "string"
230
+ },
231
+ "automationId": {
232
+ "description": "ID of the automation (the id field from /api/v1/automations OR the id field from /api/v1/automations)",
233
+ "optional": true,
234
+ "defaultValue": "''",
235
+ "type": "string"
236
+ },
237
+ "automationPostData": {
238
+ "description": "Set to true to include the current selections in the automation. Defaults to false",
239
+ "optional": true,
240
+ "defaultValue": false,
241
+ "type": "boolean"
242
+ },
243
+ "automationTriggered": {
244
+ "description": "Set to true when the automation should use the triggered run mode. Defaults to false",
245
+ "optional": true,
246
+ "defaultValue": false,
247
+ "type": "boolean"
248
+ },
249
+ "automationTriggeredText": {
250
+ "description": "Helper text when using the triggered run mode. Defaults to false",
251
+ "optional": true,
252
+ "defaultValue": "''",
253
+ "type": "string"
254
+ },
255
+ "automationExecutionToken": {
256
+ "description": "Token used when using the triggered run mode",
257
+ "optional": true,
258
+ "defaultValue": "''",
259
+ "type": "string"
260
+ },
261
+ "automationShowNotification": {
262
+ "description": "Set to true when an automation should return a notification when finished running. Defaults to false",
263
+ "optional": true,
264
+ "defaultValue": false,
265
+ "type": "boolean"
266
+ },
267
+ "automationNotificationDuration": {
268
+ "description": "The amount of time in seconds that a notification should remain visible after running an automation",
269
+ "optional": true,
270
+ "defaultValue": "''",
271
+ "type": "string"
272
+ },
273
+ "automationNotificationDurationHelp": {
274
+ "description": "Helper text when enabling notifications",
275
+ "optional": true,
276
+ "defaultValue": "''",
277
+ "type": "string"
278
+ },
279
+ "automationOpenLinkSameWindow": {
280
+ "description": "Set to true if you want links from notifications to be opened in the same tab",
281
+ "optional": true,
282
+ "defaultValue": false,
283
+ "type": "boolean"
284
+ }
284
285
  }
285
286
  }
286
287
  },
287
- "Background": {
288
- "kind": "object",
289
- "entries": {
290
- "useColorExpression": {
291
- "description": "Set to true to use color expression",
292
- "optional": true,
293
- "defaultValue": false,
294
- "type": "boolean"
295
- },
296
- "color": {
297
- "description": "Color defined by index or hex code, needed if useColorExpression is false",
298
- "optional": true,
299
- "type": "#/definitions/PaletteColor"
300
- },
301
- "colorExpression": {
302
- "description": "Color defined by expression, needed if useColorExpression is true",
303
- "optional": true,
304
- "type": "#/definitions/ColorExpression"
305
- },
306
- "mode": {
307
- "description": "Toggles the background image, set to media to show the image",
308
- "optional": true,
309
- "defaultValue": "'none'",
310
- "kind": "union",
311
- "items": [
312
- {
313
- "kind": "literal",
314
- "value": "'none'"
315
- },
316
- {
317
- "kind": "literal",
318
- "value": "'media'"
319
- }
320
- ],
321
- "type": "string"
322
- },
323
- "useImage": {
324
- "description": "Set to true to show background image",
325
- "optional": true,
326
- "defaultValue": false,
327
- "type": "boolean"
328
- },
329
- "url": {
330
- "description": "Contains the URL for the background image",
331
- "optional": true,
332
- "kind": "object",
333
- "entries": {
334
- "qStaticContentUrlDef": {
335
- "optional": true,
336
- "kind": "object",
337
- "entries": {
338
- "qUrl": {
339
- "description": "URL represented as a string",
340
- "optional": true,
341
- "type": "string"
342
- }
288
+ "NavigationAction": {
289
+ "description": "Defines a navigation action to perform after the other actions. Note that when the sn-action-button is used outside Qlik Sense you can only use the 'openWebsite' action.",
290
+ "kind": "alias",
291
+ "items": {
292
+ "kind": "object",
293
+ "entries": {
294
+ "action": {
295
+ "description": "Name of navigation action",
296
+ "kind": "union",
297
+ "items": [
298
+ {
299
+ "kind": "literal",
300
+ "value": "'nextSheet'"
301
+ },
302
+ {
303
+ "kind": "literal",
304
+ "value": "'prevSheet'"
305
+ },
306
+ {
307
+ "kind": "literal",
308
+ "value": "'firstSheet'"
309
+ },
310
+ {
311
+ "kind": "literal",
312
+ "value": "'lastSheet'"
313
+ },
314
+ {
315
+ "kind": "literal",
316
+ "value": "'goToSheet'"
317
+ },
318
+ {
319
+ "kind": "literal",
320
+ "value": "'goToSheetById'"
321
+ },
322
+ {
323
+ "kind": "literal",
324
+ "value": "'goToSheetById'"
325
+ },
326
+ {
327
+ "kind": "literal",
328
+ "value": "'goToStory'"
329
+ },
330
+ {
331
+ "kind": "literal",
332
+ "value": "'openWebsite'"
333
+ },
334
+ {
335
+ "kind": "literal",
336
+ "value": "'odagLink'"
337
+ },
338
+ {
339
+ "kind": "literal",
340
+ "value": "'openChainedApp'"
343
341
  }
344
- }
342
+ ]
343
+ },
344
+ "appId": {
345
+ "description": "app ID. Required for 'openChainedApp'",
346
+ "optional": true,
347
+ "type": "string"
348
+ },
349
+ "sheet": {
350
+ "description": "sheet ID. Required for 'goToSheet' and 'goToSheetById'",
351
+ "optional": true,
352
+ "type": "string"
353
+ },
354
+ "chartId": {
355
+ "description": "chart ID. Required for 'goToSheet' and highlighting the chart",
356
+ "optional": true,
357
+ "type": "string"
358
+ },
359
+ "story": {
360
+ "description": "Story ID. Required for 'goToStory'",
361
+ "optional": true,
362
+ "type": "string"
363
+ },
364
+ "websiteUrl": {
365
+ "description": "URL for website. required for 'openWebsite'",
366
+ "optional": true,
367
+ "type": "string"
368
+ },
369
+ "sameWindow": {
370
+ "description": "Set to true to open in same window/tab. Required for 'openWebsite'",
371
+ "optional": true,
372
+ "type": "boolean"
373
+ },
374
+ "odagLink": {
375
+ "description": "ODAG link name. Required for 'odagLink'",
376
+ "optional": true,
377
+ "type": "string"
345
378
  }
346
- },
347
- "position": {
348
- "description": "Image position",
349
- "optional": true,
350
- "defaultValue": "'center-center'",
351
- "kind": "union",
352
- "items": [
353
- {
354
- "kind": "literal",
355
- "value": "'topLeft'"
356
- },
357
- {
358
- "kind": "literal",
359
- "value": "'centerLeft'"
360
- },
361
- {
362
- "kind": "literal",
363
- "value": "'bottomLeft'"
364
- },
365
- {
366
- "kind": "literal",
367
- "value": "'topCenter'"
368
- },
369
- {
370
- "kind": "literal",
371
- "value": "'centerCenter'"
372
- },
373
- {
374
- "kind": "literal",
375
- "value": "'bottomCenter'"
376
- },
377
- {
378
- "kind": "literal",
379
- "value": "'topRight'"
380
- },
381
- {
382
- "kind": "literal",
383
- "value": "'centerRight'"
384
- },
385
- {
386
- "kind": "literal",
387
- "value": "'bottomRight'"
388
- },
389
- {
390
- "kind": "literal",
391
- "value": "'top-left'"
392
- },
393
- {
394
- "kind": "literal",
395
- "value": "'center-left'"
396
- },
397
- {
398
- "kind": "literal",
399
- "value": "'bottom-left'"
400
- },
401
- {
402
- "kind": "literal",
403
- "value": "'top-center'"
404
- },
405
- {
406
- "kind": "literal",
407
- "value": "'center-center'"
408
- },
409
- {
410
- "kind": "literal",
411
- "value": "'top-right'"
412
- },
413
- {
414
- "kind": "literal",
415
- "value": "'center-right'"
416
- },
417
- {
418
- "kind": "literal",
419
- "value": "'bottom-right'"
420
- }
421
- ],
422
- "type": "string"
423
- },
424
- "size": {
425
- "description": "Size of the image, relative to the button",
426
- "optional": true,
427
- "defaultValue": "'auto'",
428
- "kind": "union",
429
- "items": [
430
- {
431
- "kind": "literal",
432
- "value": "'auto'"
433
- },
434
- {
435
- "kind": "literal",
436
- "value": "'alwaysFit'"
437
- },
438
- {
439
- "kind": "literal",
440
- "value": "'fitWidth'"
441
- },
442
- {
443
- "kind": "literal",
444
- "value": "'fitHeight'"
445
- },
446
- {
447
- "kind": "literal",
448
- "value": "'fill'"
449
- },
450
- {
451
- "kind": "literal",
452
- "value": "'alwaysFill'"
453
- },
454
- {
455
- "kind": "literal",
456
- "value": "'stretchFit'"
457
- }
458
- ],
459
- "type": "string"
460
379
  }
461
380
  }
462
381
  },
463
- "Border": {
464
- "kind": "object",
465
- "entries": {
466
- "useBorder": {
467
- "description": "Set to true to use border expression",
468
- "optional": true,
469
- "defaultValue": false,
470
- "type": "boolean"
471
- },
472
- "width": {
473
- "description": "Relative width, 0 is no border and 1 make the border fill the entire button",
474
- "optional": true,
475
- "defaultValue": 0,
476
- "type": "number"
477
- },
478
- "radius": {
479
- "description": "Relative border radius, 0 is no rounding and 1 will make the short side a half circle",
480
- "optional": true,
481
- "defaultValue": 0,
482
- "type": "number"
483
- },
484
- "useColorExpression": {
485
- "description": "Set to true to use color expression",
486
- "optional": true,
487
- "defaultValue": false,
488
- "type": "boolean"
489
- },
490
- "color": {
491
- "description": "Color defined by index or hex code, needed if useColorExpression is false",
492
- "optional": true,
493
- "type": "#/definitions/PaletteColor"
494
- },
495
- "colorExpression": {
496
- "description": "Color defined by expression, needed if useColorExpression is true",
497
- "optional": true,
498
- "type": "string"
382
+ "Style": {
383
+ "description": "Holds styling options",
384
+ "kind": "alias",
385
+ "items": {
386
+ "kind": "object",
387
+ "entries": {
388
+ "label": {
389
+ "description": "The text displayed on the button",
390
+ "optional": true,
391
+ "defaultValue": "'Button'",
392
+ "type": "string"
393
+ },
394
+ "showLabel": {
395
+ "description": "If the label should be shown or hidden",
396
+ "optional": true,
397
+ "defaultValue": true,
398
+ "type": "boolean"
399
+ },
400
+ "font": {
401
+ "description": "Styling for the label",
402
+ "optional": true,
403
+ "type": "#/definitions/Font"
404
+ },
405
+ "background": {
406
+ "description": "Styling for background, including image",
407
+ "optional": true,
408
+ "type": "#/definitions/Background"
409
+ },
410
+ "border": {
411
+ "description": "Styling for border",
412
+ "optional": true,
413
+ "type": "#/definitions/Border"
414
+ },
415
+ "icon": {
416
+ "description": "Styling for icon",
417
+ "optional": true,
418
+ "type": "#/definitions/Icon"
419
+ }
499
420
  }
500
421
  }
501
422
  },
502
- "ColorExpression": {
503
- "description": "Format for using color expressions",
504
- "kind": "object",
505
- "entries": {
506
- "qStringExpression": {
507
- "kind": "object",
508
- "entries": {
509
- "qExpr": {
510
- "description": "expression that resolves to a supported color format",
511
- "type": "string"
423
+ "Font": {
424
+ "kind": "alias",
425
+ "items": {
426
+ "kind": "object",
427
+ "entries": {
428
+ "fontFamily": {
429
+ "description": "Font Family of the label",
430
+ "optional": true,
431
+ "defaultValue": "'Source Sans Pro'",
432
+ "type": "string"
433
+ },
434
+ "useColorExpression": {
435
+ "description": "Set to true to use color expression",
436
+ "optional": true,
437
+ "defaultValue": false,
438
+ "type": "boolean"
439
+ },
440
+ "color": {
441
+ "description": "Color defined by index or hex code, needed if useColorExpression is false",
442
+ "optional": true,
443
+ "type": "#/definitions/PaletteColor"
444
+ },
445
+ "colorExpression": {
446
+ "description": "Color defined by expression, needed if useColorExpression is true",
447
+ "optional": true,
448
+ "type": "#/definitions/ColorExpression"
449
+ },
450
+ "size": {
451
+ "description": "Relative[] size of label, must be greater than 0 and 1 fills the entire button",
452
+ "optional": true,
453
+ "defaultValue": 0.5,
454
+ "type": "number"
455
+ },
456
+ "sizeFixed": {
457
+ "description": "Fixed size of the label in pixels. Must be bigger than 5. Only active when sizeBehavior is fixed.",
458
+ "optional": true,
459
+ "defaultValue": 20,
460
+ "type": "number"
461
+ },
462
+ "align": {
463
+ "description": "Horizontal alignment",
464
+ "optional": true,
465
+ "defaultValue": "'center'",
466
+ "kind": "union",
467
+ "items": [
468
+ {
469
+ "kind": "literal",
470
+ "value": "'left'"
471
+ },
472
+ {
473
+ "kind": "literal",
474
+ "value": "'center'"
475
+ },
476
+ {
477
+ "kind": "literal",
478
+ "value": "'right'"
479
+ }
480
+ ]
481
+ },
482
+ "style": {
483
+ "description": "Additional style options",
484
+ "optional": true,
485
+ "kind": "object",
486
+ "entries": {
487
+ "bold": {
488
+ "description": "Bold text",
489
+ "optional": true,
490
+ "defaultValue": true,
491
+ "type": "boolean"
492
+ },
493
+ "italic": {
494
+ "description": "Italic text",
495
+ "optional": true,
496
+ "defaultValue": false,
497
+ "type": "boolean"
498
+ },
499
+ "underline": {
500
+ "description": "Underlined text",
501
+ "optional": true,
502
+ "defaultValue": false,
503
+ "type": "boolean"
504
+ }
512
505
  }
506
+ },
507
+ "sizeBehavior": {
508
+ "description": "Setting to determine how the fontsize of the label is calculated.",
509
+ "optional": true,
510
+ "defaultValue": "'responsive'",
511
+ "kind": "union",
512
+ "items": [
513
+ {
514
+ "kind": "literal",
515
+ "value": "'responsive'"
516
+ },
517
+ {
518
+ "kind": "literal",
519
+ "value": "'relative'"
520
+ },
521
+ {
522
+ "kind": "literal",
523
+ "value": "'fixed'"
524
+ }
525
+ ]
513
526
  }
514
527
  }
515
528
  }
516
529
  },
517
- "EnabledExpression": {
518
- "description": "Format for setting if the button is enabled/disabled with an expression",
519
- "kind": "object",
520
- "entries": {
521
- "qStringExpression": {
522
- "kind": "object",
523
- "entries": {
524
- "qExpr": {
525
- "description": "expression that resolves to a number",
526
- "type": "string"
530
+ "Background": {
531
+ "kind": "alias",
532
+ "items": {
533
+ "kind": "object",
534
+ "entries": {
535
+ "useColorExpression": {
536
+ "description": "Set to true to use color expression",
537
+ "optional": true,
538
+ "defaultValue": false,
539
+ "type": "boolean"
540
+ },
541
+ "color": {
542
+ "description": "Color defined by index or hex code, needed if useColorExpression is false",
543
+ "optional": true,
544
+ "type": "#/definitions/PaletteColor"
545
+ },
546
+ "colorExpression": {
547
+ "description": "Color defined by expression, needed if useColorExpression is true",
548
+ "optional": true,
549
+ "type": "#/definitions/ColorExpression"
550
+ },
551
+ "mode": {
552
+ "description": "Toggles the background image, set to media to show the image",
553
+ "optional": true,
554
+ "defaultValue": "'none'",
555
+ "kind": "union",
556
+ "items": [
557
+ {
558
+ "kind": "literal",
559
+ "value": "'none'"
560
+ },
561
+ {
562
+ "kind": "literal",
563
+ "value": "'media'"
564
+ }
565
+ ]
566
+ },
567
+ "useImage": {
568
+ "description": "Set to true to show background image",
569
+ "optional": true,
570
+ "defaultValue": false,
571
+ "type": "boolean"
572
+ },
573
+ "url": {
574
+ "description": "Contains the URL for the background image",
575
+ "optional": true,
576
+ "kind": "object",
577
+ "entries": {
578
+ "qStaticContentUrlDef": {
579
+ "optional": true,
580
+ "kind": "object",
581
+ "entries": {
582
+ "qUrl": {
583
+ "description": "URL represented as a string",
584
+ "optional": true,
585
+ "type": "string"
586
+ }
587
+ }
588
+ }
527
589
  }
590
+ },
591
+ "position": {
592
+ "description": "Image position",
593
+ "optional": true,
594
+ "defaultValue": "'center-center'",
595
+ "kind": "union",
596
+ "items": [
597
+ {
598
+ "kind": "literal",
599
+ "value": "'topLeft'"
600
+ },
601
+ {
602
+ "kind": "literal",
603
+ "value": "'centerLeft'"
604
+ },
605
+ {
606
+ "kind": "literal",
607
+ "value": "'bottomLeft'"
608
+ },
609
+ {
610
+ "kind": "literal",
611
+ "value": "'topCenter'"
612
+ },
613
+ {
614
+ "kind": "literal",
615
+ "value": "'centerCenter'"
616
+ },
617
+ {
618
+ "kind": "literal",
619
+ "value": "'bottomCenter'"
620
+ },
621
+ {
622
+ "kind": "literal",
623
+ "value": "'topRight'"
624
+ },
625
+ {
626
+ "kind": "literal",
627
+ "value": "'centerRight'"
628
+ },
629
+ {
630
+ "kind": "literal",
631
+ "value": "'bottomRight'"
632
+ },
633
+ {
634
+ "kind": "literal",
635
+ "value": "'top-left'"
636
+ },
637
+ {
638
+ "kind": "literal",
639
+ "value": "'center-left'"
640
+ },
641
+ {
642
+ "kind": "literal",
643
+ "value": "'bottom-left'"
644
+ },
645
+ {
646
+ "kind": "literal",
647
+ "value": "'top-center'"
648
+ },
649
+ {
650
+ "kind": "literal",
651
+ "value": "'center-center'"
652
+ },
653
+ {
654
+ "kind": "literal",
655
+ "value": "'top-right'"
656
+ },
657
+ {
658
+ "kind": "literal",
659
+ "value": "'center-right'"
660
+ },
661
+ {
662
+ "kind": "literal",
663
+ "value": "'bottom-right'"
664
+ }
665
+ ]
666
+ },
667
+ "size": {
668
+ "description": "Size of the image, relative to the button",
669
+ "optional": true,
670
+ "defaultValue": "'auto'",
671
+ "kind": "union",
672
+ "items": [
673
+ {
674
+ "kind": "literal",
675
+ "value": "'auto'"
676
+ },
677
+ {
678
+ "kind": "literal",
679
+ "value": "'alwaysFit'"
680
+ },
681
+ {
682
+ "kind": "literal",
683
+ "value": "'fitWidth'"
684
+ },
685
+ {
686
+ "kind": "literal",
687
+ "value": "'fitHeight'"
688
+ },
689
+ {
690
+ "kind": "literal",
691
+ "value": "'fill'"
692
+ },
693
+ {
694
+ "kind": "literal",
695
+ "value": "'alwaysFill'"
696
+ },
697
+ {
698
+ "kind": "literal",
699
+ "value": "'stretchFit'"
700
+ }
701
+ ]
528
702
  }
529
703
  }
530
704
  }
531
705
  },
532
- "Font": {
533
- "kind": "object",
534
- "entries": {
535
- "fontFamily": {
536
- "description": "Font Family of the label",
537
- "optional": true,
538
- "defaultValue": "'Source Sans Pro'",
539
- "type": "string"
540
- },
541
- "useColorExpression": {
542
- "description": "Set to true to use color expression",
543
- "optional": true,
544
- "defaultValue": false,
545
- "type": "boolean"
546
- },
547
- "color": {
548
- "description": "Color defined by index or hex code, needed if useColorExpression is false",
549
- "optional": true,
550
- "type": "#/definitions/PaletteColor"
551
- },
552
- "colorExpression": {
553
- "description": "Color defined by expression, needed if useColorExpression is true",
554
- "optional": true,
555
- "type": "#/definitions/ColorExpression"
556
- },
557
- "size": {
558
- "description": "Relative[] size of label, must be greater than 0 and 1 fills the entire button",
559
- "optional": true,
560
- "defaultValue": 0.5,
561
- "type": "number"
562
- },
563
- "sizeFixed": {
564
- "description": "Fixed size of the label in pixels. Must be bigger than 5. Only active when sizeBehavior is fixed.",
565
- "optional": true,
566
- "defaultValue": 20,
567
- "type": "number"
568
- },
569
- "align": {
570
- "description": "Horizontal alignment",
571
- "optional": true,
572
- "defaultValue": "'center'",
573
- "kind": "union",
574
- "items": [
575
- {
576
- "kind": "literal",
577
- "value": "'left'"
578
- },
579
- {
580
- "kind": "literal",
581
- "value": "'center'"
582
- },
583
- {
584
- "kind": "literal",
585
- "value": "'right'"
586
- }
587
- ],
588
- "type": "string"
589
- },
590
- "style": {
591
- "description": "Additional style options",
592
- "optional": true,
593
- "kind": "object",
594
- "entries": {
595
- "bold": {
596
- "description": "Bold text",
597
- "optional": true,
598
- "defaultValue": true,
599
- "type": "boolean"
600
- },
601
- "italic": {
602
- "description": "Italic text",
603
- "optional": true,
604
- "defaultValue": false,
605
- "type": "boolean"
606
- },
607
- "underline": {
608
- "description": "Underlined text",
609
- "optional": true,
610
- "defaultValue": false,
611
- "type": "boolean"
612
- }
706
+ "Border": {
707
+ "kind": "alias",
708
+ "items": {
709
+ "kind": "object",
710
+ "entries": {
711
+ "useBorder": {
712
+ "description": "Set to true to use border expression",
713
+ "optional": true,
714
+ "defaultValue": false,
715
+ "type": "boolean"
716
+ },
717
+ "width": {
718
+ "description": "Relative width, 0 is no border and 1 make the border fill the entire button",
719
+ "optional": true,
720
+ "defaultValue": 0,
721
+ "type": "number"
722
+ },
723
+ "radius": {
724
+ "description": "Relative border radius, 0 is no rounding and 1 will make the short side a half circle",
725
+ "optional": true,
726
+ "defaultValue": 0,
727
+ "type": "number"
728
+ },
729
+ "useColorExpression": {
730
+ "description": "Set to true to use color expression",
731
+ "optional": true,
732
+ "defaultValue": false,
733
+ "type": "boolean"
734
+ },
735
+ "color": {
736
+ "description": "Color defined by index or hex code, needed if useColorExpression is false",
737
+ "optional": true,
738
+ "type": "#/definitions/PaletteColor"
739
+ },
740
+ "colorExpression": {
741
+ "description": "Color defined by expression, needed if useColorExpression is true",
742
+ "optional": true,
743
+ "type": "string"
613
744
  }
614
- },
615
- "sizeBehavior": {
616
- "description": "Setting to determine how the fontsize of the label is calculated.",
617
- "optional": true,
618
- "defaultValue": "'responsive'",
619
- "kind": "union",
620
- "items": [
621
- {
622
- "kind": "literal",
623
- "value": "'responsive'"
624
- },
625
- {
626
- "kind": "literal",
627
- "value": "'relative'"
628
- },
629
- {
630
- "kind": "literal",
631
- "value": "'fixed'"
632
- }
633
- ],
634
- "type": "string"
635
745
  }
636
746
  }
637
747
  },
638
748
  "Icon": {
639
749
  "description": "Icons are only available inside Qlik Sense",
640
- "kind": "object",
641
- "entries": {
642
- "useIcon": {
643
- "description": "Set to true to show icon, default is false",
644
- "optional": true,
645
- "defaultValue": false,
646
- "type": "boolean"
647
- },
648
- "iconType": {
649
- "description": "holds the name of the icon",
650
- "optional": true,
651
- "kind": "object",
652
- "entries": {
653
- "value": {
654
- "description": "name of icon",
655
- "optional": true,
656
- "defaultValue": "''",
657
- "type": "string"
750
+ "kind": "alias",
751
+ "items": {
752
+ "kind": "object",
753
+ "entries": {
754
+ "useIcon": {
755
+ "description": "Set to true to show icon, default is false",
756
+ "optional": true,
757
+ "defaultValue": false,
758
+ "type": "boolean"
759
+ },
760
+ "iconType": {
761
+ "description": "holds the name of the icon",
762
+ "optional": true,
763
+ "kind": "object",
764
+ "entries": {
765
+ "value": {
766
+ "description": "name of icon",
767
+ "optional": true,
768
+ "defaultValue": "''",
769
+ "type": "string"
770
+ }
658
771
  }
772
+ },
773
+ "position": {
774
+ "description": "Defines which side of the label the icon will be",
775
+ "optional": true,
776
+ "defaultValue": "'left'",
777
+ "kind": "union",
778
+ "items": [
779
+ {
780
+ "kind": "literal",
781
+ "value": "'left'"
782
+ },
783
+ {
784
+ "kind": "literal",
785
+ "value": "'right'"
786
+ }
787
+ ]
659
788
  }
660
- },
661
- "position": {
662
- "description": "Defines which side of the label the icon will be",
663
- "optional": true,
664
- "defaultValue": "'left'",
665
- "kind": "union",
666
- "items": [
667
- {
668
- "kind": "literal",
669
- "value": "'left'"
670
- },
671
- {
672
- "kind": "literal",
673
- "value": "'right'"
674
- }
675
- ],
676
- "type": "string"
677
789
  }
678
790
  }
679
791
  },
680
- "NavigationAction": {
681
- "description": "Defines a navigation action to perform after the other actions. Note that when the sn-action-button is used outside Qlik Sense you can only use the 'openWebsite' action.",
682
- "kind": "object",
683
- "entries": {
684
- "action": {
685
- "description": "Name of navigation action",
686
- "kind": "union",
687
- "items": [
688
- {
689
- "kind": "literal",
690
- "value": "'nextSheet'"
691
- },
692
- {
693
- "kind": "literal",
694
- "value": "'prevSheet'"
695
- },
696
- {
697
- "kind": "literal",
698
- "value": "'firstSheet'"
699
- },
700
- {
701
- "kind": "literal",
702
- "value": "'lastSheet'"
703
- },
704
- {
705
- "kind": "literal",
706
- "value": "'goToSheet'"
707
- },
708
- {
709
- "kind": "literal",
710
- "value": "'goToSheetById'"
711
- },
712
- {
713
- "kind": "literal",
714
- "value": "'goToSheetById'"
715
- },
716
- {
717
- "kind": "literal",
718
- "value": "'goToStory'"
719
- },
720
- {
721
- "kind": "literal",
722
- "value": "'openWebsite'"
723
- },
724
- {
725
- "kind": "literal",
726
- "value": "'odagLink'"
727
- },
728
- {
729
- "kind": "literal",
730
- "value": "'openChainedApp'"
731
- }
732
- ],
733
- "type": "string"
734
- },
735
- "appId": {
736
- "description": "app ID. Required for 'openChainedApp'",
737
- "optional": true,
738
- "type": "string"
739
- },
740
- "sheet": {
741
- "description": "sheet ID. Required for 'goToSheet' and 'goToSheetById'",
742
- "optional": true,
743
- "type": "string"
744
- },
745
- "story": {
746
- "description": "Story ID. Required for 'goToStory'",
747
- "optional": true,
748
- "type": "string"
749
- },
750
- "websiteUrl": {
751
- "description": "URL for website. required for 'openWebsite'",
752
- "optional": true,
753
- "type": "string"
754
- },
755
- "sameWindow": {
756
- "description": "Set to true to open in same window/tab. Required for 'openWebsite'",
757
- "optional": true,
758
- "type": "boolean"
759
- },
760
- "odagLink": {
761
- "description": "ODAG link name. Required for 'odagLink'",
762
- "optional": true,
763
- "type": "string"
792
+ "PaletteColor": {
793
+ "description": "Color information structure. Holds the actual color and index in palette.",
794
+ "kind": "alias",
795
+ "items": {
796
+ "kind": "object",
797
+ "entries": {
798
+ "color": {
799
+ "description": "Color as hex string (only used if index: -1)",
800
+ "optional": true,
801
+ "type": "string"
802
+ },
803
+ "index": {
804
+ "description": "Index in palette",
805
+ "optional": true,
806
+ "type": "number"
807
+ }
764
808
  }
765
809
  }
766
810
  },
767
- "PaletteColor": {
768
- "description": "Color information structure. Holds the actual color and index in palette.",
769
- "kind": "object",
770
- "entries": {
771
- "color": {
772
- "description": "Color as hex string (only used if index: -1)",
773
- "optional": true,
774
- "type": "string"
775
- },
776
- "index": {
777
- "description": "Index in palette",
778
- "optional": true,
779
- "type": "number"
811
+ "ColorExpression": {
812
+ "description": "Format for using color expressions",
813
+ "kind": "alias",
814
+ "items": {
815
+ "kind": "object",
816
+ "entries": {
817
+ "qStringExpression": {
818
+ "kind": "object",
819
+ "entries": {
820
+ "qExpr": {
821
+ "description": "expression that resolves to a supported color format",
822
+ "type": "string"
823
+ }
824
+ }
825
+ }
780
826
  }
781
827
  }
782
828
  },
783
- "Style": {
784
- "description": "Holds styling options",
785
- "kind": "object",
786
- "entries": {
787
- "label": {
788
- "description": "The text displayed on the button",
789
- "optional": true,
790
- "defaultValue": "'Button'",
791
- "type": "string"
792
- },
793
- "showLabel": {
794
- "description": "If the label should be shown or hidden",
795
- "optional": true,
796
- "defaultValue": true,
797
- "type": "boolean"
798
- },
799
- "font": {
800
- "description": "Styling for the label",
801
- "optional": true,
802
- "type": "#/definitions/Font"
803
- },
804
- "background": {
805
- "description": "Styling for background, including image",
806
- "optional": true,
807
- "type": "#/definitions/Background"
808
- },
809
- "border": {
810
- "description": "Styling for border",
811
- "optional": true,
812
- "type": "#/definitions/Border"
813
- },
814
- "icon": {
815
- "description": "Styling for icon",
816
- "optional": true,
817
- "type": "#/definitions/Icon"
829
+ "EnabledExpression": {
830
+ "description": "Format for setting if the button is enabled/disabled with an expression",
831
+ "kind": "alias",
832
+ "items": {
833
+ "kind": "object",
834
+ "entries": {
835
+ "qStringExpression": {
836
+ "kind": "object",
837
+ "entries": {
838
+ "qExpr": {
839
+ "description": "expression that resolves to a number",
840
+ "type": "string"
841
+ }
842
+ }
843
+ }
818
844
  }
819
845
  }
820
846
  }