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

    FieldTakesNeededWhat it is for
    Axis (period)axisColumnOptionalA date, a date hierarchy level, a number or text periods: one rank per period
    LegendlegendColumnOptionalThe categories to rank (one band per value)
    ValuesvaluesMeasureOptionalThe measure that sets the thickness of every band
    Rank by (premium)rankByMeasureOptionalA second measure that sets the order, e.g. margin or growth
    ComparisoncomparisonMeasureOptionalPrevious year, plan or any reference value per category
    Small multiplesfacetColumnOptionalOne panel per value (premium)
    AnnotationannotationMeasureOptionalText measure: a non-blank value pins a note on that period
    TooltipstooltipsMeasureOptionalExtra fields in tooltips

    Chartview

    SettingType and options
    Chart Typetype
    • Stream graph (streamgraph) stream
    • Ribbon chart ribbon
    Orientationorientation
    • Time from left to right vertical
    • Time from top to bottom horizontal
    Period Spacingspacing
    • Equal equal
    • By date date

    Style Templatetemplate

    SettingType and options
    Templatepreset
    • Default none
    • Executive executive
    • IBCS ibcs
    • Minimal minimal
    • Presentation presentation
    • Print print
    • Custom custom
    AppliedappliedText

    Streamstream

    SettingType and options
    Layout (Offset)offset
    • Wiggle (streamgraph) wiggle
    • Silhouette (centred) silhouette
    • 100 % (expand) expand
    • Stacked from zero zero
    Stack Orderorder
    • Inside-out (largest in the middle) insideOut
    • Largest on top ascending
    • Largest at the bottom descending
    • By peak date peak
    • Data order data
    • Name name
    Edgescurve
    • Smooth smooth
    • Straight straight
    • Steps step
    Curvature (%)curvatureNumber
    Fillfill
    • From theme theme
    • Flat flat
    • Gradient gradient
    Fill Opacity (%, 0 = theme)opacityNumber
    Outline Between StreamsoutlineOn / off

    Ribbonribbon

    SettingType and options
    Largest Valuelargest
    • On top top
    • At the bottom bottom
    Column Width (%)columnWidthNumber
    Spacing Between Segments (px)gapNumber
    Ribbon Opacity (%)ribbonOpacityNumber
    Ribbon Shapecurve
    • Smooth smooth
    • Straight straight
    Curvature (%)curvatureNumber
    Ribbon BorderborderOn / off
    Corner Radius (-1 = theme)cornerRadiusNumber

    Rankingranking

    SettingType and options
    Tie Ruleties
    • Keep the previous period's order, then name previous
    • Name (A to Z) name
    Legend OrderlegendOrder
    • Rank in the last period rank
    • Total over all periods total
    • Data order data
    • Name name
    Let Readers Change the OrderreaderSortOn / off
    Order Button Text SizebuttonSizeNumber

    Labels Inside Bandslabels

    SettingType and options
    ShowshowOn / off
    Contentcontent
    • Name name
    • Name and value nameValue
    • Name and share nameShare
    • Rank and name nameRank
    • Value value
    • Share share
    • Rank rank
    Font SizefontSizeNumber
    Colour (empty = automatic contrast)colorColour
    In Every ColumneveryPeriodOn / off
    Decimals (-1 = auto)decimalsNumber

    Start LabelsstartLabels

    SettingType and options
    ShowshowOn / off
    Contentcontent
    • Name name
    • Name and value nameValue
    • Name and share nameShare
    • Rank and name nameRank
    • Value value
    • Share share
    • Rank rank
    Font SizefontSizeNumber
    ColourcolorColour

    End LabelsendLabels

    SettingType and options
    ShowshowOn / off
    Contentcontent
    • Name name
    • Name and value nameValue
    • Name and share nameShare
    • Rank and name nameRank
    • Value value
    • Share share
    • Rank rank
    Font SizefontSizeNumber
    ColourcolorColour

    Focus Coloursfocus

    SettingType and options
    Series to Emphasise (comma-separated names)namesText
    Grey Out the RestgreyRestOn / off

    Data Point Markersmarkers

    SettingType and options
    ShowshowOn / off
    SizesizeNumber

    Tooltiptooltip

    SettingType and options
    Share of the PeriodshareOn / off
    Rank (with ties)rankOn / off
    Period TotaltotalOn / off

    Compare (What Changed)compare

    SettingType and options
    Compare Withbase
    • Nothing none
    • The previous period previous
    • Same period last year (from the data) year
    • The Comparison field field
    Rank Change ▲ ▼ in LabelsrankChangeOn / off
    Change in Labels and Tooltipsdelta
    • Off off
    • Absolute (Δ) abs
    • Relative (Δ %) pct
    • Both both
    Show the Reference Rank as a GhostghostOn / off

    Top N and OthertopN

    SettingType and options
    Top N per Period (0 = all)nNumber
    The Restothers
    • One "Other" band band
    • Hide hide
    Name of the Other BandothersLabelText
    Mark Entries and ExitsmarksOn / off

    Risers and Overtakesinsights

    SettingType and options
    Highlight the Biggest Riser and FallermoversOn / off
    Mark OvertakesovertakesOn / off
    Only Overtakes Into the Top (0 = any)withinNumber
    Callout SentencecalloutOn / off

    Forecast of the Totalforecast

    SettingType and options
    ShowshowOn / off
    Periods Ahead (0 = automatic)horizonNumber
    Prediction Intervalinterval
    • None none
    • 80 % 80
    • 95 % 95
    • 80 % and 95 % both

    X-AxisxAxis

    SettingType and options
    ShowshowOn / off
    TitleshowTitleOn / off
    Font SizefontSizeNumber
    ColourcolorColour
    Vertical GridlinesgridOn / off

    Y-AxisyAxis

    SettingType and options
    ShowshowOn / off
    TitleshowTitleOn / off
    Maximum (blank = auto)maxText
    Decimals (-1 = auto)decimalsNumber
    Font SizefontSizeNumber
    ColourcolorColour

    Gridlinesgridlines

    SettingType and options
    Stylestyle
    • From theme theme
    • Solid solid
    • Dashed dashed
    • Dotted dotted
    • None none
    ColourcolorColour

    Legendlegend

    SettingType and options
    ShowshowOn / off
    Positionposition
    • Top top
    • Bottom bottom
    • Right right
    • Left left
    TitleshowTitleOn / off
    Font SizefontSizeNumber
    Text ColourcolorColour

    Total and TrendtotalLine

    SettingType and options
    Total LineshowOn / off
    Trend Line of the Totaltrend
    • None none
    • Linear linear
    Total LabelslabelsOn / off
    Total Label SizelabelSizeNumber
    ColourcolorColour

    Reference LinesrefLines

    SettingType and options
    Horizontal Lineline
    • None none
    • A value value
    • Average total average
    ValuevalueNumber
    LabellabelText
    Vertical Line at PeriodperiodText
    Vertical Line LabelperiodLabelText
    ColourcolorColour
    Show Line LabelsshowLabelsOn / off
    Label SizefontSizeNumber

    Annotationsannotations

    SettingType and options
    Events (period: text; period: text)listText
    Shade Until the Next AnnotationshadeOn / off
    Stylestyle
    • Pin with label pin
    • Flag on the axis flag
    Show NotesshowNotesOn / off
    Font SizefontSizeNumber
    ColourcolorColour

    Zoomzoom

    SettingType and options
    Ctrl + Wheel Zooms, Drag PanswheelOn / off
    Range NavigatornavigatorOn / off
    Navigator HeightnavHeightNumber

    Playbackplayback

    SettingType and options
    Play Through the PeriodsshowOn / off
    Milliseconds per PeriodspeedNumber
    Show the Playing PeriodshowPeriodOn / off
    Period Text SizeperiodSizeNumber
    Period Text ColourperiodColorColour
    Button Text SizebuttonSizeNumber

    Small MultiplessmallMultiples

    SettingType and options
    Columns (0 = auto)columnsNumber
    Shared ScalesharedScaleOn / off
    Panel TitlesshowTitlesOn / off
    Title SizetitleSizeNumber
    Title ColourtitleColorColour

    Smart Captioncaption

    SettingType and options
    ShowshowOn / off
    Positionposition
    • Top top
    • Bottom bottom
    Font SizefontSizeNumber
    ColourcolorColour

    Footnotefootnote

    SettingType and options
    ShowshowOn / off
    SourcesourceText
    State the Rank and Tie RuleruleOn / off
    Font SizefontSizeNumber
    ColourcolorColour

    Accessibilityaccessibility

    SettingType and options
    Distinguish Series Without ColourdistinguishOn / off
    Focus Outline ColourfocusColorColour
    Focus Outline WidthfocusWidthNumber
    Minimum Text Size (0 = off)minFontSizeNumber
    Data Table Text SizetableSizeNumber
    Reduce MotionreduceMotionOn / off

    Themetheme

    SettingType and options
    ThemeselectedTheme
    • SmartVisuals smartvisuals
    • Dark dark
    • Clean (White) clean
    • Slate slate
    Fontfont
    • Inter inter
    • Segoe UI segoe
    • Arial arial
    • Georgia georgia
    Transparent BackgroundtransparentBgOn / off
    Colourspalette
    • From the visual theme theme
    • From the report theme report
    Colour OrdercolorBy
    • Legend order order
    • Name (stable when filtered) name
    Reveal AnimationrevealOn / off
    Animate Data ChangesmorphOn / off

    Series ColoursseriesColors

    SettingType and options
    ColourfillColour

    Data ColoursdataPoint

    SettingType and options
    ColourfillColour

    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" } } }
          }
        }]
      }
    }