@nebula.js/sn-pivot-table 2.2.0 → 2.4.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 (8) hide show
  1. package/api-specifications/properties.json +248 -32
  2. package/core/esm/index.js +10 -10
  3. package/core/package.json +1 -1
  4. package/dist/sn-pivot-table.js +12 -12
  5. package/dist/sn-pivot-table.systemjs.js +10 -10
  6. package/package.json +26 -26
  7. package/sn-pivot-table-ext/dist/sn-pivot-table.js +12 -12
  8. package/sn-pivot-table-ext/sn-pivot-table.qext +1 -1
package/api-specifications/properties.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "name": "@nebula.js/sn-pivot-table:properties",
5
5
  "description": "Pivot Table generic object definition",
6
- "version": "2.2.0",
6
+ "version": "2.4.0",
7
7
  "license": "MIT",
8
8
  "stability": "experimental",
9
9
  "x-qlik-visibility": "public"
@@ -121,8 +121,8 @@
121
121
  "kind": "object"
122
122
  },
123
123
  "components": {
124
- "description": "Holds general styling",
125
- "nullable": true,
124
+ "description": "General and chart specific styling",
125
+ "optional": true,
126
126
  "kind": "array",
127
127
  "items": {
128
128
  "type": "#/definitions/Component"
@@ -143,6 +143,12 @@
143
143
  "entries": {
144
144
  "qDef": {
145
145
  "type": "#/definitions/InlineDimensionDef"
146
+ },
147
+ "qAttributeExpressions": {
148
+ "kind": "array",
149
+ "items": {
150
+ "type": "#/definitions/AttributeExpressionDef"
151
+ }
146
152
  }
147
153
  }
148
154
  },
@@ -157,9 +163,54 @@
157
163
  "entries": {
158
164
  "qDefs": {
159
165
  "type": "#/definitions/InlineMeasureDef"
166
+ },
167
+ "qAttributeExpressions": {
168
+ "kind": "array",
169
+ "items": {
170
+ "type": "#/definitions/AttributeExpressionDef"
171
+ }
160
172
  }
161
173
  }
162
174
  },
175
+ "AttributeExpressionDef": {
176
+ "kind": "union",
177
+ "items": [
178
+ {
179
+ "type": "#/definitions/ColorByExpressionDef"
180
+ },
181
+ {
182
+ "type": "NxAttrExprDef"
183
+ }
184
+ ]
185
+ },
186
+ "ColorByExpressionId": {
187
+ "description": "Color by expression identifier",
188
+ "kind": "union",
189
+ "items": [
190
+ {
191
+ "kind": "literal",
192
+ "value": "\"cellBackgroundColor\""
193
+ },
194
+ {
195
+ "kind": "literal",
196
+ "value": "\"cellForegroundColor\""
197
+ }
198
+ ]
199
+ },
200
+ "ColorByExpressionDef": {
201
+ "kind": "object",
202
+ "entries": {
203
+ "qExpression": {
204
+ "type": "StringExpression"
205
+ },
206
+ "id": {
207
+ "type": "#/definitions/ColorByExpressionId"
208
+ }
209
+ },
210
+ "examples": [
211
+ "{ qExpression: \"=if(Sum([Sales Quantity]) > 500, green(), blue())\", id: \"cellBackgroundColor\" }"
212
+ ]
213
+ },
163
214
  "InlineDimensionDef": {
164
215
  "description": "Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.",
165
216
  "extends": [
@@ -229,70 +280,235 @@
229
280
  }
230
281
  },
231
282
  "Component": {
232
- "description": "General styling for all columns.\nSplit up into header and content (body) styling.\nIf any property is not set, default values specific for each property is used.",
283
+ "description": "Styling defintions",
284
+ "kind": "union",
285
+ "items": [
286
+ {
287
+ "type": "#/definitions/ChartStyling"
288
+ },
289
+ {
290
+ "type": "#/definitions/GeneralStyling"
291
+ }
292
+ ]
293
+ },
294
+ "GeneralStylingKey": {
295
+ "description": "Mandatory key for general styling",
296
+ "kind": "literal",
297
+ "value": "\"general\""
298
+ },
299
+ "FontStyleValues": {
300
+ "description": "Font styling values",
301
+ "kind": "union",
302
+ "items": [
303
+ {
304
+ "kind": "literal",
305
+ "value": "\"bold\""
306
+ },
307
+ {
308
+ "kind": "literal",
309
+ "value": "\"italic\""
310
+ },
311
+ {
312
+ "kind": "literal",
313
+ "value": "\"underline\""
314
+ }
315
+ ]
316
+ },
317
+ "GeneralStyling": {
318
+ "description": "General chart styling",
233
319
  "kind": "object",
234
320
  "entries": {
235
321
  "key": {
236
- "description": "This should be set to `theme`",
322
+ "type": "#/definitions/GeneralStylingKey"
323
+ },
324
+ "title": {
325
+ "type": "#/definitions/TitleStyling"
326
+ }
327
+ },
328
+ "examples": [
329
+ "{\n key: \"general\",\n title: {\n main: {\n fontSize: \"18px\",\n fontFamily: \"Arial\",\n fontStyle: [\"bold\", \"italic\"],\n color: { color: \"orangered\" },\n }\n }\n}"
330
+ ]
331
+ },
332
+ "TitleOptions": {
333
+ "description": "Title styling options",
334
+ "kind": "object",
335
+ "entries": {
336
+ "fontSize": {
337
+ "description": "Font size in pixel value",
338
+ "optional": true,
237
339
  "type": "string"
238
340
  },
239
- "content": {
341
+ "fontFamily": {
342
+ "description": "Font family",
240
343
  "optional": true,
241
- "type": "#/definitions/ContentStyling"
344
+ "type": "string"
242
345
  },
243
- "header": {
346
+ "fontStyle": {
347
+ "description": "Font style",
348
+ "optional": true,
349
+ "kind": "array",
350
+ "items": {
351
+ "type": "#/definitions/FontStyleValues"
352
+ }
353
+ },
354
+ "color": {
355
+ "description": "Font color palette",
356
+ "optional": true,
357
+ "type": "#/definitions/PaletteColor"
358
+ }
359
+ }
360
+ },
361
+ "TitleStyling": {
362
+ "description": "Title styling",
363
+ "kind": "object",
364
+ "entries": {
365
+ "main": {
366
+ "description": "Styling for chart title",
367
+ "optional": true,
368
+ "type": "#/definitions/TitleOptions"
369
+ },
370
+ "subTitle": {
371
+ "description": "Styling for chart sub title",
372
+ "optional": true,
373
+ "type": "#/definitions/TitleOptions"
374
+ },
375
+ "footer": {
376
+ "description": "Styling for chart footer",
244
377
  "optional": true,
245
- "type": "#/definitions/HeaderStyling"
378
+ "type": "#/definitions/TitleOptions"
246
379
  }
247
380
  }
248
381
  },
249
- "ContentStyling": {
250
- "description": "Holds properties for font size, font color and hover styling.",
382
+ "ChartStylingKey": {
383
+ "description": "Mandatory key for chart styling",
384
+ "kind": "literal",
385
+ "value": "\"theme\""
386
+ },
387
+ "ChartStyling": {
388
+ "description": "Custom styling of cells",
389
+ "kind": "object",
390
+ "entries": {
391
+ "key": {
392
+ "type": "#/definitions/ChartStylingKey"
393
+ },
394
+ "header": {
395
+ "description": "Styling for header cells",
396
+ "optional": true,
397
+ "type": "#/definitions/CellStyling"
398
+ },
399
+ "dimensionValues": {
400
+ "description": "Styling for dimension value cells",
401
+ "optional": true,
402
+ "type": "#/definitions/CellStyling"
403
+ },
404
+ "measureValues": {
405
+ "description": "Styling for measure value cells",
406
+ "optional": true,
407
+ "type": "#/definitions/CellStyling"
408
+ },
409
+ "measureLabels": {
410
+ "description": "Styling for measure label cells",
411
+ "optional": true,
412
+ "type": "#/definitions/PartialCellStyling"
413
+ },
414
+ "totalValues": {
415
+ "description": "Styling for total value cells",
416
+ "optional": true,
417
+ "type": "#/definitions/PartialCellStyling"
418
+ },
419
+ "nullValues": {
420
+ "description": "Styling for null values cells",
421
+ "optional": true,
422
+ "type": "#/definitions/PartialCellStyling"
423
+ },
424
+ "grid": {
425
+ "description": "General grid styling",
426
+ "optional": true,
427
+ "type": "#/definitions/GridStyling"
428
+ }
429
+ },
430
+ "examples": [
431
+ "{\n key: \"theme\",\n dimensionValues: {\n fontSize: \"18px\",\n fontFamily: \"Arial\",\n fontStyle: [\"bold\", \"italic\"],\n fontColor: { color: \"orangered\" },\n background: { index: 2 }\n }\n}"
432
+ ]
433
+ },
434
+ "CellStyling": {
435
+ "description": "Properties for styling a cell",
251
436
  "kind": "object",
252
437
  "entries": {
253
438
  "fontSize": {
254
- "description": "Defaults to `14`",
439
+ "description": "Font size in pixel value",
255
440
  "optional": true,
256
- "type": "number"
441
+ "type": "string"
257
442
  },
258
- "fontColor": {
259
- "description": "Defaults to `#404040`",
443
+ "fontFamily": {
444
+ "description": "Font family",
260
445
  "optional": true,
261
- "type": "#/definitions/PaletteColor"
446
+ "type": "string"
262
447
  },
263
- "hoverEffect": {
264
- "description": "Toggles hover effect",
448
+ "fontStyle": {
449
+ "description": "Font style",
265
450
  "optional": true,
266
- "type": "boolean"
451
+ "kind": "array",
452
+ "items": {
453
+ "type": "#/definitions/FontStyleValues"
454
+ }
267
455
  },
268
- "hoverColor": {
269
- "description": "Background hover color. Uses `#f4f4f4` if no hover colors are set, is transparent if only `hoverFontColor` is set",
456
+ "fontColor": {
457
+ "description": "Font color palette",
270
458
  "optional": true,
271
459
  "type": "#/definitions/PaletteColor"
272
460
  },
273
- "hoverFontColor": {
274
- "description": "When only `hoverColor` is set, this is adjusted to either `#f4f4f4` or `#ffffff` for optimal contrast",
461
+ "background": {
462
+ "description": "Cell background color palette",
275
463
  "optional": true,
276
464
  "type": "#/definitions/PaletteColor"
465
+ }
466
+ }
467
+ },
468
+ "PartialCellStyling": {
469
+ "description": "Properties for styling a cell",
470
+ "kind": "object",
471
+ "entries": {
472
+ "fontStyle": {
473
+ "description": "Font style",
474
+ "optional": true,
475
+ "kind": "array",
476
+ "items": {
477
+ "type": "#/definitions/FontStyleValues"
478
+ }
277
479
  },
278
- "padding": {
279
- "description": "Css setting for the cell padding, defaults to `4px 12px`",
480
+ "fontColor": {
481
+ "description": "Font color palette",
280
482
  "optional": true,
281
- "type": "string"
483
+ "type": "#/definitions/PaletteColor"
484
+ },
485
+ "background": {
486
+ "description": "Cell background color palette",
487
+ "optional": true,
488
+ "type": "#/definitions/PaletteColor"
282
489
  }
283
490
  }
284
491
  },
285
- "HeaderStyling": {
286
- "description": "Holds properties for font size and color.",
492
+ "GridStyling": {
493
+ "description": "General grid styling",
287
494
  "kind": "object",
288
495
  "entries": {
289
- "fontSize": {
290
- "description": "Defaults to `14`",
496
+ "lineClamp": {
497
+ "description": "A numerical value that represents the number of lines a text at most can be splitt into",
291
498
  "optional": true,
292
499
  "type": "number"
293
500
  },
294
- "fontColor": {
295
- "description": "Defaults to `#404040`",
501
+ "border": {
502
+ "description": "Border color between cells",
503
+ "optional": true,
504
+ "type": "#/definitions/PaletteColor"
505
+ },
506
+ "divider": {
507
+ "description": "Border color between row and column dimensions sections",
508
+ "optional": true,
509
+ "type": "#/definitions/PaletteColor"
510
+ },
511
+ "background": {
296
512
  "optional": true,
297
513
  "type": "#/definitions/PaletteColor"
298
514
  }