Skip to content

OverlayRectOptions

OverlayRectOptions = object

Defined in: overlayRect.ts:41

optional dimension?: "width" | "height"

Defined in: overlayRect.ts:49

Which placement dimension to expose at the top level. An overlay placement takes exactly one of width/height (the other follows the aspect ratio), so the result carries only the chosen one. Defaults to 'width'.


optional margin?: number

Defined in: overlayRect.ts:55

Extra space in CSS px added around the element on every side, so the rect surrounds the element rather than sitting exactly on its edges. The rect is clamped to the viewport. Defaults to 0.


optional relativeTo?: "screen" | "recording"

Defined in: overlayRect.ts:43

Reference box recorded on the result. Defaults to 'recording'.