properties
namespaceProperties
barGrouping | Bar grouping. |
color | Color settings.
Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting |
components | Styling of chart components. |
dataPoint | Data point settings. |
dimensionAxis | Dimension axis settings. |
footnote optional string | StringExpression | Visualization footnote. |
gridLine | Grid lines settings. |
legend | Legend settings. |
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. |
preferContinuousAxis default=true boolean | Chart axis setting to control preference of scale on a dimensional axis. If true, the scale along the dimensional axis will be continuous if the data supports it, discrete otherwise. |
qHyperCubeDef | Extends |
refLine | Reference lines settings |
scrollbar default=miniChart 'bar' | 'miniChart' | '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 optional, default=true boolean | Show visualization details toggle |
showDisclaimer default=true boolean | Show visualization disclaimer toggle |
showMiniChartForContinuousAxis default=true boolean | Chart axis setting to turn on/off the mini chart for continuous axis. |
showTitles optional, default=true boolean | Show title for the visualization |
subtitle optional string | StringExpression | Visualization subtitle. |
title optional string | StringExpression | Visualization title. |
tooltip | Custom tooltip properties |
version string | Current version of this generic object definition |
Accumulation
objectIt allows you to accumulate values of your measure over one or two dimensions.
Properties
fullAccumulation boolean | Select whether the accumulation will happen on the Full range or Custom range. |
showExcludedValues boolean | Shows the excluded values (values not in the current selection) in the accumulation. |
type string | This should be set to |
accumulationDimension: optional number | Only applicable when there are two dimensions. Selects the dimension on which the accumulation will take place. If the accumulation is made across multiple dimensions, this will be the first dimension. |
crossAllDimensions optional boolean | Only applicable when there are two dimensions. Continues accumulation across both dimensions. |
disabled optional boolean | No description |
steps optional number | Only applicable when |
AttributeDimensionProperties
objectExtends NxAttrDimDef
, see Engine API: NxAttrDimDef
.
Properties
id string | One of: |
type AttributeExpressionProperties
ColorAttributes | CustomTooltipAttributesBar
objectProperties
key string | This should be set to |
style | No description |
BarStyling
objectProperties
strokeColor | Color information structure. Holds the actual color and index in palette. |
strokeWidth default='none' 'none' | 'small' | 'medium' | 'large' | Set to specify stroke width. |
width number | A number greater than 0 and less than or equal to 1. |
byDimDef
objectSettings when coloring by dimension ("mode": "byDimension"
)
Properties
key string | libraryId if |
label string | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
type 'expression' | 'libraryItem' | No description |
byMeasureDef
objectSettings when coloring by measure ("mode": "byMeasure"
)
Properties
key string | libraryId if |
label string | Label displayed for coloring (in legend and tooltip for instance). String or expression. Not used when coloring by library items. |
type 'expression' | 'libraryItem' | No description |
ColorAttributes
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id string | One of: |
CustomTooltipAttributes
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id 'customTooltipTitle' | 'customTooltipDescription' | 'customTooltipExpression' | 'customTooltipImages' | 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"
}]
```
Difference
objectProperties
showExcludedValues boolean | Shows the excluded values (values not in the current selection) in the difference. |
type string | This should be set to |
accumulationDimension: optional number | Only applicable when there are two dimensions. Selects the dimension on which the difference will take place. If the difference is made across multiple dimensions, this will be the first dimension. |
crossAllDimensions optional boolean | Only applicable when there are two dimensions. Continues the difference across both dimensions. |
disabled optional boolean | No description |
DimensionProperties
objectExtends NxDimension
, see Engine API: NxDimension
.
Properties
qAttributeDimensions | No description |
qDef | Extends |
dimRefLine
objectProperties
label string | Reference line label. |
paletteColor | Color information structure. Holds the actual color and index in palette. |
refLineExpr | No description |
show default=true boolean | ValueExpression | Set to true to display this reference line. |
align optional, default='center' 'start' | 'center' | 'end' | Set alignment for this reference line |
coloredBackground optional, default=false boolean | Set to true to fill the label and/or value of this reference line with this color |
showLabel optional, default=true boolean | Set to true to show the label of this reference line. |
showValue optional, default=true boolean | Set to true to show the value of this reference line. |
style optional | Styling settings for reference line |
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 optional boolean | Set to automatically sort the dimension. |
cId optional string | ID used by the Qlik Sense. Must be unique within the current chart. |
InlineMeasureDef
objectExtends NxInlineMeasureDef
, see Engine API: NxInlineMeasureDef
.
Properties
isCustomFormatted boolean | Set to true to toggle off the default client formatting. |
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 |
autoSort optional boolean | Set to automatically sort the measure. |
cId optional string | ID used by the Qlik Sense. Must be unique within the current chart. |
modifiers optional Array<Modifier> | Set to apply a modifier to a measure. |
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 |
type Modifier
Accumulation | Difference | MovingAverageMovingAverage
objectProperties
fullRange boolean | Select whether the moving average will happen on the Full range or Custom range. |
nullSuppression boolean | Choose to have null values calculated by the moving average modifier. |
showExcludedValues boolean | Shows the excluded values (values not in the current selection) in the moving average. |
type string | This should be set to |
accumulationDimension: optional number | Only applicable when there are two dimensions. Selects the dimension on which the moving average will take place. If the moving average is made across multiple dimensions, this will be the first dimension. |
crossAllDimensions optional boolean | Only applicable when there are two dimensions. Continues the moving average across both dimensions. |
disabled optional boolean | No description |
steps optional number | Only applicable when |
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 |
qStaticContentUrlDef
objectMedia Library structure that will be evaluated by the engine.
Properties
qUrl string | Value of media library image |
refLine
objectProperties
label string | Reference line label. |
paletteColor | Color information structure. Holds the actual color and index in palette. |
refLineExpr | No description |
show default=true boolean | ValueExpression | Set to true to display this reference line. |
coloredBackground optional, default=false boolean | Set to true to fill the label and/or value of this reference line with this color |
showLabel optional, default=true boolean | Set to true to show the label of this reference line. |
showValue optional, default=true boolean | Set to true to show the value of this reference line. |
style optional | Styling settings for reference line |
refLineStyle
objectStyling settings for reference line
Properties
lineThickness optional, default=2 number | Set the thickness for this reference line. |
lineType optional, default='' string | Set the dash type for this reference line. |