waterfallchart properties

Note: STABLE.
This API is reliable and breaking changes are unlikely.

waterfallchart()

These are the properties used by Qlik Sense waterfall charts.

Version history

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 | Expression

Visualization title shown if "showTitles": true.

subtitle

Type: String | Expression

Visualization subtitle shown if "showTitles": true.

footnote

Type: String | Expression

Visualization footnote shown if "showTitles": true.

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.

Properties

Name Type Description
qMeasures Array

Extends NxMeasure, see Engine API: NxMeasure.

Additional properties

Name Type Description
qDef Object

Extends NxInlineMeasureDef, see Engine API: NxInlineMeasureDef.

Additional 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
qAttributeExpressions Array

Extends NxAttrExprDef, see Engine API: NxAttrExprDef.

Additional properties

Name Type Description
id String

One of:

  • colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions.
  • colorByExpression: used together with color.mode="byExpression".
qLayoutExclude Object

 

customErrorMessage Object

Set to define custom error messages.

Name Type Description
calcCond String

Deprecated. Use qCalcCondition.qMsg instead.

Set to customize the calculation condition unfilled message.

measureAxis

Type: Object

Measure axis settings.

Properties

Name Type Description
showBounds Boolean

Set to show min and max on axis.

dock String

Axis docking position. Can be:

  • near
  • far

Default: near

spacing Number

Axis scale.

Default: 1

autoMinMax Boolean

Set to enable automatic max/min.

Default: true

minMax String

Set custom max/min.

One of:

  • min
  • max
  • minMax

Default: min

min ValueExpressionContainer
max ValueExpressionContainer

gridlines

Type: Object

Grid line settings.

Properties

Name Type Description
auto Boolean

Set to use automatic grid line spacing.

Default: true

spacing Integer

Grid line spacing. Used only when auto is set to false. One of:

  • 0: no lines
  • 1: wide
  • 2: medium
  • 3: narrow

Default: 2

color

Type: Object

Color settings for the waterfall chart.

Name Type Description
positiveValue Object

Properties

Name Type Description
index Integer

Index in palette.

Default: -1

color String

Color as HEX string.

Default: #0000FF

negativeValue Object

Properties

Name Type Description
index Integer

Index in palette.

Default: -1

color String

Color as HEX string.

Default: #FF0000

SubtotalValue Object

Properties

Name Type Description
index Integer

Index in palette.

Default: -1

color String

Color as HEX string.

Default: #C3C3C3

legend

Type: Object

Legend properties:

Name Type Description
show Boolean

Show the legend.

Default: true

dock String

Legend position. Can be one of:

  • auto
  • right
  • bottom
  • left
  • top

Default: auto

showTitle Boolean

Show legend title.

Default: true

Example using Visualization API

Tip: For more examples of how to create waterfall charts on the fly, see Mashups: Creating waterfall charts.

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");
});

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?