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)
type Groups type/levels string (Column of dataset expected) Column containing the relationship for each element | Data should look like: -1/parent/child
label   string (Column of dataset expected) Column containing the text label to display |
value   string (Column of dataset expected) Column containing the value |
dataset   string |

Optional

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

parameters label type description (placeholder | tooltip)
labelsOrder labels order   | use it to order labels
groups Parent Group label string (Column of dataset expected) Column containing the parent group label | For drill configuration only
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
zeroBaseline Set the baseline   | The first bar will start from that positionBy default, the value will be chosen to optimize screen space taken.
variation   string (Column of dataset expected) Column containing the variation value | Display below the main valueneed to be given for both inner and outer drill levels
reverseSentiment Reverse sentiment color boolean |
steps Add steps array | Create intermediate stepsThis will rely on the bars’ order
hideParenthesisEvolution Hide legend evolution in value boolean |
tutorial Tutorial object | Help your users understand how to use the chart!This will be displayed the first time your user uses the chart
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.
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
groupsOrder groups order   | use it to order groups
meta Additional info   | Will be displayed under each bar
defaultSelected Default drilled group   |
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1

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)
comment   string |
sentiment   object |
style   string |
sublabel   string (Column of dataset expected) Column name containing the sublabel |
source   string |