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

9 fields · 15 cards · 82 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Date`date`	Column	Optional · up to 4	A date or date/time column. A date hierarchy works too — the visual rebuilds the days from its levels.
Value`value`	Measure	Optional · up to 5	What colours the cells. Add several measures to switch between them. Empty = count of rows.
Target`target`	Measure	Optional	Optional goal per day — colour cells by attainment.
Small multiples`group`	Column	Optional	One calendar per value (plant, team, product…).
Matrix rows`rows`	Column	Optional	Row field for the matrix heatmap view.
Matrix columns`columns`	Column	Optional	Column field for the matrix heatmap view.
Notes`annotation`	Column	Optional	Event or note text per day — marked on the cell and shown in the tooltip.
Holidays`holiday`	Column	Optional	Holiday name per day (your own calendar table). Built-in national packs are in the format pane.
Tooltips`tooltips`	Measure	Optional · up to 10	Extra measures shown in tooltips.

View`view`

Setting	Type and options
Type`type`	Year strip `yearStrip` Month grid `monthGrid` Matrix heatmap `matrix`
Years`years`	Auto `auto` One strip per year `years` Continuous `continuous`
Period`period`	All data `all` Latest year `latestYear` Last 12 months `last12`
Show switcher`showSwitcher`	On / off
Allow zoom`allowZoom`	On / off

Calendar`calendar`

Setting	Type and options
Week start`weekStart`	Monday `1` Sunday `0` Saturday `6`
Year mode`yearMode`	Calendar year `calendar` Fiscal year `fiscal` Retail 4-4-5 year `retail`
Fiscal start`fiscalStart`	January `0` February `1` March `2` April `3` May `4` June `5` July `6` August `7` September `8` October `9` November `10` December `11`
Fiscal naming`fiscalNaming`	By end year `end` By start year `start`
Retail pattern`retailPattern`	4-4-5 `445` 4-5-4 `454` 5-4-4 `544`
Retail end month`retailEndMonth`	January `0` February `1` March `2` April `3` May `4` June `5` July `6` August `7` September `8` October `9` November `10` December `11`
Retail end weekday`retailEndWeekday`	Sunday `0` Monday `1` Tuesday `2` Wednesday `3` Thursday `4` Friday `5` Saturday `6`
Retail rule`retailRule`	Last weekday of month `last` Weekday nearest month end `nearest`
Week numbers`weekNumbers`	Off `none` ISO 8601 `iso` Week of 1 January = 1 `simple`
Holidays`holidays`	None `none` United States (federal) `us` United Kingdom (England & Wales) `uk` Germany (national) `de` France `fr` Czechia `cz` Poland `pl` Austria `at` Netherlands `nl` Spain (national) `es` Italy `it` Canada (federal) `ca` Australia (national) `au` Slovakia `sk` Hungary `hu` Belgium `be` Ireland `ie` Portugal `pt` Sweden `se` Denmark `dk` Norway `no` Finland `fi`
Shade weekends`shadeWeekends`	On / off
Show today`showToday`	On / off
Weekend color`weekendColor`	Colour
Holiday color`holidayColor`	Colour
Today color`todayColor`	Colour

Colours`colors`

Setting	Type and options
Palette`palette`	Theme `theme` Report theme colour `report` Greens (GitHub) `greens` Blues `blues` Oranges `oranges` Purples `purples` Viridis (colour-blind safe) `viridis` Cividis (colour-blind safe) `cividis` Magma `magma` Red – Blue (diverging) `redBlue` Brown – Teal (diverging) `brownTeal` Purple – Green (diverging) `purpleGreen` Custom colours `custom`
Low color`lowColor`	Colour
Mid color`midColor`	Colour
High color`highColor`	Colour
Empty color`emptyColor`	Colour
Scale type`scaleType`	Linear `linear` Quantile (outlier-proof) `quantile` Logarithmic `log` Manual thresholds `thresholds`
Steps`steps`	Number
Diverging`diverging`	On / off
Center`center`	Zero `zero` Mean `mean` Median `median` Custom value `custom`
Center value`centerValue`	Number
Thresholds`thresholds`	Text
Domain min`domainMin`	Text
Domain max`domainMax`	Text
Clamp outliers`clampOutliers`	On / off
Reverse`reverse`	On / off
Aggregation`aggregation`	Sum `sum` Average `avg` Minimum `min` Maximum `max` Count of rows `count`

Cells`cells`

Setting	Type and options
Shape`shape`	Theme default `theme` Rounded `rounded` Square `square` Circle `circle`
Gap`gap`	Number
Show values`showValues`	On / off
Show day numbers`showDayNumbers`	On / off

Labels`labels`

Setting	Type and options
Font family`fontFamily`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Font size`fontSize`	Number
Font color`fontColor`	Colour
Show month labels`showMonthLabels`	On / off
Weekday labels`weekdayLabels`	Alternate days `alternate` All days `all` Off `none`
Show year totals`showYearTotals`	On / off

Legend`legend`

Setting	Type and options
Prop_Show`show`	On / off
Position`position`	Bottom `bottom` Top `top`
Show title`showTitle`	On / off
Show markers`showMarkers`	On / off

Summary`summary`

Setting	Type and options
Show`show`	On / off
Show insights`showInsights`	On / off

Sparkline margins`margins`

Setting	Type and options
Weekday profile`weekdayProfile`	On / off
Period totals`periodTotals`	On / off
Bar color`barColor`	Colour

Matrix`matrix`

Setting	Type and options
Axes`axes`	Auto `auto` Rows × Columns fields `fields` Weekday × Hour `weekdayHour` Weekday × Month `weekdayMonth` Year × Month `monthYear` Month × Day `dayMonth` Weekday × Week `weekdayWeek`
Row order`rowOrder`	Natural order `data` A → Z `az` Largest total first `totalDesc`
Col order`colOrder`	Natural order `data` A → Z `az` Largest total first `totalDesc`
Show as`showAs`	Value `value` % of row `pctRow` % of column `pctCol` % of total `pctTotal`
Hour format`hourFormat`	24-hour `24` 12-hour `12`

Notes`annotations`

Setting	Type and options
Prop_Show`show`	On / off
Pinned`pinned`	Text
Show text`showText`	On / off
Prop_RuleColor`color`	Colour

Comparison`comparison`

Setting	Type and options
Mode`mode`	Off `none` Versus target `target` Versus prior year `priorYear`
Alignment`alignment`	Same weekday (52 weeks back) `weekday` Same date `date`
Range`range`	Number
Show year deltas`showYearDeltas`	On / off

Small multiples`multiples`

Setting	Type and options
Columns`columns`	Number
Shared scale`sharedScale`	On / off
Show titles`showTitles`	On / off

Insights`insights`

Setting	Type and options
Anomalies`anomalies`	On / off
Sensitivity`sensitivity`	Low `low` Medium `medium` High `high`
Direction`direction`	High and low `both` High only `high` Low only `low`
Streaks`streaks`	On / off
Streak threshold`streakThreshold`	Number
High color`highColor`	Colour
Low color`lowColor`	Colour

Measures`measures`

Setting	Type and options
Active`active`	Text
Show switcher`showSwitcher`	On / off

Theme`theme`

Setting	Type and options
Selected theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean `clean` Slate `slate`
Transparent bg`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": "calendarHeatmap23B3BA3C1DCD4DE5A9759C587CE879F3",
  "objects": {
    "view": [{
      "properties": {
        "showSwitcher": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Calendar Heatmap fields and settings

Fields

Viewview

Calendarcalendar

Colourscolors

Cellscells

Labelslabels

Legendlegend

Summarysummary

Sparkline marginsmargins

Matrixmatrix

Notesannotations

Comparisoncomparison

Small multiplesmultiples

Insightsinsights

Measuresmeasures

Themetheme