@nebula.js/sn-funnel-chart 1.5.1 → 1.5.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. package/api-specifications/api.md +3 -139
  2. package/api-specifications/plugins.json +25 -11
  3. package/api-specifications/properties.json +41 -54
  4. package/core/esm/index.js +4 -4
  5. package/dist/sn-funnel-chart.js +5 -5
  6. package/dist/sn-funnel-chart.systemjs.js +3 -3
  7. package/package.json +1 -1
  8. package/sn-funnel-chart-ext/dist/sn-funnel-chart.js +5 -5
  9. package/sn-funnel-chart-ext/sn-funnel-chart.qext +1 -1
package/api-specifications/api.md CHANGED
@@ -21,7 +21,7 @@
21
21
  - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
22
22
  - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
23
23
  - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
24
- - [.useMeasureGradient](#properties.color.useMeasureGradient)
24
+ - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
25
25
  - [.dataPoint](#properties.dataPoint) : <code>object</code>
26
26
  - [.auto](#properties.dataPoint.auto) : <code>boolean</code>
27
27
  - [.labelMode](#properties.dataPoint.labelMode) : <code>&#x27;none&#x27;</code> \| <code>&#x27;share&#x27;</code> \| <code>&#x27;value&#x27;</code>
@@ -77,7 +77,7 @@ Note: Some of the color properties are depending on which theme is currently bei
77
77
  - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
78
78
  - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
79
79
  - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
80
- - [.useMeasureGradient](#properties.color.useMeasureGradient)
80
+ - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
81
81
 
82
82
  <a name="properties.color.auto"></a>
83
83
 
@@ -265,7 +265,7 @@ Only applicable if `'colorMode': 'byDimension'`.
265
265
  **Default**: <code>true</code>
266
266
  <a name="properties.color.useMeasureGradient"></a>
267
267
 
268
- #### color.useMeasureGradient
268
+ #### color.useMeasureGradient : <code>boolean</code>
269
269
 
270
270
  Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
271
271
 
@@ -393,139 +393,3 @@ Visualization title.
393
393
  **Default**: <code>&quot;&quot;</code>
394
394
 
395
395
  # Definitions
396
-
397
- <a name="paletteColor"></a>
398
-
399
- ## paletteColor : <code>object</code>
400
-
401
- Color information structure. Holds the actual color and index in palette.
402
-
403
- **Kind**: global typedef
404
- **Properties**
405
-
406
- | Name | Type | Description |
407
- | ----- | ------------------- | -------------------------------------------- |
408
- | color | <code>string</code> | Color as hex string (mandatory if index: -1) |
409
- | index | <code>number</code> | Index in palette |
410
-
411
- <a name="byDimDef"></a>
412
-
413
- ## byDimDef : <code>object</code>
414
-
415
- Settings when coloring by dimension (`"mode": "byDimension"`)
416
-
417
- **Kind**: global typedef
418
- **Properties**
419
-
420
- | Name | Type | Description |
421
- | ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
422
- | key | <code>string</code> | libraryId if `"type": "libraryItem"`, dimension expression if `"type": "expression"` |
423
- | label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
424
- | type | <code>&#x27;expression&#x27;</code> \| <code>&#x27;libraryItem&#x27;</code> | |
425
-
426
- <a name="byMeasureDef"></a>
427
-
428
- ## byMeasureDef : <code>object</code>
429
-
430
- Settings when coloring by measure (`"mode": "byMeasure"`)
431
-
432
- **Kind**: global typedef
433
- **Properties**
434
-
435
- | Name | Type | Description |
436
- | ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
437
- | key | <code>string</code> | libraryId if `"type": "libraryItem"`, measure expression if `"type": "expression"` |
438
- | label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
439
- | type | <code>&#x27;expression&#x27;</code> \| <code>&#x27;libraryItem&#x27;</code> | |
440
-
441
- <a name="DimensionProperties"></a>
442
-
443
- ## DimensionProperties : <code>object</code>
444
-
445
- Extends `NxDimension`, see Engine API: `NxDimension`.
446
-
447
- **Kind**: global typedef
448
- **Extends**: <code>NxDimension</code>
449
- **Properties**
450
-
451
- | Name | Type |
452
- | -------------------- | ---------------------------------------------------------------------------------------- |
453
- | qAttributeDimensions | [<code>Array.&lt;AttributeDimensionProperties&gt;</code>](#AttributeDimensionProperties) |
454
- | qDef | [<code>InlineDimensionDef</code>](#InlineDimensionDef) |
455
-
456
- <a name="InlineDimensionDef"></a>
457
-
458
- ## InlineDimensionDef : <code>object</code>
459
-
460
- Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.
461
-
462
- **Kind**: global typedef
463
- **Extends**: <code>NxInlineDimensionDef</code>
464
- **Properties**
465
-
466
- | Name | Type | Description |
467
- | ----------- | ---------------------------------------------------- | ------------------------------------------------------------------- |
468
- | [autoSort] | <code>boolean</code> | Set to automatically sort the dimension. |
469
- | [cId] | <code>string</code> | ID used by the Qlik Sense. Must be unique within the current chart. |
470
- | othersLabel | <code>string</code> \| <code>StringExpression</code> | |
471
-
472
- <a name="MeasureProperties"></a>
473
-
474
- ## MeasureProperties : <code>object</code>
475
-
476
- Extends `NxMeasure`, see Engine API: `NxMeasure`.
477
-
478
- **Kind**: global typedef
479
- **Extends**: <code>NxMeasure</code>
480
- **Properties**
481
-
482
- | Name | Type |
483
- | --------------------- | ------------------------------------------------------------------------------------------ |
484
- | qAttributeExpressions | [<code>Array.&lt;AttributeExpressionProperties&gt;</code>](#AttributeExpressionProperties) |
485
- | qDef | [<code>InlineMeasureDef</code>](#InlineMeasureDef) |
486
-
487
- <a name="InlineMeasureDef"></a>
488
-
489
- ## InlineMeasureDef : <code>object</code>
490
-
491
- Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.
492
-
493
- **Kind**: global typedef
494
- **Extends**: <code>NxInlineMeasureDef</code>
495
- **Properties**
496
-
497
- | Name | Type | Default | Description |
498
- | --------------------- | ---------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------- |
499
- | [autoSort] | <code>boolean</code> | | Set to automatically sort the measure. |
500
- | [cId] | <code>string</code> | | ID used by the Qlik Sense. Must be unique within the current chart. |
501
- | isCustomFormatted | <code>boolean</code> | | Set to true to toggle off the default client formatting. |
502
- | numFormatFromTemplate | <code>boolean</code> | <code>true</code> | When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date). |
503
- | othersLabel | <code>string</code> \| <code>StringExpression</code> | | |
504
-
505
- <a name="AttributeDimensionProperties"></a>
506
-
507
- ## AttributeDimensionProperties : <code>object</code>
508
-
509
- Extends `NxAttrDimDef`, see Engine API: `NxAttrDimDef`.
510
-
511
- **Kind**: global typedef
512
- **Extends**: <code>NxAttrDimDef</code>
513
- **Properties**
514
-
515
- | Name | Type | Description |
516
- | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
517
- | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension") or `colorByExpression` together with color.mode="byExpression". |
518
-
519
- <a name="AttributeExpressionProperties"></a>
520
-
521
- ## AttributeExpressionProperties : <code>object</code>
522
-
523
- Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
524
-
525
- **Kind**: global typedef
526
- **Extends**: <code>NxAttrExprDef</code>
527
- **Properties**
528
-
529
- | Name | Type | Description |
530
- | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
531
- | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension") or `colorByExpression` together with color.mode="byExpression". |
package/api-specifications/plugins.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-funnel-chart:plugins",
5
5
  "description": "Funnel chart plugins API definitions",
6
- "version": "1.5.1",
6
+ "version": "1.5.2",
7
7
  "license": "MIT",
8
8
  "stability": "experimental",
9
9
  "x-qlik-visibility": "public"
@@ -15,11 +15,9 @@
15
15
  "entries": {
16
16
  "keys": {
17
17
  "description": "The keys (references) to different types of chart internals",
18
- "kind": "object",
19
18
  "entries": {
20
19
  "COMPONENT": {
21
20
  "description": "The unique keys of the existing components available in the funnel chart.\nThey are useful if you want to extend or override the existing components.",
22
- "kind": "object",
23
21
  "entries": {
24
22
  "DIMENSION_TITLE": {
25
23
  "description": "The dimension title component",
@@ -36,28 +34,44 @@
36
34
  "defaultValue": "funnel-labels",
37
35
  "type": "string"
38
36
  }
39
- }
37
+ },
38
+ "kind": "object"
40
39
  },
41
40
  "SCALE": {
42
41
  "description": "The scales associated with the funnel chart.\nThey are useful if you want to, via plugin, add a new component that\nuses the same scale as one of the measures.",
43
- "kind": "object",
44
42
  "entries": {
45
43
  "FILL": {
46
44
  "description": "The scale used for coloring the funnel segments",
47
45
  "defaultValue": "fill",
48
46
  "type": "string"
49
47
  }
50
- }
48
+ },
49
+ "kind": "object"
51
50
  }
52
- }
51
+ },
52
+ "kind": "object"
53
53
  },
54
54
  "layout": {
55
55
  "description": "The layout from the enigma model.",
56
- "kind": "object",
57
- "entries": {}
56
+ "type": "object"
58
57
  }
59
58
  }
60
59
  }
61
60
  },
62
- "definitions": {}
61
+ "definitions": {
62
+ "getPluginArgs": {
63
+ "description": "Prepare important chart internals for the users to build their own plugins",
64
+ "kind": "function",
65
+ "params": [
66
+ {
67
+ "name": "layoutService",
68
+ "type": "object"
69
+ }
70
+ ],
71
+ "returns": {
72
+ "description": "Chart internals that will be exposed to the users.",
73
+ "type": "#/entries/pluginArguments"
74
+ }
75
+ }
76
+ }
63
77
  }
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-funnel-chart:properties",
5
5
  "description": "Funnel chart generic object definition",
6
- "version": "1.5.1",
6
+ "version": "1.5.2",
7
7
  "license": "MIT",
8
8
  "stability": "stable",
9
9
  "x-qlik-visibility": "public"
@@ -14,7 +14,6 @@
14
14
  "entries": {
15
15
  "color": {
16
16
  "description": "Color settings.\nMost color options for visualizations are set in the color object in the options. You activate custom coloring by setting `\"auto\": false` which turns off auto-coloring.\nIf `\"auto\": true`, no other properties need to be defined in the color object.\nNote: Some of the color properties are depending on which theme is currently being used.",
17
- "kind": "object",
18
17
  "entries": {
19
18
  "auto": {
20
19
  "description": "Set to use automatic coloring.\nWhen `\"auto\": true`, color settings are based on the visualization used and the number of dimensions\nand measures, that is, the settings are not fixed, but are dependent on the data input.",
@@ -93,8 +92,7 @@
93
92
  "kind": "literal",
94
93
  "value": "'dc'"
95
94
  }
96
- ],
97
- "type": "string"
95
+ ]
98
96
  },
99
97
  "mode": {
100
98
  "description": "Sets the coloring mode for the visualization when auto-coloring has been switched off (`\"auto\": false`). Can be one of:\n* `primary`: a single color (by default blue) is used for all items in the chart. In visualizations that do not benefit from multiple colors (bar charts with one dimension and scatter plots), single color is the default setting.\n* `byDimension`: coloring is based upon the amount of dimension values. Details are set in the `\"byDimDef\"` property.\n!Note: `byDimension` can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.\n```json\n{\n \"qDef\": {\n \"qFieldDefs\": [\n \"NetScoreName\"\n ]\n },\n \"qAttributeDimensions\": [\n {\n \"qDef\": \"NetScoreName\",\n \"id\": \"colorByAlternative\",\n \"label\": \"Year\"\n }\n ]\n}\n```\n* `byExpression`: coloring is based on an expression, which in most cases is a color code. Details are set in the `\"expressionIsColor\"`, `\"expressionLabel`\" and `\"colorExpression\"` properties.\n* `byMeasure`: coloring is based on the measure value. Details are set in the `\"byMeasureDef\"` property.\n* `byMultiple`: can be used when more than one measure is used. By default, 12 colors are used for the dimensions. The colors are reused when there are more than 12 dimension values.",
@@ -121,8 +119,7 @@
121
119
  "kind": "literal",
122
120
  "value": "'byMultiple'"
123
121
  }
124
- ],
125
- "type": "string"
122
+ ]
126
123
  },
127
124
  "paletteColor": {
128
125
  "description": "The paletteColor object is used to define the color when you color by single color `(\"mode\": \"primary\")`.",
@@ -162,8 +159,7 @@
162
159
  "kind": "literal",
163
160
  "value": "'measure'"
164
161
  }
165
- ],
166
- "type": "string"
162
+ ]
167
163
  },
168
164
  "useDimColVal": {
169
165
  "description": "Set to true if you want to apply the colors defined for library dimensions when used.\nOnly applicable if `'colorMode': 'byDimension'`.",
@@ -173,14 +169,13 @@
173
169
  "useMeasureGradient": {
174
170
  "description": "Set to true if you want to apply the colors defined for library measures when used. Only applicable if `\"mode\": \"byMeasure\"`.",
175
171
  "defaultValue": true,
176
- "kind": "literal",
177
- "value": true
172
+ "type": "boolean"
178
173
  }
179
- }
174
+ },
175
+ "kind": "object"
180
176
  },
181
177
  "dataPoint": {
182
178
  "description": "Data point settings.",
183
- "kind": "object",
184
179
  "entries": {
185
180
  "auto": {
186
181
  "description": "Automatically select how to present data point values.",
@@ -204,10 +199,10 @@
204
199
  "kind": "literal",
205
200
  "value": "'value'"
206
201
  }
207
- ],
208
- "type": "string"
202
+ ]
209
203
  }
210
- }
204
+ },
205
+ "kind": "object"
211
206
  },
212
207
  "footnote": {
213
208
  "description": "Visualization footnote.",
@@ -221,12 +216,10 @@
221
216
  {
222
217
  "type": "StringExpression"
223
218
  }
224
- ],
225
- "type": "any"
219
+ ]
226
220
  },
227
221
  "funnel": {
228
222
  "description": "Funnel settings",
229
- "kind": "object",
230
223
  "entries": {
231
224
  "mode": {
232
225
  "description": "Funnel Mode",
@@ -249,10 +242,10 @@
249
242
  "kind": "literal",
250
243
  "value": "'ORDER'"
251
244
  }
252
- ],
253
- "type": "string"
245
+ ]
254
246
  }
255
- }
247
+ },
248
+ "kind": "object"
256
249
  },
257
250
  "qHyperCubeDef": {
258
251
  "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
@@ -308,8 +301,7 @@
308
301
  {
309
302
  "type": "StringExpression"
310
303
  }
311
- ],
312
- "type": "any"
304
+ ]
313
305
  },
314
306
  "title": {
315
307
  "description": "Visualization title.",
@@ -323,8 +315,7 @@
323
315
  {
324
316
  "type": "StringExpression"
325
317
  }
326
- ],
327
- "type": "any"
318
+ ]
328
319
  },
329
320
  "version": {
330
321
  "description": "Current version of this generic object definition",
@@ -387,8 +378,7 @@
387
378
  "kind": "literal",
388
379
  "value": "'libraryItem'"
389
380
  }
390
- ],
391
- "type": "string"
381
+ ]
392
382
  }
393
383
  }
394
384
  },
@@ -415,8 +405,7 @@
415
405
  "kind": "literal",
416
406
  "value": "'libraryItem'"
417
407
  }
418
- ],
419
- "type": "string"
408
+ ]
420
409
  }
421
410
  }
422
411
  },
@@ -449,16 +438,6 @@
449
438
  ],
450
439
  "kind": "object",
451
440
  "entries": {
452
- "autoSort": {
453
- "description": "Set to automatically sort the dimension.",
454
- "optional": true,
455
- "type": "boolean"
456
- },
457
- "cId": {
458
- "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
459
- "optional": true,
460
- "type": "string"
461
- },
462
441
  "othersLabel": {
463
442
  "kind": "union",
464
443
  "items": [
@@ -468,8 +447,17 @@
468
447
  {
469
448
  "type": "StringExpression"
470
449
  }
471
- ],
472
- "type": "any"
450
+ ]
451
+ },
452
+ "autoSort": {
453
+ "description": "Set to automatically sort the dimension.",
454
+ "optional": true,
455
+ "type": "boolean"
456
+ },
457
+ "cId": {
458
+ "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
459
+ "optional": true,
460
+ "type": "string"
473
461
  }
474
462
  }
475
463
  },
@@ -482,16 +470,6 @@
482
470
  ],
483
471
  "kind": "object",
484
472
  "entries": {
485
- "autoSort": {
486
- "description": "Set to automatically sort the measure.",
487
- "optional": true,
488
- "type": "boolean"
489
- },
490
- "cId": {
491
- "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
492
- "optional": true,
493
- "type": "string"
494
- },
495
473
  "isCustomFormatted": {
496
474
  "description": "Set to true to toggle off the default client formatting.",
497
475
  "type": "boolean"
@@ -510,8 +488,17 @@
510
488
  {
511
489
  "type": "StringExpression"
512
490
  }
513
- ],
514
- "type": "any"
491
+ ]
492
+ },
493
+ "autoSort": {
494
+ "description": "Set to automatically sort the measure.",
495
+ "optional": true,
496
+ "type": "boolean"
497
+ },
498
+ "cId": {
499
+ "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
500
+ "optional": true,
501
+ "type": "string"
515
502
  }
516
503
  }
517
504
  },