API reference / Common / OverlayFrame

Interface: OverlayFrame

One painted frame, as the overlay layer sees it: the on-screen pages in viewport (CSS px) space, plus the frame's scale (CSS px per document point — the zoom). A source uses scale to project page-local coordinates, or to scale an item with the content via OverlayItem.scale; chrome meant to stay constant on screen simply ignores it.

Properties

Property	Description
views PageView[]	-
scale number	CSS px per document point for this frame.
branding Rect | null	The branding decal's rect (CSS px, bottom-right), punched out of the clip so no overlay paints over the logo; null before the engine reports it.
sheet number	The sheet this frame shows, as currentSheet counts it — a 0-based index into the workbook's sheets — or -1 for a doc type without sheets. Each sheet's pages count from 0, so an overlay drawing on one sheet checks it before trusting a page index.