Skip to main content

Interface: KenBurnsOptions

Configuration options for the Ken Burns camera pan and zoom decorator.

All time durations are expressed in seconds.

Properties​

PropertyTypeDescription
delay?numberInitial delay before motion begins in seconds (default: 0s).
direction?"in" | "out"Direction shorthand: "in" (default) zooms 1.0 to scale; "out" zooms scale to 1.0.
duration?numberAnimation duration in seconds (default: 20s).
ease?stringCSS easing timing curve (default: "ease-out").
focus?KenBurnsFocusTarget focus shorthand when to is omitted (default: "center"). Explicit pan takes precedence over focus.
from?KenBurnsFocus | KenBurnsKeyframeStarting keyframe or focus anchor (default: full frame scale 1.0 at center).
loop?boolean | "alternate"Whether motion loops continuously or alternates directions (default: false, holds end frame).
pan?[number, number]Explicit target pan translation percentages [x, y] when to is omitted. Takes precedence over focus.
scale?numberPeak zoom magnification factor (default: 1.35). For zoom-in, this is the end scale; for zoom-out, the start scale.
to?KenBurnsFocus | KenBurnsKeyframeEnding keyframe or focus anchor (default: peak scale and focus).