Stream & Ribbon 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 Stream & Ribbon page; every setting works in edit mode with or without one.
8 fields · 31 cards · 135 settings Markdown for AI assistantscatalog.json
Fields
| Field | Takes | Needed | What it is for |
|---|---|---|---|
Axis (period)axis | Column | Optional | A date, a date hierarchy level, a number or text periods: one rank per period |
Legendlegend | Column | Optional | The categories to rank (one band per value) |
Valuesvalues | Measure | Optional | The measure that sets the thickness of every band |
Rank by (premium)rankBy | Measure | Optional | A second measure that sets the order, e.g. margin or growth |
Comparisoncomparison | Measure | Optional | Previous year, plan or any reference value per category |
Small multiplesfacet | Column | Optional | One panel per value (premium) |
Annotationannotation | Measure | Optional | Text measure: a non-blank value pins a note on that period |
Tooltipstooltips | Measure | Optional | Extra fields in tooltips |
Chartview
| Setting | Type and options |
|---|---|
Chart Typetype |
|
Orientationorientation |
|
Period Spacingspacing |
|
Style Templatetemplate
| Setting | Type and options |
|---|---|
Templatepreset |
|
Appliedapplied | Text |
Streamstream
| Setting | Type and options |
|---|---|
Layout (Offset)offset |
|
Stack Orderorder |
|
Edgescurve |
|
Curvature (%)curvature | Number |
Fillfill |
|
Fill Opacity (%, 0 = theme)opacity | Number |
Outline Between Streamsoutline | On / off |
Ribbonribbon
| Setting | Type and options |
|---|---|
Largest Valuelargest |
|
Column Width (%)columnWidth | Number |
Spacing Between Segments (px)gap | Number |
Ribbon Opacity (%)ribbonOpacity | Number |
Ribbon Shapecurve |
|
Curvature (%)curvature | Number |
Ribbon Borderborder | On / off |
Corner Radius (-1 = theme)cornerRadius | Number |
Rankingranking
| Setting | Type and options |
|---|---|
Tie Ruleties |
|
Legend OrderlegendOrder |
|
Let Readers Change the OrderreaderSort | On / off |
Order Button Text SizebuttonSize | Number |
Labels Inside Bandslabels
| Setting | Type and options |
|---|---|
Showshow | On / off |
Contentcontent |
|
Font SizefontSize | Number |
Colour (empty = automatic contrast)color | Colour |
In Every ColumneveryPeriod | On / off |
Decimals (-1 = auto)decimals | Number |
Start LabelsstartLabels
| Setting | Type and options |
|---|---|
Showshow | On / off |
Contentcontent |
|
Font SizefontSize | Number |
Colourcolor | Colour |
End LabelsendLabels
| Setting | Type and options |
|---|---|
Showshow | On / off |
Contentcontent |
|
Font SizefontSize | Number |
Colourcolor | Colour |
Focus Coloursfocus
| Setting | Type and options |
|---|---|
Series to Emphasise (comma-separated names)names | Text |
Grey Out the RestgreyRest | On / off |
Data Point Markersmarkers
| Setting | Type and options |
|---|---|
Showshow | On / off |
Sizesize | Number |
Tooltiptooltip
| Setting | Type and options |
|---|---|
Share of the Periodshare | On / off |
Rank (with ties)rank | On / off |
Period Totaltotal | On / off |
Compare (What Changed)compare
| Setting | Type and options |
|---|---|
Compare Withbase |
|
Rank Change ▲ ▼ in LabelsrankChange | On / off |
Change in Labels and Tooltipsdelta |
|
Show the Reference Rank as a Ghostghost | On / off |
Top N and OthertopN
| Setting | Type and options |
|---|---|
Top N per Period (0 = all)n | Number |
The Restothers |
|
Name of the Other BandothersLabel | Text |
Mark Entries and Exitsmarks | On / off |
Risers and Overtakesinsights
| Setting | Type and options |
|---|---|
Highlight the Biggest Riser and Fallermovers | On / off |
Mark Overtakesovertakes | On / off |
Only Overtakes Into the Top (0 = any)within | Number |
Callout Sentencecallout | On / off |
Forecast of the Totalforecast
| Setting | Type and options |
|---|---|
Showshow | On / off |
Periods Ahead (0 = automatic)horizon | Number |
Prediction Intervalinterval |
|
X-AxisxAxis
| Setting | Type and options |
|---|---|
Showshow | On / off |
TitleshowTitle | On / off |
Font SizefontSize | Number |
Colourcolor | Colour |
Vertical Gridlinesgrid | On / off |
Y-AxisyAxis
| Setting | Type and options |
|---|---|
Showshow | On / off |
TitleshowTitle | On / off |
Maximum (blank = auto)max | Text |
Decimals (-1 = auto)decimals | Number |
Font SizefontSize | Number |
Colourcolor | Colour |
Gridlinesgridlines
| Setting | Type and options |
|---|---|
Stylestyle |
|
Colourcolor | Colour |
Legendlegend
| Setting | Type and options |
|---|---|
Showshow | On / off |
Positionposition |
|
TitleshowTitle | On / off |
Font SizefontSize | Number |
Text Colourcolor | Colour |
Total and TrendtotalLine
| Setting | Type and options |
|---|---|
Total Lineshow | On / off |
Trend Line of the Totaltrend |
|
Total Labelslabels | On / off |
Total Label SizelabelSize | Number |
Colourcolor | Colour |
Reference LinesrefLines
| Setting | Type and options |
|---|---|
Horizontal Lineline |
|
Valuevalue | Number |
Labellabel | Text |
Vertical Line at Periodperiod | Text |
Vertical Line LabelperiodLabel | Text |
Colourcolor | Colour |
Show Line LabelsshowLabels | On / off |
Label SizefontSize | Number |
Annotationsannotations
| Setting | Type and options |
|---|---|
Events (period: text; period: text)list | Text |
Shade Until the Next Annotationshade | On / off |
Stylestyle |
|
Show NotesshowNotes | On / off |
Font SizefontSize | Number |
Colourcolor | Colour |
Zoomzoom
| Setting | Type and options |
|---|---|
Ctrl + Wheel Zooms, Drag Panswheel | On / off |
Range Navigatornavigator | On / off |
Navigator HeightnavHeight | Number |
Playbackplayback
| Setting | Type and options |
|---|---|
Play Through the Periodsshow | On / off |
Milliseconds per Periodspeed | Number |
Show the Playing PeriodshowPeriod | On / off |
Period Text SizeperiodSize | Number |
Period Text ColourperiodColor | Colour |
Button Text SizebuttonSize | Number |
Small MultiplessmallMultiples
| Setting | Type and options |
|---|---|
Columns (0 = auto)columns | Number |
Shared ScalesharedScale | On / off |
Panel TitlesshowTitles | On / off |
Title SizetitleSize | Number |
Title ColourtitleColor | Colour |
Smart Captioncaption
| Setting | Type and options |
|---|---|
Showshow | On / off |
Positionposition |
|
Font SizefontSize | Number |
Colourcolor | Colour |
Footnotefootnote
| Setting | Type and options |
|---|---|
Showshow | On / off |
Sourcesource | Text |
State the Rank and Tie Rulerule | On / off |
Font SizefontSize | Number |
Colourcolor | Colour |
Accessibilityaccessibility
| Setting | Type and options |
|---|---|
Distinguish Series Without Colourdistinguish | On / off |
Focus Outline ColourfocusColor | Colour |
Focus Outline WidthfocusWidth | Number |
Minimum Text Size (0 = off)minFontSize | Number |
Data Table Text SizetableSize | Number |
Reduce MotionreduceMotion | On / off |
Themetheme
| Setting | Type and options |
|---|---|
ThemeselectedTheme |
|
Fontfont |
|
Transparent BackgroundtransparentBg | On / off |
Colourspalette |
|
Colour OrdercolorBy |
|
Reveal Animationreveal | On / off |
Animate Data Changesmorph | On / off |
Series ColoursseriesColors
| Setting | Type and options |
|---|---|
Colourfill | Colour |
Data ColoursdataPoint
| Setting | Type and options |
|---|---|
Colourfill | Colour |
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": "smartvisualsStreamRibbonA8CA12EE1E495D3CBD2D13C9AE580AE3",
"objects": {
"stream": [{
"properties": {
"outline": { "expr": { "Literal": { "Value": "true" } } }
}
}]
}
}