@nebula.js/sn-combo-chart 1.35.2 → 1.35.4

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.
@@ -1,289 +0,0 @@
1
- # Plugins Arguments
2
-
3
- - [pluginArguments](#pluginArguments) : <code>object</code>
4
- - [.layout](#pluginArguments.layout) : <code>object</code>
5
- - [.keys](#pluginArguments.keys) : <code>object</code>
6
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
7
- - [.MAJOR](#pluginArguments.keys.SCALE.MAJOR) : <code>string</code>
8
- - [.MAJOR_INNER](#pluginArguments.keys.SCALE.MAJOR_INNER) : <code>string</code>
9
- - [.MINOR](#pluginArguments.keys.SCALE.MINOR) : <code>object</code>
10
- - [.PRIMARY](#pluginArguments.keys.SCALE.MINOR.PRIMARY) : <code>string</code>
11
- - [.SECONDARY](#pluginArguments.keys.SCALE.MINOR.SECONDARY) : <code>string</code>
12
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
13
- - [.BAR_PRIMARY](#pluginArguments.keys.COMPONENT.BAR_PRIMARY) : <code>string</code>
14
- - [.BAR_SECONDARY](#pluginArguments.keys.COMPONENT.BAR_SECONDARY) : <code>string</code>
15
- - [.AXIS](#pluginArguments.keys.COMPONENT.AXIS) : <code>object</code>
16
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS.MAJOR) : <code>string</code>
17
- - [.MAJOR_CONTINUOUS](#pluginArguments.keys.COMPONENT.AXIS.MAJOR_CONTINUOUS) : <code>string</code>
18
- - [.TIME_INNER](#pluginArguments.keys.COMPONENT.AXIS.TIME_INNER) : <code>string</code>
19
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS.MINOR) : <code>object</code>
20
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.PRIMARY) : <code>string</code>
21
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.SECONDARY) : <code>string</code>
22
- - [.AXIS_TITLE](#pluginArguments.keys.COMPONENT.AXIS_TITLE) : <code>object</code>
23
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MAJOR) : <code>string</code>
24
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR) : <code>object</code>
25
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.PRIMARY) : <code>string</code>
26
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.SECONDARY) : <code>string</code>
27
- - [.COLLECTION](#pluginArguments.keys.COLLECTION) : <code>object</code>
28
- - [.MAIN](#pluginArguments.keys.COLLECTION.MAIN) : <code>string</code>
29
-
30
- ---
31
-
32
- <a name="pluginArguments.layout"></a>
33
-
34
- ### pluginArguments.layout : <code>object</code>
35
-
36
- The layout from the enigma model.
37
-
38
- **Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
39
- <a name="pluginArguments.keys"></a>
40
-
41
- ### pluginArguments.keys : <code>object</code>
42
-
43
- The keys (references) to different types of chart internals
44
-
45
- **Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
46
-
47
- - [.keys](#pluginArguments.keys) : <code>object</code>
48
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
49
- - [.MAJOR](#pluginArguments.keys.SCALE.MAJOR) : <code>string</code>
50
- - [.MAJOR_INNER](#pluginArguments.keys.SCALE.MAJOR_INNER) : <code>string</code>
51
- - [.MINOR](#pluginArguments.keys.SCALE.MINOR) : <code>object</code>
52
- - [.PRIMARY](#pluginArguments.keys.SCALE.MINOR.PRIMARY) : <code>string</code>
53
- - [.SECONDARY](#pluginArguments.keys.SCALE.MINOR.SECONDARY) : <code>string</code>
54
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
55
- - [.BAR_PRIMARY](#pluginArguments.keys.COMPONENT.BAR_PRIMARY) : <code>string</code>
56
- - [.BAR_SECONDARY](#pluginArguments.keys.COMPONENT.BAR_SECONDARY) : <code>string</code>
57
- - [.AXIS](#pluginArguments.keys.COMPONENT.AXIS) : <code>object</code>
58
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS.MAJOR) : <code>string</code>
59
- - [.MAJOR_CONTINUOUS](#pluginArguments.keys.COMPONENT.AXIS.MAJOR_CONTINUOUS) : <code>string</code>
60
- - [.TIME_INNER](#pluginArguments.keys.COMPONENT.AXIS.TIME_INNER) : <code>string</code>
61
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS.MINOR) : <code>object</code>
62
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.PRIMARY) : <code>string</code>
63
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.SECONDARY) : <code>string</code>
64
- - [.AXIS_TITLE](#pluginArguments.keys.COMPONENT.AXIS_TITLE) : <code>object</code>
65
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MAJOR) : <code>string</code>
66
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR) : <code>object</code>
67
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.PRIMARY) : <code>string</code>
68
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.SECONDARY) : <code>string</code>
69
- - [.COLLECTION](#pluginArguments.keys.COLLECTION) : <code>object</code>
70
- - [.MAIN](#pluginArguments.keys.COLLECTION.MAIN) : <code>string</code>
71
-
72
- <a name="pluginArguments.keys.SCALE"></a>
73
-
74
- #### keys.SCALE : <code>object</code>
75
-
76
- The scales associated with the combo chart
77
- They are useful if you want to, via plugin, add a new component that
78
- uses the same scale as one of the measures.
79
-
80
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
81
-
82
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
83
- - [.MAJOR](#pluginArguments.keys.SCALE.MAJOR) : <code>string</code>
84
- - [.MAJOR_INNER](#pluginArguments.keys.SCALE.MAJOR_INNER) : <code>string</code>
85
- - [.MINOR](#pluginArguments.keys.SCALE.MINOR) : <code>object</code>
86
- - [.PRIMARY](#pluginArguments.keys.SCALE.MINOR.PRIMARY) : <code>string</code>
87
- - [.SECONDARY](#pluginArguments.keys.SCALE.MINOR.SECONDARY) : <code>string</code>
88
-
89
- <a name="pluginArguments.keys.SCALE.MAJOR"></a>
90
-
91
- ##### SCALE.MAJOR : <code>string</code>
92
-
93
- The scale used for major axis outer
94
-
95
- **Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
96
- <a name="pluginArguments.keys.SCALE.MAJOR_INNER"></a>
97
-
98
- ##### SCALE.MAJOR_INNER : <code>string</code>
99
-
100
- The scale used for major axis inner
101
-
102
- **Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
103
- <a name="pluginArguments.keys.SCALE.MINOR"></a>
104
-
105
- ##### SCALE.MINOR : <code>object</code>
106
-
107
- The scale used for minor axes
108
-
109
- **Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
110
-
111
- - [.MINOR](#pluginArguments.keys.SCALE.MINOR) : <code>object</code>
112
- - [.PRIMARY](#pluginArguments.keys.SCALE.MINOR.PRIMARY) : <code>string</code>
113
- - [.SECONDARY](#pluginArguments.keys.SCALE.MINOR.SECONDARY) : <code>string</code>
114
-
115
- <a name="pluginArguments.keys.SCALE.MINOR.PRIMARY"></a>
116
-
117
- ###### MINOR.PRIMARY : <code>string</code>
118
-
119
- The scale used for minor primary axis (the left one)
120
-
121
- **Kind**: static property of [<code>MINOR</code>](#pluginArguments.keys.SCALE.MINOR)
122
- <a name="pluginArguments.keys.SCALE.MINOR.SECONDARY"></a>
123
-
124
- ###### MINOR.SECONDARY : <code>string</code>
125
-
126
- The scale used for minor secondary axis (the right one)
127
-
128
- **Kind**: static property of [<code>MINOR</code>](#pluginArguments.keys.SCALE.MINOR)
129
- <a name="pluginArguments.keys.COMPONENT"></a>
130
-
131
- #### keys.COMPONENT : <code>object</code>
132
-
133
- The unique keys of the existing components available in the chart.
134
- They are useful if you want to extend or override the existing components.
135
-
136
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
137
-
138
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
139
- - [.BAR_PRIMARY](#pluginArguments.keys.COMPONENT.BAR_PRIMARY) : <code>string</code>
140
- - [.BAR_SECONDARY](#pluginArguments.keys.COMPONENT.BAR_SECONDARY) : <code>string</code>
141
- - [.AXIS](#pluginArguments.keys.COMPONENT.AXIS) : <code>object</code>
142
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS.MAJOR) : <code>string</code>
143
- - [.MAJOR_CONTINUOUS](#pluginArguments.keys.COMPONENT.AXIS.MAJOR_CONTINUOUS) : <code>string</code>
144
- - [.TIME_INNER](#pluginArguments.keys.COMPONENT.AXIS.TIME_INNER) : <code>string</code>
145
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS.MINOR) : <code>object</code>
146
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.PRIMARY) : <code>string</code>
147
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.SECONDARY) : <code>string</code>
148
- - [.AXIS_TITLE](#pluginArguments.keys.COMPONENT.AXIS_TITLE) : <code>object</code>
149
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MAJOR) : <code>string</code>
150
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR) : <code>object</code>
151
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.PRIMARY) : <code>string</code>
152
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.SECONDARY) : <code>string</code>
153
-
154
- <a name="pluginArguments.keys.COMPONENT.BAR_PRIMARY"></a>
155
-
156
- ##### COMPONENT.BAR_PRIMARY : <code>string</code>
157
-
158
- The first bar component
159
-
160
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
161
- <a name="pluginArguments.keys.COMPONENT.BAR_SECONDARY"></a>
162
-
163
- ##### COMPONENT.BAR_SECONDARY : <code>string</code>
164
-
165
- The second bar component
166
-
167
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
168
- <a name="pluginArguments.keys.COMPONENT.AXIS"></a>
169
-
170
- ##### COMPONENT.AXIS : <code>object</code>
171
-
172
- The axis components
173
-
174
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
175
-
176
- - [.AXIS](#pluginArguments.keys.COMPONENT.AXIS) : <code>object</code>
177
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS.MAJOR) : <code>string</code>
178
- - [.MAJOR_CONTINUOUS](#pluginArguments.keys.COMPONENT.AXIS.MAJOR_CONTINUOUS) : <code>string</code>
179
- - [.TIME_INNER](#pluginArguments.keys.COMPONENT.AXIS.TIME_INNER) : <code>string</code>
180
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS.MINOR) : <code>object</code>
181
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.PRIMARY) : <code>string</code>
182
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.SECONDARY) : <code>string</code>
183
-
184
- <a name="pluginArguments.keys.COMPONENT.AXIS.MAJOR"></a>
185
-
186
- ###### AXIS.MAJOR : <code>string</code>
187
-
188
- The major discrete axis component
189
-
190
- **Kind**: static property of [<code>AXIS</code>](#pluginArguments.keys.COMPONENT.AXIS)
191
- <a name="pluginArguments.keys.COMPONENT.AXIS.MAJOR_CONTINUOUS"></a>
192
-
193
- ###### AXIS.MAJOR_CONTINUOUS : <code>string</code>
194
-
195
- The major continuous axis component
196
-
197
- **Kind**: static property of [<code>AXIS</code>](#pluginArguments.keys.COMPONENT.AXIS)
198
- <a name="pluginArguments.keys.COMPONENT.AXIS.TIME_INNER"></a>
199
-
200
- ###### AXIS.TIME_INNER : <code>string</code>
201
-
202
- The time inner axis component
203
-
204
- **Kind**: static property of [<code>AXIS</code>](#pluginArguments.keys.COMPONENT.AXIS)
205
- <a name="pluginArguments.keys.COMPONENT.AXIS.MINOR"></a>
206
-
207
- ###### AXIS.MINOR : <code>object</code>
208
-
209
- The minor axis components
210
-
211
- **Kind**: static property of [<code>AXIS</code>](#pluginArguments.keys.COMPONENT.AXIS)
212
-
213
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS.MINOR) : <code>object</code>
214
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.PRIMARY) : <code>string</code>
215
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS.MINOR.SECONDARY) : <code>string</code>
216
-
217
- <a name="pluginArguments.keys.COMPONENT.AXIS.MINOR.PRIMARY"></a>
218
-
219
- ####### MINOR.PRIMARY : <code>string</code>
220
- The minor primary axis component
221
-
222
- **Kind**: static property of [<code>MINOR</code>](#pluginArguments.keys.COMPONENT.AXIS.MINOR)
223
- <a name="pluginArguments.keys.COMPONENT.AXIS.MINOR.SECONDARY"></a>
224
-
225
- ####### MINOR.SECONDARY : <code>string</code>
226
- The minor secondary axis component
227
-
228
- **Kind**: static property of [<code>MINOR</code>](#pluginArguments.keys.COMPONENT.AXIS.MINOR)
229
- <a name="pluginArguments.keys.COMPONENT.AXIS_TITLE"></a>
230
-
231
- ##### COMPONENT.AXIS_TITLE : <code>object</code>
232
-
233
- The axis title components
234
-
235
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
236
-
237
- - [.AXIS_TITLE](#pluginArguments.keys.COMPONENT.AXIS_TITLE) : <code>object</code>
238
- - [.MAJOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MAJOR) : <code>string</code>
239
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR) : <code>object</code>
240
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.PRIMARY) : <code>string</code>
241
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.SECONDARY) : <code>string</code>
242
-
243
- <a name="pluginArguments.keys.COMPONENT.AXIS_TITLE.MAJOR"></a>
244
-
245
- ###### AXIS_TITLE.MAJOR : <code>string</code>
246
-
247
- The major axis title component
248
-
249
- **Kind**: static property of [<code>AXIS_TITLE</code>](#pluginArguments.keys.COMPONENT.AXIS_TITLE)
250
- <a name="pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR"></a>
251
-
252
- ###### AXIS_TITLE.MINOR : <code>object</code>
253
-
254
- The minor axis title components
255
-
256
- **Kind**: static property of [<code>AXIS_TITLE</code>](#pluginArguments.keys.COMPONENT.AXIS_TITLE)
257
-
258
- - [.MINOR](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR) : <code>object</code>
259
- - [.PRIMARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.PRIMARY) : <code>string</code>
260
- - [.SECONDARY](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.SECONDARY) : <code>string</code>
261
-
262
- <a name="pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.PRIMARY"></a>
263
-
264
- ####### MINOR.PRIMARY : <code>string</code>
265
- The minor primary axis title component
266
-
267
- **Kind**: static property of [<code>MINOR</code>](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR)
268
- <a name="pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR.SECONDARY"></a>
269
-
270
- ####### MINOR.SECONDARY : <code>string</code>
271
- The minor secondary axis title component
272
-
273
- **Kind**: static property of [<code>MINOR</code>](#pluginArguments.keys.COMPONENT.AXIS_TITLE.MINOR)
274
- <a name="pluginArguments.keys.COLLECTION"></a>
275
-
276
- #### keys.COLLECTION : <code>object</code>
277
-
278
- The data collections the users can use to get data from
279
-
280
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
281
- <a name="pluginArguments.keys.COLLECTION.MAIN"></a>
282
-
283
- ##### COLLECTION.MAIN : <code>string</code>
284
-
285
- The main data collection
286
-
287
- **Kind**: static property of [<code>COLLECTION</code>](#pluginArguments.keys.COLLECTION)
288
-
289
- # Definitions