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

5 fields · 10 cards · 49 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Score (0–10)`score`	Column	Required	The likelihood-to-recommend answer, 0–10
Wave / Period`wave`	Column	Optional	Optional: track the score over waves in model sort order
Segment`segment`	Column	Optional	Optional: compare the score across banner segments, with significance letters
Value`value`	Measure	Required	Respondent count — or Sum of Weight for weighted results
Sum of Weight² (significance)`weightsq`	Measure	Optional	Optional: SUM(weight²) enables effective bases for weighted significance

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Transparent Background`transparentBg`	On / off
Quick Style`stylePreset`	Custom (keep my settings) `custom` Agency deck `agency` Executive summary `executive` Compact tracker `compact`

Score Mapping`mapping`

Setting	Type and options
Detractors Up To`detractorMax`	Number
Promoters From`promoterMin`	Number

Display`display`

Setting	Type and options
Show Headline Score`showHeadline`	On / off
Show Split Bar`showSplit`	On / off
Show Wave Trend`showTrend`	On / off
Score Decimal Places`scoreDecimals`	Number
Score Style`scoreStyle`	Number `number` Badge `badge` Face `face`
Score Position`scorePosition`	Left `left` Center `center` Right `right`
Change vs`deltaReference`	Previous wave `previous` First wave `first` Target `target`
Colour Score by Band`colorByBand`	On / off
Good from`bandGood`	Number
Poor below`bandPoor`	Number
Score Label`scoreLabel`	Text
Animate Score`animateScore`	On / off
Show 0–10 Histogram`showHistogram`	On / off
Trend Smoothing`rollingWaves`	None `1` 3-wave rolling average `3`
Sort Segments`segmentSort`	Data order `data` By score `score` By change vs previous wave `change`
Show Margin of Error (±)`showMarginOfError`	On / off
Show Confidence Band on Trend`showConfidenceBand`	On / off

Colors`colorSettings`

Setting	Type and options
Detractors`detractorColor`	Colour
Passives`passiveColor`	Colour
Promoters`promoterColor`	Colour

Bars`barSettings`

Setting	Type and options
Corner Radius`cornerRadius`	Number
Bar Thickness (%)`thickness`	Number
Gap Between Segments`segmentGap`	Number

Labels`labelSettings`

Setting	Type and options
Font Size`fontSize`	Number
Font`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Font Color`fontColor`	Colour
Show Split %`showShares`	On / off
Show Base (n=)`showBase`	On / off

Significance (Premium)`significance`

Setting	Type and options
Test Change vs Previous Wave`enabled`	On / off
Confidence Level`confidence`	90 % `90` 95 % `95` 99 % `99`
Min Base for Testing`minBase`	Number
Multiple-Comparison Correction`correction`	None `none` Bonferroni `bonferroni`
Explain Letters in Footer`showLetterLegend`	On / off
Hatch Low Bases`lowBaseHatch`	On / off

Target (Premium)`target`

Setting	Type and options
Show Target`show`	On / off
Target Score`value`	Number
Label`label`	Text
Color (empty = theme)`color`	Colour
Show Gap to Target`showGapHint`	On / off

Smart Caption`insights`

Setting	Type and options
Show Caption`show`	On / off
Position`position`	Top `top` Bottom `bottom`

Footnote`footnote`

Setting	Type and options
Show Footnote`show`	On / off
Template ({base} {n} {neff} {wave} {question} {source})`template`	Text
Source`source`	Text

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": "npsChartBAC1A083FCF3471CB82882A8EB97F109",
  "objects": {
    "theme": [{
      "properties": {
        "transparentBg": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

NPS fields and settings

Fields

Themetheme

Score Mappingmapping

Displaydisplay

ColorscolorSettings

BarsbarSettings

LabelslabelSettings

Significance (Premium)significance

Target (Premium)target

Smart Captioninsights

Footnotefootnote