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

15 fields · 40 cards · 203 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
Column values`columns`	Measure	Optional	Measures drawn as columns
Secondary axis values`secondary`	Measure	Optional	Measures drawn on the right-hand axis
Target`target`	Measure	Optional	Plan, budget or target: a dashed series and the base for variances
Comparison`comparison`	Measure	Optional	Previous year or any comparison series from the model
Open`open`	Measure	Optional	Opening value of each period (candles)
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
Close`close`	Measure	Optional	Closing value of each period (candles)
Volume`volume`	Measure	Optional	Traded volume per period (volume pane)
Annotation`annotation`	Measure	Optional	Text measure: a non-blank value pins a note on that period
Small multiples`facet`	Column	Optional	One panel per value (premium)
Tooltips`tooltips`	Measure	Optional	Extra fields in tooltips

View`view`

Setting	Type and options
Chart`type`	Line `line` Area `area` Combo `combo` Sparklines `sparklines` Candlestick `candlestick` Ridgeline (joy plot) `ridgeline`
Show View Tabs`showTabs`	On / off

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

Lines`lines`

Setting	Type and options
Line Shape`interpolation`	Straight `straight` Smooth (never overshoots) `smooth` Step (after) `stepAfter` Step (before) `stepBefore` Step (middle) `stepMiddle`
Line Width (0 = theme)`width`	Number
Missing Values`missing`	Leave a gap `gap` Treat as zero `zero` Connect across `connect` Interpolate `interpolate` Repeat previous value `previous`
Show Values As`showAs`	Value `value` Running total `cumulative` Year to date `ytd` Index (first = 100) `index` % change vs previous `pctChange` Moving sum `movingSum`
Fiscal Year Starts In Month`fiscalStart`	Number
Moving Sum Periods`window`	Number
Show Top N Series (0 = all)`topN`	Number
Other Series`others`	Thin grey context lines `context` Sum as "Others" `sum` Hide `hide`

Area`area`

Setting	Type and options
Layout`layout`	Overlapping `overlap` Stacked `stacked` 100 % stacked `percent` Streamgraph `stream` Range band (Low to High) `range` Difference between two series `difference`
Fill`fill`	From theme `theme` Gradient `gradient` Flat `flat`
Fill Opacity (%, 0 = theme)`opacity`	Number
Line On Top`showLine`	On / off
Stack Order`order`	Data order `data` By total `total` Inside-out `insideOut`

Ridgeline`ridgeline`

Setting	Type and options
Overlap (%)`overlap`	Number
Height Scale`scale`	Each ridge to its own peak `own` Shared across ridges `global`
Order`order`	Data order `data` Name `name` Date of the peak `peak` Total `total`
Ridge Labels`showLabels`	On / off

Columns`columns`

Setting	Type and options
Layout`layout`	Clustered `clustered` Stacked `stacked` 100 % stacked `percent`
Column Width (%)`width`	Number
Corner Radius (-1 = theme)`cornerRadius`	Number
Hide Zero Values`hideZeros`	On / off
Target As`target`	Tick on each column `tick` Line `line`
IBCS Scenario Notation`ibcs`	On / off

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

Candles`candles`

Setting	Type and options
Style`style`	Candles `candle` Hollow candles `hollow` OHLC bars `ohlc` Heikin-Ashi `heikin` Renko `renko` Close line `line` Close area `area`
Up Colour`upColor`	Colour
Down Colour`downColor`	Colour
Brick Size (0 = ATR)`brickSize`	Number
Volume Pane`showVolume`	On / off
Volume Pane Height (%)`volumeHeight`	Number
Show Calendar Gaps`calendarGaps`	On / off
Flag Invalid Bars`validate`	On / off

Indicators`indicators`

Setting	Type and options
Moving Average 1 Periods (0 = off)`ma1`	Number
Moving Average 1 Type`ma1Type`	SMA `sma` EMA `ema` WMA `wma`
Moving Average 2 Periods (0 = off)`ma2`	Number
Moving Average 2 Type`ma2Type`	SMA `sma` EMA `ema` WMA `wma`
Moving Average 3 Periods (0 = off)`ma3`	Number
Moving Average 3 Type`ma3Type`	SMA `sma` EMA `ema` WMA `wma`
Bollinger Bands`bollinger`	On / off
Bollinger Periods`bollPeriod`	Number
Bollinger Width (σ)`bollMult`	Number
VWAP`vwap`	On / off
RSI Pane`rsi`	On / off
MACD Pane`macd`	On / off
Stochastic Pane`stochastic`	On / off
ATR Pane`atr`	On / off
Pivot Levels`pivots`	On / off

Markers`markers`

Setting	Type and options
Show Markers`show`	None `none` All points `all` Last point `last` Minimum and maximum `minmax` First and last `firstlast`
Shape`shape`	From theme `theme` Circle `circle` Square `square` Diamond `diamond` Triangle `triangle`
Size`size`	Number

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

End-of-Line Labels`endLabels`

Setting	Type and options
Show`show`	On / off
Content`content`	Series name `name` Last value `value` Name and value `both`
Font Size`fontSize`	Number
Up To N Series (more: legend)`maxSeries`	Number

Highlights`highlights`

Setting	Type and options
Mark Maximum`max`	On / off
Mark Minimum`min`	On / off
Mark Peaks and Troughs`peaks`	On / off
Peak Prominence (% of range)`prominence`	Number

Threshold Colouring`threshold`

Setting	Type and options
Colour Above / Below`show`	On / off
Threshold`source`	A value `value` The Target field `target`
Value`value`	Number
Above Colour`aboveColor`	Colour
Below Colour`belowColor`	Colour

Difference Fill`difference`

Setting	Type and options
Fill Between Two Series`show`	On / off
Compare With`against`	The second series `second` The Target field `target`
Higher Is Better`higherIsBetter`	On / off
Better Colour`goodColor`	Colour
Worse Colour`badColor`	Colour

Range Band`band`

Setting	Type and options
Show Low-High Band`show`	On / off
Colour`color`	Colour
Opacity (%)`opacity`	Number
Edge Lines`edges`	On / off

Actual and Forecast Styling`actual`

Setting	Type and options
Actuals End At`through`	No styling `none` Last period with an actual `auto` A date `date`
Date (yyyy-mm-dd)`date`	Text
Vertical Rule`rule`	On / off
Rule Label`ruleLabel`	Text

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

Compare`compare`

Setting	Type and options
Compare With`base`	Nothing `none` Same period last year (from the data) `previousYear` The Target field `target` The Comparison field `comparison`
Show the Comparison Line`ghost`	On / off
Variance Band`varianceBand`	On / off
Variance Bars`varianceBars`	Off `off` Absolute (Δ) `absolute` Relative (Δ %) `relative`
Higher Is Better`higherIsBetter`	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`

Seasonal Decomposition`decomposition`

Setting	Type and options
Trend, Seasonal and Remainder`show`	On / off
Season Length (0 = from dates)`season`	Number

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

Secondary Y-Axes`y2Axis`

Setting	Type and options
Show`show`	On / off
Title`showTitle`	On / off
Minimum (blank = auto)`min`	Text
Maximum (blank = auto)`max`	Text
Logarithmic Scale`log`	On / off
Colour Each Axis Like Its Series`colorByAxis`	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

Series Axes`seriesAxis`

Setting	Type and options
Axis`axis`	Axis 1 (left) `1` Axis 2 (right) `2` Axis 3 (left, outer) `3` Axis 4 (right, outer) `4`

Series Line Styles`seriesStyle`

Setting	Type and options
Line Style`dash`	Solid `solid` Dashed `dashed` Dotted `dotted` Dash-dot `dashdot`

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": "smartvisualsTimeSeries8778F9314B5C66CBC87EAA01E0B048DF",
  "objects": {
    "view": [{
      "properties": {
        "showTabs": { "expr": { "Literal": { "Value": "true" } } }
      }
    }]
  }
}

Time Series fields and settings

Fields

Viewview

Presets and Templatespresets

Lineslines

Areaarea

Ridgelineridgeline

Columnscolumns

Sparklinessparklines

Candlescandles

Indicatorsindicators

Markersmarkers

Data Labelslabels

End-of-Line LabelsendLabels

Highlightshighlights

Threshold Colouringthreshold

Difference Filldifference

Range Bandband

Actual and Forecast Stylingactual

Trend Linetrend

Forecastforecast

Comparecompare

Trend TesttrendTest

Seasonal Decompositiondecomposition

X-AxisxAxis

Y-AxisyAxis

Secondary Y-Axesy2Axis

Gridlinesgridlines

Legendlegend

Reference LinesrefLines

Reference BandsrefBands

Annotationsannotations

Zoomnavigator

Small MultiplessmallMultiples

Smart Captioncaption

Footnotefootnote

Accessibilityaccessibility

Themetheme

Series ColoursseriesColors

Series AxesseriesAxis

Series Line StylesseriesStyle

Data ColoursdataPoint