Year in Review 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 Year in Review page; every setting works in edit mode with or without one.
5 fields · 12 cards · 104 settings Markdown for AI assistantscatalog.json
Fields
| Field | Takes | Needed | What it is for |
|---|---|---|---|
Datedate | Column | Optional · up to 4 | The date of each row: a date column, or a date hierarchy (Year, Quarter, Month, Day). |
Valuevalue | Measure | Optional | The measure the year is about: revenue, units, orders, hours, visits. |
Categoriescategory | Column | Optional · up to 2 | Up to two fields to rank: product line, region, channel. The first one also drives the biggest mover. |
For Each (Premium)forEach | Column | Optional | One year in review per value of this field: per sales rep, team, plant or customer. A Target that does not vary by this field counts in full for each. |
Target (Premium)target | Measure | Optional | A target or plan measure by date. A target that repeats on every category row of a day counts once; one that differs by category is added up. Dates after the last actual do not count. |
Themetheme
| Setting | Type and options |
|---|---|
ThemeselectedTheme |
|
Stylestyle |
|
Artart |
|
Transparent BackgroundtransparentBg | On / off |
Card Corners (px, -1 = Theme)corners | Number |
Viewview
| Setting | Type and options |
|---|---|
Viewview |
|
Grid Columns (0 = Auto)gridColumns | Number |
Advance AutomaticallyautoAdvance | On / off |
Seconds Per Cardseconds | Number |
Pause On HoverpauseOnHover | On / off |
Show Progress BarsshowProgress | On / off |
Show ArrowsshowArrows | On / off |
Motionmotion |
|
Periodperiod
| Setting | Type and options |
|---|---|
Periodmode |
|
Yearyear | Number |
Year Starts InfiscalStart |
|
Year Iscompleteness |
|
Week Starts OnweekStart |
|
Combine Values Byaggregation |
|
Cardscards
| Setting | Type and options |
|---|---|
Show Introintro | On / off |
Show Totaltotal | On / off |
Show Peakpeak | On / off |
Show Top categoriestop | On / off |
Show Top categories (second field)top2 | On / off |
Show Biggest movermover | On / off |
Show Streakstreak | On / off |
Show Rhythmrhythm | On / off |
Show Recordsrecords | On / off |
Show Milestonesmilestones | On / off |
Show Personalitypersonality | On / off |
Show Target (Premium)target | On / off |
Show Team awards (Premium)awards | On / off |
Show Summarysummary | On / off |
Top NtopN | Number |
Streak CountsstreakRule |
|
Streak ValuestreakValue | Number |
Target Is FortargetScope |
|
Texttext
| Setting | Type and options |
|---|---|
Languagelanguage |
|
Namename | Text |
Titletitle | Text |
Measure LabelmeasureLabel | Text |
NumbersnumberStyle |
|
Fontfont |
|
Text Size (%)textSize | Number |
Accessibilityaccessibility
| Setting | Type and options |
|---|---|
Focus Outline ColorfocusColor | Colour |
Focus Outline Width (px)focusWidth | Number |
Minimum Text Size (px, 0 = Off)minFontSize | Number |
Motionmotion |
|
Comparison (Premium)comparison
| Setting | Type and options |
|---|---|
Compare With Last Yearcompare | On / off |
For Each (Premium)forEach
| Setting | Type and options |
|---|---|
Showdisplay |
|
Show RankshowRank | On / off |
Ordersort |
|
Most TilesmaxTiles | Number |
Card Order (Premium)order
| Setting | Type and options |
|---|---|
Custom Ordercustom | On / off |
Intro Positionpos_intro | Number |
Total Positionpos_total | Number |
Peak Positionpos_peak | Number |
Top categories Positionpos_top | Number |
Top categories (second field) Positionpos_top2 | Number |
Biggest mover Positionpos_mover | Number |
Streak Positionpos_streak | Number |
Rhythm Positionpos_rhythm | Number |
Records Positionpos_records | Number |
Milestones Positionpos_milestones | Number |
Personality Positionpos_personality | Number |
Target Positionpos_target | Number |
Custom card 1 Positionpos_custom1 | Number |
Custom card 2 Positionpos_custom2 | Number |
Custom card 3 Positionpos_custom3 | Number |
Team awards Positionpos_awards | Number |
Summary Positionpos_summary | Number |
Card Builder (Premium)builder
| Setting | Type and options |
|---|---|
Show Custom Card 1show1 | On / off |
Card 1 Titletitle1 | Text |
Card 1 Textbody1 | Text |
Show Custom Card 2show2 | On / off |
Card 2 Titletitle2 | Text |
Card 2 Textbody2 | Text |
Show Custom Card 3show3 | On / off |
Card 3 Titletitle3 | Text |
Card 3 Textbody3 | Text |
Colorscolors
| Setting | Type and options |
|---|---|
Texttext | Colour |
Accentaccent | Colour |
Upup | Colour |
Downdown | Colour |
Chart Barsbars | Colour |
Progress Bars And Buttonsprogress | Colour |
Page BackgroundpageBg | Colour |
Card Backgroundsbackgrounds
| Setting | Type and options |
|---|---|
Introbg_intro | Colour |
Totalbg_total | Colour |
Peakbg_peak | Colour |
Top categoriesbg_top | Colour |
Top categories (second field)bg_top2 | Colour |
Biggest moverbg_mover | Colour |
Streakbg_streak | Colour |
Rhythmbg_rhythm | Colour |
Recordsbg_records | Colour |
Milestonesbg_milestones | Colour |
Personalitybg_personality | Colour |
Targetbg_target | Colour |
Custom card 1bg_custom1 | Colour |
Custom card 2bg_custom2 | Colour |
Custom card 3bg_custom3 | Colour |
Team awardsbg_awards | Colour |
Summarybg_summary | 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": "wrappedYearInReview590CC3915B59468CB5347877640DE889",
"objects": {
"theme": [{
"properties": {
"transparentBg": { "expr": { "Literal": { "Value": "true" } } }
}
}]
}
}