ImageTransformInput
input_object

Choose a version:

The available options for transforming an image.

All transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored.

Fields

Anchor to ImageTransformInput.crop crop CropRegion: The region of the image to remain after cropping. Must be used in conjunction with the maxWidth and/or maxHeight fields, where the maxWidth and maxHeight aren't equal. The crop argument should coincide with the smaller value. A smaller maxWidth indicates a LEFT or RIGHT crop, while a smaller maxHeight indicates a TOP or BOTTOM crop. For example, { maxWidth: 5, maxHeight: 10, crop: LEFT } will result in an image with a width of 5 and height of 10, where the right side of the image is removed.
Anchor to ImageTransformInput.maxHeight maxHeight Int: Image height in pixels between 1 and 5760.
Anchor to ImageTransformInput.maxWidth maxWidth Int: Image width in pixels between 1 and 5760.
Anchor to ImageTransformInput.preferredContentType preferredContentType ImageContentType: Convert the source image into the preferred content type. Supported conversions: .svg to .png, any file type to .jpg, and any file type to .webp.
Anchor to ImageTransformInput.scale scale Int default:1: Image size multiplier for high-resolution retina displays. Must be within 1..3.

Was this section helpful?

Map

ImageTransformInput