@nebula.js/sn-table 1.4.0 → 1.5.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/README.md +64 -4
- package/api-specifications/properties.json +64 -21
- package/core/esm/index.js +15874 -26831
- package/core/package.json +1 -1
- package/dist/sn-table.js +19 -17
- package/package.json +38 -35
package/README.md
CHANGED
|
@@ -4,13 +4,15 @@
|
|
|
4
4
|
|
|
5
5
|
# sn-table
|
|
6
6
|
|
|
7
|
-
table supernova for nebula.js
|
|
7
|
+
table supernova for [nebula.js]
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Mashup Usage
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
### Installing
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
If you use npm:
|
|
14
|
+
|
|
15
|
+
`npm install @nebula.js/sn-table`
|
|
14
16
|
|
|
15
17
|
```js
|
|
16
18
|
import { embed } from '@nebula.js/stardust';
|
|
@@ -29,3 +31,61 @@ nuked.render({
|
|
|
29
31
|
type: 'table',
|
|
30
32
|
});
|
|
31
33
|
```
|
|
34
|
+
|
|
35
|
+
Look into [Build a simple mashup using nebula.js](https://qlik.dev/tutorials/build-a-simple-mashup-using-nebulajs) to learn more.
|
|
36
|
+
|
|
37
|
+
[See full example](./mashup-example) of the mashup usage.
|
|
38
|
+
|
|
39
|
+
More specifics and information about the sn-table can be found in [the Qlik developer portal](https://qlik.dev/libraries-and-tools/visualizations/table).
|
|
40
|
+
|
|
41
|
+
## Visualization Extension Usage
|
|
42
|
+
|
|
43
|
+
### Steps to create a sn-table extension as as a Qlik Sense extension
|
|
44
|
+
|
|
45
|
+
Install all dependencies:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
yarn
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Build nebula.js visualization:
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
yarn build
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Build a nebula visualization as a Qlik Sense extension:
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
yarn sense
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
| [Saas Edition of Qlik Sense] | [Qlik Sense Enterprise] | [Qlik Sense Desktop] |
|
|
64
|
+
| :-----------------------------------------------------------------------------: | :--------------------------------------------------------------: | :------------------------------------------------------------------------: |
|
|
65
|
+
| Copy sn-table-ext into https://your-tenant.us.qlikcloud.com/console/extensions/ | Copy sn-table-ext into Qlik Management Console (QMC)->Extensions | Copy sn-table-ext into ..\Users\<UserName>\Documents\Qlik\Sense\Extensions |
|
|
66
|
+
|
|
67
|
+
## API
|
|
68
|
+
|
|
69
|
+
The API can also be found in [the Qlik developer portal](https://qlik.dev/apis/javascript/nebula-table)
|
|
70
|
+
|
|
71
|
+
## Contribution
|
|
72
|
+
|
|
73
|
+
Follow the instructions in our [contributing guide](./.github/CONTRIBUTION.md).
|
|
74
|
+
|
|
75
|
+
## Package
|
|
76
|
+
|
|
77
|
+
| name | status | description |
|
|
78
|
+
| ---------- | ---------------------------------- | ----------------------------- |
|
|
79
|
+
| [sn-table] | [![sn-table-status]][sn-table-npm] | table supernova for nebula.js |
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
`@nebula.js/sn-table` is [MIT licensed](./LICENSE).
|
|
84
|
+
|
|
85
|
+
[nebula.js]: https://qlik.dev/libraries-and-tools/nebulajs
|
|
86
|
+
[sn-table]: https://github.com/qlik-oss/sn-table
|
|
87
|
+
[sn-table-status]: https://img.shields.io/npm/v/@nebula.js/sn-table.svg
|
|
88
|
+
[sn-table-npm]: https://www.npmjs.com/package/@nebula.js/sn-table
|
|
89
|
+
[saas edition of qlik sense]: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-extensions.htm
|
|
90
|
+
[qlik sense enterprise]: https://help.qlik.com/en-US/sense-developer/May2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm
|
|
91
|
+
[qlik sense desktop]: https://help.qlik.com/en-US/sense-developer/May2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"name": "@nebula.js/sn-table:properties",
|
|
5
5
|
"description": "Table generic object definition",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.5.0",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"stability": "experimental",
|
|
9
9
|
"x-qlik-visibility": "public"
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"properties": {
|
|
13
13
|
"extends": [
|
|
14
14
|
{
|
|
15
|
-
"type": "
|
|
15
|
+
"type": "GenericObjectProperties"
|
|
16
16
|
}
|
|
17
17
|
],
|
|
18
18
|
"kind": "object",
|
|
@@ -28,31 +28,56 @@
|
|
|
28
28
|
"description": "Visualization footnote",
|
|
29
29
|
"optional": true,
|
|
30
30
|
"defaultValue": "",
|
|
31
|
-
"
|
|
31
|
+
"kind": "union",
|
|
32
|
+
"items": [
|
|
33
|
+
{
|
|
34
|
+
"type": "string"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"type": "StringExpression"
|
|
38
|
+
}
|
|
39
|
+
],
|
|
40
|
+
"type": "any"
|
|
32
41
|
},
|
|
33
42
|
"qHyperCubeDef": {
|
|
43
|
+
"description": "Extends HyperCubeDef, see Engine API: HyperCubeDef",
|
|
34
44
|
"extends": [
|
|
35
45
|
{
|
|
36
|
-
"type": "
|
|
46
|
+
"type": "HyperCubeDef"
|
|
37
47
|
}
|
|
38
48
|
],
|
|
39
49
|
"kind": "object",
|
|
40
50
|
"entries": {
|
|
51
|
+
"columnWidths": {
|
|
52
|
+
"kind": "array",
|
|
53
|
+
"items": {
|
|
54
|
+
"type": "number"
|
|
55
|
+
}
|
|
56
|
+
},
|
|
41
57
|
"qColumnOrder": {
|
|
42
|
-
"
|
|
58
|
+
"kind": "array",
|
|
59
|
+
"items": {
|
|
60
|
+
"type": "number"
|
|
61
|
+
}
|
|
43
62
|
},
|
|
44
63
|
"qDimensions": {
|
|
64
|
+
"description": "The maximum amount of dimensions is 15",
|
|
45
65
|
"kind": "array",
|
|
46
66
|
"items": {
|
|
47
67
|
"type": "#/definitions/DimensionProperties"
|
|
48
68
|
}
|
|
49
69
|
},
|
|
50
70
|
"qMeasures": {
|
|
71
|
+
"description": "The maximum amount of measures is 15",
|
|
51
72
|
"kind": "array",
|
|
52
73
|
"items": {
|
|
53
74
|
"type": "#/definitions/MeasureProperties"
|
|
54
75
|
}
|
|
55
76
|
},
|
|
77
|
+
"qMode": {
|
|
78
|
+
"defaultValue": "S",
|
|
79
|
+
"type": "schemasNxHypercubeMode"
|
|
80
|
+
},
|
|
56
81
|
"qSuppressMissing": {
|
|
57
82
|
"defaultValue": true,
|
|
58
83
|
"type": "boolean"
|
|
@@ -73,16 +98,34 @@
|
|
|
73
98
|
"description": "Visualization subtitle",
|
|
74
99
|
"optional": true,
|
|
75
100
|
"defaultValue": "",
|
|
76
|
-
"
|
|
101
|
+
"kind": "union",
|
|
102
|
+
"items": [
|
|
103
|
+
{
|
|
104
|
+
"type": "string"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"type": "StringExpression"
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"type": "any"
|
|
77
111
|
},
|
|
78
112
|
"title": {
|
|
79
113
|
"description": "Visualization title",
|
|
80
114
|
"optional": true,
|
|
81
115
|
"defaultValue": "",
|
|
82
|
-
"
|
|
116
|
+
"kind": "union",
|
|
117
|
+
"items": [
|
|
118
|
+
{
|
|
119
|
+
"type": "string"
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"type": "StringExpression"
|
|
123
|
+
}
|
|
124
|
+
],
|
|
125
|
+
"type": "any"
|
|
83
126
|
},
|
|
84
127
|
"version": {
|
|
85
|
-
"description": "Current version of this generic object definition
|
|
128
|
+
"description": "Current version of this generic object definition",
|
|
86
129
|
"type": "string"
|
|
87
130
|
}
|
|
88
131
|
}
|
|
@@ -90,7 +133,7 @@
|
|
|
90
133
|
},
|
|
91
134
|
"definitions": {
|
|
92
135
|
"AttributeExpressionProperties": {
|
|
93
|
-
"description": "Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef
|
|
136
|
+
"description": "Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.\nColumn specific styling overrides general styling, that is defined in `components`.",
|
|
94
137
|
"extends": [
|
|
95
138
|
{
|
|
96
139
|
"type": "NxAttrExprDef"
|
|
@@ -99,7 +142,7 @@
|
|
|
99
142
|
"kind": "object",
|
|
100
143
|
"entries": {
|
|
101
144
|
"id": {
|
|
102
|
-
"description": "
|
|
145
|
+
"description": "specifying what the color applies to",
|
|
103
146
|
"kind": "union",
|
|
104
147
|
"items": [
|
|
105
148
|
{
|
|
@@ -116,11 +159,11 @@
|
|
|
116
159
|
}
|
|
117
160
|
},
|
|
118
161
|
"ContentStyling": {
|
|
119
|
-
"description": "Holds properties for font size, font color and hover styling",
|
|
162
|
+
"description": "Holds properties for font size, font color and hover styling.",
|
|
120
163
|
"kind": "object",
|
|
121
164
|
"entries": {
|
|
122
165
|
"fontSize": {
|
|
123
|
-
"description": "
|
|
166
|
+
"description": "Defaults to `14`",
|
|
124
167
|
"optional": true,
|
|
125
168
|
"type": "number"
|
|
126
169
|
},
|
|
@@ -147,7 +190,7 @@
|
|
|
147
190
|
}
|
|
148
191
|
},
|
|
149
192
|
"DimensionProperties": {
|
|
150
|
-
"description": "Extends `NxDimension`, see Engine API: `NxDimension
|
|
193
|
+
"description": "Extends `NxDimension`, see Engine API: `NxDimension`",
|
|
151
194
|
"extends": [
|
|
152
195
|
{
|
|
153
196
|
"type": "NxDimension"
|
|
@@ -167,16 +210,16 @@
|
|
|
167
210
|
}
|
|
168
211
|
},
|
|
169
212
|
"HeaderStyling": {
|
|
170
|
-
"description": "Holds properties for font size and color",
|
|
213
|
+
"description": "Holds properties for font size and color.",
|
|
171
214
|
"kind": "object",
|
|
172
215
|
"entries": {
|
|
173
216
|
"fontSize": {
|
|
174
|
-
"description": "
|
|
217
|
+
"description": "Defaults to `14`",
|
|
175
218
|
"optional": true,
|
|
176
219
|
"type": "number"
|
|
177
220
|
},
|
|
178
221
|
"fontColor": {
|
|
179
|
-
"description": "
|
|
222
|
+
"description": "Defaults to `#404040`",
|
|
180
223
|
"optional": true,
|
|
181
224
|
"type": "#/definitions/PaletteColor"
|
|
182
225
|
}
|
|
@@ -213,7 +256,7 @@
|
|
|
213
256
|
}
|
|
214
257
|
},
|
|
215
258
|
"MeasureProperties": {
|
|
216
|
-
"description": "Extends `NxMeasure`, see Engine API: `NxMeasure
|
|
259
|
+
"description": "Extends `NxMeasure`, see Engine API: `NxMeasure`",
|
|
217
260
|
"extends": [
|
|
218
261
|
{
|
|
219
262
|
"type": "NxMeasure"
|
|
@@ -233,7 +276,7 @@
|
|
|
233
276
|
}
|
|
234
277
|
},
|
|
235
278
|
"PaletteColor": {
|
|
236
|
-
"description": "Color information structure. Holds the actual color and index in palette
|
|
279
|
+
"description": "Color information structure. Holds the actual color and index in palette",
|
|
237
280
|
"kind": "object",
|
|
238
281
|
"entries": {
|
|
239
282
|
"color": {
|
|
@@ -247,7 +290,7 @@
|
|
|
247
290
|
}
|
|
248
291
|
},
|
|
249
292
|
"Styling": {
|
|
250
|
-
"description": "General styling for all columns
|
|
293
|
+
"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.",
|
|
251
294
|
"kind": "object",
|
|
252
295
|
"entries": {
|
|
253
296
|
"key": {
|
|
@@ -265,7 +308,7 @@
|
|
|
265
308
|
}
|
|
266
309
|
},
|
|
267
310
|
"TextAlign": {
|
|
268
|
-
"description": "Holds text
|
|
311
|
+
"description": "Holds text alignment for a specific column.",
|
|
269
312
|
"extends": [
|
|
270
313
|
{
|
|
271
314
|
"type": "NxInlineDimensionDef"
|
|
@@ -278,7 +321,7 @@
|
|
|
278
321
|
"type": "boolean"
|
|
279
322
|
},
|
|
280
323
|
"align": {
|
|
281
|
-
"description": "Is used (and
|
|
324
|
+
"description": "Is used (and mandatory) if `auto` is false",
|
|
282
325
|
"kind": "union",
|
|
283
326
|
"items": [
|
|
284
327
|
{
|