/** * @description Determines how to crop, scale, and/or zoom the delivered asset according to the requested dimensions. * @memberOf Actions * @namespace Resize * @see Learn more about Gravity and Focus {@link Qualifiers.Gravity| here } * @example *

Scaling an image

* import {Cloudinary} from "@cloudinary/url-gen"; * import {scale, fit, pad, crop} from '@cloudinary/url-gen/actions/resize'; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); * * image.resize( scale(100, 100) ); * // All resize actions have a similar interface. * // image.resize( fit(100, 100)) ); * // image.resize( pad(100, 100)) ); * // image.resize( crop(100, 100)) ); * // However, Some actions have additional arguments exposed as builder methods. * // See the documentation for each method for more information * * * // Alternative syntax, using builder methods * image.resize( * scale() * .width(100) * .height(100) * ); * image.toString() * * @example *

Cropping with automatic focus(Gravity)

* import {Cloudinary} from "@cloudinary/url-gen"; * * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}}); * const image = yourCldInstance.image('woman'); * * import {scale} from '@cloudinary/url-gen/actions/resize'; * import {autoGravity} from '@cloudinary/url-gen/qualifiers/gravity'; * * image.resize( crop(100, 100).gravity(autoGravity()) ); * * // Alternative syntax, using builder methods * image.resize( * scale() * .width(100) * .height(100) * .gravity(autoGravity()) * ); * image.toString() */ import { ResizePadAction } from "./resize/ResizePadAction.js"; import { ResizeSimpleAction } from "./resize/ResizeSimpleAction.js"; import { ResizeScaleAction } from "./resize/ResizeScaleAction.js"; import { ThumbResizeAction } from "./resize/ThumbnailAction.js"; import { AutoGravity } from "../qualifiers/gravity/autoGravity/AutoGravity.js"; import { CompassGravity } from "../qualifiers/gravity/compassGravity/CompassGravity.js"; import { ResizeCropAction } from "./resize/ResizeCropAction.js"; import { ResizeFillAction } from "./resize/ResizeFillAction.js"; import { ResizeLimitFitAction } from "./resize/ResizeLimitFitAction.js"; import { ResizeLimitFillAction } from "./resize/ResizeLimitFillAction.js"; import { ResizeLimitPadAction } from "./resize/ResizeLimitPadAction.js"; import { ResizeMinimumPadAction } from "./resize/ResizeMinimumPadAction.js"; import { ResizeAdvancedAction } from "./resize/ResizeAdvancedAction.js"; import { ResizeAutoPadAction } from "./resize/ResizeAutoPadAction.js"; /** * @summary action * @description * Changes the size of the image exactly to the given width and height without necessarily retaining the original aspect ratio:
* all original image parts are visible but might be stretched or shrunk. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ScaleAction} */ declare function scale(width?: number | string, height?: number | string): ResizeScaleAction; /** * @summary action * @description * Scales your image based on automatically calculated areas of interest within each specific photo. * * For details, see the Imagga Crop and Scale {@link https://cloudinary.com/documentation/imagga_crop_and_scale_addon#smartly_scale_images|add-on documentation}. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeSimpleAction} */ declare function imaggaScale(width?: number | string, height?: number | string): ResizeSimpleAction; /** * @summary action * @description * Crops your image based on automatically calculated areas of interest within each specific photo. * * For details, see the Imagga Crop and Scale {@link https://cloudinary.com/documentation/imagga_crop_and_scale_addon#smartly_crop_images|add-on documentation}. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeSimpleAction} */ declare function imaggaCrop(width?: number | string, height?: number | string): ResizeSimpleAction; /** * @summary action * @description Extracts a region of the given width and height out of the original image. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeCropAction} */ declare function crop(width?: number | string, height?: number | string): ResizeCropAction; /** * @summary action * @description * Creates an image with the exact given width and height without distorting the image.
* This option first scales up or down as much as needed to at least fill both of the given dimensions.

* If the requested aspect ratio is different than the original, cropping will occur on the dimension that exceeds the requested size after scaling. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeFillAction} */ declare function fill(width?: string | number, height?: string | number): ResizeFillAction; /** * @summary action * @description * The image is resized so that it takes up as much space as possible within a bounding box defined by the given width and height parameters.
* The original aspect ratio is retained and all of the original image is visible. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeSimpleAction} */ declare function fit(width?: string | number, height?: string | number): ResizeSimpleAction; /** * @summary action * @description * Resizes the asset to fill the given width and height while retaining the original aspect ratio. * * If the proportions of the original asset do not match the given width and height, padding is added to the asset * to reach the required size. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizePadAction} */ declare function pad(width?: string | number, height?: string | number): ResizePadAction; /** * @summary action * @description * Creates an asset with the exact given width and height without distorting the asset, but only if the original * asset is larger than the specified resolution limits. * * The asset is scaled down to fill the given width and height without distorting the asset, and then the dimension * that exceeds the request is cropped. If the original dimensions are both smaller than the requested size, it is * not resized at all. * * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeLimitFillAction} */ declare function limitFill(width?: string | number, height?: string | number): ResizeLimitFillAction; /** * @summary action * @description * Resizes the asset so that it takes up as much space as possible within a bounding box defined by the given * width and height parameters, but only if the original asset is larger than the given limit (width and height). * * The asset is scaled down, the original aspect ratio is retained and all of the original asset is visible. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeSimpleAction} */ declare function limitFit(width?: number | string, height?: number | string): ResizeLimitFitAction; /** * @summary action * @description * Resizes the asset to fill the given width and height while retaining the original aspect ratio, but only if the * original asset is smaller than the given minimum (width and height). * * The asset is scaled up. If the proportions of the original asset do not match the given width and height, * padding is added to the asset to reach the required size. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizePadAction} */ declare function minimumPad(width?: string | number, height?: string | number): ResizeMinimumPadAction; /** * @summary action * @description * Resizes the asset so that it takes up as much space as possible within a bounding box defined by the given * width and height parameters, but only if the original asset is smaller than the given minimum (width and height). * * The asset is scaled up, the original aspect ratio is retained and all of the original asset is visible. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeSimpleAction} */ declare function minimumFit(width?: number | string, height?: number | string): ResizeSimpleAction; /** * @summary action * @memberOf Actions.Resize * @description * Tries to prevent a "bad crop" by first attempting to use the fill mode, but adding padding if it is determined * that more of the original image needs to be included in the final image. * * Especially useful if the aspect ratio of the delivered image is considerably different from the original's * aspect ratio. * * Only supported in conjunction with Automatic cropping. * * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizePadAction} */ declare function fillPad(width?: string | number, height?: string | number): ResizePadAction; /** * @summary action * @description * The thumb cropping mode is specifically used for creating image thumbnails from either face or custom coordinates,
* and must always be accompanied by the gravity parameter set to one of the face detection or custom values. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ThumbResizeAction} */ declare function thumbnail(width?: string | number, height?: string | number): ThumbResizeAction; /** * @summary action * @description * Automatically determines the best crop based on the gravity and specified dimensions. * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ThumbResizeAction} */ declare function auto(width?: number | string, height?: number | string): ResizeAdvancedAction; /** * @summary action * @description * Resizes the asset to fill the given width and height while retaining the original aspect ratio, but only if the * original asset is larger than the given limit (width and height). * * The asset is scaled down. If the proportions of the original asset do not match the given width and height, * padding is added to the asset to reach the required size. * * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizePadAction} */ declare function limitPad(width?: string | number, height?: string | number): ResizeLimitPadAction; /** * @summary action * @description * Tries to prevent a "bad crop" by first attempting to use the auto cropping mode, but adding some padding * if the algorithm determines that more of the original image needs to be included in the final image. * * @memberOf Actions.Resize * @param {number|string} width The required width of a transformed asset. * @param {number|string} height The required height of a transformed asset. * @return {Actions.Resize.ResizeAutoPadAction} */ declare function autoPad(width?: string | number, height?: string | number): ResizeAutoPadAction; declare const Resize: { imaggaScale: typeof imaggaScale; imaggaCrop: typeof imaggaCrop; crop: typeof crop; fill: typeof fill; scale: typeof scale; minimumPad: typeof minimumPad; fit: typeof fit; pad: typeof pad; limitFit: typeof limitFit; thumbnail: typeof thumbnail; limitFill: typeof limitFill; minimumFit: typeof minimumFit; limitPad: typeof limitPad; fillPad: typeof fillPad; auto: typeof auto; autoPad: typeof autoPad; }; export { Resize, imaggaScale, imaggaCrop, crop, fill, scale, minimumPad, fit, pad, limitFit, thumbnail, limitFill, minimumFit, limitPad, fillPad, auto, autoPad };