@nebula.js/sn-funnel-chart 1.10.2 → 1.10.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.
Files changed (9) hide show
  1. package/api-specifications/properties.json +2 -2
  2. package/core/esm/index.js +4 -4
  3. package/dist/sn-funnel-chart.js +5 -5
  4. package/dist/sn-funnel-chart.systemjs.js +2 -2
  5. package/package.json +1 -1
  6. package/sn-funnel-chart-ext/dist/sn-funnel-chart.js +5 -5
  7. package/sn-funnel-chart-ext/sn-funnel-chart.qext +1 -1
  8. package/api-specifications/api.md +0 -395
  9. package/api-specifications/plugins.md +0 -90
package/sn-funnel-chart-ext/sn-funnel-chart.qext CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "Funnel chart",
3
- "version": "1.10.2",
3
+ "version": "1.10.4",
4
4
  "description": "A sequential chart visualizing a linear process with connected stages, for example a sales process with potential revenue at each stage.",
5
5
  "author": "QlikTech International AB",
6
6
  "icon": "filter",
package/api-specifications/api.md DELETED
@@ -1,395 +0,0 @@
1
- # API Reference
2
-
3
- - [properties](#properties) : <code>object</code>
4
- - [.version](#properties.version) : <code>string</code>
5
- - [.color](#properties.color) : <code>object</code>
6
- - [.auto](#properties.color.auto) : <code>boolean</code>
7
- - [.autoMinMax](#properties.color.autoMinMax) : <code>boolean</code>
8
- - [.byDimDef](#properties.color.byDimDef) : [<code>byDimDef</code>](#byDimDef)
9
- - [.byMeasureDef](#properties.color.byMeasureDef) : [<code>byMeasureDef</code>](#byMeasureDef)
10
- - [.colorExpression](#properties.color.colorExpression) : <code>string</code>
11
- - [.dimensionScheme](#properties.color.dimensionScheme) : <code>string</code>
12
- - [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
13
- - [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
14
- - [.measureMin](#properties.color.measureMin) : <code>ValueExpression</code>
15
- - [.measureMax](#properties.color.measureMax) : <code>ValueExpression</code>
16
- - [.measureScheme](#properties.color.measureScheme) : <code>&#x27;sg&#x27;</code> \| <code>&#x27;sc&#x27;</code> \| <code>&#x27;dg&#x27;</code> \| <code>&#x27;dc&#x27;</code>
17
- - [.mode](#properties.color.mode) : <code>&#x27;primary&#x27;</code> \| <code>&#x27;byDimension&#x27;</code> \| <code>&#x27;byExpression&#x27;</code> \| <code>&#x27;byMeasure&#x27;</code> \| <code>&#x27;byMultiple&#x27;</code>
18
- - [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
19
- - [.persistent](#properties.color.persistent) : <code>boolean</code>
20
- - [.reverseScheme](#properties.color.reverseScheme) : <code>boolean</code>
21
- - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
22
- - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
23
- - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
24
- - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
25
- - [.dataPoint](#properties.dataPoint) : <code>object</code>
26
- - [.auto](#properties.dataPoint.auto) : <code>boolean</code>
27
- - [.labelMode](#properties.dataPoint.labelMode) : <code>&#x27;none&#x27;</code> \| <code>&#x27;share&#x27;</code> \| <code>&#x27;value&#x27;</code>
28
- - [.footnote](#properties.footnote) : <code>string</code> \| <code>StringExpression</code>
29
- - [.funnel](#properties.funnel) : <code>object</code>
30
- - [.mode](#properties.funnel.mode) : <code>&#x27;AREA&#x27;</code> \| <code>&#x27;HEIGHT&#x27;</code> \| <code>&#x27;WIDTH&#x27;</code> \| <code>&#x27;ORDER&#x27;</code>
31
- - [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
32
- - [.qDimensions](#properties.qHyperCubeDef.qDimensions) : [<code>Array.&lt;DimensionProperties&gt;</code>](#DimensionProperties)
33
- - [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [<code>Array.&lt;MeasureProperties&gt;</code>](#MeasureProperties)
34
- - [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : <code>boolean</code>
35
- - [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : <code>boolean</code>
36
- - [.showDimensionTitle](#properties.showDimensionTitle) : <code>boolean</code>
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
-
41
- ---
42
-
43
- <a name="properties.version"></a>
44
-
45
- ### properties.version : <code>string</code>
46
-
47
- Current version of this generic object definition
48
-
49
- **Kind**: static property of [<code>properties</code>](#properties)
50
- <a name="properties.color"></a>
51
-
52
- ### properties.color : <code>object</code>
53
-
54
- Color settings.
55
- 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.
56
- If `"auto": true`, no other properties need to be defined in the color object.
57
- Note: Some of the color properties are depending on which theme is currently being used.
58
-
59
- **Kind**: static property of [<code>properties</code>](#properties)
60
-
61
- - [.color](#properties.color) : <code>object</code>
62
- - [.auto](#properties.color.auto) : <code>boolean</code>
63
- - [.autoMinMax](#properties.color.autoMinMax) : <code>boolean</code>
64
- - [.byDimDef](#properties.color.byDimDef) : [<code>byDimDef</code>](#byDimDef)
65
- - [.byMeasureDef](#properties.color.byMeasureDef) : [<code>byMeasureDef</code>](#byMeasureDef)
66
- - [.colorExpression](#properties.color.colorExpression) : <code>string</code>
67
- - [.dimensionScheme](#properties.color.dimensionScheme) : <code>string</code>
68
- - [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
69
- - [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
70
- - [.measureMin](#properties.color.measureMin) : <code>ValueExpression</code>
71
- - [.measureMax](#properties.color.measureMax) : <code>ValueExpression</code>
72
- - [.measureScheme](#properties.color.measureScheme) : <code>&#x27;sg&#x27;</code> \| <code>&#x27;sc&#x27;</code> \| <code>&#x27;dg&#x27;</code> \| <code>&#x27;dc&#x27;</code>
73
- - [.mode](#properties.color.mode) : <code>&#x27;primary&#x27;</code> \| <code>&#x27;byDimension&#x27;</code> \| <code>&#x27;byExpression&#x27;</code> \| <code>&#x27;byMeasure&#x27;</code> \| <code>&#x27;byMultiple&#x27;</code>
74
- - [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
75
- - [.persistent](#properties.color.persistent) : <code>boolean</code>
76
- - [.reverseScheme](#properties.color.reverseScheme) : <code>boolean</code>
77
- - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
78
- - [.useBaseColors](#properties.color.useBaseColors) : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
79
- - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
80
- - [.useMeasureGradient](#properties.color.useMeasureGradient) : <code>boolean</code>
81
-
82
- <a name="properties.color.auto"></a>
83
-
84
- #### color.auto : <code>boolean</code>
85
-
86
- Set to use automatic coloring.
87
- When `"auto": true`, color settings are based on the visualization used and the number of dimensions
88
- and measures, that is, the settings are not fixed, but are dependent on the data input.
89
-
90
- **Kind**: static property of [<code>color</code>](#properties.color)
91
- **Default**: <code>true</code>
92
- <a name="properties.color.autoMinMax"></a>
93
-
94
- #### color.autoMinMax : <code>boolean</code>
95
-
96
- Set to false to define custom color range. Custom color range is only applicable when coloring is by measure (`"mode": "byMeasure"`) or by expression (`"mode": "byExpression"`).
97
- When coloring is by expression, `"expressionIsColor": "false"` must be set for custom color range to work.
98
-
99
- **Kind**: static property of [<code>color</code>](#properties.color)
100
- **Default**: <code>true</code>
101
- <a name="properties.color.byDimDef"></a>
102
-
103
- #### color.byDimDef : [<code>byDimDef</code>](#byDimDef)
104
-
105
- **Kind**: static property of [<code>color</code>](#properties.color)
106
- **Default**: <code>undefined</code>
107
- <a name="properties.color.byMeasureDef"></a>
108
-
109
- #### color.byMeasureDef : [<code>byMeasureDef</code>](#byMeasureDef)
110
-
111
- **Kind**: static property of [<code>color</code>](#properties.color)
112
- **Default**: <code>undefined</code>
113
- <a name="properties.color.colorExpression"></a>
114
-
115
- #### color.colorExpression : <code>string</code>
116
-
117
- Sets the color expression to be used when `"mode": "byExpression"` is defined.
118
- Expression can evaluate either to a numerical value or a color code if `"expressionIsColor": true`.
119
- Supported formats are: `RGB`, `ARGB` and `HSL`
120
-
121
- **Kind**: static property of [<code>color</code>](#properties.color)
122
- **Default**: <code>&quot;undefined&quot;</code>
123
- **Example**
124
-
125
- ```js
126
- "colorExpression": "=if(sum(Sales)<avg(Total aggr(sum(Sales),Product)),rgb(255,0,0),RGB(0,255,0))"
127
- ```
128
-
129
- <a name="properties.color.dimensionScheme"></a>
130
-
131
- #### color.dimensionScheme : <code>string</code>
132
-
133
- Color scheme when `"mode": "byDimension"` or `"mode": "byMultiple"` (`"12"` or `"100"` for most themes).
134
-
135
- **Kind**: static property of [<code>color</code>](#properties.color)
136
- **Default**: <code>&quot;12&quot;</code>
137
- <a name="properties.color.expressionIsColor"></a>
138
-
139
- #### color.expressionIsColor : <code>boolean</code>
140
-
141
- Set to define whether the result of the expression is a valid CSS3 color.
142
- Only applicable when `"mode": "byExpression"`.
143
-
144
- **Kind**: static property of [<code>color</code>](#properties.color)
145
- **Default**: <code>true</code>
146
- <a name="properties.color.expressionLabel"></a>
147
-
148
- #### color.expressionLabel : <code>string</code>
149
-
150
- Label to be defined on tool tips when using a coloring expression.
151
- Only used if `"expressionIsColor": false`.
152
-
153
- **Kind**: static property of [<code>color</code>](#properties.color)
154
- **Default**: <code>&quot;&quot;</code>
155
- <a name="properties.color.measureMin"></a>
156
-
157
- #### color.measureMin : <code>ValueExpression</code>
158
-
159
- Set the min value for the color range.
160
- Only applicable if `"autoMinMax": false`.
161
-
162
- **Kind**: static property of [<code>color</code>](#properties.color)
163
- **Default**: <code>undefined</code>
164
- <a name="properties.color.measureMax"></a>
165
-
166
- #### color.measureMax : <code>ValueExpression</code>
167
-
168
- Set the max value for the color range.
169
- Only applicable if `"autoMinMax": false`.
170
-
171
- **Kind**: static property of [<code>color</code>](#properties.color)
172
- **Default**: <code>undefined</code>
173
- <a name="properties.color.measureScheme"></a>
174
-
175
- #### color.measureScheme : <code>&#x27;sg&#x27;</code> \| <code>&#x27;sc&#x27;</code> \| <code>&#x27;dg&#x27;</code> \| <code>&#x27;dc&#x27;</code>
176
-
177
- Color scheme when `"mode": "byMeasure"`. Can be one of:
178
-
179
- - `sg`: (sequential gradient) the transition between the different color groups is made using different shades of colors. High measure values have darker hues
180
- - `sc`: (sequential classes) the transition between the different color groups is made using distinctly different colors.
181
- - `dg`: (diverging gradient) used when working with data that is ordered from low to high, for instance, to show the relationship between different areas on a map. Low and high values have dark colors, mid-range colors are light.
182
- - `dc`: (diverging classes) can be seen as two sequential classes combined, with the mid-range shared. The two extremes, high and low, are emphasized with dark colors with contrasting hues, and the mid-range critical values are emphasized with light colors.
183
-
184
- **Kind**: static property of [<code>color</code>](#properties.color)
185
- **Default**: <code>&quot;sg&quot;</code>
186
- <a name="properties.color.mode"></a>
187
-
188
- #### color.mode : <code>&#x27;primary&#x27;</code> \| <code>&#x27;byDimension&#x27;</code> \| <code>&#x27;byExpression&#x27;</code> \| <code>&#x27;byMeasure&#x27;</code> \| <code>&#x27;byMultiple&#x27;</code>
189
-
190
- Sets the coloring mode for the visualization when auto-coloring has been switched off (`"auto": false`). Can be one of:
191
-
192
- - `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.
193
- - `byDimension`: coloring is based upon the amount of dimension values. Details are set in the `"byDimDef"` property.
194
- !Note: `byDimension` can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.
195
-
196
- ```json
197
- {
198
- "qDef": {
199
- "qFieldDefs": ["NetScoreName"]
200
- },
201
- "qAttributeDimensions": [
202
- {
203
- "qDef": "NetScoreName",
204
- "id": "colorByAlternative",
205
- "label": "Year"
206
- }
207
- ]
208
- }
209
- ```
210
-
211
- - `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.
212
- - `byMeasure`: coloring is based on the measure value. Details are set in the `"byMeasureDef"` property.
213
- - `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.
214
-
215
- **Kind**: static property of [<code>color</code>](#properties.color)
216
- **Default**: <code>&quot;primary&quot;</code>
217
- <a name="properties.color.paletteColor"></a>
218
-
219
- #### color.paletteColor : [<code>paletteColor</code>](#paletteColor)
220
-
221
- The paletteColor object is used to define the color when you color by single color `("mode": "primary")`.
222
-
223
- **Kind**: static property of [<code>color</code>](#properties.color)
224
- **Default**: <code>{ index: 6 }</code>
225
- <a name="properties.color.persistent"></a>
226
-
227
- #### color.persistent : <code>boolean</code>
228
-
229
- Set to use persistent colors on data points between selections. Only applicable when using one dimension and when `"mode": "byDimension"` or when `"mode": "byMultiple"`.
230
-
231
- **Kind**: static property of [<code>color</code>](#properties.color)
232
- **Default**: <code>false</code>
233
- <a name="properties.color.reverseScheme"></a>
234
-
235
- #### color.reverseScheme : <code>boolean</code>
236
-
237
- Set to reverse the color scheme.
238
-
239
- **Kind**: static property of [<code>color</code>](#properties.color)
240
- **Default**: <code>false</code>
241
- <a name="properties.color.singleColor"></a>
242
-
243
- #### ~~color.singleColor : <code>number</code>~~
244
-
245
- **_Use `paletteColor` instead._**
246
-
247
- **Kind**: static property of [<code>color</code>](#properties.color)
248
- <a name="properties.color.useBaseColors"></a>
249
-
250
- #### color.useBaseColors : <code>&#x27;off&#x27;</code> \| <code>&#x27;dimension&#x27;</code> \| <code>&#x27;measure&#x27;</code>
251
-
252
- Use colors encoded in master items.
253
- Only applicable when `"mode": "primary"` or `"mode": "byMultiple"` has been defined.
254
-
255
- **Kind**: static property of [<code>color</code>](#properties.color)
256
- **Default**: <code>&quot;off&quot;</code>
257
- <a name="properties.color.useDimColVal"></a>
258
-
259
- #### color.useDimColVal : <code>boolean</code>
260
-
261
- Set to true if you want to apply the colors defined for library dimensions when used.
262
- Only applicable if `'colorMode': 'byDimension'`.
263
-
264
- **Kind**: static property of [<code>color</code>](#properties.color)
265
- **Default**: <code>true</code>
266
- <a name="properties.color.useMeasureGradient"></a>
267
-
268
- #### color.useMeasureGradient : <code>boolean</code>
269
-
270
- Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
271
-
272
- **Kind**: static property of [<code>color</code>](#properties.color)
273
- **Default**: <code>true</code>
274
- <a name="properties.dataPoint"></a>
275
-
276
- ### properties.dataPoint : <code>object</code>
277
-
278
- Data point settings.
279
-
280
- **Kind**: static property of [<code>properties</code>](#properties)
281
-
282
- - [.dataPoint](#properties.dataPoint) : <code>object</code>
283
- - [.auto](#properties.dataPoint.auto) : <code>boolean</code>
284
- - [.labelMode](#properties.dataPoint.labelMode) : <code>&#x27;none&#x27;</code> \| <code>&#x27;share&#x27;</code> \| <code>&#x27;value&#x27;</code>
285
-
286
- <a name="properties.dataPoint.auto"></a>
287
-
288
- #### dataPoint.auto : <code>boolean</code>
289
-
290
- Automatically select how to present data point values.
291
-
292
- **Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
293
- **Default**: <code>true</code>
294
- <a name="properties.dataPoint.labelMode"></a>
295
-
296
- #### dataPoint.labelMode : <code>&#x27;none&#x27;</code> \| <code>&#x27;share&#x27;</code> \| <code>&#x27;value&#x27;</code>
297
-
298
- Set how to present data point values. Dependent of the auto property
299
-
300
- **Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
301
- **Default**: <code>&quot;share&quot;</code>
302
- <a name="properties.footnote"></a>
303
-
304
- ### properties.footnote : <code>string</code> \| <code>StringExpression</code>
305
-
306
- Visualization footnote.
307
-
308
- **Kind**: static property of [<code>properties</code>](#properties)
309
- **Default**: <code>&quot;&quot;</code>
310
- <a name="properties.funnel"></a>
311
-
312
- ### properties.funnel : <code>object</code>
313
-
314
- Funnel settings
315
-
316
- **Kind**: static property of [<code>properties</code>](#properties)
317
- <a name="properties.funnel.mode"></a>
318
-
319
- #### funnel.mode : <code>&#x27;AREA&#x27;</code> \| <code>&#x27;HEIGHT&#x27;</code> \| <code>&#x27;WIDTH&#x27;</code> \| <code>&#x27;ORDER&#x27;</code>
320
-
321
- Funnel Mode
322
-
323
- **Kind**: static property of [<code>funnel</code>](#properties.funnel)
324
- **Default**: <code>&quot;WIDTH&quot;</code>
325
- <a name="properties.qHyperCubeDef"></a>
326
-
327
- ### properties.qHyperCubeDef ⇐ <code>HyperCubeDef</code>
328
-
329
- Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
330
-
331
- **Kind**: static property of [<code>properties</code>](#properties)
332
- **Extends**: <code>HyperCubeDef</code>
333
-
334
- - [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
335
- - [.qDimensions](#properties.qHyperCubeDef.qDimensions) : [<code>Array.&lt;DimensionProperties&gt;</code>](#DimensionProperties)
336
- - [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [<code>Array.&lt;MeasureProperties&gt;</code>](#MeasureProperties)
337
- - [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : <code>boolean</code>
338
- - [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : <code>boolean</code>
339
-
340
- <a name="properties.qHyperCubeDef.qDimensions"></a>
341
-
342
- #### qHyperCubeDef.qDimensions : [<code>Array.&lt;DimensionProperties&gt;</code>](#DimensionProperties)
343
-
344
- **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
345
- <a name="properties.qHyperCubeDef.qMeasures"></a>
346
-
347
- #### qHyperCubeDef.qMeasures : [<code>Array.&lt;MeasureProperties&gt;</code>](#MeasureProperties)
348
-
349
- **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
350
- <a name="properties.qHyperCubeDef.qSuppressMissing"></a>
351
-
352
- #### qHyperCubeDef.qSuppressMissing : <code>boolean</code>
353
-
354
- **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
355
- **Default**: <code>true</code>
356
- <a name="properties.qHyperCubeDef.qSuppressZero"></a>
357
-
358
- #### qHyperCubeDef.qSuppressZero : <code>boolean</code>
359
-
360
- **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
361
- **Default**: <code>false</code>
362
- <a name="properties.showDimensionTitle"></a>
363
-
364
- ### properties.showDimensionTitle : <code>boolean</code>
365
-
366
- Display the dimension title.
367
-
368
- **Kind**: static property of [<code>properties</code>](#properties)
369
- **Default**: <code>true</code>
370
- <a name="properties.showTitles"></a>
371
-
372
- ### properties.showTitles : <code>boolean</code>
373
-
374
- Show title for the visualization.
375
-
376
- **Kind**: static property of [<code>properties</code>](#properties)
377
- **Default**: <code>true</code>
378
- <a name="properties.subtitle"></a>
379
-
380
- ### properties.subtitle : <code>string</code> \| <code>StringExpression</code>
381
-
382
- Visualization subtitle.
383
-
384
- **Kind**: static property of [<code>properties</code>](#properties)
385
- **Default**: <code>&quot;&quot;</code>
386
- <a name="properties.title"></a>
387
-
388
- ### properties.title : <code>string</code> \| <code>StringExpression</code>
389
-
390
- Visualization title.
391
-
392
- **Kind**: static property of [<code>properties</code>](#properties)
393
- **Default**: <code>&quot;&quot;</code>
394
-
395
- # Definitions
package/api-specifications/plugins.md DELETED
@@ -1,90 +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
- - [.FILL](#pluginArguments.keys.SCALE.FILL) : <code>string</code>
8
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
9
- - [.FUNNEL](#pluginArguments.keys.COMPONENT.FUNNEL) : <code>string</code>
10
- - [.FUNNEL_LABELS](#pluginArguments.keys.COMPONENT.FUNNEL_LABELS) : <code>string</code>
11
- - [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
12
-
13
- ---
14
-
15
- <a name="pluginArguments.layout"></a>
16
-
17
- ### pluginArguments.layout : <code>object</code>
18
-
19
- The layout from the enigma model.
20
-
21
- **Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
22
- <a name="pluginArguments.keys"></a>
23
-
24
- ### pluginArguments.keys : <code>object</code>
25
-
26
- The keys (references) to different types of chart internals
27
-
28
- **Kind**: static property of [<code>pluginArguments</code>](#pluginArguments)
29
-
30
- - [.keys](#pluginArguments.keys) : <code>object</code>
31
- - [.SCALE](#pluginArguments.keys.SCALE) : <code>object</code>
32
- - [.FILL](#pluginArguments.keys.SCALE.FILL) : <code>string</code>
33
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
34
- - [.FUNNEL](#pluginArguments.keys.COMPONENT.FUNNEL) : <code>string</code>
35
- - [.FUNNEL_LABELS](#pluginArguments.keys.COMPONENT.FUNNEL_LABELS) : <code>string</code>
36
- - [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
37
-
38
- <a name="pluginArguments.keys.SCALE"></a>
39
-
40
- #### keys.SCALE : <code>object</code>
41
-
42
- The scales associated with the funnel chart.
43
- They are useful if you want to, via plugin, add a new component that
44
- uses the same scale as one of the measures.
45
-
46
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
47
- <a name="pluginArguments.keys.SCALE.FILL"></a>
48
-
49
- ##### SCALE.FILL : <code>string</code>
50
-
51
- The scale used for coloring the funnel segments
52
-
53
- **Kind**: static property of [<code>SCALE</code>](#pluginArguments.keys.SCALE)
54
- <a name="pluginArguments.keys.COMPONENT"></a>
55
-
56
- #### keys.COMPONENT : <code>object</code>
57
-
58
- The unique keys of the existing components available in the funnel chart.
59
- They are useful if you want to extend or override the existing components.
60
-
61
- **Kind**: static property of [<code>keys</code>](#pluginArguments.keys)
62
-
63
- - [.COMPONENT](#pluginArguments.keys.COMPONENT) : <code>object</code>
64
- - [.FUNNEL](#pluginArguments.keys.COMPONENT.FUNNEL) : <code>string</code>
65
- - [.FUNNEL_LABELS](#pluginArguments.keys.COMPONENT.FUNNEL_LABELS) : <code>string</code>
66
- - [.DIMENSION_TITLE](#pluginArguments.keys.COMPONENT.DIMENSION_TITLE) : <code>string</code>
67
-
68
- <a name="pluginArguments.keys.COMPONENT.FUNNEL"></a>
69
-
70
- ##### COMPONENT.FUNNEL : <code>string</code>
71
-
72
- The funnel component
73
-
74
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
75
- <a name="pluginArguments.keys.COMPONENT.FUNNEL_LABELS"></a>
76
-
77
- ##### COMPONENT.FUNNEL_LABELS : <code>string</code>
78
-
79
- The funnel labels component
80
-
81
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
82
- <a name="pluginArguments.keys.COMPONENT.DIMENSION_TITLE"></a>
83
-
84
- ##### COMPONENT.DIMENSION_TITLE : <code>string</code>
85
-
86
- The dimension title component
87
-
88
- **Kind**: static property of [<code>COMPONENT</code>](#pluginArguments.keys.COMPONENT)
89
-
90
- # Definitions