Waterfall reference

To represent the different component in a result

Overview

📖 Learn More about the Waterfall here.

📖 Find examples on the Waterfall here.

Parameters

Required

You must fill these parameters to produce a Waterfall

parameters label type description (placeholder | tooltip)
meta     |
dataset   string |
label   string (Column of dataset expected) Column containing the text label to display |
type Groups type/levels string (Column of dataset expected) Column containing labels relationship | Data should look like: -1/parent/child
value   string (Column of dataset expected) Column containing the value |

Optional

You can let these parameters unset if you do not need them

parameters label type description (placeholder | tooltip)
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1
steps Add steps array | Create intermediate stepsThis will rely on the bars’ order
groupsOrder Parents order   | Use it to order parents
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
tutorial Tutorial object |
tutorial/content Message string Enter your message | This will be displayed to your users
tutorial/alwaysShow Always show this tutorial boolean | By default the tutorial is shown once only
tutorial/id   string Enter an ID | Change the ID to display the tutorial again. All tutorials with the same ID will be displayed only once.
groups Parent label string (Column of dataset expected) Column containing parent group label |
labelsOrder Labels order   | Use it to order labels
hideParenthesisEvolution Hide legend evolution boolean |
reverseSentiment Reverse automatic sentiment color boolean | By default, value above 0 are in green, and below in red
zeroBaseline Baseline   | Value on which to position the x axisBy default, the value will be chosen to optimize screen space taken.
variation   string (Column of dataset expected) Column containing variation value | Display below the main valueneed to be given for both inner and outer drill levels

Others

This parameters are either common to all charts, or hidden from studio. You can use them in code mode, but it’s not recommended !

parameters label type description (placeholder | tooltip)
defaultSelected Default drilled group   |
source   string |
sublabel   string (Column of dataset expected) Column name containing the sublabel |
sentiment   object |
comment   string |
style   string |