Newspaper 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 Newspaper page; every setting works in edit mode with or without one.

8 fields · 11 cards · 68 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Category`category`	Column	Optional	Who the stories are about: branch, region, product, team.
Period`period`	Column	Optional	When: month, quarter, year or a date. Enables movers, records and streaks.
Edition By ★`editionBy`	Column	Optional	One front page per value, for example per business unit or country (premium).
Measure`measure`	Measure	Optional	The lead measure the front page reports on.
More Measures ★`secondary`	Measure	Optional · up to 2	Up to two more measures for Editor's desk stories (premium).
Target ★`target`	Measure	Optional	Plan, budget or target for the lead measure: stories against plan (premium).
Image`image`	Column	Optional	A logo or photo per category as a data: URI. Web addresses are never fetched.
Tooltips`tooltips`	Measure	Optional · up to 5	Extra values shown when hovering a story.

Setting	Type and options
Show Masthead`show`	On / off
Title`title`	Text
Tagline`tagline`	Text
Show Edition Line`showEditionLine`	On / off
Title Size (0 = Auto)`titleSize`	Number

Edition`edition`

Setting	Type and options
Style`style`	Newspaper `newspaper` Boardroom `boardroom`
Layout`layout`	Auto (Fit the Tile) `auto` Broadsheet `broadsheet` Tabloid `tabloid` Digest `digest`
Stories Below the Lead`storyCount`	Number
Show In Brief`showBriefs`	On / off
Show The Numbers`showNumbers`	On / off
Edition Period`editionPeriod`	Auto (Skip a Half-Loaded Period) `auto` Latest `latest` Previous `previous`
Compare With`comparison`	Previous Period `previous` Previous Period and Last Year ★ `both`

Editions ★`editions`

Setting	Type and options
Open on Edition ★`start`	Text

Stories`stories`

Setting	Type and options
Headline Language`language`	Auto (Report Language) `auto` English `en` Español `es` Português `pt` Deutsch `de`
Headline Case`headlineCase`	Sentence case `sentence` Title Case `title` UPPERCASE `upper`
Smallest Change Worth Reporting (%)`minChange`	Number
Which Way Is Better`polarity`	Auto (From the Measure Name) `auto` Higher Is Better `higher` Lower Is Better `lower` Neither Is Better `neutral`
Measure Type`measureType`	Auto (From Format and Name) `auto` Amount (Adds Up) `amount` Average or Ratio `average` Percentage (Changes in Points) `percent`
Rank Changes`showOvertake`	On / off
Biggest Rise and Fall`showMovers`	On / off
Total`showTotal`	On / off
Leader and Lead Margin`showLeader`	On / off
Share of the Top Three`showConcentration`	On / off
Leave Out (Comma-Separated)`muteCategories`	Text

Charts`charts`

Setting	Type and options
Show Charts`show`	On / off
Story Color (Empty = Theme)`accentColor`	Colour
Rise Color (Empty = Theme)`upColor`	Colour
Fall Color (Empty = Theme)`downColor`	Colour
Bar Color (fx)`barColor`	Colour

Images`images`

Setting	Type and options
Show Images`show`	On / off
Image Size (px)`size`	Number
Round Images`rounded`	On / off

Typography`typography`

Setting	Type and options
Headline Font`headlineFont`	Theme `theme` Serif `serif` Sans `sans` Condensed `condensed`
Body Font`bodyFont`	Theme `theme` Serif `serif` Sans `sans`
Body Text Size`bodySize`	Number
Headline Scale (%)`headlineScale`	Number

Editor's Desk ★`editorsDesk`

Setting	Type and options
Records ★`recordStories`	On / off
Streaks and Comebacks ★`streakStories`	On / off
Unusual Moves ★`unusualStories`	On / off
Plan Stories ★`targetStories`	On / off
Stories on More Measures ★`secondaryStories`	On / off
Year-to-Date Story ★`ytdStory`	On / off
Lead Headline Template ★`leadTemplate`	Text
Lead Deck Template ★`deckTemplate`	Text
Pin to the Lead ★`pinCategory`	Text

Headline Templates ★`headlineTemplates`

Setting	Type and options
Lead Change ★`overtakeLead`	Text
Rank Change ★`overtake`	Text
Record ★`record`	Text
Biggest Rise ★`surge`	Text
Biggest Fall ★`slump`	Text
Comeback ★`comeback`	Text
Streak ★`streak`	Text
Unusual Move ★`unusual`	Text
Total ★`total`	Text
Leader ★`leader`	Text
Lead Margin ★`gap`	Text
Share of the Top Three ★`concentration`	Text
Plan ★`target`	Text
Year to Date ★`ytd`	Text

Accessibility`accessibility`

Setting	Type and options
Focus Outline Color (Empty = Theme)`focusColor`	Colour
Focus Outline Width`focusWidth`	Number
Minimum Text Size`minTextSize`	Number
Reduce Motion`reduceMotion`	On / off
Arrows for Rise and Fall`nonColorCues`	On / off

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Special Edition`specialEdition`	None `none` Vintage ★ `vintage` Evening Edition ★ `pink`
Paper Color (Empty = Theme)`bgColor`	Colour
Transparent Background`transparentBg`	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": "smartvisualsNewspaper5E1A7C93D0B24F6A8E21C4D7B9F03A61",
  "objects": {
    "masthead": [{
      "properties": {
        "show": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Newspaper fields and settings

Fields

Mastheadmasthead

Editionedition

Editions ★editions

Storiesstories

Chartscharts

Imagesimages

Typographytypography

Editor's Desk ★editorsDesk

Headline Templates ★headlineTemplates

Accessibilityaccessibility

Themetheme