Waterfall & PVM fields and settings

Every field well and every setting in the format pane of version 1.0.1.0, read from the package you download. The internal names in grey are what a PBIR file or a report-authoring agent uses. Which features need a licence is on the Waterfall & PVM page; every setting works in edit mode with or without one.

12 fields · 18 cards · 106 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Category`category`	Column	Optional · up to 4	Steps of the waterfall, or the items of a price-volume-mix bridge (product, customer, SKU). Add a hierarchy to drill.
Period`period`	Column	Optional	Optional year, quarter or scenario field with two or more values: the first is the base, the last the current period.
Small multiples`group`	Column	Optional	Optional field: one bridge per value, on a shared scale.
Value`value`	Measure	Optional	The amount to bridge: revenue, sales, margin, cost.
Comparison value`baseValue`	Measure	Optional	Budget, prior year or forecast for the same amount. Draws the start pillar and the change per category.
Volume`volume`	Measure	Optional	Units sold (quantity). With a comparison, turns the bridge into price, volume and mix effects.
Comparison volume`baseVolume`	Measure	Optional	Units in the comparison period or plan (not needed with a Period field).
Value at comparison FX`valueFx`	Measure	Optional	Current value translated at the comparison period's exchange rates (constant currency). Adds a currency effect.
Cost`cost`	Measure	Optional	Cost of the units sold. Turns the bridge into a margin bridge with a separate cost effect.
Comparison cost`baseCost`	Measure	Optional	Cost in the comparison period (not needed with a Period field).
Step type`stepType`	Measure	Optional	Optional per-row type for classic waterfalls: start, delta, subtract, subtotal or total (or 2, 0, -1, 1, 3). Use First or Max on a text column.
Tooltips`tooltips`	Measure	Optional · up to 5	Extra measures shown in the tooltip.

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Use report theme colors`useReportTheme`	On / off
Font`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Transparent background`transparentBg`	On / off
Background`bgColor`	Colour

Chart type & method`chart`

Setting	Type and options
Chart type`chartType`	Automatic `auto` Waterfall `classic` Variance bridge `variance` Price-volume-mix bridge `pvm`
Compare`compare`	Last two periods `lastTwo` First to last period `firstLast` Every period (chained) `chain`
PVM method`priceBasis`	Price at current volume `current` Price at base volume `base` Price at base volume, separate interaction `interaction` Midpoint (symmetric) `midpoint`
Separate mix effect`separateMix`	On / off
New and lost items as effects`separateNewLost`	On / off
Hide zero effects`hideZero`	On / off
Break down effect by item`breakdown`	None `none` Volume `volume` Mix `mix` Price `price` Cost `cost` Price × volume `interaction` Currency `fx` New items `new` Lost items `lost` Other `other`
Items per broken-down effect`breakdownN`	Number
Value at comparison FX holds`fxMode`	Current period at the previous period's rates `prior` Every period at constant rates `constant`
Notation`notation`	Standard `standard` IBCS `ibcs`
Comparison scenario`scenario`	Prior year (PY) `PY` Plan (PL) `PL` Forecast (FC) `FC`

Layout`layout`

Setting	Type and options
Orientation`orientation`	Vertical `vertical` Horizontal `horizontal`
Sort steps`sortBy`	Data order `data` Largest impact first `impact` Value, high to low `valueDesc` Value, low to high `valueAsc` Name, A to Z `name`
Show top N steps (0 = all)`topN`	Number
Bar width % (0 = theme)`barWidth`	Number
Others label (blank = Others (n))`othersLabel`	Text

Legend`legend`

Setting	Type and options
Legend`show`	On / off
Position`position`	Top `top` Bottom `bottom`
Font size`fontSize`	Number
Font color`fontColor`	Colour

Effect names`effectNames`

Setting	Type and options
Volume`volume`	Text
Mix`mix`	Text
Price`price`	Text
Cost`cost`	Text
Price × volume`interaction`	Text
Currency`fx`	Text
New items`new`	Text
Lost items`lost`	Text
Other`other`	Text

Bars & colors`colors`

Setting	Type and options
Color bars`colorMode`	Increase / decrease `direction` By effect or category `effect`
Direction`polarity`	Higher is better `higher` Lower is better `lower`
Increase`increaseColor`	Colour
Decrease`decreaseColor`	Colour
Start pillar`startColor`	Colour
End pillar`totalColor`	Colour
Subtotals`subtotalColor`	Colour
Hatch adverse bars`hatchAdverse`	On / off

Step colors`dataPoint`

Setting	Type and options
Color`fill`	Colour

Effect colors`effectColors`

Setting	Type and options
Volume`volume`	Colour
Mix`mix`	Colour
Price`price`	Colour
Cost`cost`	Colour
Price × volume`interaction`	Colour
Currency`fx`	Colour
New items`new`	Colour
Lost items`lost`	Colour
Other`other`	Colour

Connectors`connectors`

Setting	Type and options
Connector lines`show`	On / off
Color`color`	Colour
Style`style`	Theme `theme` Solid `solid` Dashed `dashed` Dotted `dotted`
Width (0 = theme)`width`	Number

Data labels`labels`

Setting	Type and options
Data labels`show`	On / off
Show`content`	Value `value` % of start `pct` Value and % `both`
Display units`displayUnits`	Auto `auto` None `none` Thousands `K` Millions `M` Billions `B`
Decimal places`decimals`	Auto `auto` 0 1 2 3
Position`position`	Outside end `outside` Inside end `inside`
Rounded labels add up`reconcile`	On / off
Font size`fontSize`	Number
Font color`fontColor`	Colour
% of start color`pctColor`	Colour

Category labels`categoryAxis`

Setting	Type and options
Category labels`show`	On / off
Font size`fontSize`	Number
Font color`fontColor`	Colour
Effect and period bands`bandColor`	Colour

Start & end pillars`pillars`

Setting	Type and options
Start pillar`showStart`	On / off
Start label (blank = field name)`startLabel`	Text
End pillar / total`showEnd`	On / off
End label (blank = field name)`endLabel`	Text

Value axis`valueAxis`

Setting	Type and options
Axis labels`show`	On / off
Gridlines`showGrid`	On / off
Grid color`gridColor`	Colour
Font size`fontSize`	Number
Font color`fontColor`	Colour
Baseline color`lineColor`	Colour
Axis break for small steps`axisBreak`	On / off

Difference highlight`difference`

Setting	Type and options
Difference highlight`show`	On / off
Show`mode`	Value and % `both` Value `abs` % `pct`
Color`color`	Colour
Font size`fontSize`	Number

Data table`table`

Setting	Type and options
Data table`show`	On / off
Font size`fontSize`	Number
Font color`fontColor`	Colour
Header color`headerColor`	Colour
Rule lines`ruleColor`	Colour
Item table (effects per item)`itemTable`	On / off
Items in the item table`itemRows`	Number

Small multiples`smallMultiples`

Setting	Type and options
Columns (0 = auto)`columns`	Number
Shared scale`sharedScale`	On / off
Panel titles`showTitles`	On / off
Title font size`titleFontSize`	Number
Title color`titleColor`	Colour

Insight & footnote`insights`

Setting	Type and options
Insight sentence`showInsight`	On / off
Insight font size`insightFontSize`	Number
Insight color`insightColor`	Colour
Method footnote`showFootnote`	On / off
Footnote font size`footnoteFontSize`	Number
Footnote color`footnoteColor`	Colour

Accessibility`accessibility`

Setting	Type and options
Focus outline color`focusColor`	Colour
Focus outline width`focusWidth`	Number
Minimum text size`minFontSize`	Number
Hatch adverse bars`hatchAdverse`	On / off

Setting a value in PBIR

In a visual.json, a setting goes under visual.objects, by card and internal name. Toggles take true or false, choices and text a value in single quotes ('auto'), numbers a D suffix (12D).

"visual": {
  "visualType": "waterfallPvmBridge7D3C9E21A4B84F6FA1E2C5D8B9F04A13",
  "objects": {
    "theme": [{
      "properties": {
        "useReportTheme": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Waterfall & PVM fields and settings

Fields

Themetheme

Chart type & methodchart

Layoutlayout

Legendlegend

Effect nameseffectNames

Bars & colorscolors

Step colorsdataPoint

Effect colorseffectColors

Connectorsconnectors

Data labelslabels

Category labelscategoryAxis

Start & end pillarspillars

Value axisvalueAxis

Difference highlightdifference

Data tabletable

Small multiplessmallMultiples

Insight & footnoteinsights

Accessibilityaccessibility