Sankey fields and settings

Every field well and every setting in the format pane of version 1.0.0.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 Sankey page; every setting works in edit mode with or without one.

9 fields · 17 cards · 184 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Source`source`	Column	Optional	Where a flow starts. Use with Destination when your table holds pairs (any depth).
Destination`destination`	Column	Optional	Where a flow goes. A node can be a destination and a source: the visual builds the levels.
Stages (in order)`stages`	Column	Optional · up to 10	A flat table: one column per stage, left to right (channel, first order, status). No reshaping needed. Up to 10 stages.
Amount`amount`	Measure	Optional	The size of each flow. Without it, flows count rows.
Compare With (Premium)`compareAmount`	Measure	Optional	Budget, prior period or scenario. Shows what changed per flow (Premium).
Period (Premium)`period`	Column	Optional	A date or period column. With one stage it draws an alluvial over time; otherwise it compares the latest two periods (Premium).
Split By (Premium)`split`	Column	Optional	One small Sankey per value, same colors and order in every panel (Premium). Bind a hierarchy (Region, Country) to drill the panels down.
Color By`colorBy`	Column	Optional	Colors nodes by this attribute (region, type) instead of by node name.
Tooltips`tooltips`	Measure	Optional · up to 5	Extra fields for the tooltip.

Flow`flow`

Setting	Type and options
Data Shape`mode`	Automatic `auto` Pairs (Source and Destination) `pairs` Flat Table (Stages) `journey` Before and After (Premium) `migration`
Orientation`orientation`	Left to Right `horizontal` Top to Bottom `vertical`
Align Nodes`align`	From the Start `left` To the End `right` Endpoints at the End `justify`
Blank Stages`blankStages`	Skip the Stage `skip` Show as (Blank) `blank` End the Path `end`
Loops`loops`	Draw as Arcs `arcs` Hide `hide`
Period Field Draws`periodUse`	Automatic `auto` Alluvial Over Time `alluvial` Comparison of Two Periods `compare`
Show Zero Flows`showZero`	On / off
Finance Mode: Losses for Negative Values (Premium)`finance`	On / off

Nodes`nodes`

Setting	Type and options
Color Nodes By`colorMode`	Node Name (Stable) `name` Column `level` One Color `single`
Node Color`singleColor`	Colour
Color Rule`rule`	Colour
Node Width (0 = Theme)`width`	Number
Node Spacing`spacing`	Number
Corner Radius (-1 = Theme)`cornerRadius`	Number
Order Nodes`sort`	Fewest Crossings `smart` Largest First `value` A to Z `az` Data Order `data` Custom (Drag) `custom`
Show Top N per Column, 0 = All (Premium)`topN`	Number
Merge Nodes Below % of Column (Premium)`minNodePct`	Number
Other Label`otherLabel`	Text
Drop-Off and Entry Nodes (Premium)`balance`	On / off

Node Colors`nodeColors`

Setting	Type and options
Node Color 1`c0`	Colour
Node Color 2`c1`	Colour
Node Color 3`c2`	Colour
Node Color 4`c3`	Colour
Node Color 5`c4`	Colour
Node Color 6`c5`	Colour
Node Color 7`c6`	Colour
Node Color 8`c7`	Colour
Node Color 9`c8`	Colour
Node Color 10`c9`	Colour
Node Color 11`c10`	Colour
Node Color 12`c11`	Colour
Node Color 13`c12`	Colour
Node Color 14`c13`	Colour
Node Color 15`c14`	Colour
Node Color 16`c15`	Colour
Node Color 17`c16`	Colour
Node Color 18`c17`	Colour
Node Color 19`c18`	Colour
Node Color 20`c19`	Colour
Node Color 21`c20`	Colour
Node Color 22`c21`	Colour
Node Color 23`c22`	Colour
Node Color 24`c23`	Colour
Node Color 25`c24`	Colour
Node Color 26`c25`	Colour
Node Color 27`c26`	Colour
Node Color 28`c27`	Colour
Node Color 29`c28`	Colour
Node Color 30`c29`	Colour

Node Icons`nodeIcons`

Setting	Type and options
Node Icon 1`i0`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 2`i1`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 3`i2`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 4`i3`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 5`i4`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 6`i5`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 7`i6`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 8`i7`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 9`i8`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 10`i9`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 11`i10`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 12`i11`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 13`i12`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 14`i13`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 15`i14`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 16`i15`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 17`i16`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 18`i17`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 19`i18`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 20`i19`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 21`i20`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 22`i21`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 23`i22`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 24`i23`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 25`i24`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 26`i25`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 27`i26`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 28`i27`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 29`i28`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`
Node Icon 30`i29`	None `none` Factory `factory` Lightning `bolt` Sun `sun` Flame `flame` Water Drop `water` Leaf `leaf` Person `user` People `users` Cart `cart` Store `store` Truck `truck` Box `box` Gear `gear` Coin `coin` Globe `globe` Building `building` Heart `heart` Star `star` Flag `flag` Check `check`

Annotations`annotations`

Setting	Type and options
Note 1`a0`	Text
Note 2`a1`	Text
Note 3`a2`	Text
Note 4`a3`	Text
Note 5`a4`	Text
Note 6`a5`	Text
Note 7`a6`	Text
Note 8`a7`	Text
Note 9`a8`	Text
Note 10`a9`	Text
Note 11`a10`	Text
Note 12`a11`	Text
Note 13`a12`	Text
Note 14`a13`	Text
Note 15`a14`	Text
Note 16`a15`	Text
Note 17`a16`	Text
Note 18`a17`	Text
Note 19`a18`	Text
Note 20`a19`	Text
Note 21`a20`	Text
Note 22`a21`	Text
Note 23`a22`	Text
Note 24`a23`	Text
Note 25`a24`	Text
Note 26`a25`	Text
Note 27`a26`	Text
Note 28`a27`	Text
Note 29`a28`	Text
Note 30`a29`	Text

Links`links`

Setting	Type and options
Color Links By`colorMode`	Theme Default `theme` Gradient `gradient` Source Node `source` Destination Node `target` One Color `single` Change (Compare) `change`
Link Color`singleColor`	Colour
Color Rule`rule`	Colour
Opacity % (-1 = Theme)`opacity`	Number
Curvature % (-1 = Theme)`curvature`	Number
Arrowheads`arrows`	On / off
Stayed Flows (Before and After)`stayed`	Normal `normal` Muted `muted` Hidden `hide`

Node Labels`nodeLabels`

Setting	Type and options
Show`show`	On / off
Name`name`	On / off
Value`value`	On / off
Percentage`percent`	On / off
Percentage Of`percentBasis`	Total `total` Column `level` Largest Source `source` Inflow vs Size `incoming`
Font`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Text Size`fontSize`	Number
Bold`bold`	On / off
Italic`italic`	On / off
Underline`underline`	On / off
Name Color`color`	Colour
Value Color`valueColor`	Colour
Display Units`units`	Auto `auto` None `none` Thousands `K` Millions `M` Billions `B`
Decimals (-1 = Auto)`decimals`	Number

Link Labels`linkLabels`

Setting	Type and options
Show`show`	On / off
Value`value`	On / off
Percentage of Source`percent`	On / off

Column Headers`headers`

Setting	Type and options
Show`show`	On / off
Font`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Text Size`fontSize`	Number
Bold`bold`	On / off
Italic`italic`	On / off
Underline`underline`	On / off
Color`color`	Colour
Column 1 Header`h0`	Text
Column 2 Header`h1`	Text
Column 3 Header`h2`	Text
Column 4 Header`h3`	Text
Column 5 Header`h4`	Text
Column 6 Header`h5`	Text
Column 7 Header`h6`	Text
Column 8 Header`h7`	Text
Column 9 Header`h8`	Text
Column 10 Header`h9`	Text

Compare (Premium)`compare`

Setting	Type and options
Compare`enabled`	On / off
Current Period (Empty = Latest)`currentPeriod`	Text
Compare With Period (Empty = Previous)`comparisonPeriod`	Text
Count as Unchanged Below %`flatBand`	Number
Biggest Changes Strip`strip`	On / off
Show Lost Flows (Dashed)`showLost`	On / off

Small Multiples (Premium)`smallMultiples`

Setting	Type and options
Columns (0 = Auto)`columns`	Number
Same Scale in Every Panel`sharedScale`	On / off

Insights (Premium)`insights`

Setting	Type and options
Show Insights`show`	On / off
Number of Sentences`count`	Number

Interaction`interaction`

Setting	Type and options
Trace Paths on Hover and Click`trace`	On / off
Dimmed Opacity %`dim`	Number
Drag Nodes`drag`	On / off
Reset Dragged Positions`resetLayout`	On / off
Data Table Button`tableButton`	On / off
Double-Click Collapses Downstream (Premium)`expand`	On / off
Trace Exact Volume Shares in Journeys (Premium)`volumeTrace`	On / off
Export Button (Premium)`exportButton`	On / off
Export Format`exportFormat`	Excel Workbook `xlsx` CSV `csv`

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Use Report Theme Colors`reportColors`	On / off
Transparent Background`transparentBg`	On / off
Background Color`bgColor`	Colour

Accessibility`accessibility`

Setting	Type and options
Focus Outline Color`focusColor`	Colour
Focus Outline Width`focusWidth`	Number
Minimum Text Size`minFontSize`	Number
Reduce Motion`reduceMotion`	On / off
Patterns for States (Non-Color Cue)`patterns`	On / off

Style Template`styleTemplate`

Setting	Type and options
This Visual's Style Code (Copy)`copy`	Text
Paste a Style Code to Apply`paste`	Text

State`state`

Setting	Type and options
Positions`positions`	Text
Order`order`	Text
Color Memory`colorMemory`	Text
Color Keys`colorKeys`	Text

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": "smartVisualsSankey7C41D2E09B8A4F6E9D3A51C2B7E04F18",
  "objects": {
    "flow": [{
      "properties": {
        "showZero": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Sankey fields and settings

Fields

Flowflow

Nodesnodes

Node ColorsnodeColors

Node IconsnodeIcons

Annotationsannotations

Linkslinks

Node LabelsnodeLabels

Link LabelslinkLabels

Column Headersheaders

Compare (Premium)compare

Small Multiples (Premium)smallMultiples

Insights (Premium)insights

Interactioninteraction

Themetheme

Accessibilityaccessibility

Style TemplatestyleTemplate

Statestate