Timeline 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 Timeline page; every setting works in edit mode with or without one.
14 fields · 16 cards · 65 settings Markdown for AI assistantscatalog.json
Fields
| Field | Takes | Needed | What it is for |
|---|---|---|---|
Eventevent | Column | Optional | What happened: the label of each event, milestone, range or era. |
Startstart | Column | Optional | When it happens or begins. A date, a date and time, or a whole number read as a year (negative = BC); text such as c. 1450 marks an approximate date. Bind the field, not its Date Hierarchy. |
End (Optional)end | Column | Optional | When it ends. Blank or equal to Start makes a point in time; later makes a range; ongoing (or a date in the year 9999) runs to today. |
Lane (Optional)lane | Column | Optional | One swimlane per value: team, workstream, region, product line. Up to 3 lanes are free; more lanes are premium. |
Lane Group (Premium)laneGroup | Column | Optional | Puts lanes under a heading the reader can collapse (Group > Lane): plant > workstream, region > team. |
Category (Optional)category | Column | Optional | Colour, shape and legend. A category named Milestone draws milestones; Era, Phase or Period draws background eras (premium). |
Description (Optional)description | Column | Optional | Detail text shown in the tooltip, read by screen readers and shown in story mode. |
Icon or Image (Optional)image | Column | Optional | A built-in icon name (flag, star, rocket, check, ...) or an embedded data:image value. Web addresses are not loaded. |
Link (Optional)link | Column | Optional | A web address (https://...) the event opens when its label is clicked; Power BI asks the reader before leaving the report. |
Milestone Dates (Premium)milestoneDates | Column | Optional · up to 12 | Several date fields, one row per project: each field becomes a named milestone on the row's own line. No unpivoting. |
Planned Date (Premium)planned | Column | Optional | The planned date of the event: draws the slip between plan and actual. A planned date without a Start is a pending milestone, overdue once the date has passed. |
Planned Milestone Dates (Premium)plannedMilestoneDates | Column | Optional · up to 12 | The planned date of each Milestone Dates field, matched by name (Launch and Launch Planned) or else by order: slip, pending and overdue for every milestone. |
Importance (Optional)importance | Measure | Optional | Higher values keep their labels when space is short. Also carries cross-highlighting. |
Tooltipstooltips | Measure | Optional · up to 10 | Extra values shown in the tooltip. |
Themetheme
| Setting | Type and options |
|---|---|
ThemeselectedTheme |
|
Background (empty = theme)bgColor | Colour |
Transparent BackgroundtransparentBg | On / off |
Layoutlayout
| Setting | Type and options |
|---|---|
Orientationorientation |
|
Densitydensity |
|
Label Placementplacement |
|
Max Label Rows per Side (0 = Auto)maxLevels | Number |
Lane OrderlaneOrder |
|
Lane HeadersshowLaneHeaders | On / off |
Lane Groups Start Collapsed (Premium)groupsCollapsed | On / off |
Range LabelsshowSpanLabels | On / off |
Dates in LabelsshowDatesInLabels | On / off |
Descriptions on the CanvasshowDescriptions | On / off |
Time Axisaxis
| Setting | Type and options |
|---|---|
Show Axisshow | On / off |
Positionposition |
|
Two-Row AxistwoRows | On / off |
Gridlinesgridlines | On / off |
Font SizefontSize | Number |
Font Colour (empty = theme)fontColor | Colour |
Eventsevents
| Setting | Type and options |
|---|---|
Marker SizemarkerSize | Number |
Milestone Guide LinesmilestoneLines | On / off |
ColoursdataColors
| Setting | Type and options |
|---|---|
Colourfill | Colour |
Category StylescategoryStyles
| Setting | Type and options |
|---|---|
Stylestyle |
|
Eras (Premium)eras
| Setting | Type and options |
|---|---|
Show Erasshow | On / off |
Band Opacity %opacity | Number |
Todaytoday
| Setting | Type and options |
|---|---|
Show Today Lineshow | On / off |
Colour (empty = theme)lineColor | Colour |
Reference LinesreferenceLines
| Setting | Type and options |
|---|---|
Show Reference Linesshow | On / off |
Line StylelineStyle |
|
Line 1 Date (YYYY-MM-DD or year)date1 | Text |
Line 1 Labellabel1 | Text |
Line 1 Colour (empty = theme)color1 | Colour |
Line 2 Date (YYYY-MM-DD or year)date2 | Text |
Line 2 Labellabel2 | Text |
Line 2 Colour (empty = theme)color2 | Colour |
Line 3 Date (YYYY-MM-DD or year)date3 | Text |
Line 3 Labellabel3 | Text |
Line 3 Colour (empty = theme)color3 | Colour |
Legendlegend
| Setting | Type and options |
|---|---|
Show Legendshow | On / off |
Positionposition |
|
Font SizefontSize | Number |
Font Colour (empty = theme)fontColor | Colour |
Textlabels
| Setting | Type and options |
|---|---|
FontfontFamily |
|
Font SizefontSize | Number |
Font Colour (empty = theme)fontColor | Colour |
Lane Header SizelaneHeaderSize | Number |
Story Mode (Premium)story
| Setting | Type and options |
|---|---|
Story Mode Buttonenabled | On / off |
Seconds per Step (Play)seconds | Number |
Roadmap Analysis (Premium)analysis
| Setting | Type and options |
|---|---|
Planned vs ActualshowSlip | On / off |
On-Time Tolerance (Days)slipTolerance | Number |
Gap Between EventsgapChips | On / off |
Mark Longest Quiet PeriodlongestGap | On / off |
Collapse Empty StretchesaxisBreaks | On / off |
Collapse Gaps Longer Than % of SpanbreakThreshold | Number |
Status StripstatusStrip
| Setting | Type and options |
|---|---|
Show Status Stripshow | On / off |
Accessibilityaccessibility
| Setting | Type and options |
|---|---|
Focus Outline ColourfocusColor | Colour |
Focus Outline WidthfocusWidth | Number |
Minimum Text SizeminTextSize | Number |
Distinct Shape per CategorydistinctShapes | 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": "smartvisualsTimelineA7E4E5921C9F483E91463BA7B778AB45",
"objects": {
"theme": [{
"properties": {
"transparentBg": { "expr": { "Literal": { "Value": "true" } } }
}
}]
}
}