Rules / Report Design

Ensure pages do not scroll vertically

warning ENSURE_PAGES_DO_NOT_SCROLL_VERTICALLY · ported · report layer · scope: Page

What it checks

Visible pages taller than the threshold, 720 pixels by default.

Each finding names the page, as Page "Store detail", and its detail gives the height, as height 1080, more than 720. The line is the page's height.

Example

Fires the rule in page.json
{
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/page/2.1.0/schema.json",
  "name": "4c2d9e8f1a7b3065d2e4",
  "displayName": "Store detail",
  "displayOption": "FitToWidth",
  "height": 1080,
  "width": 1280
}
After the fix in page.json
{
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/report/definition/page/2.1.0/schema.json",
  "name": "4c2d9e8f1a7b3065d2e4",
  "displayName": "Store detail",
  "displayOption": "FitToWidth",
  "height": 720,
  "width": 1280
}

Why it matters

A page taller than the screen it is read on no longer fits in one view. Under Fit to width the reader has to scroll to reach its lower half, and under Fit to page the whole page shrinks until it fits, text and all. Either way, a visual below the first screen is one a reader may never see, and a slicer at the top of the page changes numbers further down that the reader cannot see change.

How to fix it

Split the page: move the lower half to a page of its own, or to a drillthrough page if it holds detail about one item. Where the content has to stay together, tighten it, with fewer or smaller visuals, or with bookmarks that switch between two views in the same space. Then set the height back: in Power BI Desktop, click an empty part of the canvas so the Format pane shows the page, open Canvas settings, and choose the 16:9 type, or set the Height under the Custom type. In page.json, the page's size is its height and width.

When to ignore it

A page designed to be scrolled, laid out as one long column for Fit to width and read that way, is a deliberate choice, and so is a page sized for printing. Before deciding, open the page the way readers do, in the Power BI service or on the device they use, and check that nothing important sits below the first screen.

To ignore this rule on one page, add { "name": "pbiplint.ignore", "value": "ENSURE_PAGES_DO_NOT_SCROLL_VERTICALLY" } to the annotations array of its page.json. Power BI Desktop keeps the annotation. To turn the rule off for a whole project, set "ENSURE_PAGES_DO_NOT_SCROLL_VERTICALLY": "off" under rules in pbiplint.config.json.

Quirks

Ported from PBI Inspector's base rules by Nat Van Gulck.

Check a report for this Improve this page