waterfallchart properties
This API is reliable and breaking changes are unlikely.
waterfallchart()
These are the properties used by Qlik Sense waterfall charts.
Version history
| Version state | Details |
|---|---|
| Introduced | Qlik Sense September 2017 |
Properties
showTitles
Type: Boolean
Show title for the visualization.
Default: true.
showDetails
Type: Boolean
Sets if visualization details should be shown.
Default: false
title
Type: String | qStringExpression
Visualization title shown if "showTitles": true.
subtitle
Type: String | qStringExpression
Visualization subtitle shown if "showTitles": true.
footnote
Type: String | qStringExpression
Visualization footnote shown if "showTitles": true.
disableNavMenu
Type: Boolean
Disables the hover menu in the visualization.
Default: false
qHyperCubeDef
Type: Object
The hypercube definition used by most visualizations.
A subset of the properties available in the qHyperCubeDef is presented here. For complete documentation of all available properties, see Engine API: HyperCubeDef.
qMeasures
Type: Array
Description: Extends NxMeasure, see Engine API: NxMeasure.
Additional properties
-
qDef
Type: Object
Description: Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.
qDef Properties Name Type Description autoSort Boolean Set to automatically sort the measure.
Default: true
cId String ID used by the client. Must be unique within the current chart. numFormatFromTemplate Boolean When enabled, the number format to use can be selected from multiple predefined formats based on the desired type: number or date.
Default: true
isCustomFormatted Boolean Set to true to toggle off the default client formatting. othersLabel StringExpressionContainer String expression container. -
qAttributeExpressions
Type: Array
Extends NxAttrExprDef, see Engine API: NxAttrExprDef.
id
Type: String
One of:
- cellBackgroundColor: for attribute expression, expression for background color of table cell.
- cellForegroundColor: for attribute expression, expression for text color of table cell.
qLayoutExclude
Type: Object
customErrorMessage
Type: Object
Set to define custom error messages.
-
calcCondition
Type: String
Description: Deprecated. Use qCalcCondition.qMsg instead. Set to customize the calculation condition unfilled message.
measureAxis
Type: Object
Measure axis settings.
| Name | Type | Description |
|---|---|---|
| showBounds | Boolean |
Set to show min and max on axis. |
| dock | String |
Sets the axis docking position. Can be one of:
Default: near |
| spacing | Number |
Set the axis scale: Default: 1 |
| autoMinMax | Boolean |
Set to use automatic min/max for measure color. Default: true |
| minMax | String |
Set custom max/min. Can be one of:
Default: min |
| min | ValueExpressionContainer | Set the min value for the range. |
| max | ValueExpressionContainer | Set the max value for the range. |
gridlines
Type: Object
Grid line settings.
| Name | Type | Description |
|---|---|---|
| auto | Boolean |
Set to show grid lines. Default: true |
| spacing | Integer |
Defines the grid line spacing. Used when "auto": false. Can be one of:
Default: 2 |
color
Type: Object
Color settings for the waterfall chart.
| Name | Type | Description |
|---|---|---|
| positiveValue | Object |
Color for positive values. Properties:
|
| negativeValue | Object |
Color for negative values. Properties:
|
| subtotalValue | Object |
Color for subtotal values. Properties:
|
legend
Type: Object
Legend settings.
| Name | Type | Description |
|---|---|---|
| show | Boolean |
Set to show the legend. Default: true |
| dock | String |
Sets the legend position. Can be one of:
Default: auto |
| showTitle | Boolean |
Show the legend title. Default: true |
In this example we create a basic waterfall chart, containing of three measures, with a custom title and color legend switched off.
app.visualization.create(
'waterfallchart',
[
{
"qDef": {
"qLabel": "Expected",
"qDef": "Avg(ExpPutts)",
"valueType": "NORMAL"
}
},
{
"qDef": {
"qLabel": "Actual",
"qDef": "Avg(Putts)",
"valueType": "INVERSE"
}
},
{
"qDef": {
"qLabel": "Shots gained or lost",
"qDef": "Avg(ExpPutts-Putts)",
"valueType": "SUBTOTAL"
}
}
],
{
"showTitles": true,
"title": "Shots gained or lost putting",
"legend": {
"show": false
}
}
).then(function(vis){
vis.show("QV01");
});