@nebula.js/sn-histogram 1.0.3 → 1.0.5
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 +18554 -4
- package/core/esm/index.js.map +1 -1
- package/dist/sn-histogram.js +38132 -15
- package/dist/sn-histogram.js.map +1 -1
- package/dist/sn-histogram.systemjs.js +30298 -11
- package/dist/sn-histogram.systemjs.js.map +1 -1
- package/package.json +8 -6
- package/sn-histogram-ext/dist/sn-histogram.js +4 -4
- package/sn-histogram-ext/sn-histogram.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
|
-
* [.bins](#properties.bins) : <code>object</code>
|
|
7
|
-
* [.auto](#properties.bins.auto) : <code>boolean</code>
|
|
8
|
-
* [.binCount](#properties.bins.binCount) : <code>number</code>
|
|
9
|
-
* [.binSize](#properties.bins.binSize) : <code>number</code>
|
|
10
|
-
* [.offset](#properties.bins.offset) : <code>number</code>
|
|
11
|
-
* [.countDistinct](#properties.bins.countDistinct) : <code>boolean</code>
|
|
12
|
-
* [.binMode](#properties.bins.binMode) : <code>string</code>
|
|
13
|
-
* [.color](#properties.color) : <code>object</code>
|
|
14
|
-
* [.bar](#properties.color.bar) : <code>object</code>
|
|
15
|
-
* [.paletteColor](#properties.color.bar.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
16
|
-
* [.dataPoint](#properties.dataPoint) : <code>object</code>
|
|
17
|
-
* [.showLabels](#properties.dataPoint.showLabels) : <code>boolean</code>
|
|
18
|
-
* [.dimensionAxis](#properties.dimensionAxis) : <code>object</code>
|
|
19
|
-
* [.dock](#properties.dimensionAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
20
|
-
* [.label](#properties.dimensionAxis.label) : <code>'auto'</code>
|
|
21
|
-
* [.show](#properties.dimensionAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
|
|
22
|
-
* [.measureAxis](#properties.measureAxis) : <code>object</code>
|
|
23
|
-
* [.autoMinMax](#properties.measureAxis.autoMinMax) : <code>boolean</code>
|
|
24
|
-
* [.dock](#properties.measureAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
25
|
-
* [.label](#properties.measureAxis.label) : <code>string</code> \| <code>StringExpression</code>
|
|
26
|
-
* [.max](#properties.measureAxis.max) : <code>number</code> \| <code>ValueExpression</code>
|
|
27
|
-
* [.min](#properties.measureAxis.min) : <code>number</code> \| <code>ValueExpression</code>
|
|
28
|
-
* [.minMax](#properties.measureAxis.minMax) : <code>'min'</code> \| <code>'max'</code> \| <code>'minMax'</code>
|
|
29
|
-
* [.show](#properties.measureAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
|
|
30
|
-
* [.spacing](#properties.measureAxis.spacing) : <code>number</code>
|
|
31
|
-
* [.gridlines](#properties.gridlines) : <code>object</code>
|
|
32
|
-
* [.auto](#properties.gridlines.auto) : <code>boolean</code>
|
|
33
|
-
* [.spacing](#properties.gridlines.spacing) : <code>0</code> \| <code>2</code> \| <code>3</code>
|
|
34
|
-
* [.refLine](#properties.refLine) : <code>object</code>
|
|
35
|
-
* [.refLines](#properties.refLine.refLines) : [<code>Array.<refLine></code>](#refLine)
|
|
36
|
-
* [.sorting](#properties.sorting) : <code>object</code>
|
|
37
|
-
* [.autoSort](#properties.sorting.autoSort) : <code>true</code>
|
|
38
|
-
* [.showTitles](#properties.showTitles) : <code>boolean</code>
|
|
39
|
-
* [.subtitle](#properties.subtitle) : <code>string</code> \| <code>StringExpression</code>
|
|
40
|
-
* [.title](#properties.title) : <code>string</code> \| <code>StringExpression</code>
|
|
41
|
-
* [.footnote](#properties.footnote) : <code>string</code> \| <code>StringExpression</code>
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
<a name="properties.version"></a>
|
|
45
|
-
|
|
46
|
-
### properties.version : <code>string</code>
|
|
47
|
-
Current version of this generic object definition.
|
|
48
|
-
|
|
49
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
50
|
-
<a name="properties.qHyperCubeDef"></a>
|
|
51
|
-
|
|
52
|
-
### properties.qHyperCubeDef ⇐ <code>HyperCubeDef</code>
|
|
53
|
-
Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
|
|
54
|
-
|
|
55
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
56
|
-
**Extends**: <code>HyperCubeDef</code>
|
|
57
|
-
<a name="properties.bins"></a>
|
|
58
|
-
|
|
59
|
-
### properties.bins : <code>object</code>
|
|
60
|
-
Bin settings.
|
|
61
|
-
|
|
62
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
63
|
-
|
|
64
|
-
* [.bins](#properties.bins) : <code>object</code>
|
|
65
|
-
* [.auto](#properties.bins.auto) : <code>boolean</code>
|
|
66
|
-
* [.binCount](#properties.bins.binCount) : <code>number</code>
|
|
67
|
-
* [.binSize](#properties.bins.binSize) : <code>number</code>
|
|
68
|
-
* [.offset](#properties.bins.offset) : <code>number</code>
|
|
69
|
-
* [.countDistinct](#properties.bins.countDistinct) : <code>boolean</code>
|
|
70
|
-
* [.binMode](#properties.bins.binMode) : <code>string</code>
|
|
71
|
-
|
|
72
|
-
<a name="properties.bins.auto"></a>
|
|
73
|
-
|
|
74
|
-
#### bins.auto : <code>boolean</code>
|
|
75
|
-
Auto mode generates a nice looking histogram without special parameters.
|
|
76
|
-
|
|
77
|
-
**Kind**: static property of [<code>bins</code>](#properties.bins)
|
|
78
|
-
<a name="properties.bins.binCount"></a>
|
|
79
|
-
|
|
80
|
-
#### bins.binCount : <code>number</code>
|
|
81
|
-
Number of bars to be displayed, used when binMode is set to 'maxCount'.
|
|
82
|
-
|
|
83
|
-
**Kind**: static property of [<code>bins</code>](#properties.bins)
|
|
84
|
-
**Default**: <code></code>
|
|
85
|
-
<a name="properties.bins.binSize"></a>
|
|
86
|
-
|
|
87
|
-
#### bins.binSize : <code>number</code>
|
|
88
|
-
The width of the bars, used when binMode is set to 'size'.
|
|
89
|
-
|
|
90
|
-
**Kind**: static property of [<code>bins</code>](#properties.bins)
|
|
91
|
-
<a name="properties.bins.offset"></a>
|
|
92
|
-
|
|
93
|
-
#### bins.offset : <code>number</code>
|
|
94
|
-
Used to know where to start displaying bars on x-axis.
|
|
95
|
-
|
|
96
|
-
**Kind**: static property of [<code>bins</code>](#properties.bins)
|
|
97
|
-
<a name="properties.bins.countDistinct"></a>
|
|
98
|
-
|
|
99
|
-
#### bins.countDistinct : <code>boolean</code>
|
|
100
|
-
Shows unique values.
|
|
101
|
-
|
|
102
|
-
**Kind**: static property of [<code>bins</code>](#properties.bins)
|
|
103
|
-
<a name="properties.bins.binMode"></a>
|
|
104
|
-
|
|
105
|
-
#### bins.binMode : <code>string</code>
|
|
106
|
-
MaxCount - Able to adjust the maximum number of bars to be displayed. size - Able to adjust size of bars and offset from x-axis.
|
|
107
|
-
|
|
108
|
-
**Kind**: static property of [<code>bins</code>](#properties.bins)
|
|
109
|
-
<a name="properties.color"></a>
|
|
110
|
-
|
|
111
|
-
### properties.color : <code>object</code>
|
|
112
|
-
Color settings.
|
|
113
|
-
|
|
114
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
115
|
-
|
|
116
|
-
* [.color](#properties.color) : <code>object</code>
|
|
117
|
-
* [.bar](#properties.color.bar) : <code>object</code>
|
|
118
|
-
* [.paletteColor](#properties.color.bar.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
|
119
|
-
|
|
120
|
-
<a name="properties.color.bar"></a>
|
|
121
|
-
|
|
122
|
-
#### color.bar : <code>object</code>
|
|
123
|
-
**Kind**: static property of [<code>color</code>](#properties.color)
|
|
124
|
-
<a name="properties.color.bar.paletteColor"></a>
|
|
125
|
-
|
|
126
|
-
##### bar.paletteColor : [<code>paletteColor</code>](#paletteColor)
|
|
127
|
-
The paletteColor object is used to define the bar color.
|
|
128
|
-
|
|
129
|
-
**Kind**: static property of [<code>bar</code>](#properties.color.bar)
|
|
130
|
-
**Default**: <code>{ index: 6 }</code>
|
|
131
|
-
<a name="properties.dataPoint"></a>
|
|
132
|
-
|
|
133
|
-
### properties.dataPoint : <code>object</code>
|
|
134
|
-
Data points
|
|
135
|
-
|
|
136
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
137
|
-
<a name="properties.dataPoint.showLabels"></a>
|
|
138
|
-
|
|
139
|
-
#### dataPoint.showLabels : <code>boolean</code>
|
|
140
|
-
Show labels on bars
|
|
141
|
-
|
|
142
|
-
**Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
|
|
143
|
-
**Default**: <code>false</code>
|
|
144
|
-
<a name="properties.dimensionAxis"></a>
|
|
145
|
-
|
|
146
|
-
### properties.dimensionAxis : <code>object</code>
|
|
147
|
-
Dimension axis settings.
|
|
148
|
-
|
|
149
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
150
|
-
|
|
151
|
-
* [.dimensionAxis](#properties.dimensionAxis) : <code>object</code>
|
|
152
|
-
* [.dock](#properties.dimensionAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
153
|
-
* [.label](#properties.dimensionAxis.label) : <code>'auto'</code>
|
|
154
|
-
* [.show](#properties.dimensionAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
|
|
155
|
-
|
|
156
|
-
<a name="properties.dimensionAxis.dock"></a>
|
|
157
|
-
|
|
158
|
-
#### dimensionAxis.dock : <code>'near'</code> \| <code>'far'</code>
|
|
159
|
-
Axis docking position
|
|
160
|
-
|
|
161
|
-
**Kind**: static property of [<code>dimensionAxis</code>](#properties.dimensionAxis)
|
|
162
|
-
**Default**: <code>"near"</code>
|
|
163
|
-
<a name="properties.dimensionAxis.label"></a>
|
|
164
|
-
|
|
165
|
-
#### dimensionAxis.label : <code>'auto'</code>
|
|
166
|
-
Label orientation
|
|
167
|
-
|
|
168
|
-
**Kind**: static property of [<code>dimensionAxis</code>](#properties.dimensionAxis)
|
|
169
|
-
**Default**: <code>auto</code>
|
|
170
|
-
<a name="properties.dimensionAxis.show"></a>
|
|
171
|
-
|
|
172
|
-
#### dimensionAxis.show : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
|
|
173
|
-
Labels and title
|
|
174
|
-
|
|
175
|
-
**Kind**: static property of [<code>dimensionAxis</code>](#properties.dimensionAxis)
|
|
176
|
-
<a name="properties.measureAxis"></a>
|
|
177
|
-
|
|
178
|
-
### properties.measureAxis : <code>object</code>
|
|
179
|
-
Measure axis settings.
|
|
180
|
-
|
|
181
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
182
|
-
|
|
183
|
-
* [.measureAxis](#properties.measureAxis) : <code>object</code>
|
|
184
|
-
* [.autoMinMax](#properties.measureAxis.autoMinMax) : <code>boolean</code>
|
|
185
|
-
* [.dock](#properties.measureAxis.dock) : <code>'near'</code> \| <code>'far'</code>
|
|
186
|
-
* [.label](#properties.measureAxis.label) : <code>string</code> \| <code>StringExpression</code>
|
|
187
|
-
* [.max](#properties.measureAxis.max) : <code>number</code> \| <code>ValueExpression</code>
|
|
188
|
-
* [.min](#properties.measureAxis.min) : <code>number</code> \| <code>ValueExpression</code>
|
|
189
|
-
* [.minMax](#properties.measureAxis.minMax) : <code>'min'</code> \| <code>'max'</code> \| <code>'minMax'</code>
|
|
190
|
-
* [.show](#properties.measureAxis.show) : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
|
|
191
|
-
* [.spacing](#properties.measureAxis.spacing) : <code>number</code>
|
|
192
|
-
|
|
193
|
-
<a name="properties.measureAxis.autoMinMax"></a>
|
|
194
|
-
|
|
195
|
-
#### measureAxis.autoMinMax : <code>boolean</code>
|
|
196
|
-
Automatic max/min
|
|
197
|
-
|
|
198
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
199
|
-
**Default**: <code>true</code>
|
|
200
|
-
<a name="properties.measureAxis.dock"></a>
|
|
201
|
-
|
|
202
|
-
#### measureAxis.dock : <code>'near'</code> \| <code>'far'</code>
|
|
203
|
-
Axis docking position
|
|
204
|
-
|
|
205
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
206
|
-
**Default**: <code>"near"</code>
|
|
207
|
-
<a name="properties.measureAxis.label"></a>
|
|
208
|
-
|
|
209
|
-
#### measureAxis.label : <code>string</code> \| <code>StringExpression</code>
|
|
210
|
-
Label to show on the measure axis, if left empty it defaults to 'Frequency'
|
|
211
|
-
|
|
212
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
213
|
-
**Default**: <code>""</code>
|
|
214
|
-
<a name="properties.measureAxis.max"></a>
|
|
215
|
-
|
|
216
|
-
#### measureAxis.max : <code>number</code> \| <code>ValueExpression</code>
|
|
217
|
-
Axis max value. `"autoMinMax"` must be set to false and `"minMax"`
|
|
218
|
-
must be set to `"max"` or `"minMax"` to use this property
|
|
219
|
-
|
|
220
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
221
|
-
**Default**: <code>10</code>
|
|
222
|
-
<a name="properties.measureAxis.min"></a>
|
|
223
|
-
|
|
224
|
-
#### measureAxis.min : <code>number</code> \| <code>ValueExpression</code>
|
|
225
|
-
Axis min value. `"autoMinMax"` must be set to false and `"minMax"`
|
|
226
|
-
must be set to `"min"` or `"minMax"` to use this property
|
|
227
|
-
|
|
228
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
229
|
-
**Default**: <code>0</code>
|
|
230
|
-
<a name="properties.measureAxis.minMax"></a>
|
|
231
|
-
|
|
232
|
-
#### measureAxis.minMax : <code>'min'</code> \| <code>'max'</code> \| <code>'minMax'</code>
|
|
233
|
-
Set custom max/min
|
|
234
|
-
|
|
235
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
236
|
-
**Default**: <code>"min"</code>
|
|
237
|
-
<a name="properties.measureAxis.show"></a>
|
|
238
|
-
|
|
239
|
-
#### measureAxis.show : <code>'all'</code> \| <code>'labels'</code> \| <code>'title'</code> \| <code>'none'</code>
|
|
240
|
-
Labels and title
|
|
241
|
-
|
|
242
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
243
|
-
**Default**: <code>"all"</code>
|
|
244
|
-
<a name="properties.measureAxis.spacing"></a>
|
|
245
|
-
|
|
246
|
-
#### measureAxis.spacing : <code>number</code>
|
|
247
|
-
Axis scale
|
|
248
|
-
|
|
249
|
-
**Kind**: static property of [<code>measureAxis</code>](#properties.measureAxis)
|
|
250
|
-
**Default**: <code>1</code>
|
|
251
|
-
<a name="properties.gridlines"></a>
|
|
252
|
-
|
|
253
|
-
### properties.gridlines : <code>object</code>
|
|
254
|
-
Grid lines settings.
|
|
255
|
-
|
|
256
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
257
|
-
|
|
258
|
-
* [.gridlines](#properties.gridlines) : <code>object</code>
|
|
259
|
-
* [.auto](#properties.gridlines.auto) : <code>boolean</code>
|
|
260
|
-
* [.spacing](#properties.gridlines.spacing) : <code>0</code> \| <code>2</code> \| <code>3</code>
|
|
261
|
-
|
|
262
|
-
<a name="properties.gridlines.auto"></a>
|
|
263
|
-
|
|
264
|
-
#### gridlines.auto : <code>boolean</code>
|
|
265
|
-
Automatic grid line spacing.
|
|
266
|
-
|
|
267
|
-
**Kind**: static property of [<code>gridlines</code>](#properties.gridlines)
|
|
268
|
-
**Default**: <code>true</code>
|
|
269
|
-
<a name="properties.gridlines.spacing"></a>
|
|
270
|
-
|
|
271
|
-
#### gridlines.spacing : <code>0</code> \| <code>2</code> \| <code>3</code>
|
|
272
|
-
Grid line spacing. Used only when auto is set to false.
|
|
273
|
-
|
|
274
|
-
**Kind**: static property of [<code>gridlines</code>](#properties.gridlines)
|
|
275
|
-
**Default**: <code>2</code>
|
|
276
|
-
<a name="properties.refLine"></a>
|
|
277
|
-
|
|
278
|
-
### properties.refLine : <code>object</code>
|
|
279
|
-
Reference lines settings
|
|
280
|
-
|
|
281
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
282
|
-
<a name="properties.refLine.refLines"></a>
|
|
283
|
-
|
|
284
|
-
#### refLine.refLines : [<code>Array.<refLine></code>](#refLine)
|
|
285
|
-
Array of measure based reference line definitions
|
|
286
|
-
|
|
287
|
-
**Kind**: static property of [<code>refLine</code>](#properties.refLine)
|
|
288
|
-
<a name="properties.sorting"></a>
|
|
289
|
-
|
|
290
|
-
### properties.sorting : <code>object</code>
|
|
291
|
-
Wrapper for sorting properties which will be set on the outer dimension.
|
|
292
|
-
|
|
293
|
-
**Kind**: static property of [<code>properties</code>](#properties)
|
|
294
|
-
<a name="properties.sorting.autoSort"></a>
|
|
295
|
-
|
|
296
|
-
#### sorting.autoSort : <code>true</code>
|
|
297
|
-
Sort automatically
|
|
298
|
-
|
|
299
|
-
**Kind**: static property of [<code>sorting</code>](#properties.sorting)
|
|
300
|
-
**Default**: <code>true</code>
|
|
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
|