import { FocusOnValue } from "./focusOn.js"; import { CompassGravity } from "./gravity/compassGravity/CompassGravity.js"; import { FocusOnGravity } from "./gravity/focusOnGravity/FocusOnGravity.js"; import { AutoGravity } from "./gravity/autoGravity/AutoGravity.js"; import { CompassQualifier } from "./gravity/qualifiers/compass/CompassQualifier.js"; import { XYCenterGravity } from "./gravity/xyCenterGravity/XYCenterGravity.js"; /** * @description Defines the gravity based on directional values from a compass. * Learn more: {@link https://cloudinary.com/documentation/resizing_and_cropping#control_gravity|Control gravity for images} * Learn more: {@link https://cloudinary.com/documentation/video_resizing_and_cropping#control_gravity|Control gravity for videos} * @param {Qualifiers.Compass | string} direction A compass Values * @memberOf Qualifiers.Gravity * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {compass} from "@cloudinary/url-gen/qualifiers/gravity"; * import {north} from "@cloudinary/url-gen/qualifiers/compass"; * import {crop} from "@cloudinary/url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); * image.resize(crop().width(300).gravity(compass(north()))) * @return {CompassGravity} */ declare function compass(direction: CompassQualifier | string): CompassGravity; /** * @summary qualifier * @description Specifies what to focus on, for example: faces, objects, eyes, etc. * @param {...Qualifier.FocusOn} args One or more objects to focus on * @memberOf Qualifiers.Gravity * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {focusOn} from "@cloudinary/url-gen/qualifiers/gravity"; * import {crop} from "@cloudinary/url-gen/actions/resize"; * import {cat} from "@cloudinary/url-gen/qualifiers/focusOn"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); * image.resize(crop().width(300).gravity(focusOn(cat()))) * @return {FocusOnGravity} */ declare function focusOn(...args: FocusOnValue[]): FocusOnGravity; /** * @summary qualifier * @description Automatically identifies the most interesting regions in the asset, can be qualified further by including what to focus on. * @memberOf Qualifiers.Gravity * @return {Qualifiers.Gravity.AutoGravity} * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {autoGravity} from "@cloudinary/url-gen/qualifiers/gravity"; * import {crop} from "@cloudinary/url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); * image.resize(crop().width(300).gravity(autoGravity())) * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {autoGravity} from "@cloudinary/url-gen/qualifiers/gravity"; * import {crop} from "@cloudinary/url-gen/actions/resize"; * import {cat} from "@cloudinary/url-gen/qualifiers/focusOn"; * import {AutoFocus} from "@cloudinary/url-gen/qualifiers/autoFocus"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); * image.resize(crop().width(300).gravity(autoGravity().autoFocus(AutoFocus.focusOn(cat())))) */ declare function autoGravity(): AutoGravity; /** * @summary qualifier * @description Set the center of gravity to the given x & y coordinates. * @memberOf Qualifiers.Gravity * @return {XYCenterGravity} */ declare function xyCenter(): XYCenterGravity; /** * @description A qualifier that determines which part of an asset to focus on, and thus which part of the asset to keep,
* when any part of the asset is cropped. For overlays, this setting determines where to place the overlay. * @namespace Gravity * @memberOf Qualifiers * @example * import {Cloudinary} from "@cloudinary/url-gen"; * import {compass} from "@cloudinary/url-gen/qualifiers/gravity"; * import {north} from "@cloudinary/url-gen/qualifiers/compass"; * import {crop} from "@cloudinary/url-gen/actions/resize"; * * const yourCldInstance = new Cloudinary({cloud: {cloudName: 'demo'}}); * const image = yourCldInstance.image('woman'); * image.resize(crop().width(300).gravity(compass(north()))) * * // Expand every function separately to see its own example */ declare const Gravity: { compass: typeof compass; autoGravity: typeof autoGravity; focusOn: typeof focusOn; xyCenter: typeof xyCenter; }; export { Gravity, compass, autoGravity, focusOn, xyCenter };