@nebula.js/sn-waterfall 1.0.4 → 1.0.6
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/core/esm/index.js +15861 -4
- package/core/esm/index.js.map +1 -1
- package/dist/sn-waterfall.js +35439 -13
- package/dist/sn-waterfall.js.map +1 -1
- package/dist/sn-waterfall.systemjs.js +27600 -11
- package/dist/sn-waterfall.systemjs.js.map +1 -1
- package/package.json +5 -3
- package/sn-waterfall-ext/dist/sn-waterfall.js +3 -3
- package/sn-waterfall-ext/sn-waterfall.qext +1 -1
- package/api-specifications/api.md +0 -330
|
@@ -1,330 +0,0 @@
|
|
|
1
|
-
# API Reference
|
|
2
|
-
|
|
3
|
-
* [properties](#properties) : <code>object</code>
|
|
4
|
-
* [.version](#properties.version) : <code>string</code>
|
|
5
|
-
* [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
|
|
6
|
-
* [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [<code>Array.<MeasureProperties></code>](#MeasureProperties)
|
|
7
|
-
* [.color](#properties.color) : <code>object</code>
|
|
8
|
-
* [.auto](#properties.color.auto) : <code>boolean</code>
|
|
9
|
-
* [.positiveValue](#properties.color.positiveValue) : <code>object</code>
|
|
10
|
-
* [.paletteColor](#properties.color.positiveValue.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
11
|
-
* [.negativeValue](#properties.color.negativeValue) : <code>object</code>
|
|
12
|
-
* [.paletteColor](#properties.color.negativeValue.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
13
|
-
* [.subtotal](#properties.color.subtotal) : <code>object</code>
|
|
14
|
-
* [.paletteColor](#properties.color.subtotal.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
15
|
-
* [.dataPoint](#properties.dataPoint) : <code>object</code>
|
|
16
|
-
* [.showLabels](#properties.dataPoint.showLabels) : <code>boolean</code>
|
|
17
|
-
* [.dimensionAxis](#properties.dimensionAxis) : <code>object</code>
|
|
18
|
-
* [.dock](#properties.dimensionAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
19
|
-
* [.label](#properties.dimensionAxis.label) : <code>'auto'</code> \| <code>'horizontal'</code> \| <code>'tilted'</code>
|
|
20
|
-
* [.show](#properties.dimensionAxis.show) : <code>'labels'</code> \| <code>'none'</code>
|
|
21
|
-
* [.gridlines](#properties.gridlines) : <code>object</code>
|
|
22
|
-
* [.auto](#properties.gridlines.auto) : <code>boolean</code>
|
|
23
|
-
* [.spacing](#properties.gridlines.spacing) : <code>0</code> \| <code>2</code> \| <code>3</code>
|
|
24
|
-
* [.legend](#properties.legend) : <code>object</code>
|
|
25
|
-
* [.dock](#properties.legend.dock) : <code>'auto'</code> \| <code>'right'</code> \| <code>'left'</code> \| <code>'bottom'</code> \| <code>'top'</code>
|
|
26
|
-
* [.show](#properties.legend.show) : <code>boolean</code>
|
|
27
|
-
* [.measureAxis](#properties.measureAxis) : <code>object</code>
|
|
28
|
-
* [.autoMinMax](#properties.measureAxis.autoMinMax) : <code>boolean</code>
|
|
29
|
-
* [.dock](#properties.measureAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
30
|
-
* [.max](#properties.measureAxis.max) : <code>number</code> \| <code>ValueExpression</code>
|
|
31
|
-
* [.min](#properties.measureAxis.min) : <code>number</code> \| <code>ValueExpression</code>
|
|
32
|
-
* [.minMax](#properties.measureAxis.minMax) : <code>'min'</code> \| <code>'max'</code> \| <code>'minMax'</code>
|
|
33
|
-
* [.show](#properties.measureAxis.show) : <code>'labels'</code> \| <code>'none'</code>
|
|
34
|
-
* [.spacing](#properties.measureAxis.spacing) : <code>number</code>
|
|
35
|
-
* [.refLine](#properties.refLine) : <code>object</code>
|
|
36
|
-
* [.refLines](#properties.refLine.refLines) : [<code>Array.<refLine></code>](#refLine)
|
|
37
|
-
* [.showTitles](#properties.showTitles) : <code>boolean</code>
|
|
38
|
-
* [.subtitle](#properties.subtitle) : <code>string</code> \| <code>StringExpression</code>
|
|
39
|
-
* [.title](#properties.title) : <code>string</code> \| <code>StringExpression</code>
|
|
40
|
-
* [.footnote](#properties.footnote) : <code>string</code> \| <code>StringExpression</code>
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
<a name="properties.version"></a>
|
|
44
|
-
|
|
45
|
-
### properties.version : <code>string</code>
|
|
46
|
-
Current version of this generic object definition.
|
|
47
|
-
|
|
48
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
49
|
-
<a name="properties.qHyperCubeDef"></a>
|
|
50
|
-
|
|
51
|
-
### properties.qHyperCubeDef ⇐ <code>HyperCubeDef</code>
|
|
52
|
-
Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
|
|
53
|
-
|
|
54
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
55
|
-
**Extends**: <code>HyperCubeDef</code>
|
|
56
|
-
<a name="properties.qHyperCubeDef.qMeasures"></a>
|
|
57
|
-
|
|
58
|
-
#### qHyperCubeDef.qMeasures : [<code>Array.<MeasureProperties></code>](#MeasureProperties)
|
|
59
|
-
**Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
|
|
60
|
-
<a name="properties.color"></a>
|
|
61
|
-
|
|
62
|
-
### properties.color : <code>object</code>
|
|
63
|
-
Color settings.
|
|
64
|
-
Most 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.
|
|
65
|
-
If `"auto": true`, no other properties need to be defined in the color object.
|
|
66
|
-
Note: Some of the color properties are depending on which theme is currently being used.
|
|
67
|
-
|
|
68
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
69
|
-
|
|
70
|
-
* [.color](#properties.color) : <code>object</code>
|
|
71
|
-
* [.auto](#properties.color.auto) : <code>boolean</code>
|
|
72
|
-
* [.positiveValue](#properties.color.positiveValue) : <code>object</code>
|
|
73
|
-
* [.paletteColor](#properties.color.positiveValue.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
74
|
-
* [.negativeValue](#properties.color.negativeValue) : <code>object</code>
|
|
75
|
-
* [.paletteColor](#properties.color.negativeValue.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
76
|
-
* [.subtotal](#properties.color.subtotal) : <code>object</code>
|
|
77
|
-
* [.paletteColor](#properties.color.subtotal.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
78
|
-
|
|
79
|
-
<a name="properties.color.auto"></a>
|
|
80
|
-
|
|
81
|
-
#### color.auto : <code>boolean</code>
|
|
82
|
-
Set to use automatic coloring.
|
|
83
|
-
When `"auto": true`, color settings are based on the visualization used and the number of dimensions
|
|
84
|
-
and measures, that is, the settings are not fixed, but are dependent on the data input.
|
|
85
|
-
|
|
86
|
-
**Kind**: static property of [<code>color</code>](#properties.color)
|
|
87
|
-
**Default**: <code>true</code>
|
|
88
|
-
<a name="properties.color.positiveValue"></a>
|
|
89
|
-
|
|
90
|
-
#### color.positiveValue : <code>object</code>
|
|
91
|
-
Positive value color.
|
|
92
|
-
|
|
93
|
-
**Kind**: static property of [<code>color</code>](#properties.color)
|
|
94
|
-
<a name="properties.color.positiveValue.paletteColor"></a>
|
|
95
|
-
|
|
96
|
-
##### positiveValue.paletteColor : [<code>paletteColor</code>](#paletteColor)
|
|
97
|
-
paletteColor
|
|
98
|
-
|
|
99
|
-
**Kind**: static property of [<code>positiveValue</code>](#properties.color.positiveValue)
|
|
100
|
-
**Default**: <code>{ index: 6, color: null }</code>
|
|
101
|
-
<a name="properties.color.negativeValue"></a>
|
|
102
|
-
|
|
103
|
-
#### color.negativeValue : <code>object</code>
|
|
104
|
-
Negative value color.
|
|
105
|
-
|
|
106
|
-
**Kind**: static property of [<code>color</code>](#properties.color)
|
|
107
|
-
<a name="properties.color.negativeValue.paletteColor"></a>
|
|
108
|
-
|
|
109
|
-
##### negativeValue.paletteColor : [<code>paletteColor</code>](#paletteColor)
|
|
110
|
-
paletteColor
|
|
111
|
-
|
|
112
|
-
**Kind**: static property of [<code>negativeValue</code>](#properties.color.negativeValue)
|
|
113
|
-
**Default**: <code>{ index: -1, color: '#cc6677' }</code>
|
|
114
|
-
<a name="properties.color.subtotal"></a>
|
|
115
|
-
|
|
116
|
-
#### color.subtotal : <code>object</code>
|
|
117
|
-
Subtotal value color.
|
|
118
|
-
|
|
119
|
-
**Kind**: static property of [<code>color</code>](#properties.color)
|
|
120
|
-
<a name="properties.color.subtotal.paletteColor"></a>
|
|
121
|
-
|
|
122
|
-
##### subtotal.paletteColor : [<code>paletteColor</code>](#paletteColor)
|
|
123
|
-
paletteColor
|
|
124
|
-
|
|
125
|
-
**Kind**: static property of [<code>subtotal</code>](#properties.color.subtotal)
|
|
126
|
-
**Default**: <code>{ index: -1, color: '#c3c3c3' }</code>
|
|
127
|
-
<a name="properties.dataPoint"></a>
|
|
128
|
-
|
|
129
|
-
### properties.dataPoint : <code>object</code>
|
|
130
|
-
Data point.
|
|
131
|
-
|
|
132
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
133
|
-
<a name="properties.dataPoint.showLabels"></a>
|
|
134
|
-
|
|
135
|
-
#### dataPoint.showLabels : <code>boolean</code>
|
|
136
|
-
Show labels.
|
|
137
|
-
|
|
138
|
-
**Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
|
|
139
|
-
**Default**: <code>true</code>
|
|
140
|
-
<a name="properties.dimensionAxis"></a>
|
|
141
|
-
|
|
142
|
-
### properties.dimensionAxis : <code>object</code>
|
|
143
|
-
Dimension axis settings.
|
|
144
|
-
|
|
145
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
146
|
-
|
|
147
|
-
* [.dimensionAxis](#properties.dimensionAxis) : <code>object</code>
|
|
148
|
-
* [.dock](#properties.dimensionAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
149
|
-
* [.label](#properties.dimensionAxis.label) : <code>'auto'</code> \| <code>'horizontal'</code> \| <code>'tilted'</code>
|
|
150
|
-
* [.show](#properties.dimensionAxis.show) : <code>'labels'</code> \| <code>'none'</code>
|
|
151
|
-
|
|
152
|
-
<a name="properties.dimensionAxis.dock"></a>
|
|
153
|
-
|
|
154
|
-
#### dimensionAxis.dock : <code>'near'</code> \| <code>'far'</code>
|
|
155
|
-
Axis docking position
|
|
156
|
-
|
|
157
|
-
**Kind**: static property of [<code>dimensionAxis</code>](#properties.dimensionAxis)
|
|
158
|
-
**Default**: <code>"near"</code>
|
|
159
|
-
<a name="properties.dimensionAxis.label"></a>
|
|
160
|
-
|
|
161
|
-
#### dimensionAxis.label : <code>'auto'</code> \| <code>'horizontal'</code> \| <code>'tilted'</code>
|
|
162
|
-
Label orientation
|
|
163
|
-
|
|
164
|
-
**Kind**: static property of [<code>dimensionAxis</code>](#properties.dimensionAxis)
|
|
165
|
-
<a name="properties.dimensionAxis.show"></a>
|
|
166
|
-
|
|
167
|
-
#### dimensionAxis.show : <code>'labels'</code> \| <code>'none'</code>
|
|
168
|
-
Labels and title
|
|
169
|
-
|
|
170
|
-
**Kind**: static property of [<code>dimensionAxis</code>](#properties.dimensionAxis)
|
|
171
|
-
**Default**: <code>labels</code>
|
|
172
|
-
<a name="properties.gridlines"></a>
|
|
173
|
-
|
|
174
|
-
### properties.gridlines : <code>object</code>
|
|
175
|
-
Grid lines settings.
|
|
176
|
-
|
|
177
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
178
|
-
|
|
179
|
-
* [.gridlines](#properties.gridlines) : <code>object</code>
|
|
180
|
-
* [.auto](#properties.gridlines.auto) : <code>boolean</code>
|
|
181
|
-
* [.spacing](#properties.gridlines.spacing) : <code>0</code> \| <code>2</code> \| <code>3</code>
|
|
182
|
-
|
|
183
|
-
<a name="properties.gridlines.auto"></a>
|
|
184
|
-
|
|
185
|
-
#### gridlines.auto : <code>boolean</code>
|
|
186
|
-
Automatic grid line spacing.
|
|
187
|
-
|
|
188
|
-
**Kind**: static property of [<code>gridlines</code>](#properties.gridlines)
|
|
189
|
-
**Default**: <code>true</code>
|
|
190
|
-
<a name="properties.gridlines.spacing"></a>
|
|
191
|
-
|
|
192
|
-
#### gridlines.spacing : <code>0</code> \| <code>2</code> \| <code>3</code>
|
|
193
|
-
Grid line spacing. Used only when auto is set to false.
|
|
194
|
-
|
|
195
|
-
**Kind**: static property of [<code>gridlines</code>](#properties.gridlines)
|
|
196
|
-
**Default**: <code>2</code>
|
|
197
|
-
<a name="properties.legend"></a>
|
|
198
|
-
|
|
199
|
-
### properties.legend : <code>object</code>
|
|
200
|
-
Legend settings.
|
|
201
|
-
|
|
202
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
203
|
-
|
|
204
|
-
* [.legend](#properties.legend) : <code>object</code>
|
|
205
|
-
* [.dock](#properties.legend.dock) : <code>'auto'</code> \| <code>'right'</code> \| <code>'left'</code> \| <code>'bottom'</code> \| <code>'top'</code>
|
|
206
|
-
* [.show](#properties.legend.show) : <code>boolean</code>
|
|
207
|
-
|
|
208
|
-
<a name="properties.legend.dock"></a>
|
|
209
|
-
|
|
210
|
-
#### legend.dock : <code>'auto'</code> \| <code>'right'</code> \| <code>'left'</code> \| <code>'bottom'</code> \| <code>'top'</code>
|
|
211
|
-
Sets the legend position.
|
|
212
|
-
|
|
213
|
-
**Kind**: static property of [<code>legend</code>](#properties.legend)
|
|
214
|
-
**Default**: <code>'auto'</code>
|
|
215
|
-
<a name="properties.legend.show"></a>
|
|
216
|
-
|
|
217
|
-
#### legend.show : <code>boolean</code>
|
|
218
|
-
Set to show the legend.
|
|
219
|
-
|
|
220
|
-
**Kind**: static property of [<code>legend</code>](#properties.legend)
|
|
221
|
-
**Default**: <code>true</code>
|
|
222
|
-
<a name="properties.measureAxis"></a>
|
|
223
|
-
|
|
224
|
-
### properties.measureAxis : <code>object</code>
|
|
225
|
-
Measure axis settings.
|
|
226
|
-
|
|
227
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
228
|
-
|
|
229
|
-
* [.measureAxis](#properties.measureAxis) : <code>object</code>
|
|
230
|
-
* [.autoMinMax](#properties.measureAxis.autoMinMax) : <code>boolean</code>
|
|
231
|
-
* [.dock](#properties.measureAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
232
|
-
* [.max](#properties.measureAxis.max) : <code>number</code> \| <code>ValueExpression</code>
|
|
233
|
-
* [.min](#properties.measureAxis.min) : <code>number</code> \| <code>ValueExpression</code>
|
|
234
|
-
* [.minMax](#properties.measureAxis.minMax) : <code>'min'</code> \| <code>'max'</code> \| <code>'minMax'</code>
|
|
235
|
-
* [.show](#properties.measureAxis.show) : <code>'labels'</code> \| <code>'none'</code>
|
|
236
|
-
* [.spacing](#properties.measureAxis.spacing) : <code>number</code>
|
|
237
|
-
|
|
238
|
-
<a name="properties.measureAxis.autoMinMax"></a>
|
|
239
|
-
|
|
240
|
-
#### measureAxis.autoMinMax : <code>boolean</code>
|
|
241
|
-
Automatic max/min
|
|
242
|
-
|
|
243
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
244
|
-
**Default**: <code>true</code>
|
|
245
|
-
<a name="properties.measureAxis.dock"></a>
|
|
246
|
-
|
|
247
|
-
#### measureAxis.dock : <code>'near'</code> \| <code>'far'</code>
|
|
248
|
-
Axis docking position
|
|
249
|
-
|
|
250
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
251
|
-
**Default**: <code>"near"</code>
|
|
252
|
-
<a name="properties.measureAxis.max"></a>
|
|
253
|
-
|
|
254
|
-
#### measureAxis.max : <code>number</code> \| <code>ValueExpression</code>
|
|
255
|
-
Axis max value. `"autoMinMax"` must be set to false and `"minMax"`
|
|
256
|
-
must be set to `"max"` or `"minMax"` to use this property
|
|
257
|
-
|
|
258
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
259
|
-
**Default**: <code>10</code>
|
|
260
|
-
<a name="properties.measureAxis.min"></a>
|
|
261
|
-
|
|
262
|
-
#### measureAxis.min : <code>number</code> \| <code>ValueExpression</code>
|
|
263
|
-
Axis min value. `"autoMinMax"` must be set to false and `"minMax"`
|
|
264
|
-
must be set to `"min"` or `"minMax"` to use this property
|
|
265
|
-
|
|
266
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
267
|
-
**Default**: <code>0</code>
|
|
268
|
-
<a name="properties.measureAxis.minMax"></a>
|
|
269
|
-
|
|
270
|
-
#### measureAxis.minMax : <code>'min'</code> \| <code>'max'</code> \| <code>'minMax'</code>
|
|
271
|
-
Set custom max/min
|
|
272
|
-
|
|
273
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
274
|
-
**Default**: <code>"min"</code>
|
|
275
|
-
<a name="properties.measureAxis.show"></a>
|
|
276
|
-
|
|
277
|
-
#### measureAxis.show : <code>'labels'</code> \| <code>'none'</code>
|
|
278
|
-
Labels and title
|
|
279
|
-
|
|
280
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
281
|
-
**Default**: <code>"labels"</code>
|
|
282
|
-
<a name="properties.measureAxis.spacing"></a>
|
|
283
|
-
|
|
284
|
-
#### measureAxis.spacing : <code>number</code>
|
|
285
|
-
Axis scale
|
|
286
|
-
|
|
287
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
288
|
-
**Default**: <code>1</code>
|
|
289
|
-
<a name="properties.refLine"></a>
|
|
290
|
-
|
|
291
|
-
### properties.refLine : <code>object</code>
|
|
292
|
-
Reference lines settings
|
|
293
|
-
|
|
294
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
295
|
-
<a name="properties.refLine.refLines"></a>
|
|
296
|
-
|
|
297
|
-
#### refLine.refLines : [<code>Array.<refLine></code>](#refLine)
|
|
298
|
-
Array of measure based reference line definitions
|
|
299
|
-
|
|
300
|
-
**Kind**: static property of [<code>refLine</code>](#properties.refLine)
|
|
301
|
-
<a name="properties.showTitles"></a>
|
|
302
|
-
|
|
303
|
-
### properties.showTitles : <code>boolean</code>
|
|
304
|
-
Show title for the visualization.
|
|
305
|
-
|
|
306
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
307
|
-
**Default**: <code>true</code>
|
|
308
|
-
<a name="properties.subtitle"></a>
|
|
309
|
-
|
|
310
|
-
### properties.subtitle : <code>string</code> \| <code>StringExpression</code>
|
|
311
|
-
Visualization subtitle.
|
|
312
|
-
|
|
313
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
314
|
-
**Default**: <code>""</code>
|
|
315
|
-
<a name="properties.title"></a>
|
|
316
|
-
|
|
317
|
-
### properties.title : <code>string</code> \| <code>StringExpression</code>
|
|
318
|
-
Visualization title.
|
|
319
|
-
|
|
320
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
321
|
-
**Default**: <code>""</code>
|
|
322
|
-
<a name="properties.footnote"></a>
|
|
323
|
-
|
|
324
|
-
### properties.footnote : <code>string</code> \| <code>StringExpression</code>
|
|
325
|
-
Visualization footnote.
|
|
326
|
-
|
|
327
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
328
|
-
**Default**: <code>""</code>
|
|
329
|
-
|
|
330
|
-
# Definitions
|