properties
namespaceProperties
color | Color settings.
Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting |
dimensionAxis | Dimension axis settings. |
footnote string
| StringExpression | Visualization footnote. |
gridLine | Grid lines settings. Used only when using commom axis. |
measureAxis | Measure axis settings. |
orientation default=vertical 'vertical'
| 'horizontal' | Orientation setting. If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right. |
qHyperCubeDef | Extends |
scrollbar default=bar 'bar'
| 'none' | Sets the style of the scroll bar |
scrollStartPos default=0 number | Scroll Alignment. If 0, then the scrollbar will start at the left/top of the chart, if 1 it starts at the right/bottom of the chart. Generally decides if the scroll starts at the beginning or end of the data |
showDetails default=true boolean | Show visualization details toggle |
showTitles default=true boolean | Show title for the visualization |
subtitle string
| StringExpression | Visualization subtitle. |
title string
| StringExpression | Visualization title. |
tooltip | Custom tooltip properties |
version string | Current version of this generic object definition |
type AttributeExpressionProperties
AttributeExpressions | CustomTooltipAttributesAttributeExpressions
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id string | If set to |
```json
"qAttributeExpressions": [{
"qExpression": "Avg(Sales)",
"qLibraryId: "",
"qAttribute: true,
"id": "bullet-target"
},
{
"qExpression: "Avg(Sales)/2",
"qLibraryId: "",
"qAttribute: true,
"id: "bullet-segment"
}]
```
conditionalColoringProperties
objectProperties
segments | No description |
```json
"segments": {
"limits": [
{
"gradient": false
}
],
"paletteColors": [
{
"color": "#bfbfbf",
"index": -1
},
{
"color": "#a5a5a5",
"index": -1
}
]
}
```
CustomTooltipAttributes
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id 'customTooltipTitle'
| 'customTooltipDescription'
| 'customTooltipExpression' | Indicates how the attribute expression will be interpreted by the chart.
|
```json
"qAttributeExpressions": [{
"qExpression": "",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 0,
"qFmt": "",
"qDec": "",
"qThou": "",
}
"qLabel": "custom title",
"qLabelExpression": "",
"id": "customTooltipTitle"
},
{
"qExpression": "avg(population)",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 0,
"qFmt": "",
"qDec": "",
"qThou": "",
}
"qLabel": "",
"qLabelExpression": "",
"id": "customTooltipDescription"
},
{
"qExpression": "",
"qLibraryId": "zpDNMcg",
"qAttribute": true,
"qNumFormat": {
"qType": "U",
"qnDec": 10,
"qUseThou": 0,
"qFmt": "",
"qDec": "",
"qThou": "",
}
"qLabel": "",
"qLabelExpression": "",
"id": "customTooltipExpression"
},
{
"qExpression": "sum(population)",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": {
"qType": "M",
"qnDec": 2,
"qUseThou": 0,
"qFmt": "$#,##0.00;-$#,##0.00",
"qDec": ".",
"qThou": ",",
}
"qLabel": "",
"qLabelExpression": "=avg(population)",
"id": "customTooltipExpression"
},
{
"qExpression": "'https://my_url/'+sum(population)",
"qLibraryId": "",
"qAttribute": true,
"qNumFormat": null,
"qLabel": "",
"qLabelExpression": "",
"cId": "generatedUniqueId",
"id": "customTooltipImages"
}]
```
DimensionProperties
objectExtends NxDimension
, see Engine API: NxDimension
.
Properties
qDef | Extends |
ImageComponent
objectImage component information structure.
Properties
cId string | Identifier of the image component - used as a link with an attribute expression |
ref string
| StringExpression
| MediaLibraryRef | The reference value of the image |
size string | Size as 'small','medium','large' or 'original' |
type string | Input type as 'url' or 'media library' |
InlineDimensionDef
objectExtends NxInlineDimensionDef
, see Engine API: NxInlineDimensionDef
.
Properties
othersLabel string
| StringExpression | No description |
autoSort boolean | Set to automatically sort the dimension. |
cId string | ID used by the Qlik Sense. Must be unique within the current chart. |
InlineMeasureDef
objectExtends NxInlineMeasureDef
, see Engine API: NxInlineMeasureDef
.
Properties
autoMinMax boolean | Default false. Set to true to custmize the ranges of measure. |
conditionalColoring | Information of how the segments |
isCustomFormatted boolean | Set to true to toggle off the default client formatting. |
max number
| ValueExpression | Set the max value of the range. |
min string | Set the min value of the range. |
minMax string | Set custom max/min. Default "min". Supported type are: 'min'|'max'|'minMax'. |
numFormatFromTemplate default=true boolean | When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date). |
othersLabel string
| StringExpression | No description |
useSegments boolean | Default false. Set to true to customize segment colors. |
autoSort boolean | Set to automatically sort the measure. |
cId string | ID used by the Qlik Sense. Must be unique within the current chart. |
limitsProperties
objectProperties
gradient boolean | Set gradient of the color. |
MasterVisualizationChart
objectChart component information structure.
Properties
object | Chart component information structure. |
style | Chart component information structure. |
MasterVisualizationChartObject
objectChart component information structure.
Properties
refId string | Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization |
MasterVisualizationChartStyle
objectChart component information structure.
Properties
size string | Input type as 'small' or 'medium' or 'large' |
MeasureProperties
objectExtends NxMeasure
, see Engine API: NxMeasure
.
Properties
qAttributeExpressions | No description |
qDef | Extends |
MediaLibraryRef
objectMedia Library Reference structure.
Properties
qStaticContentUrlDef object | Media library structure |
paletteColor
objectColor information structure. Holds the actual color and index in palette.
Properties
color string | Color as hex string (mandatory if index: -1) |
index number | Index in palette |
paletteColorsProperties
objectProperties
paletteColor | No description |
properties.dataPoint.showLabels
booleanShow labels on data points
properties.dataPoint.showSegmentLabels
booleanShow segment labels
properties.dataPoint.showTotalLabels
booleanShow total labels
qStaticContentUrlDef
objectMedia Library structure that will be evaluated by the engine.
Properties
qUrl string | Value of media library image |
segmentsProperties
objectProperties
limits | No description |
paletteColors | No description |