waterfall Plot
A waterfall plot shows the cumulative effect of sequentially introduced positive or negative values.
Notes
Computed variables:
..x.. : category id.
..xlabel.. : category name.
..ymin.. : lower value of the change.
..ymax.. : upper value of the change.
..measure.. : kind of a calculation: absolute, relative or total.
..flow_type.. : direction of the flow: increasing, decreasing, or the result (total).
..initial.. : initial value of the change.
..value.. : current cumsum (result of the change) or absolute value (depending on the "measure" column).
..dy.. : value of the change.
Examples
Parameters
The data to be displayed in this layer.
Name of a variable.
Name of a numeric variable.
Kind of a calculation. Values in 'measure' column could be:
"absolute" - the value is shown as is;
"relative" - the value is shown as a difference from the previous value;
"total" - the value is shown as a cumulative sum of all previous values.
Grouping variable. Each group calculates its own statistics.
Color of the box boundary lines. For more info see: aesthetics.html#color-and-fill. Use "flow_type" to color lines by the direction of the flow.
Fill color of the boxes. For more info see: aesthetics.html#color-and-fill. Use "flow_type" to color boxes by the direction of the flow.
default = 0.0. Line width of the box boundary lines.
Transparency level of the boxes. Understands numbers between 0 and 1.
Int or String or List or Pair. Type of the box boundary lines. Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"), a hex string (up to 8 digits for dash-gap lengths), or a pattern offset to listOf(dash, gap, ...)
/ listOf(dash, gap, ...)
. For more info see: aesthetics.html#line-types.
default = 0.9. Width of the boxes. Typically range between 0 and 1. Values that are greater than 1 lead to overlapping of the boxes.
default = false. true - show the legend.
Result of the call to the layerTooltips()
function. Tooltips for boxes with relative values. Specifies appearance, style and content. When "none", tooltips are not shown. When "detailed", a more detailed (compared to the default) version of the tooltips is shown.
Result of the call to the layerTooltips()
function. Tooltips for boxes with absolute values. Specifies appearance, style and content. When "none", tooltips are not shown. When "detailed", a more detailed (compared to the default) version of the tooltips is shown.
default = 0.0. Values with measure "absolute" or "total" are relative to this value.
default = false. Sorts categories by absolute value of the changes.
Groups all categories under a certain threshold value into "Other" category.
Groups all categories with the smallest changes, except the first maxValues
, into "Other" category.
default = true. Setting the calcTotal
to true will put the final cumulative sum into a new separate box. Taken into account only if the "measure" column isn't provided.
The header of the last box with the final cumulative sum, if "measure" column isn't provided. Also used as a title in the legend for columns of type "total".
Horizontal line passing through 0. Set "blank" or result of elementBlank()
to draw nothing. Set elementLine()
to specify parameters.
default = true. Option to place horizontal line over the other layers.
Line between neighbouring boxes connecting the end of the previous box and the beginning of the next box. Set "blank" or result of elementBlank()
to draw nothing. Set elementLine()
to specify parameters.
Label on the box. Shows change value. Set "blank" or result of elementBlank()
to draw nothing. Set elementText()
to specify parameters. Use "flow_type" for color
parameter of the elementText()
to color labels by the direction of the flow.
Format used to transform label mapping values to a string. For more info see: formats.html Note: the "$" must be escaped as "\$".
Examples:
".2f" -> "12.45"
"Score: {.2f}" -> "Score: 12.45"
"Score: {}" -> "Score: 12.454789"