Skip to main content

CropParams

cropParams selects a rectangular region from the source asset before the element is composed.

interface CropParams {
x: number;
y: number;
width: number;
height: number;
}
PropertyRequiredNotes
xYesLeft edge of the crop region.
yYesTop edge of the crop region.
widthYesCrop region width.
heightYesCrop region height.

Values are measured in pixels and must stay within plan limits.

Example

{
"cropParams": {
"x": 100,
"y": 50,
"width": 800,
"height": 600
}
}

Used By