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 Array<Component> | Styling of chart components. |
dataPoint | Data point settings. |
dimensionAxis | Dimension axis settings. |
footnote string
| StringExpression | Visualization footnote. |
legend | Legend settings. |
measureAxes | Measure axes settings. Must be an array with 2 measureAxis objects. |
nullMode default=gap 'gap'
| 'connect'
| 'zero' | Null value presentation |
orientation default=vertical 'vertical'
| 'horizontal' | Chart orientation setting. If vertical, the dimension axis can only be docked on bottom or top and measure axis on left or right. If horizontal, the dimension axis can only be docked on left or right and measure axis on bottom or top. |
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 |
scrollStartPos default=0 number | Scroll Alignment. Decides if the scroll starts at the beginning or end of the data. Where 0 means at the beginning and 1 at the end. |
showMiniChartForContinuousAxis default=true boolean | Chart axis setting to turn on/off the mini chart for continuous axis. |
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. |
Accumulation
objectIt allows you to accumulate values of your measure over one dimension.
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 |
disabled boolean | No description |
steps number | Only applicable when |
AttributeDimensionProperties
objectExtends NxAttrDimDef
, see Engine API: NxAttrDimDef
.
Properties
id string | One of: |
type AttributeExpressionProperties
ColorAttributes | CustomTooltipAttributesAxis
objectProperties
axis | No description |
key string | This should be set to |
AxisStyling
objectProperties
label | No description |
title | No description |
Bar
objectProperties
bar | No description |
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. |
ChartStyling
objectProperties
label | Bar labels if bar and data point labels if line. |
ColorAttributes
objectExtends NxAttrExprDef
, see Engine API: NxAttrExprDef
.
Properties
id string | One of: |
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
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 default='center' 'start'
| 'center'
| 'end' | Set alignment for this reference line |
coloredBackground default=false boolean | Set to true to fill the label and/or value of this reference line with this color |
showLabel default=true boolean | Set to true to show the label of this reference line. |
showValue default=true boolean | Set to true to show the value of this reference line. |
style | Styling settings for reference line |
FontStyling
objectProperties
color | Color information structure. Holds the actual color and index in palette. |
fontFamily string | No description |
fontSize string | No description |
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
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 boolean | Set to automatically sort the measure. |
cId string | ID used by the Qlik Sense. Must be unique within the current chart. |
color | Series information that defines the type of series and how it is represented. |
modifiers Array<Modifier> | Set to apply a modifier to a measure. |
series | Series information that defines the type of series and how it is represented. |
LabelNameStyling
objectProperties
name | No description |
LabelValueStyling
objectProperties
value | No description |
Legend
objectProperties
key string | This should be set to |
legend | No description |
LegendStyling
objectProperties
label | No description |
title | No description |
Line
objectProperties
key string | This should be set to |
line | No description |
style | No description |
LineStyling
objectProperties
dataPointSize default=6 number | Set to specify the size of the data point. |
lineCurve default="linear" 'linear'
| 'monotone' | No description |
lineThickness default=1 number | Set to specify line thickness. Can be set from 1 to 5. |
lineType default="solid" 'solid'
| 'dashed' | No description |
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' |
measureAxis
objectProperties
max number
| ValueExpression | Axis max value. |
min 'min'
| 'max'
| 'minMax' | Axis min value. |
minMax 'min'
| 'max'
| 'minMax' | Set custom max/min |
autoMinMax default=true boolean | Automatic max/min |
dock default="near" 'near'
| 'far' | Axis docking position |
show default="all" 'all'
| 'labels'
| 'title'
| 'none' | Labels and title |
spacing default=1 number | Axis scale |
MeasureColor
objectSeries information that defines the type of series and how it is represented.
Properties
mode default="primary" 'primary'
| 'byExpression' | Sets the coloring mode for the measure when coloring has been switched on Can be one of:
|
on default=false boolean | Set if the color settings should be used |
paletteColor default={ | Color information structure. Holds the actual color and index in palette. |
colorExpression string | Sets the color expression to be used when |
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
AccumulationpaletteColor
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 default=false boolean | Set to true to fill the label and/or value of this reference line with this color |
showLabel default=true boolean | Set to true to show the label of this reference line. |
showValue default=true boolean | Set to true to show the value of this reference line. |
style | Styling settings for reference line |
refLineStyle
objectStyling settings for reference line
Properties
lineThickness default=2 number | Set the thickness for this reference line. |
lineType default='' string | Set the dash type for this reference line. |
Series
objectSeries information that defines the type of series and how it is represented.
Properties
options | Series options for the Marker type. |
axis default=0 0
| 1 | Set which axes the series should be represented on. 0 for primary axis and 1 for secondary axis. Defaults to primary with less than 2 measure, otherwise secondary axis. |
type default="bar" 'bar'
| 'line'
| 'marker' | Set the type of series. Defaults to 'bar' with less than 2 measure, otherwise 'line'. |
SeriesMarkerOptions
objectSeries options for the Marker type.
Properties
fill default=true boolean | Set to true if the marker should be filled with a color. If false, only stroke of the marker is rendered. |
type default="circle" 'circle'
| 'line'
| 'diamond'
| 'triangle'
| 'rect' | Set the type of marker. |