Leaderboard fields and settings

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

11 fields · 24 cards · 214 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Entrant`entrant`	Column	Optional	The name on the row
Value`value`	Measure	Optional	What entrants are ranked by
Comparison value`comparison`	Measure	Optional	The previous period's value — drives Movement
Period`period`	Column	Optional	A period axis — drives Movement, streaks and personal best
Image`image`	Column	Optional	A data URI image for the row
Group`group`	Column	Optional	Team or region
Subtitle`subtitle`	Column	Optional	A second line under the name
Target`target`	Measure	Optional	Drives percent to goal
Period progress`progress`	Measure	Optional	How far through the period, 0 to 1 — drives the projection
Is me`isMe`	Measure	Optional	1 on the row that belongs to the person viewing the report, for example [Rep email] = USERPRINCIPALNAME(). Each viewer then sees their own row.
Tooltips`tooltip`	Measure	Optional	Extra fields for the tooltip

Board`board`

Setting	Type and options
Preset`preset`	Custom `custom` League table `league` Sales floor TV `salesFloor` Lowest wins (defects, times) `lowestWins` Executive top 10 `executive` Compact table `compact`
Layout`layout`	List `list` Podium and list `podium` Grid of tiles `grid` Rank history chart `bump`
Density`density`	Comfortable `comfortable` Compact `compact` Wall `wall`
Rows visible`rowsVisible`	Number
Row height`rowHeight`	Number
Row gap`rowGap`	Number
Radius`radius`	Number
Padding`padding`	Number

Ranking`ranking`

Setting	Type and options
Direction`direction`	Highest value wins `highestWins` Lowest value wins `lowestWins`
Rank by`rankBy`	The value `value` Percent of target `pctToTarget` Change against the comparison `change` Change in percent `changePct`
Tie rule`tieRule`	Competition — 1, 2, 2, 4 `competition` Modified competition — 1, 3, 3, 4 `modifiedCompetition` Dense — 1, 2, 2, 3 `dense` Ordinal — 1, 2, 3, 4 (no ties) `ordinal`
Tie detection`tieDetection`	On the displayed value `displayed` On the exact value `exact`
Tie marker`tieMarker`	Equals sign `=` Letter T `T` No marker `none`
Tie break`tieBreak`	Name A to Z `nameAsc` Name Z to A `nameDesc` Model order `modelOrder` Comparison value `comparison` Group, then name `groupThenName`
Blanks`blanks`	Hide them `exclude` Rank them last `rankLast` Show them unranked `showUnranked`
Start at`startAt`	Number
Rank within group`rankWithinGroup`	On / off

Rank number`rankNumber`

Setting	Type and options
Show`show`	On / off
Style`style`	Follow the theme `auto` Plain `plain` In a circle `circle` In a pill `pill` Medal `medal`
Medals`medals`	On / off
Medal gold`medalGold`	Colour
Medal silver`medalSilver`	Colour
Medal bronze`medalBronze`	Colour
Font family`fontFamily`	Format string
Font size`fontSize`	Format string
Bold`bold`	On / off
Italic`italic`	On / off
Underline`underline`	On / off
Color`color`	Colour
Width`width`	Number

Entrant`entrant`

Setting	Type and options
Font family`fontFamily`	Format string
Font size`fontSize`	Format string
Bold`bold`	On / off
Italic`italic`	On / off
Underline`underline`	On / off
Color`color`	Colour
Max lines`maxLines`	Number
Subtitle source`subtitleSource`	None `none` Group `group` Subtitle field `subtitle` Value `value` Rank change `movement`
Subtitle font family`subtitleFontFamily`	Format string
Subtitle font size`subtitleFontSize`	Format string
Subtitle bold`subtitleBold`	On / off
Subtitle italic`subtitleItalic`	On / off
Subtitle underline`subtitleUnderline`	On / off
Subtitle color`subtitleColor`	Colour

Image`image`

Setting	Type and options
Show`show`	On / off
Shape`shape`	Follow the theme `auto` Circle `circle` Rounded `rounded` Square `square`
Size`size`	Number
Border width`borderWidth`	Number
Border color`borderColor`	Colour
Fallback`fallback`	Initials `initials` Silhouette `icon` Nothing `none`
Initials source`initialsSource`	From the group `group` From the name `hash` One colour `fixed`
Initials color`initialsColor`	Colour

Value`value`

Setting	Type and options
Show`show`	On / off
Position`position`	Right of the name `right` Under the name `belowName`
Font family`fontFamily`	Format string
Font size`fontSize`	Format string
Bold`bold`	On / off
Italic`italic`	On / off
Underline`underline`	On / off
Color`color`	Colour
Decimals`decimals`	Number
Abbreviate`abbreviate`	Automatic `auto` Never `none` Thousands `thousands` Millions `millions` Billions `billions`
Align`align`	Left `left` Right `right`
Prefix`prefix`	Text
Suffix`suffix`	Text

Value bar`valueBar`

Setting	Type and options
Show`show`	On / off
Style`style`	Follow the theme `auto` Gradient `gradient` Flat `flat` Thin `thin` Square `square` No bar `none`
Mode`mode`	Share of the leader `leader` Share of the maximum `max` Share of the target `target`
Placement`placement`	Automatic `auto` Under the value `underValue` Behind the row `behindRow` Its own column `column`
Color mode`colorMode`	One colour `single` By group `group` By rank `rank`
Color`color`	Colour
Track`track`	Colour
Height`height`	Number
Radius`radius`	Number

Movement`movement`

Setting	Type and options
Show`show`	On / off
Compare to`compareTo`	Previous period `previous` First period in view `first` A set number of periods back `kBack`
Periods back`periodsBack`	Number
Glyph`glyph`	Follow the theme `auto` Triangle `triangle` Chevron `chevron` Caret `caret` Arrow `arrow`
Show places`showPlaces`	On / off
Show value change`showValueChange`	On / off
Value change as`valueChangeAs`	Absolute `absolute` Percent `percent` Both `both`
Color by`colorBy`	Rank direction `rank` Value direction `value`
Up color`upColor`	Colour
Down color`downColor`	Colour
Flat color`flatColor`	Colour
New badge`newBadge`	On / off
New text`newText`	Text
Show dropouts`showDropouts`	On / off

Badges`badges`

Setting	Type and options
Personal best`personalBest`	On / off
Personal best label`personalBestLabel`	Text
Personal best color`personalBestColor`	Colour
Streak`streak`	On / off
Streak threshold`streakThreshold`	Number
Missing period`missingPeriod`	Breaks the streak `breaks` Is ignored `ignores`
Streak label`streakLabel`	Text
Streak color`streakColor`	Colour
Biggest mover`biggestMover`	On / off
Biggest mover label`biggestMoverLabel`	Text
Biggest mover color`biggestMoverColor`	Colour

Sparkline`sparkline`

Setting	Type and options
Show`show`	On / off
Series`series`	Rank `rank` Value `value`
Periods`periods`	Number
Line width`lineWidth`	Number
Color`color`	Colour
Area`area`	On / off
Last point`lastPoint`	On / off

Target`target`

Setting	Type and options
Show percent`showPercent`	On / off
Over color`overColor`	Colour
Under color`underColor`	Colour
Show marker`showMarker`	On / off
Marker color`markerColor`	Colour
Show gap to next`showGapToNext`	On / off
Gap label`gapLabel`	Text
Show projection`showProjection`	On / off
Projection color`projectionColor`	Colour

Groups`groups`

Setting	Type and options
Mode`mode`	Off `off` Nested standings `nested` Coloured chips `chips`
Header show`headerShow`	On / off
Aggregate`aggregate`	Sum `sum` Average `average` Maximum `max`
Fill`fill`	Colour

Top N`topN`

Setting	Type and options
Enabled`enabled`	On / off
Direction`direction`	Top `top` Bottom `bottom`
Count`count`	Number
Others show`othersShow`	On / off
Others label`othersLabel`	Text
Others aggregate`othersAggregate`	Sum `sum` Average `average` Count `count` No value `none`
Show rank range`showRankRange`	On / off

Focus row`focusRow`

Setting	Type and options
Enabled`enabled`	On / off
Source`source`	Pinned entrants `pinned` The current selection `selection`
Position`position`	Pinned to the bottom `bottom` Pinned to the top `top`
Show gap label`showGapLabel`	On / off
Me highlight`meHighlight`	On / off
Me header`meHeader`	On / off
Pinned`pinned`	On / off

Cut-off lines`cutoff`

Setting	Type and options
Enabled`enabled`	On / off
First after`firstAfter`	Number
First label`firstLabel`	Text
First color`firstColor`	Colour
Second after`secondAfter`	Number
Second label`secondLabel`	Text
Second color`secondColor`	Colour
Style`style`	Dashed `dashed` Solid `solid` Double `double`
Shade below`shadeBelow`	On / off

Race analytics`race`

Setting	Type and options
Gap to leader`gapToLeader`	On / off
Gap to cutoff`gapToCutoff`	On / off
Needed pace`neededPace`	On / off
Tier mode`tierMode`	Off `off` By place — top X% of the board `percentile` By percent of target `pctTarget`
Tier1 at`tier1At`	Number
Tier2 at`tier2At`	Number
Tier3 at`tier3At`	Number
Tier1 target`tier1Target`	Number
Tier2 target`tier2Target`	Number
Tier3 target`tier3Target`	Number
Tier1 label`tier1Label`	Text
Tier2 label`tier2Label`	Text
Tier3 label`tier3Label`	Text
Tier1 color`tier1Color`	Colour
Tier2 color`tier2Color`	Colour
Tier3 color`tier3Color`	Colour
Tier stripe`tierStripe`	On / off

Rank history chart`bump`

Setting	Type and options
Periods`periods`	Number
Lines`lines`	Number
Emphasis`emphasis`	The current top three `top3` Only the selection `selection` Every line equally `all`
Color by`colorBy`	One per entrant `entrant` By group `group` The accent `accent`
Line width`lineWidth`	Number
Markers`markers`	On / off
Start labels`startLabels`	On / off

Wall mode`wall`

Setting	Type and options
Enabled`enabled`	On / off
Auto scale`autoScale`	Fit the rows to the screen `fitRows` Use the sizes as set `fixed`
Page size`pageSize`	Number
Interval`interval`	Number
Transition`transition`	Slide `slide` Fade `fade` None `none`
Pause on interaction`pauseOnInteraction`	On / off
Show page indicator`showPageIndicator`	On / off
Loop`loop`	On / off
Hide chrome`hideChrome`	On / off

Header`header`

Setting	Type and options
Show`show`	On / off
Title source`titleSource`	From the value field `auto` Custom text `custom` No title `none`
Title text`titleText`	Text
Subtitle text`subtitleText`	Text
Show comparison label`showComparisonLabel`	On / off
Comparison label`comparisonLabel`	Text
Show tie note`showTieNote`	On / off
Show biggest mover`showBiggestMover`	On / off
Show count`showCount`	On / off
Count label`countLabel`	Text
Align`align`	Left `left` Centre `center` Right `right`
Font family`fontFamily`	Format string
Font size`fontSize`	Format string
Bold`bold`	On / off
Italic`italic`	On / off
Underline`underline`	On / off
Color`color`	Colour
Divider`divider`	On / off

Animation`animation`

Setting	Type and options
Enabled`enabled`	On / off
Duration`duration`	Number
Easing`easing`	Smooth `smooth` Linear `linear` Spring `spring`
Stagger`stagger`	On / off

Interaction`interaction`

Setting	Type and options
Cross filter`crossFilter`	On / off
Multi select`multiSelect`	On / off
Selection style`selectionStyle`	Dim the others `dim` Outline the selected `outline` Both `both`
Dim opacity`dimOpacity`	Number
Tie selects`tieSelects`	Just that entrant `self` Every tied entrant `group`
Context menu`contextMenu`	On / off

Language`language`

Setting	Type and options
Locale`locale`	Follow Power BI `auto` English `en-US` Čeština `cs-CZ`

Theme`themeCard`

Setting	Type and options
Theme`theme`	SmartVisuals `smartvisuals` Dark `dark` Clean `clean` Slate `slate`
Accent`accent`	Colour
Background`background`	Colour
Border`border`	On / off
Border color`borderColor`	Colour
Use report colors`useReportColors`	On / off

Accessibility`accessibility`

Setting	Type and options
Focus color`focusColor`	Colour
Focus width`focusWidth`	Number
Min font size`minFontSize`	Number
Movement text`movementText`	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": "smartVisualsLeaderboardA1F4C7E29B4D46A0B8E3D5C7F2A19E60",
  "objects": {
    "ranking": [{
      "properties": {
        "rankWithinGroup": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Leaderboard fields and settings

Fields

Boardboard

Rankingranking

Rank numberrankNumber

Entrantentrant

Imageimage

Valuevalue

Value barvalueBar

Movementmovement

Badgesbadges

Sparklinesparkline

Targettarget

Groupsgroups

Top NtopN

Focus rowfocusRow

Cut-off linescutoff

Race analyticsrace

Rank history chartbump

Wall modewall

Headerheader

Animationanimation

Interactioninteraction

Languagelanguage

ThemethemeCard

Accessibilityaccessibility