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

8 fields · 21 cards · 111 settings Markdown for AI assistants catalog.json

Fields

Field	Takes	Needed	What it is for
Axis (date)`axis`	Column	Optional	The time axis: a date, a date hierarchy level, a number or text periods
Legend`legend`	Column	Optional	One series per value (one row per value in Sparklines)
Values`values`	Measure	Optional	Measures drawn as lines, areas or sparklines
Target`target`	Measure	Optional	Plan, budget or target: a dashed series and the base for variances
High`high`	Measure	Optional	Highest value of each period (candles), or the top of a range band
Low`low`	Measure	Optional	Lowest value of each period (candles), or the bottom of a range band
Small multiples`facet`	Column	Optional	One panel per value (premium)
Tooltips`tooltips`	Measure	Optional	Extra fields in tooltips

Presets and Templates`presets`

Setting	Type and options
Apply Preset`preset`	(choose to apply) `none` Executive `executive` Finance (IBCS) `finance` Trading `trading` Monitoring `monitoring` Print `print`
Style Template (copy or paste)`template`	Text

Sparklines`sparklines`

Setting	Type and options
Layout`layout`	Table `table` Grid of tiles `grid`
Sparkline`type`	Line `line` Area `area` Columns `column` Win / loss `winloss` Last value vs target `bullet`
Table Columns`columns`	Text
Change Compares`changeBasis`	Last vs first in view `window` Last vs previous point `previous` Last vs same period a year ago `year`
Scale`scale`	Shared (honest comparison) `shared` Independent per row (shape only) `independent`
Sort Rows By`sortBy`	Data order `data` Name `name` Last value `last` Change `change` Change % `changePct` Trend (Sen's slope) `trend`
Sort Direction`sortDirection`	Ascending `asc` Descending `desc`
Row Height`rowHeight`	Number
Tile Columns (0 = auto)`tileColumns`	Number
Mark First`markFirst`	On / off
Mark Last`markLast`	On / off
Mark Minimum and Maximum`markMinMax`	On / off
Mark Negative Values`markNegative`	On / off
Normal Range From`bandFrom`	Text
Normal Range To`bandTo`	Text
Higher Is Better`higherIsBetter`	On / off
Year-End Projection`yearEnd`	On / off

Data Labels`labels`

Setting	Type and options
Show`show`	None `none` All points `all` Last point `last` Minimum and maximum `minmax` First and last `firstlast`
Label Every Nth Point`every`	Number
Decimals (-1 = auto)`decimals`	Number
Font Size`fontSize`	Number
Colour`color`	Colour
Background Pill`background`	On / off

Trend Line`trend`

Setting	Type and options
Type`type`	None `none` Linear `linear` Polynomial (2nd order) `poly2` Polynomial (3rd order) `poly3` Polynomial (4th order) `poly4` Exponential `exponential` Logarithmic `logarithmic` Power `power` LOESS (smooth) `loess` Simple moving average `sma` Exponential moving average `ema` Weighted moving average `wma`
Moving Average Periods`window`	Number
LOESS Span (%)`span`	Number
For Every Series`allSeries`	On / off
Line Style`dash`	Solid `solid` Dashed `dashed` Dotted `dotted` Dash-dot `dashdot`
Equation and R² in Legend`showEquation`	On / off

Forecast`forecast`

Setting	Type and options
Show Forecast`show`	On / off
Periods Ahead (0 = one season)`horizon`	Number
Or Forecast Through (yyyy-mm-dd)`through`	Text
Model`model`	Automatic (lowest AICc) `auto` Simple exponential smoothing `ANN` Holt linear trend `AAN` Damped trend `AAdN` Seasonal, no trend `ANA` Holt-Winters additive `AAA` Holt-Winters damped `AAdA`
Season Length (0 = from dates)`season`	Number
Prediction Interval`level`	None `none` 80 % `80` 95 % `95` 80 % and 95 % `both`
Mark Anomalies`anomalies`	On / off
For Every Series`allSeries`	On / off

Trend Test`trendTest`

Setting	Type and options
Test for a Trend (Mann-Kendall)`show`	On / off
Significance Level`alpha`	10 % `0.1` 5 % `0.05` 1 % `0.01`

X-Axis`xAxis`

Setting	Type and options
Show`show`	On / off
Title`showTitle`	On / off
Font Size`fontSize`	Number
Colour`color`	Colour
Vertical Gridlines`grid`	On / off

Y-Axis`yAxis`

Setting	Type and options
Show`show`	On / off
Title`showTitle`	On / off
Minimum (blank = auto)`min`	Text
Maximum (blank = auto)`max`	Text
Start At Zero`zero`	Automatic (columns and areas) `auto` Always `always` Never `never`
Logarithmic Scale`log`	On / off
Decimals (-1 = auto)`decimals`	Number
Font Size`fontSize`	Number
Colour`color`	Colour
Align Zero Across Axes`align`	On / off

Gridlines`gridlines`

Setting	Type and options
Style`style`	From theme `theme` Solid `solid` Dashed `dashed` Dotted `dotted` Zebra bands `bands` None `none`
Colour`color`	Colour

Legend`legend`

Setting	Type and options
Show`show`	On / off
Position`position`	Top `top` Bottom `bottom` Right `right`
Font Size`fontSize`	Number
Text Colour`color`	Colour

Reference Lines`refLines`

Setting	Type and options
Line 1`line1`	None `none` A value `value` Average `average` Median `median` Percentile `percentile` Minimum `min` Maximum `max` Target field (last value) `target`
Line 1 Value`line1Value`	Number
Line 1 Percentile`line1Pct`	Number
Line 1 Label`line1Label`	Text
Line 1 Colour`line1Color`	Colour
Line 2`line2`	None `none` A value `value` Average `average` Median `median` Percentile `percentile` Minimum `min` Maximum `max` Target field (last value) `target`
Line 2 Value`line2Value`	Number
Line 2 Percentile`line2Pct`	Number
Line 2 Label`line2Label`	Text
Line 2 Colour`line2Color`	Colour
For Every Series`perSeries`	On / off
Vertical Line`vertical`	None `none` Today `today` A date `date`
Vertical Line Date (yyyy-mm-dd)`verticalDate`	Text
Vertical Line Label`verticalLabel`	Text

Reference Bands`refBands`

Setting	Type and options
Value Band From`valueFrom`	Text
Value Band To`valueTo`	Text
Value Band Label`valueLabel`	Text
Value Band Colour`valueColor`	Colour
Period From (yyyy-mm-dd)`timeFrom`	Text
Period To (yyyy-mm-dd)`timeTo`	Text
Period Label`timeLabel`	Text
Period Colour`timeColor`	Colour

Annotations`annotations`

Setting	Type and options
Style`style`	Pin with label `pin` Flag on the axis `flag` Numbered, listed in the footnote `numbered`
Shade Until the Next Annotation`shadeUntilNext`	On / off
Font Size`fontSize`	Number
Colour`color`	Colour

Zoom`navigator`

Setting	Type and options
Range Navigator`show`	On / off
Navigator Height`height`	Number
Ctrl + Wheel Zooms, Drag Pans`wheel`	On / off

Small Multiples`smallMultiples`

Setting	Type and options
Columns (0 = auto)`columns`	Number
Shared Y-Axis`sharedY`	On / off

Smart Caption`caption`

Setting	Type and options
Show`show`	On / off
Position`position`	Top `top` Bottom `bottom`
Font Size`fontSize`	Number
Text Colour`color`	Colour

Footnote`footnote`

Setting	Type and options
Show`show`	On / off
Source`source`	Text
State the Methods`showMethod`	On / off
Font Size`fontSize`	Number
Text Colour`color`	Colour

Accessibility`accessibility`

Setting	Type and options
Distinguish Series Without Colour`distinguish`	On / off
Focus Outline Colour`focusColor`	Colour
Focus Outline Width`focusWidth`	Number
Minimum Text Size (0 = off)`minFontSize`	Number

Theme`theme`

Setting	Type and options
Theme`selectedTheme`	SmartVisuals `smartvisuals` Dark `dark` Clean (White) `clean` Slate `slate`
Font`font`	Inter `inter` Segoe UI `segoe` Arial `arial` Georgia `georgia`
Transparent Background`transparentBg`	On / off

Series Colours`seriesColors`

Setting	Type and options
Colour`fill`	Colour

Data Colours`dataPoint`

Setting	Type and options
Colour`fill`	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": "smartvisualsSparklines273A71B3DDD15D046A87FA01A562EB26",
  "objects": {
    "sparklines": [{
      "properties": {
        "markFirst": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Sparklines fields and settings

Fields

Presets and Templatespresets

Sparklinessparklines

Data Labelslabels

Trend Linetrend

Forecastforecast

Trend TesttrendTest

X-AxisxAxis

Y-AxisyAxis

Gridlinesgridlines

Legendlegend

Reference LinesrefLines

Reference BandsrefBands

Annotationsannotations

Zoomnavigator

Small MultiplessmallMultiples

Smart Captioncaption

Footnotefootnote

Accessibilityaccessibility

Themetheme

Series ColoursseriesColors

Data ColoursdataPoint