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