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

12 fields · 15 cards · 73 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
KPI`category`	Column	Optional	One forecast per KPI, region, plant line or project.
Group`group`	Column	Optional	Optional sections: KPIs are grouped under a header with their weather counts.
Period`period`	Column	Optional	Optional date or period: the latest period with an actual is today's weather; the history draws the trend and feeds the forecast.
Actual`value`	Measure	Optional	The measured value of the KPI.
Target`target`	Measure	Optional	Plan, budget or goal. Today's weather is the actual against it; future periods are judged against their own target.
Comparison`comparison`	Measure	Optional · up to 3	Prior year, last forecast or any value to compare the actual with. The first is free; a second and third are premium. The weather stays actual vs target.
Rain threshold`rainAt`	Measure	Optional	Optional per-KPI value where rain begins (below it for higher-is-better KPIs, above it for lower-is-better).
Storm threshold`stormAt`	Measure	Optional	Optional per-KPI value where storm begins.
Lower is better`lowerIsBetter`	Measure	Optional	Per-KPI direction: 1/true where a lower value is better (costs, defects, lead time). Aggregate with Max.
Elapsed %`elapsed`	Measure	Optional	Share of the period already elapsed (0 to 1) for pace: a to-date value is judged against target × elapsed.
Unit or format`unit`	Measure	Optional	Per-KPI unit (%, days, kWh, €) or format string (0.0%) for mixed-unit scorecards. Use First or Max on a text column.
Tooltips`tooltips`	Measure	Optional · up to 5	Extra measures shown in the tooltip.

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Font`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Weather art`glyphStyle`	Theme default `theme` Illustrated `illustrated` Glow `glow` Line `line` Solid `solid`
Backdrop`skyScene`	None `none` Sky scenes `sky`
Transparent background`transparentBg`	On / off
Background color`backgroundColor`	Colour

Layout`layout`

Setting	Type and options
Layout`mode`	Auto `auto` Hero `hero` Grid `grid` Forecast strip `strip` Boardroom table `boardroom`
Sort`sortBy`	Data order `data` Worst first `worst` Best first `best` Name, A to Z `name`
Tile columns (0 = auto)`tileColumns`	Number
Rotate KPIs every n seconds (0 = off)`rotateSeconds`	Number
Group headers`showGroups`	On / off
Rotation dots`showDots`	On / off

Tiles`tiles`

Setting	Type and options
Tile color`tileColor`	Colour
Border color`borderColor`	Colour
Status stripe`stripe`	Theme default `theme` On `on` Off `off`
Corner radius (-1 = theme)`cornerRadius`	Number

Weather rules`status`

Setting	Type and options
Direction`polarity`	Higher is better `higher` Lower is better `lower`
Sunny from (% of target)`sunnyFrom`	Number
Partly cloudy from (% of target)`partlyFrom`	Number
Rain from (% of target), storm below`rainFrom`	Number
Trend rule`trendAdjust`	Off `off` Falling trend lowers the weather `lower`
Steady wind within (± % points)`steadyBand`	Number

Weather words`words`

Setting	Type and options
Show words`show`	On / off
Words`wordSet`	Weather `weather` Business `business` Custom `custom`
Sunny`sunny`	Text
Partly cloudy`partly`	Text
Rain`rain`	Text
Storm`storm`	Text
No reading`fog`	Text

Weather colors`colors`

Setting	Type and options
Sunny`sunnyColor`	Colour
Partly cloudy`partlyColor`	Colour
Rain`rainColor`	Colour
Storm`stormColor`	Colour
No reading`fogColor`	Colour

Values`values`

Setting	Type and options
Value`showValue`	On / off
Target`showTarget`	On / off
Variance`varianceMode`	Off `none` Percent `pct` Absolute `abs` Absolute and percent `both`
Display units`displayUnits`	Auto `auto` None `none` Thousands `thousands` Millions `millions` Billions `billions`
Decimal places (-1 = auto)`decimals`	Number
Value size (0 = auto)`valueSize`	Number
Value color`valueColor`	Colour

Comparison`comparison`

Setting	Type and options
Show comparison`show`	On / off
Variance to comparison`varianceMode`	Percent `pct` Absolute `abs` Absolute and percent `both`
Comparison value`showValue`	On / off

Trend`trend`

Setting	Type and options
Wind arrow`showWind`	On / off
Sparkline`showSparkline`	On / off
Sparkline color`sparkColor`	Colour
Target line in sparkline`showTargetLine`	On / off
Target line color`targetLineColor`	Colour
Wind arrow color`windColor`	Colour
Current value from`aggregation`	Latest period `latest` Sum of periods `sum` Average of periods `average`

Outlook`forecast`

Setting	Type and options
Periods ahead (0 = off)`horizon`	Number
Trend fitted on last n periods`window`	Number
Chance of meeting target`showChance`	On / off
Chance as`chanceStyle`	Percent (70%) `percent` Odds (7 in 10) `in10`
Forecast values`showValues`	On / off
Storm warnings in the report`showWarnings`	On / off
Outlook text size (0 = auto)`outlookSize`	Number

Pace`pace`

Setting	Type and options
Period elapsed`period`	Off `none` Year to date (today) `year` Quarter to date (today) `quarter` Month to date (today) `month` Fixed % `fixed` Elapsed % field `measure`
Elapsed %`fixedElapsed`	Number

Labels`labels`

Setting	Type and options
KPI names`showName`	On / off
Font size`fontSize`	Number
Font color`fontColor`	Colour
Secondary text color`secondaryColor`	Colour

Weather report`report`

Setting	Type and options
Summary sentence`show`	On / off
Position`position`	Top `top` Bottom `bottom`
Font size`fontSize`	Number
Color`color`	Colour

Animation`animation`

Setting	Type and options
Weather animation`mode`	Off `off` Play once, then rest `settle` Continuous (wall screens) `continuous`

Accessibility`accessibility`

Setting	Type and options
Focus outline color`focusColor`	Colour
Focus outline width`focusWidth`	Number
Minimum text size (0 = off)`minFontSize`	Number
Reduce motion`reduceMotion`	Follow system `system` Always reduce `always` Off `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": "kpiWeatherFF07437A76914148ACA0775101EF3B6F",
  "objects": {
    "theme": [{
      "properties": {
        "transparentBg": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

KPI Weather fields and settings

Fields

Themetheme

Layoutlayout

Tilestiles

Weather rulesstatus

Weather wordswords

Weather colorscolors

Valuesvalues

Comparisoncomparison

Trendtrend

Outlookforecast

Pacepace

Labelslabels

Weather reportreport

Animationanimation

Accessibilityaccessibility