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 | - [.formatting](#properties.color.formatting)
|
15 | - [.numFormatFromTemplate](#properties.color.formatting.numFormatFromTemplate) : <code>boolean</code>
|
16 | - [.isCustomFormatted](#properties.color.formatting.isCustomFormatted) : <code>boolean</code>
|
17 | - [.measureMin](#properties.color.measureMin) : <code>ValueExpression</code>
|
18 | - [.measureMax](#properties.color.measureMax) : <code>ValueExpression</code>
|
19 | - [.measureScheme](#properties.color.measureScheme) : <code>'sg'</code> \| <code>'sc'</code> \| <code>'dg'</code> \| <code>'dc'</code>
|
20 | - [.mode](#properties.color.mode) : <code>'primary'</code> \| <code>'byDimension'</code> \| <code>'byExpression'</code> \| <code>'byMeasure'</code> \| <code>'byMultiple'</code>
|
21 | - [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
22 | - [.persistent](#properties.color.persistent) : <code>boolean</code>
|
23 | - [.reverseScheme](#properties.color.reverseScheme) : <code>boolean</code>
|
24 | - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
|
25 | - [.useBaseColors](#properties.color.useBaseColors) : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
|
26 | - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
|
27 | - [.useMeasureGradient](#properties.color.useMeasureGradient)
|
28 | - [.components](#properties.components) : [<code>Array.<Component></code>](#Component)
|
29 | - [.dataPoint](#properties.dataPoint) : <code>object</code>
|
30 | - [.auto](#properties.dataPoint.auto) : <code>boolean</code>
|
31 | - [.labelMode](#properties.dataPoint.labelMode) : <code>'none'</code> \| <code>'share'</code> \| <code>'value'</code>
|
32 | - [.labelValueMode](#properties.dataPoint.labelValueMode) : <code>'arc'</code> \| <code>'radius'</code>
|
33 | - [.dimensionTitle](#properties.dimensionTitle) : <code>boolean</code>
|
34 | - [.donut](#properties.donut) : <code>object</code>
|
35 | - [.showAsDonut](#properties.donut.showAsDonut) : <code>boolean</code>
|
36 | - [.footnote](#properties.footnote) : <code>string</code> \| <code>StringExpression</code>
|
37 | - [.legend](#properties.legend) : <code>object</code>
|
38 | - [.dock](#properties.legend.dock) : <code>'auto'</code> \| <code>'right'</code> \| <code>'left'</code> \| <code>'bottom'</code> \| <code>'top'</code>
|
39 | - [.show](#properties.legend.show) : <code>boolean</code>
|
40 | - [.showTitle](#properties.legend.showTitle) : <code>boolean</code>
|
41 | - [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
|
42 | - [.qDimensions](#properties.qHyperCubeDef.qDimensions) : [<code>Array.<DimensionProperties></code>](#DimensionProperties)
|
43 | - [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [<code>Array.<MeasureProperties></code>](#MeasureProperties)
|
44 | - [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : <code>boolean</code>
|
45 | - [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : <code>boolean</code>
|
46 | - [.showDetails](#properties.showDetails) : <code>boolean</code>
|
47 | - [.showDisclaimer](#properties.showDisclaimer) : <code>boolean</code>
|
48 | - [.showTitles](#properties.showTitles) : <code>boolean</code>
|
49 | - [.subtitle](#properties.subtitle) : <code>string</code> \| <code>StringExpression</code>
|
50 | - [.title](#properties.title) : <code>string</code> \| <code>StringExpression</code>
|
51 | - [.tooltip](#properties.tooltip) : <code>object</code>
|
52 | - [.auto](#properties.tooltip.auto) : <code>boolean</code>
|
53 | - [.hideBasic](#properties.tooltip.hideBasic) : <code>boolean</code>
|
54 | - [.data](#properties.tooltip.data) : <code>object</code>
|
55 | - [.qHyperCubeDef](#properties.tooltip.data.qHyperCubeDef) : <code>HyperCubeDef</code>
|
56 | - [.imageComponents](#properties.tooltip.imageComponents) : [<code>Array.<ImageComponent></code>](#ImageComponent)
|
57 |
|
58 | ---
|
59 |
|
60 | <a name="properties.version"></a>
|
61 |
|
62 | ### properties.version : <code>string</code>
|
63 |
|
64 | Current version of this generic object definition
|
65 |
|
66 | **Kind**: static property of [<code>properties</code>](#properties)
|
67 | <a name="properties.color"></a>
|
68 |
|
69 | ### properties.color : <code>object</code>
|
70 |
|
71 | Color settings.
|
72 | 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.
|
73 | If `"auto": true`, no other properties need to be defined in the color object.
|
74 | Note: Some of the color properties are depending on which theme is currently being used.
|
75 |
|
76 | **Kind**: static property of [<code>properties</code>](#properties)
|
77 |
|
78 | - [.color](#properties.color) : <code>object</code>
|
79 | - [.auto](#properties.color.auto) : <code>boolean</code>
|
80 | - [.autoMinMax](#properties.color.autoMinMax) : <code>boolean</code>
|
81 | - [.byDimDef](#properties.color.byDimDef) : [<code>byDimDef</code>](#byDimDef)
|
82 | - [.byMeasureDef](#properties.color.byMeasureDef) : [<code>byMeasureDef</code>](#byMeasureDef)
|
83 | - [.colorExpression](#properties.color.colorExpression) : <code>string</code>
|
84 | - [.dimensionScheme](#properties.color.dimensionScheme) : <code>string</code>
|
85 | - [.expressionIsColor](#properties.color.expressionIsColor) : <code>boolean</code>
|
86 | - [.expressionLabel](#properties.color.expressionLabel) : <code>string</code>
|
87 | - [.formatting](#properties.color.formatting)
|
88 | - [.numFormatFromTemplate](#properties.color.formatting.numFormatFromTemplate) : <code>boolean</code>
|
89 | - [.isCustomFormatted](#properties.color.formatting.isCustomFormatted) : <code>boolean</code>
|
90 | - [.measureMin](#properties.color.measureMin) : <code>ValueExpression</code>
|
91 | - [.measureMax](#properties.color.measureMax) : <code>ValueExpression</code>
|
92 | - [.measureScheme](#properties.color.measureScheme) : <code>'sg'</code> \| <code>'sc'</code> \| <code>'dg'</code> \| <code>'dc'</code>
|
93 | - [.mode](#properties.color.mode) : <code>'primary'</code> \| <code>'byDimension'</code> \| <code>'byExpression'</code> \| <code>'byMeasure'</code> \| <code>'byMultiple'</code>
|
94 | - [.paletteColor](#properties.color.paletteColor) : [<code>paletteColor</code>](#paletteColor)
|
95 | - [.persistent](#properties.color.persistent) : <code>boolean</code>
|
96 | - [.reverseScheme](#properties.color.reverseScheme) : <code>boolean</code>
|
97 | - ~~[.singleColor](#properties.color.singleColor) : <code>number</code>~~
|
98 | - [.useBaseColors](#properties.color.useBaseColors) : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
|
99 | - [.useDimColVal](#properties.color.useDimColVal) : <code>boolean</code>
|
100 | - [.useMeasureGradient](#properties.color.useMeasureGradient)
|
101 |
|
102 | <a name="properties.color.auto"></a>
|
103 |
|
104 | #### color.auto : <code>boolean</code>
|
105 |
|
106 | Set to use automatic coloring.
|
107 | When `"auto": true`, color settings are based on the visualization used and the number of dimensions
|
108 | and measures, that is, the settings are not fixed, but are dependent on the data input.
|
109 |
|
110 | **Kind**: static property of [<code>color</code>](#properties.color)
|
111 | **Default**: <code>true</code>
|
112 | <a name="properties.color.autoMinMax"></a>
|
113 |
|
114 | #### color.autoMinMax : <code>boolean</code>
|
115 |
|
116 | 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"`).
|
117 | When coloring is by expression, `"expressionIsColor": "false"` must be set for custom color range to work.
|
118 |
|
119 | **Kind**: static property of [<code>color</code>](#properties.color)
|
120 | **Default**: <code>true</code>
|
121 | <a name="properties.color.byDimDef"></a>
|
122 |
|
123 | #### color.byDimDef : [<code>byDimDef</code>](#byDimDef)
|
124 |
|
125 | **Kind**: static property of [<code>color</code>](#properties.color)
|
126 | **Default**: <code>undefined</code>
|
127 | <a name="properties.color.byMeasureDef"></a>
|
128 |
|
129 | #### color.byMeasureDef : [<code>byMeasureDef</code>](#byMeasureDef)
|
130 |
|
131 | **Kind**: static property of [<code>color</code>](#properties.color)
|
132 | **Default**: <code>undefined</code>
|
133 | <a name="properties.color.colorExpression"></a>
|
134 |
|
135 | #### color.colorExpression : <code>string</code>
|
136 |
|
137 | Sets the color expression to be used when `"mode": "byExpression"` is defined.
|
138 | Expression can evaluate either to a numerical value or a color code if `"expressionIsColor": true`.
|
139 | Supported formats are: `RGB`, `ARGB` and `HSL`
|
140 |
|
141 | **Kind**: static property of [<code>color</code>](#properties.color)
|
142 | **Default**: <code>"undefined"</code>
|
143 | **Example**
|
144 |
|
145 | ```js
|
146 | "colorExpression": "=if(sum(Sales)<avg(Total aggr(sum(Sales),Product)),rgb(255,0,0),RGB(0,255,0))"
|
147 | ```
|
148 |
|
149 | <a name="properties.color.dimensionScheme"></a>
|
150 |
|
151 | #### color.dimensionScheme : <code>string</code>
|
152 |
|
153 | Color scheme when `"mode": "byDimension"` or `"mode": "byMultiple"` (`"12"` or `"100"` for most themes).
|
154 |
|
155 | **Kind**: static property of [<code>color</code>](#properties.color)
|
156 | **Default**: <code>"12"</code>
|
157 | <a name="properties.color.expressionIsColor"></a>
|
158 |
|
159 | #### color.expressionIsColor : <code>boolean</code>
|
160 |
|
161 | Set to define whether the result of the expression is a valid CSS3 color.
|
162 | Only applicable when `"mode": "byExpression"`.
|
163 |
|
164 | **Kind**: static property of [<code>color</code>](#properties.color)
|
165 | **Default**: <code>true</code>
|
166 | <a name="properties.color.expressionLabel"></a>
|
167 |
|
168 | #### color.expressionLabel : <code>string</code>
|
169 |
|
170 | Label to be defined on tool tips when using a coloring expression.
|
171 | Only used if `"expressionIsColor": false`.
|
172 |
|
173 | **Kind**: static property of [<code>color</code>](#properties.color)
|
174 | **Default**: <code>""</code>
|
175 | <a name="properties.color.formatting"></a>
|
176 |
|
177 | #### color.formatting
|
178 |
|
179 | Color by measure number formatting options
|
180 |
|
181 | **Kind**: static property of [<code>color</code>](#properties.color)
|
182 |
|
183 | - [.formatting](#properties.color.formatting)
|
184 | - [.numFormatFromTemplate](#properties.color.formatting.numFormatFromTemplate) : <code>boolean</code>
|
185 | - [.isCustomFormatted](#properties.color.formatting.isCustomFormatted) : <code>boolean</code>
|
186 |
|
187 | <a name="properties.color.formatting.numFormatFromTemplate"></a>
|
188 |
|
189 | ##### formatting.numFormatFromTemplate : <code>boolean</code>
|
190 |
|
191 | When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).
|
192 |
|
193 | **Kind**: static property of [<code>formatting</code>](#properties.color.formatting)
|
194 | **Default**: <code>true</code>
|
195 | <a name="properties.color.formatting.isCustomFormatted"></a>
|
196 |
|
197 | ##### formatting.isCustomFormatted : <code>boolean</code>
|
198 |
|
199 | If true, the client formatting will be toggled off
|
200 |
|
201 | **Kind**: static property of [<code>formatting</code>](#properties.color.formatting)
|
202 | **Default**: <code>undefined</code>
|
203 | <a name="properties.color.measureMin"></a>
|
204 |
|
205 | #### color.measureMin : <code>ValueExpression</code>
|
206 |
|
207 | Set the min value for the color range.
|
208 | Only applicable if `"autoMinMax": false`.
|
209 |
|
210 | **Kind**: static property of [<code>color</code>](#properties.color)
|
211 | **Default**: <code>undefined</code>
|
212 | <a name="properties.color.measureMax"></a>
|
213 |
|
214 | #### color.measureMax : <code>ValueExpression</code>
|
215 |
|
216 | Set the max value for the color range.
|
217 | Only applicable if `"autoMinMax": false`.
|
218 |
|
219 | **Kind**: static property of [<code>color</code>](#properties.color)
|
220 | **Default**: <code>undefined</code>
|
221 | <a name="properties.color.measureScheme"></a>
|
222 |
|
223 | #### color.measureScheme : <code>'sg'</code> \| <code>'sc'</code> \| <code>'dg'</code> \| <code>'dc'</code>
|
224 |
|
225 | Color scheme when `"mode": "byMeasure"`. Can be one of:
|
226 |
|
227 | - `sg`: (sequential gradient) the transition between the different color groups is made using different shades of colors. High measure values have darker hues
|
228 | - `sc`: (sequential classes) the transition between the different color groups is made using distinctly different colors.
|
229 | - `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.
|
230 | - `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.
|
231 |
|
232 | **Kind**: static property of [<code>color</code>](#properties.color)
|
233 | **Default**: <code>"sg"</code>
|
234 | <a name="properties.color.mode"></a>
|
235 |
|
236 | #### color.mode : <code>'primary'</code> \| <code>'byDimension'</code> \| <code>'byExpression'</code> \| <code>'byMeasure'</code> \| <code>'byMultiple'</code>
|
237 |
|
238 | Sets the coloring mode for the visualization when auto-coloring has been switched off (`"auto": false`). Can be one of:
|
239 |
|
240 | - `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.
|
241 | - `byDimension`: coloring is based upon the amount of dimension values. Details are set in the `"byDimDef"` property.
|
242 | !Note: `byDimension` can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below.
|
243 |
|
244 | ```json
|
245 | {
|
246 | "qDef": {
|
247 | "qFieldDefs": ["NetScoreName"]
|
248 | },
|
249 | "qAttributeDimensions": [
|
250 | {
|
251 | "qDef": "NetScoreName",
|
252 | "id": "colorByAlternative",
|
253 | "label": "Year"
|
254 | }
|
255 | ]
|
256 | }
|
257 | ```
|
258 |
|
259 | - `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.
|
260 | - `byMeasure`: coloring is based on the measure value. Details are set in the `"byMeasureDef"` property.
|
261 | - `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.
|
262 |
|
263 | **Kind**: static property of [<code>color</code>](#properties.color)
|
264 | **Default**: <code>"primary"</code>
|
265 | <a name="properties.color.paletteColor"></a>
|
266 |
|
267 | #### color.paletteColor : [<code>paletteColor</code>](#paletteColor)
|
268 |
|
269 | The paletteColor object is used to define the color when you color by single color `("mode": "primary")`.
|
270 |
|
271 | **Kind**: static property of [<code>color</code>](#properties.color)
|
272 | **Default**: <code>{ index: 6 }</code>
|
273 | <a name="properties.color.persistent"></a>
|
274 |
|
275 | #### color.persistent : <code>boolean</code>
|
276 |
|
277 | Set to use persistent colors on data points between selections. Only applicable when using one dimension and when `"mode": "byDimension"` or when `"mode": "byMultiple"`.
|
278 |
|
279 | **Kind**: static property of [<code>color</code>](#properties.color)
|
280 | **Default**: <code>false</code>
|
281 | <a name="properties.color.reverseScheme"></a>
|
282 |
|
283 | #### color.reverseScheme : <code>boolean</code>
|
284 |
|
285 | Set to reverse the color scheme.
|
286 |
|
287 | **Kind**: static property of [<code>color</code>](#properties.color)
|
288 | **Default**: <code>false</code>
|
289 | <a name="properties.color.singleColor"></a>
|
290 |
|
291 | #### ~~color.singleColor : <code>number</code>~~
|
292 |
|
293 | **_Deprecated_**
|
294 |
|
295 | **Kind**: static property of [<code>color</code>](#properties.color)
|
296 | <a name="properties.color.useBaseColors"></a>
|
297 |
|
298 | #### color.useBaseColors : <code>'off'</code> \| <code>'dimension'</code> \| <code>'measure'</code>
|
299 |
|
300 | Use colors encoded in master items.
|
301 | Only applicable when `"mode": "primary"` or `"mode": "byMultiple"` has been defined.
|
302 |
|
303 | **Kind**: static property of [<code>color</code>](#properties.color)
|
304 | **Default**: <code>"off"</code>
|
305 | <a name="properties.color.useDimColVal"></a>
|
306 |
|
307 | #### color.useDimColVal : <code>boolean</code>
|
308 |
|
309 | Set to true if you want to apply the colors defined for library dimensions when used.
|
310 | Only applicable if `'colorMode': 'byDimension'`.
|
311 |
|
312 | **Kind**: static property of [<code>color</code>](#properties.color)
|
313 | **Default**: <code>true</code>
|
314 | <a name="properties.color.useMeasureGradient"></a>
|
315 |
|
316 | #### color.useMeasureGradient
|
317 |
|
318 | Set to true if you want to apply the colors defined for library measures when used. Only applicable if `"mode": "byMeasure"`.
|
319 |
|
320 | **Kind**: static property of [<code>color</code>](#properties.color)
|
321 | **Default**: <code>true</code>
|
322 | <a name="properties.components"></a>
|
323 |
|
324 | ### properties.components : [<code>Array.<Component></code>](#Component)
|
325 |
|
326 | Styling of chart components.
|
327 |
|
328 | **Kind**: static property of [<code>properties</code>](#properties)
|
329 | <a name="properties.dataPoint"></a>
|
330 |
|
331 | ### properties.dataPoint : <code>object</code>
|
332 |
|
333 | Data point settings.
|
334 |
|
335 | **Kind**: static property of [<code>properties</code>](#properties)
|
336 |
|
337 | - [.dataPoint](#properties.dataPoint) : <code>object</code>
|
338 | - [.auto](#properties.dataPoint.auto) : <code>boolean</code>
|
339 | - [.labelMode](#properties.dataPoint.labelMode) : <code>'none'</code> \| <code>'share'</code> \| <code>'value'</code>
|
340 | - [.labelValueMode](#properties.dataPoint.labelValueMode) : <code>'arc'</code> \| <code>'radius'</code>
|
341 |
|
342 | <a name="properties.dataPoint.auto"></a>
|
343 |
|
344 | #### dataPoint.auto : <code>boolean</code>
|
345 |
|
346 | Automatically select how to present data point values.
|
347 |
|
348 | **Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
|
349 | **Default**: <code>true</code>
|
350 | <a name="properties.dataPoint.labelMode"></a>
|
351 |
|
352 | #### dataPoint.labelMode : <code>'none'</code> \| <code>'share'</code> \| <code>'value'</code>
|
353 |
|
354 | Set how to present data point values. Dependent of the auto property
|
355 |
|
356 | **Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
|
357 | **Default**: <code>"share"</code>
|
358 | <a name="properties.dataPoint.labelValueMode"></a>
|
359 |
|
360 | #### dataPoint.labelValueMode : <code>'arc'</code> \| <code>'radius'</code>
|
361 |
|
362 | Set how to present data point values. Dependent of the auto property
|
363 |
|
364 | **Kind**: static property of [<code>dataPoint</code>](#properties.dataPoint)
|
365 | **Default**: <code>"arc"</code>
|
366 | <a name="properties.dimensionTitle"></a>
|
367 |
|
368 | ### properties.dimensionTitle : <code>boolean</code>
|
369 |
|
370 | Display the dimension title.
|
371 |
|
372 | **Kind**: static property of [<code>properties</code>](#properties)
|
373 | **Default**: <code>true</code>
|
374 | <a name="properties.donut"></a>
|
375 |
|
376 | ### properties.donut : <code>object</code>
|
377 |
|
378 | Pie chart donut settings.
|
379 |
|
380 | **Kind**: static property of [<code>properties</code>](#properties)
|
381 | <a name="properties.donut.showAsDonut"></a>
|
382 |
|
383 | #### donut.showAsDonut : <code>boolean</code>
|
384 |
|
385 | Set to present the pie chart as a donut.
|
386 |
|
387 | **Kind**: static property of [<code>donut</code>](#properties.donut)
|
388 | **Default**: <code>false</code>
|
389 | <a name="properties.footnote"></a>
|
390 |
|
391 | ### properties.footnote : <code>string</code> \| <code>StringExpression</code>
|
392 |
|
393 | Visualization footnote.
|
394 |
|
395 | **Kind**: static property of [<code>properties</code>](#properties)
|
396 | **Default**: <code>""</code>
|
397 | <a name="properties.legend"></a>
|
398 |
|
399 | ### properties.legend : <code>object</code>
|
400 |
|
401 | Legend settings.
|
402 |
|
403 | **Kind**: static property of [<code>properties</code>](#properties)
|
404 |
|
405 | - [.legend](#properties.legend) : <code>object</code>
|
406 | - [.dock](#properties.legend.dock) : <code>'auto'</code> \| <code>'right'</code> \| <code>'left'</code> \| <code>'bottom'</code> \| <code>'top'</code>
|
407 | - [.show](#properties.legend.show) : <code>boolean</code>
|
408 | - [.showTitle](#properties.legend.showTitle) : <code>boolean</code>
|
409 |
|
410 | <a name="properties.legend.dock"></a>
|
411 |
|
412 | #### legend.dock : <code>'auto'</code> \| <code>'right'</code> \| <code>'left'</code> \| <code>'bottom'</code> \| <code>'top'</code>
|
413 |
|
414 | Sets the legend position.
|
415 |
|
416 | **Kind**: static property of [<code>legend</code>](#properties.legend)
|
417 | **Default**: <code>"auto"</code>
|
418 | <a name="properties.legend.show"></a>
|
419 |
|
420 | #### legend.show : <code>boolean</code>
|
421 |
|
422 | Set to show the legend.
|
423 |
|
424 | **Kind**: static property of [<code>legend</code>](#properties.legend)
|
425 | **Default**: <code>true</code>
|
426 | <a name="properties.legend.showTitle"></a>
|
427 |
|
428 | #### legend.showTitle : <code>boolean</code>
|
429 |
|
430 | Show the legend title.
|
431 |
|
432 | **Kind**: static property of [<code>legend</code>](#properties.legend)
|
433 | **Default**: <code>true</code>
|
434 | <a name="properties.qHyperCubeDef"></a>
|
435 |
|
436 | ### properties.qHyperCubeDef ⇐ <code>HyperCubeDef</code>
|
437 |
|
438 | Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
|
439 |
|
440 | **Kind**: static property of [<code>properties</code>](#properties)
|
441 | **Extends**: <code>HyperCubeDef</code>
|
442 |
|
443 | - [.qHyperCubeDef](#properties.qHyperCubeDef) ⇐ <code>HyperCubeDef</code>
|
444 | - [.qDimensions](#properties.qHyperCubeDef.qDimensions) : [<code>Array.<DimensionProperties></code>](#DimensionProperties)
|
445 | - [.qMeasures](#properties.qHyperCubeDef.qMeasures) : [<code>Array.<MeasureProperties></code>](#MeasureProperties)
|
446 | - [.qSuppressMissing](#properties.qHyperCubeDef.qSuppressMissing) : <code>boolean</code>
|
447 | - [.qSuppressZero](#properties.qHyperCubeDef.qSuppressZero) : <code>boolean</code>
|
448 |
|
449 | <a name="properties.qHyperCubeDef.qDimensions"></a>
|
450 |
|
451 | #### qHyperCubeDef.qDimensions : [<code>Array.<DimensionProperties></code>](#DimensionProperties)
|
452 |
|
453 | **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
|
454 | <a name="properties.qHyperCubeDef.qMeasures"></a>
|
455 |
|
456 | #### qHyperCubeDef.qMeasures : [<code>Array.<MeasureProperties></code>](#MeasureProperties)
|
457 |
|
458 | **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
|
459 | <a name="properties.qHyperCubeDef.qSuppressMissing"></a>
|
460 |
|
461 | #### qHyperCubeDef.qSuppressMissing : <code>boolean</code>
|
462 |
|
463 | **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
|
464 | **Default**: <code>true</code>
|
465 | <a name="properties.qHyperCubeDef.qSuppressZero"></a>
|
466 |
|
467 | #### qHyperCubeDef.qSuppressZero : <code>boolean</code>
|
468 |
|
469 | **Kind**: static property of [<code>qHyperCubeDef</code>](#properties.qHyperCubeDef)
|
470 | **Default**: <code>false</code>
|
471 | <a name="properties.showDetails"></a>
|
472 |
|
473 | ### properties.showDetails : <code>boolean</code>
|
474 |
|
475 | Show visualization details toggle
|
476 |
|
477 | **Kind**: static property of [<code>properties</code>](#properties)
|
478 | **Default**: <code>false</code>
|
479 | <a name="properties.showDisclaimer"></a>
|
480 |
|
481 | ### properties.showDisclaimer : <code>boolean</code>
|
482 |
|
483 | Show visualization disclaimer toggle
|
484 |
|
485 | **Kind**: static property of [<code>properties</code>](#properties)
|
486 | **Default**: <code>true</code>
|
487 | <a name="properties.showTitles"></a>
|
488 |
|
489 | ### properties.showTitles : <code>boolean</code>
|
490 |
|
491 | Show title for the visualization.
|
492 |
|
493 | **Kind**: static property of [<code>properties</code>](#properties)
|
494 | **Default**: <code>true</code>
|
495 | <a name="properties.subtitle"></a>
|
496 |
|
497 | ### properties.subtitle : <code>string</code> \| <code>StringExpression</code>
|
498 |
|
499 | Visualization subtitle.
|
500 |
|
501 | **Kind**: static property of [<code>properties</code>](#properties)
|
502 | **Default**: <code>""</code>
|
503 | <a name="properties.title"></a>
|
504 |
|
505 | ### properties.title : <code>string</code> \| <code>StringExpression</code>
|
506 |
|
507 | Visualization title.
|
508 |
|
509 | **Kind**: static property of [<code>properties</code>](#properties)
|
510 | **Default**: <code>""</code>
|
511 | <a name="properties.tooltip"></a>
|
512 |
|
513 | ### properties.tooltip : <code>object</code>
|
514 |
|
515 | Custom tooltip properties
|
516 |
|
517 | **Kind**: static property of [<code>properties</code>](#properties)
|
518 |
|
519 | - [.tooltip](#properties.tooltip) : <code>object</code>
|
520 | - [.auto](#properties.tooltip.auto) : <code>boolean</code>
|
521 | - [.hideBasic](#properties.tooltip.hideBasic) : <code>boolean</code>
|
522 | - [.data](#properties.tooltip.data) : <code>object</code>
|
523 | - [.qHyperCubeDef](#properties.tooltip.data.qHyperCubeDef) : <code>HyperCubeDef</code>
|
524 | - [.imageComponents](#properties.tooltip.imageComponents) : [<code>Array.<ImageComponent></code>](#ImageComponent)
|
525 |
|
526 | <a name="properties.tooltip.auto"></a>
|
527 |
|
528 | #### tooltip.auto : <code>boolean</code>
|
529 |
|
530 | Toggle for using custom tooltip or regular tooltip
|
531 |
|
532 | **Kind**: static property of [<code>tooltip</code>](#properties.tooltip)
|
533 | **Default**: <code>true</code>
|
534 | <a name="properties.tooltip.hideBasic"></a>
|
535 |
|
536 | #### tooltip.hideBasic : <code>boolean</code>
|
537 |
|
538 | Toggle for hiding basic information from custom tooltip
|
539 |
|
540 | **Kind**: static property of [<code>tooltip</code>](#properties.tooltip)
|
541 | **Default**: <code>false</code>
|
542 | <a name="properties.tooltip.data"></a>
|
543 |
|
544 | #### tooltip.data : <code>object</code>
|
545 |
|
546 | Data for the custom tooltip.
|
547 |
|
548 | **Kind**: static property of [<code>tooltip</code>](#properties.tooltip)
|
549 | <a name="properties.tooltip.data.qHyperCubeDef"></a>
|
550 |
|
551 | ##### data.qHyperCubeDef : <code>HyperCubeDef</code>
|
552 |
|
553 | A hypercube definition containing measures to be displayed in the custom tooltip.
|
554 | Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.
|
555 |
|
556 | **Kind**: static property of [<code>data</code>](#properties.tooltip.data)
|
557 | **Default**: <code>undefined</code>
|
558 | <a name="properties.tooltip.imageComponents"></a>
|
559 |
|
560 | #### tooltip.imageComponents : [<code>Array.<ImageComponent></code>](#ImageComponent)
|
561 |
|
562 | The imageComponents objects are used to define the images displayed by the custom tooltip.
|
563 |
|
564 | **Kind**: static property of [<code>tooltip</code>](#properties.tooltip)
|
565 | **Default**: <code>undefined</code>
|
566 |
|
567 | # Definitions
|
568 |
|
569 | <a name="paletteColor"></a>
|
570 |
|
571 | ## paletteColor : <code>object</code>
|
572 |
|
573 | Color information structure. Holds the actual color and index in palette.
|
574 |
|
575 | **Kind**: global typedef
|
576 | **Properties**
|
577 |
|
578 | | Name | Type | Description |
|
579 | | ----- | ------------------- | -------------------------------------------- |
|
580 | | color | <code>string</code> | Color as hex string (mandatory if index: -1) |
|
581 | | index | <code>number</code> | Index in palette |
|
582 |
|
583 | <a name="Component"></a>
|
584 |
|
585 | ## Component : [<code>Slices</code>](#Slices)
|
586 |
|
587 | **Kind**: global typedef
|
588 | <a name="Slices"></a>
|
589 |
|
590 | ## Slices : <code>object</code>
|
591 |
|
592 | **Kind**: global typedef
|
593 | **Properties**
|
594 |
|
595 | | Name | Type | Description |
|
596 | | ----- | -------------------------------------------- | ------------------------------------------------------------------------------------ |
|
597 | | key | <code>string</code> | This should be set to `"slices"` (Determines which component the settings apply to). |
|
598 | | style | [<code>SlicesStyling</code>](#SlicesStyling) | |
|
599 |
|
600 | <a name="SlicesStyling"></a>
|
601 |
|
602 | ## SlicesStyling : <code>object</code>
|
603 |
|
604 | **Kind**: global typedef
|
605 | **Properties**
|
606 |
|
607 | | Name | Type | Default | Description |
|
608 | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | --------------------------------------------------------------------------- |
|
609 | | strokeColor | [<code>paletteColor</code>](#paletteColor) | <code>"{</code> | index: -1, color: '#ffffff' }" |
|
610 | | strokeWidth | <code>'none'</code> \| <code>'small'</code> \| <code>'medium'</code> \| <code>'large'</code> | <code>'none'</code> | Set to specify stroke width. |
|
611 | | cornerRadius | <code>number</code> | <code>0</code> | A number between 0 and 40. |
|
612 | | innerRadius | <code>number</code> | <code>0.55</code> | A number between 0.05 and 0.75. Only applicable for "donut" representation. |
|
613 |
|
614 | <a name="byDimDef"></a>
|
615 |
|
616 | ## byDimDef : <code>object</code>
|
617 |
|
618 | Settings when coloring by dimension (`"mode": "byDimension"`)
|
619 |
|
620 | **Kind**: global typedef
|
621 | **Properties**
|
622 |
|
623 | | Name | Type | Description |
|
624 | | ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
625 | | key | <code>string</code> | libraryId if `"type": "libraryItem"`, dimension expression if `"type": "expression"` |
|
626 | | label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
|
627 | | type | <code>'expression'</code> \| <code>'libraryItem'</code> | |
|
628 |
|
629 | <a name="byMeasureDef"></a>
|
630 |
|
631 | ## byMeasureDef : <code>object</code>
|
632 |
|
633 | Settings when coloring by measure (`"mode": "byMeasure"`)
|
634 |
|
635 | **Kind**: global typedef
|
636 | **Properties**
|
637 |
|
638 | | Name | Type | Description |
|
639 | | ----- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
640 | | key | <code>string</code> | libraryId if `"type": "libraryItem"`, measure expression if `"type": "expression"` |
|
641 | | label | <code>string</code> | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
|
642 | | type | <code>'expression'</code> \| <code>'libraryItem'</code> | |
|
643 |
|
644 | <a name="DimensionProperties"></a>
|
645 |
|
646 | ## DimensionProperties : <code>object</code>
|
647 |
|
648 | Extends `NxDimension`, see Engine API: `NxDimension`.
|
649 |
|
650 | **Kind**: global typedef
|
651 | **Extends**: <code>NxDimension</code>
|
652 | **Properties**
|
653 |
|
654 | | Name | Type |
|
655 | | -------------------- | ---------------------------------------------------------------------------------------- |
|
656 | | qAttributeDimensions | [<code>Array.<AttributeDimensionProperties></code>](#AttributeDimensionProperties) |
|
657 | | qDef | [<code>InlineDimensionDef</code>](#InlineDimensionDef) |
|
658 |
|
659 | <a name="InlineDimensionDef"></a>
|
660 |
|
661 | ## InlineDimensionDef : <code>object</code>
|
662 |
|
663 | Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.
|
664 |
|
665 | **Kind**: global typedef
|
666 | **Extends**: <code>NxInlineDimensionDef</code>
|
667 | **Properties**
|
668 |
|
669 | | Name | Type | Description |
|
670 | | ----------- | ---------------------------------------------------- | ------------------------------------------------------------------- |
|
671 | | [autoSort] | <code>boolean</code> | Set to automatically sort the dimension. |
|
672 | | [cId] | <code>string</code> | ID used by the Qlik Sense. Must be unique within the current chart. |
|
673 | | othersLabel | <code>string</code> \| <code>StringExpression</code> | |
|
674 |
|
675 | <a name="MeasureProperties"></a>
|
676 |
|
677 | ## MeasureProperties : <code>object</code>
|
678 |
|
679 | Extends `NxMeasure`, see Engine API: `NxMeasure`.
|
680 |
|
681 | **Kind**: global typedef
|
682 | **Extends**: <code>NxMeasure</code>
|
683 | **Properties**
|
684 |
|
685 | | Name | Type |
|
686 | | --------------------- | ------------------------------------------------------------------------------------------ |
|
687 | | qAttributeExpressions | [<code>Array.<AttributeExpressionProperties></code>](#AttributeExpressionProperties) |
|
688 | | qDef | [<code>InlineMeasureDef</code>](#InlineMeasureDef) |
|
689 |
|
690 | <a name="InlineMeasureDef"></a>
|
691 |
|
692 | ## InlineMeasureDef : <code>object</code>
|
693 |
|
694 | Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.
|
695 |
|
696 | **Kind**: global typedef
|
697 | **Extends**: <code>NxInlineMeasureDef</code>
|
698 | **Properties**
|
699 |
|
700 | | Name | Type | Default | Description |
|
701 | | --------------------- | ---------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
702 | | [autoSort] | <code>boolean</code> | | Set to automatically sort the measure. |
|
703 | | [cId] | <code>string</code> | | ID used by the Qlik Sense. Must be unique within the current chart. |
|
704 | | isCustomFormatted | <code>boolean</code> | | Set to true to toggle off the default client formatting. |
|
705 | | numFormatFromTemplate | <code>boolean</code> | <code>true</code> | When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date). |
|
706 | | othersLabel | <code>string</code> \| <code>StringExpression</code> | | |
|
707 |
|
708 | <a name="AttributeDimensionProperties"></a>
|
709 |
|
710 | ## AttributeDimensionProperties : <code>object</code>
|
711 |
|
712 | Extends `NxAttrDimDef`, see Engine API: `NxAttrDimDef`.
|
713 |
|
714 | **Kind**: global typedef
|
715 | **Extends**: <code>NxAttrDimDef</code>
|
716 | **Properties**
|
717 |
|
718 | | Name | Type | Description |
|
719 | | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
720 | | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension") or `colorByExpression` together with color.mode="byExpression". |
|
721 |
|
722 | <a name="AttributeExpressionProperties"></a>
|
723 |
|
724 | ## AttributeExpressionProperties : [<code>ColorAttributes</code>](#ColorAttributes) \| [<code>CustomTooltipAttributes</code>](#CustomTooltipAttributes)
|
725 |
|
726 | **Kind**: global typedef
|
727 | <a name="ColorAttributes"></a>
|
728 |
|
729 | ## ColorAttributes : <code>object</code>
|
730 |
|
731 | Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
|
732 |
|
733 | **Kind**: global typedef
|
734 | **Extends**: <code>NxAttrExprDef</code>
|
735 | **Properties**
|
736 |
|
737 | | Name | Type | Description |
|
738 | | ---- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
739 | | id | <code>string</code> | One of: `colorByAlternative`: colors the chart using different dimensions (can be used together with color.mode="byDimension") or `colorByExpression` together with color.mode="byExpression". |
|
740 |
|
741 | <a name="CustomTooltipAttributes"></a>
|
742 |
|
743 | ## CustomTooltipAttributes : <code>object</code>
|
744 |
|
745 | Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.
|
746 |
|
747 | **Kind**: global typedef
|
748 | **Extends**: <code>NxAttrExprDef</code>
|
749 | **Properties**
|
750 |
|
751 | | Name | Type | Description |
|
752 | | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
753 | | id | <code>'customTooltipTitle'</code> \| <code>'customTooltipDescription'</code> \| <code>'customTooltipExpression'</code> | Indicates how the attribute expression will be interpreted by the chart. `customTooltipTitle`: additional title displayed on the custom tooltip `customTooltipDescription`: description displayed on the custom tooltip `customTooltipExpression`: measures displayed on the custom tooltip |
|
754 |
|
755 | **Example**
|
756 |
|
757 | ```json
|
758 | "qAttributeExpressions": [{
|
759 | "qExpression": "",
|
760 | "qLibraryId": "",
|
761 | "qAttribute": true,
|
762 | "qNumFormat": {
|
763 | "qType": "U",
|
764 | "qnDec": 10,
|
765 | "qUseThou": 0,
|
766 | "qFmt": "",
|
767 | "qDec": "",
|
768 | "qThou": "",
|
769 | }
|
770 | "qLabel": "custom title",
|
771 | "qLabelExpression": "",
|
772 | "id": "customTooltipTitle"
|
773 | },
|
774 | {
|
775 | "qExpression": "avg(population)",
|
776 | "qLibraryId": "",
|
777 | "qAttribute": true,
|
778 | "qNumFormat": {
|
779 | "qType": "U",
|
780 | "qnDec": 10,
|
781 | "qUseThou": 0,
|
782 | "qFmt": "",
|
783 | "qDec": "",
|
784 | "qThou": "",
|
785 | }
|
786 | "qLabel": "",
|
787 | "qLabelExpression": "",
|
788 | "id": "customTooltipDescription"
|
789 | },
|
790 | {
|
791 | "qExpression": "",
|
792 | "qLibraryId": "zpDNMcg",
|
793 | "qAttribute": true,
|
794 | "qNumFormat": {
|
795 | "qType": "U",
|
796 | "qnDec": 10,
|
797 | "qUseThou": 0,
|
798 | "qFmt": "",
|
799 | "qDec": "",
|
800 | "qThou": "",
|
801 | }
|
802 | "qLabel": "",
|
803 | "qLabelExpression": "",
|
804 | "id": "customTooltipExpression"
|
805 | },
|
806 | {
|
807 | "qExpression": "sum(population)",
|
808 | "qLibraryId": "",
|
809 | "qAttribute": true,
|
810 | "qNumFormat": {
|
811 | "qType": "M",
|
812 | "qnDec": 2,
|
813 | "qUseThou": 0,
|
814 | "qFmt": "$#,##0.00;-$#,##0.00",
|
815 | "qDec": ".",
|
816 | "qThou": ",",
|
817 | }
|
818 | "qLabel": "",
|
819 | "qLabelExpression": "=avg(population)",
|
820 | "id": "customTooltipExpression"
|
821 | },
|
822 | {
|
823 | "qExpression": "'https://my_url/'+sum(population)",
|
824 | "qLibraryId": "",
|
825 | "qAttribute": true,
|
826 | "qNumFormat": null,
|
827 | "qLabel": "",
|
828 | "qLabelExpression": "",
|
829 | "cId": "generatedUniqueId",
|
830 | "id": "customTooltipImages"
|
831 | }]
|
832 | ```
|
833 |
|
834 | <a name="ImageComponent"></a>
|
835 |
|
836 | ## ImageComponent : <code>object</code>
|
837 |
|
838 | Image component information structure.
|
839 |
|
840 | **Kind**: global typedef
|
841 | **Properties**
|
842 |
|
843 | | Name | Type | Description |
|
844 | | ---- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
845 | | type | <code>string</code> | Input type as 'url' or 'media library' |
|
846 | | size | <code>string</code> | Size as 'small','medium','large' or 'original' |
|
847 | | cId | <code>string</code> | Identifier of the image component - used as a link with an attribute expression |
|
848 | | ref | <code>string</code> \| <code>StringExpression</code> \| [<code>MediaLibraryRef</code>](#MediaLibraryRef) | The reference value of the image |
|
849 |
|
850 | <a name="MediaLibraryRef"></a>
|
851 |
|
852 | ## MediaLibraryRef : <code>object</code>
|
853 |
|
854 | Media Library Reference structure.
|
855 |
|
856 | **Kind**: global typedef
|
857 | **Properties**
|
858 |
|
859 | | Name | Type | Description |
|
860 | | -------------------- | ------------------- | ----------------------- |
|
861 | | qStaticContentUrlDef | <code>object</code> | Media library structure |
|
862 |
|
863 | <a name="qStaticContentUrlDef"></a>
|
864 |
|
865 | ## qStaticContentUrlDef : <code>object</code>
|
866 |
|
867 | Media Library structure that will be evaluated by the engine.
|
868 |
|
869 | **Kind**: global typedef
|
870 | **Properties**
|
871 |
|
872 | | Name | Type | Description |
|
873 | | ---- | ------------------- | ---------------------------- |
|
874 | | qUrl | <code>string</code> | Value of media library image |
|