Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
akamai.getImagingPolicyImage
Explore with Pulumi AI
Using getImagingPolicyImage
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getImagingPolicyImage(args: GetImagingPolicyImageArgs, opts?: InvokeOptions): Promise<GetImagingPolicyImageResult>
function getImagingPolicyImageOutput(args: GetImagingPolicyImageOutputArgs, opts?: InvokeOptions): Output<GetImagingPolicyImageResult>
def get_imaging_policy_image(policy: Optional[GetImagingPolicyImagePolicy] = None,
opts: Optional[InvokeOptions] = None) -> GetImagingPolicyImageResult
def get_imaging_policy_image_output(policy: Optional[pulumi.Input[GetImagingPolicyImagePolicyArgs]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetImagingPolicyImageResult]
func LookupImagingPolicyImage(ctx *Context, args *LookupImagingPolicyImageArgs, opts ...InvokeOption) (*LookupImagingPolicyImageResult, error)
func LookupImagingPolicyImageOutput(ctx *Context, args *LookupImagingPolicyImageOutputArgs, opts ...InvokeOption) LookupImagingPolicyImageResultOutput
> Note: This function is named LookupImagingPolicyImage
in the Go SDK.
public static class GetImagingPolicyImage
{
public static Task<GetImagingPolicyImageResult> InvokeAsync(GetImagingPolicyImageArgs args, InvokeOptions? opts = null)
public static Output<GetImagingPolicyImageResult> Invoke(GetImagingPolicyImageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetImagingPolicyImageResult> getImagingPolicyImage(GetImagingPolicyImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: akamai:index/getImagingPolicyImage:getImagingPolicyImage
arguments:
# arguments dictionary
The following arguments are supported:
getImagingPolicyImage Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Json string
- Policy
Get
Imaging Policy Image Policy
- Id string
- The provider-assigned unique ID for this managed resource.
- Json string
- Policy
Get
Imaging Policy Image Policy
- id String
- The provider-assigned unique ID for this managed resource.
- json String
- policy
Get
Imaging Policy Image Policy
- id string
- The provider-assigned unique ID for this managed resource.
- json string
- policy
Get
Imaging Policy Image Policy
- id str
- The provider-assigned unique ID for this managed resource.
- json str
- policy
Get
Imaging Policy Image Policy
- id String
- The provider-assigned unique ID for this managed resource.
- json String
- policy Property Map
Supporting Types
GetImagingPolicyImagePolicy
- Breakpoints
Get
Imaging Policy Image Policy Breakpoints - The breakpoint widths (in pixels) to use to create derivative images/videos.
- Hosts List<string>
- Hosts that are allowed for image/video URLs within transformations or variables.
- Output
Get
Imaging Policy Image Policy Output - Dictates the output quality (either
quality
orperceptualQuality
) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (85
), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers. - Post
Breakpoint List<GetTransformations Imaging Policy Image Policy Post Breakpoint Transformation> - Post-processing Transformations are applied to the image after image and quality settings have been applied.
- Rollout
Duration string - The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
- Serve
Stale stringDuration - The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
- Transformations
List<Get
Imaging Policy Image Policy Transformation> - Set of image transformations to apply to the source image. If unspecified, no operations are performed.
- Variables
List<Get
Imaging Policy Image Policy Variable> - Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
- Breakpoints
Get
Imaging Policy Image Policy Breakpoints - The breakpoint widths (in pixels) to use to create derivative images/videos.
- Hosts []string
- Hosts that are allowed for image/video URLs within transformations or variables.
- Output
Get
Imaging Policy Image Policy Output Type - Dictates the output quality (either
quality
orperceptualQuality
) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (85
), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers. - Post
Breakpoint []GetTransformations Imaging Policy Image Policy Post Breakpoint Transformation - Post-processing Transformations are applied to the image after image and quality settings have been applied.
- Rollout
Duration string - The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
- Serve
Stale stringDuration - The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
- Transformations
[]Get
Imaging Policy Image Policy Transformation - Set of image transformations to apply to the source image. If unspecified, no operations are performed.
- Variables
[]Get
Imaging Policy Image Policy Variable - Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
- breakpoints
Get
Imaging Policy Image Policy Breakpoints - The breakpoint widths (in pixels) to use to create derivative images/videos.
- hosts List<String>
- Hosts that are allowed for image/video URLs within transformations or variables.
- output
Get
Imaging Policy Image Policy Output - Dictates the output quality (either
quality
orperceptualQuality
) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (85
), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers. - post
Breakpoint List<GetTransformations Imaging Policy Image Policy Post Breakpoint Transformation> - Post-processing Transformations are applied to the image after image and quality settings have been applied.
- rollout
Duration String - The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
- serve
Stale StringDuration - The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
- transformations
List<Get
Imaging Policy Image Policy Transformation> - Set of image transformations to apply to the source image. If unspecified, no operations are performed.
- variables
List<Get
Imaging Policy Image Policy Variable> - Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
- breakpoints
Get
Imaging Policy Image Policy Breakpoints - The breakpoint widths (in pixels) to use to create derivative images/videos.
- hosts string[]
- Hosts that are allowed for image/video URLs within transformations or variables.
- output
Get
Imaging Policy Image Policy Output - Dictates the output quality (either
quality
orperceptualQuality
) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (85
), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers. - post
Breakpoint GetTransformations Imaging Policy Image Policy Post Breakpoint Transformation[] - Post-processing Transformations are applied to the image after image and quality settings have been applied.
- rollout
Duration string - The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
- serve
Stale stringDuration - The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
- transformations
Get
Imaging Policy Image Policy Transformation[] - Set of image transformations to apply to the source image. If unspecified, no operations are performed.
- variables
Get
Imaging Policy Image Policy Variable[] - Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
- breakpoints
Get
Imaging Policy Image Policy Breakpoints - The breakpoint widths (in pixels) to use to create derivative images/videos.
- hosts Sequence[str]
- Hosts that are allowed for image/video URLs within transformations or variables.
- output
Get
Imaging Policy Image Policy Output - Dictates the output quality (either
quality
orperceptualQuality
) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (85
), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers. - post_
breakpoint_ Sequence[Gettransformations Imaging Policy Image Policy Post Breakpoint Transformation] - Post-processing Transformations are applied to the image after image and quality settings have been applied.
- rollout_
duration str - The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
- serve_
stale_ strduration - The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
- transformations
Sequence[Get
Imaging Policy Image Policy Transformation] - Set of image transformations to apply to the source image. If unspecified, no operations are performed.
- variables
Sequence[Get
Imaging Policy Image Policy Variable] - Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
- breakpoints Property Map
- The breakpoint widths (in pixels) to use to create derivative images/videos.
- hosts List<String>
- Hosts that are allowed for image/video URLs within transformations or variables.
- output Property Map
- Dictates the output quality (either
quality
orperceptualQuality
) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (85
), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers. - post
Breakpoint List<Property Map>Transformations - Post-processing Transformations are applied to the image after image and quality settings have been applied.
- rollout
Duration String - The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. This value has no effect on the staging network.
- serve
Stale StringDuration - The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
- transformations List<Property Map>
- Set of image transformations to apply to the source image. If unspecified, no operations are performed.
- variables List<Property Map>
- Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
GetImagingPolicyImagePolicyBreakpoints
- Widths List<int>
- Widths []int
- widths List<Integer>
- widths number[]
- widths Sequence[int]
- widths List<Number>
GetImagingPolicyImagePolicyOutput
- Adaptive
Quality string - Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
- Allow
Pristine stringOn Downsize - Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
- Allowed
Formats List<string> - The graphics file formats allowed for browser specific results.
- Forced
Formats List<string> - The forced extra formats for the
imFormat
query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image. - Perceptual
Quality string - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - Perceptual
Quality stringFloor - Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
- Perceptual
Quality stringVar - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - Prefer
Modern stringFormats - Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
- Quality string
- Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- Quality
Var string - Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- Adaptive
Quality string - Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
- Allow
Pristine stringOn Downsize - Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
- Allowed
Formats []string - The graphics file formats allowed for browser specific results.
- Forced
Formats []string - The forced extra formats for the
imFormat
query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image. - Perceptual
Quality string - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - Perceptual
Quality stringFloor - Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
- Perceptual
Quality stringVar - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - Prefer
Modern stringFormats - Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
- Quality string
- Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- Quality
Var string - Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- adaptive
Quality String - Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
- allow
Pristine StringOn Downsize - Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
- allowed
Formats List<String> - The graphics file formats allowed for browser specific results.
- forced
Formats List<String> - The forced extra formats for the
imFormat
query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image. - perceptual
Quality String - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - perceptual
Quality StringFloor - Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
- perceptual
Quality StringVar - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - prefer
Modern StringFormats - Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
- quality String
- Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- quality
Var String - Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- adaptive
Quality string - Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
- allow
Pristine stringOn Downsize - Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
- allowed
Formats string[] - The graphics file formats allowed for browser specific results.
- forced
Formats string[] - The forced extra formats for the
imFormat
query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image. - perceptual
Quality string - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - perceptual
Quality stringFloor - Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
- perceptual
Quality stringVar - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - prefer
Modern stringFormats - Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
- quality string
- Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- quality
Var string - Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- adaptive_
quality str - Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
- allow_
pristine_ stron_ downsize - Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
- allowed_
formats Sequence[str] - The graphics file formats allowed for browser specific results.
- forced_
formats Sequence[str] - The forced extra formats for the
imFormat
query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image. - perceptual_
quality str - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - perceptual_
quality_ strfloor - Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
- perceptual_
quality_ strvar - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - prefer_
modern_ strformats - Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
- quality str
- Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- quality_
var str - Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- adaptive
Quality String - Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
- allow
Pristine StringOn Downsize - Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
- allowed
Formats List<String> - The graphics file formats allowed for browser specific results.
- forced
Formats List<String> - The forced extra formats for the
imFormat
query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image. - perceptual
Quality String - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - perceptual
Quality StringFloor - Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
- perceptual
Quality StringVar - Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the
quality
setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tieredhigh
,mediumHigh
,medium
,mediumLow
, orlow
. - prefer
Modern StringFormats - Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
- quality String
- Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
- quality
Var String - Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
GetImagingPolicyImagePolicyPostBreakpointTransformation
- Background
Colors List<GetImaging Policy Image Policy Post Breakpoint Transformation Background Color> - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- Blurs
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Blur> - Applies a Gaussian blur to the image.
- Chroma
Keys List<GetImaging Policy Image Policy Post Breakpoint Transformation Chroma Key> - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- Composites
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite> - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- Compounds
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Compound> - Contrasts
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Contrast> - Adjusts both the contrast and brightness of an image.
- Goops
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Goop> - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- Grayscales
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Grayscale> - Restricts image color to shades of gray only.
- Hsls
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsl> - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - Hsvs
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsv> - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - If
Dimensions List<GetImaging Policy Image Policy Post Breakpoint Transformation If Dimension> - If
Orientations List<GetImaging Policy Image Policy Post Breakpoint Transformation If Orientation> - Max
Colors List<GetImaging Policy Image Policy Post Breakpoint Transformation Max Color> - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- Mirrors
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Mirror> - Flips an image horizontally, vertically, or both.
- Mono
Hues List<GetImaging Policy Image Policy Post Breakpoint Transformation Mono Hue> - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- Opacities
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Opacity> - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- Remove
Colors List<GetImaging Policy Image Policy Post Breakpoint Transformation Remove Color> - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- Unsharp
Masks List<GetImaging Policy Image Policy Post Breakpoint Transformation Unsharp Mask> - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- Background
Colors []GetImaging Policy Image Policy Post Breakpoint Transformation Background Color - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- Blurs
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Blur - Applies a Gaussian blur to the image.
- Chroma
Keys []GetImaging Policy Image Policy Post Breakpoint Transformation Chroma Key - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- Composites
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- Compounds
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Compound - Contrasts
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Contrast - Adjusts both the contrast and brightness of an image.
- Goops
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Goop - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- Grayscales
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Grayscale - Restricts image color to shades of gray only.
- Hsls
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsl - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - Hsvs
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsv - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - If
Dimensions []GetImaging Policy Image Policy Post Breakpoint Transformation If Dimension - If
Orientations []GetImaging Policy Image Policy Post Breakpoint Transformation If Orientation - Max
Colors []GetImaging Policy Image Policy Post Breakpoint Transformation Max Color - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- Mirrors
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Mirror - Flips an image horizontally, vertically, or both.
- Mono
Hues []GetImaging Policy Image Policy Post Breakpoint Transformation Mono Hue - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- Opacities
[]Get
Imaging Policy Image Policy Post Breakpoint Transformation Opacity - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- Remove
Colors []GetImaging Policy Image Policy Post Breakpoint Transformation Remove Color - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- Unsharp
Masks []GetImaging Policy Image Policy Post Breakpoint Transformation Unsharp Mask - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- background
Colors List<GetImaging Policy Image Policy Post Breakpoint Transformation Background Color> - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Blur> - Applies a Gaussian blur to the image.
- chroma
Keys List<GetImaging Policy Image Policy Post Breakpoint Transformation Chroma Key> - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite> - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Compound> - contrasts
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Contrast> - Adjusts both the contrast and brightness of an image.
- goops
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Goop> - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Grayscale> - Restricts image color to shades of gray only.
- hsls
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsl> - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsv> - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if
Dimensions List<GetImaging Policy Image Policy Post Breakpoint Transformation If Dimension> - if
Orientations List<GetImaging Policy Image Policy Post Breakpoint Transformation If Orientation> - max
Colors List<GetImaging Policy Image Policy Post Breakpoint Transformation Max Color> - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Mirror> - Flips an image horizontally, vertically, or both.
- mono
Hues List<GetImaging Policy Image Policy Post Breakpoint Transformation Mono Hue> - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities
List<Get
Imaging Policy Image Policy Post Breakpoint Transformation Opacity> - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- remove
Colors List<GetImaging Policy Image Policy Post Breakpoint Transformation Remove Color> - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- unsharp
Masks List<GetImaging Policy Image Policy Post Breakpoint Transformation Unsharp Mask> - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- background
Colors GetImaging Policy Image Policy Post Breakpoint Transformation Background Color[] - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs
Get
Imaging Policy Image Policy Post Breakpoint Transformation Blur[] - Applies a Gaussian blur to the image.
- chroma
Keys GetImaging Policy Image Policy Post Breakpoint Transformation Chroma Key[] - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites
Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite[] - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds
Get
Imaging Policy Image Policy Post Breakpoint Transformation Compound[] - contrasts
Get
Imaging Policy Image Policy Post Breakpoint Transformation Contrast[] - Adjusts both the contrast and brightness of an image.
- goops
Get
Imaging Policy Image Policy Post Breakpoint Transformation Goop[] - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales
Get
Imaging Policy Image Policy Post Breakpoint Transformation Grayscale[] - Restricts image color to shades of gray only.
- hsls
Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsl[] - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs
Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsv[] - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if
Dimensions GetImaging Policy Image Policy Post Breakpoint Transformation If Dimension[] - if
Orientations GetImaging Policy Image Policy Post Breakpoint Transformation If Orientation[] - max
Colors GetImaging Policy Image Policy Post Breakpoint Transformation Max Color[] - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors
Get
Imaging Policy Image Policy Post Breakpoint Transformation Mirror[] - Flips an image horizontally, vertically, or both.
- mono
Hues GetImaging Policy Image Policy Post Breakpoint Transformation Mono Hue[] - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities
Get
Imaging Policy Image Policy Post Breakpoint Transformation Opacity[] - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- remove
Colors GetImaging Policy Image Policy Post Breakpoint Transformation Remove Color[] - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- unsharp
Masks GetImaging Policy Image Policy Post Breakpoint Transformation Unsharp Mask[] - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- background_
colors Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Background Color] - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Blur] - Applies a Gaussian blur to the image.
- chroma_
keys Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Chroma Key] - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite] - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Compound] - contrasts
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Contrast] - Adjusts both the contrast and brightness of an image.
- goops
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Goop] - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Grayscale] - Restricts image color to shades of gray only.
- hsls
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsl] - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Hsv] - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if_
dimensions Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation If Dimension] - if_
orientations Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation If Orientation] - max_
colors Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Max Color] - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Mirror] - Flips an image horizontally, vertically, or both.
- mono_
hues Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Mono Hue] - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities
Sequence[Get
Imaging Policy Image Policy Post Breakpoint Transformation Opacity] - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- remove_
colors Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Remove Color] - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- unsharp_
masks Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Unsharp Mask] - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- background
Colors List<Property Map> - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs List<Property Map>
- Applies a Gaussian blur to the image.
- chroma
Keys List<Property Map> - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites List<Property Map>
- Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds List<Property Map>
- contrasts List<Property Map>
- Adjusts both the contrast and brightness of an image.
- goops List<Property Map>
- Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales List<Property Map>
- Restricts image color to shades of gray only.
- hsls List<Property Map>
- Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs List<Property Map>
- Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if
Dimensions List<Property Map> - if
Orientations List<Property Map> - max
Colors List<Property Map> - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors List<Property Map>
- Flips an image horizontally, vertically, or both.
- mono
Hues List<Property Map> - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities List<Property Map>
- Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- remove
Colors List<Property Map> - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- unsharp
Masks List<Property Map> - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
GetImagingPolicyImagePolicyPostBreakpointTransformationBackgroundColor
GetImagingPolicyImagePolicyPostBreakpointTransformationBlur
- Sigma string
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- Sigma
Var string - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- Sigma string
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- Sigma
Var string - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma String
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma
Var String - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma string
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma
Var string - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma str
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma_
var str - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma String
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma
Var String - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
GetImagingPolicyImagePolicyPostBreakpointTransformationChromaKey
- Hue string
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Hue
Feather string - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Feather stringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Tolerance string - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Tolerance stringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Var string - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Lightness
Feather string - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Feather stringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Tolerance string - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Lightness
Tolerance stringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Saturation
Feather string - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Feather stringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Tolerance string - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- Saturation
Tolerance stringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- Hue string
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Hue
Feather string - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Feather stringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Tolerance string - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Tolerance stringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Var string - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Lightness
Feather string - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Feather stringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Tolerance string - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Lightness
Tolerance stringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Saturation
Feather string - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Feather stringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Tolerance string - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- Saturation
Tolerance stringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue String
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue
Feather String - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Feather StringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Tolerance String - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Tolerance StringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Var String - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness
Feather String - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Feather StringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Tolerance String - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness
Tolerance StringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation
Feather String - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Feather StringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Tolerance String - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation
Tolerance StringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue string
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue
Feather string - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Feather stringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Tolerance string - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Tolerance stringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Var string - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness
Feather string - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Feather stringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Tolerance string - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness
Tolerance stringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation
Feather string - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Feather stringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Tolerance string - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation
Tolerance stringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue str
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue_
feather str - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue_
feather_ strvar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue_
tolerance str - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue_
tolerance_ strvar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue_
var str - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness_
feather str - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness_
feather_ strvar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness_
tolerance str - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness_
tolerance_ strvar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation_
feather str - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation_
feather_ strvar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation_
tolerance str - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation_
tolerance_ strvar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue String
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue
Feather String - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Feather StringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Tolerance String - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Tolerance StringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Var String - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness
Feather String - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Feather StringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Tolerance String - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness
Tolerance StringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation
Feather String - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Feather StringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Tolerance String - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation
Tolerance StringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
GetImagingPolicyImagePolicyPostBreakpointTransformationComposite
- Image
Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite Image - Gravity string
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Gravity
Var string - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Placement string
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Placement
Var string - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Scale string
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - Scale
Dimension string - The dimension, either
width
orheight
, of the source image to scale. - Scale
Dimension stringVar - The dimension, either
width
orheight
, of the source image to scale. - Scale
Var string - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - XPosition string
- The x-axis position of the image to apply.
- XPosition
Var string - The x-axis position of the image to apply.
- YPosition string
- The y-axis position of the image to apply.
- YPosition
Var string - The y-axis position of the image to apply.
- Image
Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite Image - Gravity string
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Gravity
Var string - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Placement string
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Placement
Var string - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Scale string
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - Scale
Dimension string - The dimension, either
width
orheight
, of the source image to scale. - Scale
Dimension stringVar - The dimension, either
width
orheight
, of the source image to scale. - Scale
Var string - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - XPosition string
- The x-axis position of the image to apply.
- XPosition
Var string - The x-axis position of the image to apply.
- YPosition string
- The y-axis position of the image to apply.
- YPosition
Var string - The y-axis position of the image to apply.
- image
Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite Image - gravity String
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity
Var String - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement String
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement
Var String - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale String
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale
Dimension String - The dimension, either
width
orheight
, of the source image to scale. - scale
Dimension StringVar - The dimension, either
width
orheight
, of the source image to scale. - scale
Var String - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x
Position String - The x-axis position of the image to apply.
- x
Position StringVar - The x-axis position of the image to apply.
- y
Position String - The y-axis position of the image to apply.
- y
Position StringVar - The y-axis position of the image to apply.
- image
Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite Image - gravity string
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity
Var string - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement string
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement
Var string - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale string
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale
Dimension string - The dimension, either
width
orheight
, of the source image to scale. - scale
Dimension stringVar - The dimension, either
width
orheight
, of the source image to scale. - scale
Var string - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x
Position string - The x-axis position of the image to apply.
- x
Position stringVar - The x-axis position of the image to apply.
- y
Position string - The y-axis position of the image to apply.
- y
Position stringVar - The y-axis position of the image to apply.
- image
Get
Imaging Policy Image Policy Post Breakpoint Transformation Composite Image - gravity str
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity_
var str - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement str
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement_
var str - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale str
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale_
dimension str - The dimension, either
width
orheight
, of the source image to scale. - scale_
dimension_ strvar - The dimension, either
width
orheight
, of the source image to scale. - scale_
var str - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x_
position str - The x-axis position of the image to apply.
- x_
position_ strvar - The x-axis position of the image to apply.
- y_
position str - The y-axis position of the image to apply.
- y_
position_ strvar - The y-axis position of the image to apply.
- image Property Map
- gravity String
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity
Var String - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement String
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement
Var String - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale String
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale
Dimension String - The dimension, either
width
orheight
, of the source image to scale. - scale
Dimension StringVar - The dimension, either
width
orheight
, of the source image to scale. - scale
Var String - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x
Position String - The x-axis position of the image to apply.
- x
Position StringVar - The x-axis position of the image to apply.
- y
Position String - The y-axis position of the image to apply.
- y
Position StringVar - The y-axis position of the image to apply.
GetImagingPolicyImagePolicyPostBreakpointTransformationCompositeImage
- Box
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Box Image> - A rectangular box, with a specified color and applied transformation.
- Circle
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Circle Image> - A rectangular box, with a specified color and applied transformation.
- Text
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Text Image> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- Url
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Url Image> - An image loaded from a URL.
- Box
Images []GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Box Image - A rectangular box, with a specified color and applied transformation.
- Circle
Images []GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Circle Image - A rectangular box, with a specified color and applied transformation.
- Text
Images []GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Text Image - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- Url
Images []GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Url Image - An image loaded from a URL.
- box
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Box Image> - A rectangular box, with a specified color and applied transformation.
- circle
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Circle Image> - A rectangular box, with a specified color and applied transformation.
- text
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Text Image> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images List<GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Url Image> - An image loaded from a URL.
- box
Images GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Box Image[] - A rectangular box, with a specified color and applied transformation.
- circle
Images GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Circle Image[] - A rectangular box, with a specified color and applied transformation.
- text
Images GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Text Image[] - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Url Image[] - An image loaded from a URL.
- box_
images Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Box Image] - A rectangular box, with a specified color and applied transformation.
- circle_
images Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Circle Image] - A rectangular box, with a specified color and applied transformation.
- text_
images Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Text Image] - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url_
images Sequence[GetImaging Policy Image Policy Post Breakpoint Transformation Composite Image Url Image] - An image loaded from a URL.
- box
Images List<Property Map> - A rectangular box, with a specified color and applied transformation.
- circle
Images List<Property Map> - A rectangular box, with a specified color and applied transformation.
- text
Images List<Property Map> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images List<Property Map> - An image loaded from a URL.
GetImagingPolicyImagePolicyPostBreakpointTransformationCompositeImageBoxImage
- Color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Height string
- The height of the box in pixels.
- Height
Var string - The height of the box in pixels.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- Color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Height string
- The height of the box in pixels.
- Height
Var string - The height of the box in pixels.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- color String
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height String
- The height of the box in pixels.
- height
Var String - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
- color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height string
- The height of the box in pixels.
- height
Var string - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - width string
- The width of the box in pixels.
- width
Var string - The width of the box in pixels.
- color str
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color_
var str - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height str
- The height of the box in pixels.
- height_
var str - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - width str
- The width of the box in pixels.
- width_
var str - The width of the box in pixels.
- color String
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height String
- The height of the box in pixels.
- height
Var String - The height of the box in pixels.
- transformation Property Map
- width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
GetImagingPolicyImagePolicyPostBreakpointTransformationCompositeImageCircleImage
- Color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- Color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- color String
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter String
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var String - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
- color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - width string
- The width of the box in pixels.
- width
Var string - The width of the box in pixels.
- color str
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color_
var str - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter str
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter_
var str - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - width str
- The width of the box in pixels.
- width_
var str - The width of the box in pixels.
- color String
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter String
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var String - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation Property Map
- width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
GetImagingPolicyImagePolicyPostBreakpointTransformationCompositeImageTextImage
- Fill string
- The main fill color of the text.
- Fill
Var string - The main fill color of the text.
- Size string
- The size in pixels to render the text.
- Size
Var string - The size in pixels to render the text.
- Stroke string
- The color for the outline of the text.
- Stroke
Size string - The thickness in points for the outline of the text.
- Stroke
Size stringVar - The thickness in points for the outline of the text.
- Stroke
Var string - The color for the outline of the text.
- Text string
- The line of text to render.
- Text
Var string - The line of text to render.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Fill string
- The main fill color of the text.
- Fill
Var string - The main fill color of the text.
- Size string
- The size in pixels to render the text.
- Size
Var string - The size in pixels to render the text.
- Stroke string
- The color for the outline of the text.
- Stroke
Size string - The thickness in points for the outline of the text.
- Stroke
Size stringVar - The thickness in points for the outline of the text.
- Stroke
Var string - The color for the outline of the text.
- Text string
- The line of text to render.
- Text
Var string - The line of text to render.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill String
- The main fill color of the text.
- fill
Var String - The main fill color of the text.
- size String
- The size in pixels to render the text.
- size
Var String - The size in pixels to render the text.
- stroke String
- The color for the outline of the text.
- stroke
Size String - The thickness in points for the outline of the text.
- stroke
Size StringVar - The thickness in points for the outline of the text.
- stroke
Var String - The color for the outline of the text.
- text String
- The line of text to render.
- text
Var String - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - typeface String
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var String - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill string
- The main fill color of the text.
- fill
Var string - The main fill color of the text.
- size string
- The size in pixels to render the text.
- size
Var string - The size in pixels to render the text.
- stroke string
- The color for the outline of the text.
- stroke
Size string - The thickness in points for the outline of the text.
- stroke
Size stringVar - The thickness in points for the outline of the text.
- stroke
Var string - The color for the outline of the text.
- text string
- The line of text to render.
- text
Var string - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill str
- The main fill color of the text.
- fill_
var str - The main fill color of the text.
- size str
- The size in pixels to render the text.
- size_
var str - The size in pixels to render the text.
- stroke str
- The color for the outline of the text.
- stroke_
size str - The thickness in points for the outline of the text.
- stroke_
size_ strvar - The thickness in points for the outline of the text.
- stroke_
var str - The color for the outline of the text.
- text str
- The line of text to render.
- text_
var str - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - typeface str
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface_
var str - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill String
- The main fill color of the text.
- fill
Var String - The main fill color of the text.
- size String
- The size in pixels to render the text.
- size
Var String - The size in pixels to render the text.
- stroke String
- The color for the outline of the text.
- stroke
Size String - The thickness in points for the outline of the text.
- stroke
Size StringVar - The thickness in points for the outline of the text.
- stroke
Var String - The color for the outline of the text.
- text String
- The line of text to render.
- text
Var String - The line of text to render.
- transformation Property Map
- typeface String
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var String - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
GetImagingPolicyImagePolicyPostBreakpointTransformationCompositeImageUrlImage
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Url string
- The URL of the image.
- Url
Var string - The URL of the image.
- Transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Url string
- The URL of the image.
- Url
Var string - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - url String
- The URL of the image.
- url
Var String - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - url string
- The URL of the image.
- url
Var string - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Post Breakpoint Transformation - url str
- The URL of the image.
- url_
var str - The URL of the image.
- transformation Property Map
- url String
- The URL of the image.
- url
Var String - The URL of the image.
GetImagingPolicyImagePolicyPostBreakpointTransformationCompound
GetImagingPolicyImagePolicyPostBreakpointTransformationContrast
- Brightness string
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Brightness
Var string - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Contrast string
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - Contrast
Var string - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- Brightness string
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Brightness
Var string - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Contrast string
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - Contrast
Var string - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness String
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness
Var String - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast String
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast
Var String - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness string
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness
Var string - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast string
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast
Var string - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness str
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness_
var str - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast str
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast_
var str - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness String
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness
Var String - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast String
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast
Var String - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
GetImagingPolicyImagePolicyPostBreakpointTransformationGoop
- Chaos string
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Chaos
Var string - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Density string
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Density
Var string - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Power string
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Power
Var string - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Seed string
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - Seed
Var string - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- Chaos string
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Chaos
Var string - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Density string
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Density
Var string - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Power string
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Power
Var string - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Seed string
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - Seed
Var string - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos String
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos
Var String - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density String
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density
Var String - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power String
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power
Var String - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed String
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed
Var String - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos string
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos
Var string - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density string
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density
Var string - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power string
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power
Var string - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed string
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed
Var string - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos str
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos_
var str - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density str
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density_
var str - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power str
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power_
var str - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed str
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed_
var str - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos String
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos
Var String - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density String
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density
Var String - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power String
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power
Var String - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed String
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed
Var String - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
GetImagingPolicyImagePolicyPostBreakpointTransformationGrayscale
GetImagingPolicyImagePolicyPostBreakpointTransformationHsl
- Hue string
- The number of degrees to rotate colors around the color wheel,
0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0
by default. - Lightness string
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Lightness
Var string - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- Hue string
- The number of degrees to rotate colors around the color wheel,
0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0
by default. - Lightness string
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Lightness
Var string - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue String
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness String
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness
Var String - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue string
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue
Var string - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness string
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness
Var string - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue str
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue_
var str - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness str
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness_
var str - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation str
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation_
var str - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue String
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness String
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness
Var String - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
GetImagingPolicyImagePolicyPostBreakpointTransformationHsv
- Hue string
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0.0
by default. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Value string
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- Value
Var string - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- Hue string
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0.0
by default. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Value string
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- Value
Var string - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue String
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value String
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value
Var String - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue string
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue
Var string - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value string
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value
Var string - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue str
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue_
var str - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation str
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation_
var str - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value str
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value_
var str - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue String
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value String
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value
Var String - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
GetImagingPolicyImagePolicyPostBreakpointTransformationIfDimension
- Default
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Dimension string
- The dimension to use to select the transformation, either
height
,width
, orboth
. - Dimension
Var string - The dimension to use to select the transformation, either
height
,width
, orboth
. - Equal
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Greater
Than GetImaging Policy Image Policy Post Breakpoint Transformation - Less
Than GetImaging Policy Image Policy Post Breakpoint Transformation - Value string
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- Value
Var string - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- Default
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Dimension string
- The dimension to use to select the transformation, either
height
,width
, orboth
. - Dimension
Var string - The dimension to use to select the transformation, either
height
,width
, orboth
. - Equal
Get
Imaging Policy Image Policy Post Breakpoint Transformation - Greater
Than GetImaging Policy Image Policy Post Breakpoint Transformation - Less
Than GetImaging Policy Image Policy Post Breakpoint Transformation - Value string
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- Value
Var string - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default_
Get
Imaging Policy Image Policy Post Breakpoint Transformation - dimension String
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension
Var String - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal
Get
Imaging Policy Image Policy Post Breakpoint Transformation - greater
Than GetImaging Policy Image Policy Post Breakpoint Transformation - less
Than GetImaging Policy Image Policy Post Breakpoint Transformation - value String
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value
Var String - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default
Get
Imaging Policy Image Policy Post Breakpoint Transformation - dimension string
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension
Var string - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal
Get
Imaging Policy Image Policy Post Breakpoint Transformation - greater
Than GetImaging Policy Image Policy Post Breakpoint Transformation - less
Than GetImaging Policy Image Policy Post Breakpoint Transformation - value string
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value
Var string - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default
Get
Imaging Policy Image Policy Post Breakpoint Transformation - dimension str
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension_
var str - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal
Get
Imaging Policy Image Policy Post Breakpoint Transformation - greater_
than GetImaging Policy Image Policy Post Breakpoint Transformation - less_
than GetImaging Policy Image Policy Post Breakpoint Transformation - value str
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value_
var str - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default Property Map
- dimension String
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension
Var String - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal Property Map
- greater
Than Property Map - less
Than Property Map - value String
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value
Var String - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
GetImagingPolicyImagePolicyPostBreakpointTransformationIfOrientation
GetImagingPolicyImagePolicyPostBreakpointTransformationMaxColor
- colors str
- The value representing the maximum number of colors to use with the source image.
- colors_
var str - The value representing the maximum number of colors to use with the source image.
GetImagingPolicyImagePolicyPostBreakpointTransformationMirror
- Horizontal string
- Flips the image horizontally.
- Horizontal
Var string - Flips the image horizontally.
- Vertical string
- Flips the image vertically.
- Vertical
Var string - Flips the image vertically.
- Horizontal string
- Flips the image horizontally.
- Horizontal
Var string - Flips the image horizontally.
- Vertical string
- Flips the image vertically.
- Vertical
Var string - Flips the image vertically.
- horizontal String
- Flips the image horizontally.
- horizontal
Var String - Flips the image horizontally.
- vertical String
- Flips the image vertically.
- vertical
Var String - Flips the image vertically.
- horizontal string
- Flips the image horizontally.
- horizontal
Var string - Flips the image horizontally.
- vertical string
- Flips the image vertically.
- vertical
Var string - Flips the image vertically.
- horizontal str
- Flips the image horizontally.
- horizontal_
var str - Flips the image horizontally.
- vertical str
- Flips the image vertically.
- vertical_
var str - Flips the image vertically.
- horizontal String
- Flips the image horizontally.
- horizontal
Var String - Flips the image horizontally.
- vertical String
- Flips the image vertically.
- vertical
Var String - Flips the image vertically.
GetImagingPolicyImagePolicyPostBreakpointTransformationMonoHue
- Hue string
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- Hue
Var string - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- Hue string
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- Hue
Var string - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue String
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue
Var String - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue string
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue
Var string - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue str
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue_
var str - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue String
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue
Var String - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
GetImagingPolicyImagePolicyPostBreakpointTransformationOpacity
- Opacity string
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - Opacity
Var string - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- Opacity string
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - Opacity
Var string - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity String
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity
Var String - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity string
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity
Var string - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity str
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity_
var str - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity String
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity
Var String - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
GetImagingPolicyImagePolicyPostBreakpointTransformationRemoveColor
- Color string
- The hexadecimal CSS color value to remove.
- Color
Var string - The hexadecimal CSS color value to remove.
- Feather string
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Feather
Var string - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Tolerance string
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- Tolerance
Var string - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- Color string
- The hexadecimal CSS color value to remove.
- Color
Var string - The hexadecimal CSS color value to remove.
- Feather string
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Feather
Var string - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Tolerance string
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- Tolerance
Var string - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color String
- The hexadecimal CSS color value to remove.
- color
Var String - The hexadecimal CSS color value to remove.
- feather String
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather
Var String - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance String
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance
Var String - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color string
- The hexadecimal CSS color value to remove.
- color
Var string - The hexadecimal CSS color value to remove.
- feather string
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather
Var string - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance string
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance
Var string - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color str
- The hexadecimal CSS color value to remove.
- color_
var str - The hexadecimal CSS color value to remove.
- feather str
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather_
var str - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance str
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance_
var str - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color String
- The hexadecimal CSS color value to remove.
- color
Var String - The hexadecimal CSS color value to remove.
- feather String
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather
Var String - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance String
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance
Var String - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
GetImagingPolicyImagePolicyPostBreakpointTransformationUnsharpMask
- Gain string
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Gain
Var string - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Sigma string
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Sigma
Var string - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Threshold string
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- Threshold
Var string - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- Gain string
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Gain
Var string - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Sigma string
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Sigma
Var string - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Threshold string
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- Threshold
Var string - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain String
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain
Var String - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma String
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma
Var String - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold String
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold
Var String - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain string
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain
Var string - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma string
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma
Var string - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold string
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold
Var string - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain str
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain_
var str - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma str
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma_
var str - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold str
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold_
var str - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain String
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain
Var String - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma String
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma
Var String - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold String
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold
Var String - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
GetImagingPolicyImagePolicyTransformation
- Appends
List<Get
Imaging Policy Image Policy Transformation Append> - Places a specified
image
beside the source image. The API places theimage
on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image. - Aspect
Crops List<GetImaging Policy Image Policy Transformation Aspect Crop> - Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
- Background
Colors List<GetImaging Policy Image Policy Transformation Background Color> - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- Blurs
List<Get
Imaging Policy Image Policy Transformation Blur> - Applies a Gaussian blur to the image.
- Chroma
Keys List<GetImaging Policy Image Policy Transformation Chroma Key> - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- Composites
List<Get
Imaging Policy Image Policy Transformation Composite> - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- Compounds
List<Get
Imaging Policy Image Policy Transformation Compound> - Contrasts
List<Get
Imaging Policy Image Policy Transformation Contrast> - Adjusts both the contrast and brightness of an image.
- Crops
List<Get
Imaging Policy Image Policy Transformation Crop> - Crops an image.
- Face
Crops List<GetImaging Policy Image Policy Transformation Face Crop> - Applies a method to detect faces in the source image and applies the rectangular crop on either the
biggest
face orall
of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates. - Feature
Crops List<GetImaging Policy Image Policy Transformation Feature Crop> - Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified
width
andheight
values. - Fit
And List<GetFills Imaging Policy Image Policy Transformation Fit And Fill> - Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
- Goops
List<Get
Imaging Policy Image Policy Transformation Goop> - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- Grayscales
List<Get
Imaging Policy Image Policy Transformation Grayscale> - Restricts image color to shades of gray only.
- Hsls
List<Get
Imaging Policy Image Policy Transformation Hsl> - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - Hsvs
List<Get
Imaging Policy Image Policy Transformation Hsv> - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - If
Dimensions List<GetImaging Policy Image Policy Transformation If Dimension> - If
Orientations List<GetImaging Policy Image Policy Transformation If Orientation> - Im
Queries List<GetImaging Policy Image Policy Transformation Im Query> - Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
- Max
Colors List<GetImaging Policy Image Policy Transformation Max Color> - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- Mirrors
List<Get
Imaging Policy Image Policy Transformation Mirror> - Flips an image horizontally, vertically, or both.
- Mono
Hues List<GetImaging Policy Image Policy Transformation Mono Hue> - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- Opacities
List<Get
Imaging Policy Image Policy Transformation Opacity> - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- Region
Of List<GetInterest Crops Imaging Policy Image Policy Transformation Region Of Interest Crop> - Crops to a region around a specified area of interest relative to the specified
width
andheight
values. - Relative
Crops List<GetImaging Policy Image Policy Transformation Relative Crop> - Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
- Remove
Colors List<GetImaging Policy Image Policy Transformation Remove Color> - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- Resizes
List<Get
Imaging Policy Image Policy Transformation Resize> - Resizes an image to a particular, absolute dimension. If you don't enter a
width
or aheight
, the image is resized with thefit
aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect. - Rotates
List<Get
Imaging Policy Image Policy Transformation Rotate> - Rotate the image around its center by indicating the degrees of rotation.
- Scales
List<Get
Imaging Policy Image Policy Transformation Scale> - Changes the image's size to different dimensions relative to its starting size.
- Shears
List<Get
Imaging Policy Image Policy Transformation Shears> - Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a
BackgroundColor
transformation for these areas. - Trims
List<Get
Imaging Policy Image Policy Transformation Trim> - Automatically crops uniform backgrounds from the edges of an image.
- Unsharp
Masks List<GetImaging Policy Image Policy Transformation Unsharp Mask> - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- Appends
[]Get
Imaging Policy Image Policy Transformation Append - Places a specified
image
beside the source image. The API places theimage
on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image. - Aspect
Crops []GetImaging Policy Image Policy Transformation Aspect Crop - Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
- Background
Colors []GetImaging Policy Image Policy Transformation Background Color - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- Blurs
[]Get
Imaging Policy Image Policy Transformation Blur - Applies a Gaussian blur to the image.
- Chroma
Keys []GetImaging Policy Image Policy Transformation Chroma Key - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- Composites
[]Get
Imaging Policy Image Policy Transformation Composite - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- Compounds
[]Get
Imaging Policy Image Policy Transformation Compound - Contrasts
[]Get
Imaging Policy Image Policy Transformation Contrast - Adjusts both the contrast and brightness of an image.
- Crops
[]Get
Imaging Policy Image Policy Transformation Crop - Crops an image.
- Face
Crops []GetImaging Policy Image Policy Transformation Face Crop - Applies a method to detect faces in the source image and applies the rectangular crop on either the
biggest
face orall
of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates. - Feature
Crops []GetImaging Policy Image Policy Transformation Feature Crop - Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified
width
andheight
values. - Fit
And []GetFills Imaging Policy Image Policy Transformation Fit And Fill - Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
- Goops
[]Get
Imaging Policy Image Policy Transformation Goop - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- Grayscales
[]Get
Imaging Policy Image Policy Transformation Grayscale - Restricts image color to shades of gray only.
- Hsls
[]Get
Imaging Policy Image Policy Transformation Hsl - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - Hsvs
[]Get
Imaging Policy Image Policy Transformation Hsv - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - If
Dimensions []GetImaging Policy Image Policy Transformation If Dimension - If
Orientations []GetImaging Policy Image Policy Transformation If Orientation - Im
Queries []GetImaging Policy Image Policy Transformation Im Query - Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
- Max
Colors []GetImaging Policy Image Policy Transformation Max Color - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- Mirrors
[]Get
Imaging Policy Image Policy Transformation Mirror - Flips an image horizontally, vertically, or both.
- Mono
Hues []GetImaging Policy Image Policy Transformation Mono Hue - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- Opacities
[]Get
Imaging Policy Image Policy Transformation Opacity - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- Region
Of []GetInterest Crops Imaging Policy Image Policy Transformation Region Of Interest Crop - Crops to a region around a specified area of interest relative to the specified
width
andheight
values. - Relative
Crops []GetImaging Policy Image Policy Transformation Relative Crop - Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
- Remove
Colors []GetImaging Policy Image Policy Transformation Remove Color - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- Resizes
[]Get
Imaging Policy Image Policy Transformation Resize - Resizes an image to a particular, absolute dimension. If you don't enter a
width
or aheight
, the image is resized with thefit
aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect. - Rotates
[]Get
Imaging Policy Image Policy Transformation Rotate - Rotate the image around its center by indicating the degrees of rotation.
- Scales
[]Get
Imaging Policy Image Policy Transformation Scale - Changes the image's size to different dimensions relative to its starting size.
- Shears
[]Get
Imaging Policy Image Policy Transformation Shears - Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a
BackgroundColor
transformation for these areas. - Trims
[]Get
Imaging Policy Image Policy Transformation Trim - Automatically crops uniform backgrounds from the edges of an image.
- Unsharp
Masks []GetImaging Policy Image Policy Transformation Unsharp Mask - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- appends
List<Get
Imaging Policy Image Policy Transformation Append> - Places a specified
image
beside the source image. The API places theimage
on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image. - aspect
Crops List<GetImaging Policy Image Policy Transformation Aspect Crop> - Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
- background
Colors List<GetImaging Policy Image Policy Transformation Background Color> - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs
List<Get
Imaging Policy Image Policy Transformation Blur> - Applies a Gaussian blur to the image.
- chroma
Keys List<GetImaging Policy Image Policy Transformation Chroma Key> - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites
List<Get
Imaging Policy Image Policy Transformation Composite> - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds
List<Get
Imaging Policy Image Policy Transformation Compound> - contrasts
List<Get
Imaging Policy Image Policy Transformation Contrast> - Adjusts both the contrast and brightness of an image.
- crops
List<Get
Imaging Policy Image Policy Transformation Crop> - Crops an image.
- face
Crops List<GetImaging Policy Image Policy Transformation Face Crop> - Applies a method to detect faces in the source image and applies the rectangular crop on either the
biggest
face orall
of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates. - feature
Crops List<GetImaging Policy Image Policy Transformation Feature Crop> - Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified
width
andheight
values. - fit
And List<GetFills Imaging Policy Image Policy Transformation Fit And Fill> - Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
- goops
List<Get
Imaging Policy Image Policy Transformation Goop> - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales
List<Get
Imaging Policy Image Policy Transformation Grayscale> - Restricts image color to shades of gray only.
- hsls
List<Get
Imaging Policy Image Policy Transformation Hsl> - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs
List<Get
Imaging Policy Image Policy Transformation Hsv> - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if
Dimensions List<GetImaging Policy Image Policy Transformation If Dimension> - if
Orientations List<GetImaging Policy Image Policy Transformation If Orientation> - im
Queries List<GetImaging Policy Image Policy Transformation Im Query> - Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
- max
Colors List<GetImaging Policy Image Policy Transformation Max Color> - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors
List<Get
Imaging Policy Image Policy Transformation Mirror> - Flips an image horizontally, vertically, or both.
- mono
Hues List<GetImaging Policy Image Policy Transformation Mono Hue> - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities
List<Get
Imaging Policy Image Policy Transformation Opacity> - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- region
Of List<GetInterest Crops Imaging Policy Image Policy Transformation Region Of Interest Crop> - Crops to a region around a specified area of interest relative to the specified
width
andheight
values. - relative
Crops List<GetImaging Policy Image Policy Transformation Relative Crop> - Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
- remove
Colors List<GetImaging Policy Image Policy Transformation Remove Color> - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- resizes
List<Get
Imaging Policy Image Policy Transformation Resize> - Resizes an image to a particular, absolute dimension. If you don't enter a
width
or aheight
, the image is resized with thefit
aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect. - rotates
List<Get
Imaging Policy Image Policy Transformation Rotate> - Rotate the image around its center by indicating the degrees of rotation.
- scales
List<Get
Imaging Policy Image Policy Transformation Scale> - Changes the image's size to different dimensions relative to its starting size.
- shears
List<Get
Imaging Policy Image Policy Transformation Shears> - Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a
BackgroundColor
transformation for these areas. - trims
List<Get
Imaging Policy Image Policy Transformation Trim> - Automatically crops uniform backgrounds from the edges of an image.
- unsharp
Masks List<GetImaging Policy Image Policy Transformation Unsharp Mask> - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- appends
Get
Imaging Policy Image Policy Transformation Append[] - Places a specified
image
beside the source image. The API places theimage
on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image. - aspect
Crops GetImaging Policy Image Policy Transformation Aspect Crop[] - Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
- background
Colors GetImaging Policy Image Policy Transformation Background Color[] - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs
Get
Imaging Policy Image Policy Transformation Blur[] - Applies a Gaussian blur to the image.
- chroma
Keys GetImaging Policy Image Policy Transformation Chroma Key[] - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites
Get
Imaging Policy Image Policy Transformation Composite[] - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds
Get
Imaging Policy Image Policy Transformation Compound[] - contrasts
Get
Imaging Policy Image Policy Transformation Contrast[] - Adjusts both the contrast and brightness of an image.
- crops
Get
Imaging Policy Image Policy Transformation Crop[] - Crops an image.
- face
Crops GetImaging Policy Image Policy Transformation Face Crop[] - Applies a method to detect faces in the source image and applies the rectangular crop on either the
biggest
face orall
of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates. - feature
Crops GetImaging Policy Image Policy Transformation Feature Crop[] - Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified
width
andheight
values. - fit
And GetFills Imaging Policy Image Policy Transformation Fit And Fill[] - Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
- goops
Get
Imaging Policy Image Policy Transformation Goop[] - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales
Get
Imaging Policy Image Policy Transformation Grayscale[] - Restricts image color to shades of gray only.
- hsls
Get
Imaging Policy Image Policy Transformation Hsl[] - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs
Get
Imaging Policy Image Policy Transformation Hsv[] - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if
Dimensions GetImaging Policy Image Policy Transformation If Dimension[] - if
Orientations GetImaging Policy Image Policy Transformation If Orientation[] - im
Queries GetImaging Policy Image Policy Transformation Im Query[] - Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
- max
Colors GetImaging Policy Image Policy Transformation Max Color[] - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors
Get
Imaging Policy Image Policy Transformation Mirror[] - Flips an image horizontally, vertically, or both.
- mono
Hues GetImaging Policy Image Policy Transformation Mono Hue[] - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities
Get
Imaging Policy Image Policy Transformation Opacity[] - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- region
Of GetInterest Crops Imaging Policy Image Policy Transformation Region Of Interest Crop[] - Crops to a region around a specified area of interest relative to the specified
width
andheight
values. - relative
Crops GetImaging Policy Image Policy Transformation Relative Crop[] - Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
- remove
Colors GetImaging Policy Image Policy Transformation Remove Color[] - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- resizes
Get
Imaging Policy Image Policy Transformation Resize[] - Resizes an image to a particular, absolute dimension. If you don't enter a
width
or aheight
, the image is resized with thefit
aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect. - rotates
Get
Imaging Policy Image Policy Transformation Rotate[] - Rotate the image around its center by indicating the degrees of rotation.
- scales
Get
Imaging Policy Image Policy Transformation Scale[] - Changes the image's size to different dimensions relative to its starting size.
- shears
Get
Imaging Policy Image Policy Transformation Shears[] - Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a
BackgroundColor
transformation for these areas. - trims
Get
Imaging Policy Image Policy Transformation Trim[] - Automatically crops uniform backgrounds from the edges of an image.
- unsharp
Masks GetImaging Policy Image Policy Transformation Unsharp Mask[] - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- appends
Sequence[Get
Imaging Policy Image Policy Transformation Append] - Places a specified
image
beside the source image. The API places theimage
on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image. - aspect_
crops Sequence[GetImaging Policy Image Policy Transformation Aspect Crop] - Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
- background_
colors Sequence[GetImaging Policy Image Policy Transformation Background Color] - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs
Sequence[Get
Imaging Policy Image Policy Transformation Blur] - Applies a Gaussian blur to the image.
- chroma_
keys Sequence[GetImaging Policy Image Policy Transformation Chroma Key] - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites
Sequence[Get
Imaging Policy Image Policy Transformation Composite] - Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds
Sequence[Get
Imaging Policy Image Policy Transformation Compound] - contrasts
Sequence[Get
Imaging Policy Image Policy Transformation Contrast] - Adjusts both the contrast and brightness of an image.
- crops
Sequence[Get
Imaging Policy Image Policy Transformation Crop] - Crops an image.
- face_
crops Sequence[GetImaging Policy Image Policy Transformation Face Crop] - Applies a method to detect faces in the source image and applies the rectangular crop on either the
biggest
face orall
of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates. - feature_
crops Sequence[GetImaging Policy Image Policy Transformation Feature Crop] - Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified
width
andheight
values. - fit_
and_ Sequence[Getfills Imaging Policy Image Policy Transformation Fit And Fill] - Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
- goops
Sequence[Get
Imaging Policy Image Policy Transformation Goop] - Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales
Sequence[Get
Imaging Policy Image Policy Transformation Grayscale] - Restricts image color to shades of gray only.
- hsls
Sequence[Get
Imaging Policy Image Policy Transformation Hsl] - Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs
Sequence[Get
Imaging Policy Image Policy Transformation Hsv] - Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if_
dimensions Sequence[GetImaging Policy Image Policy Transformation If Dimension] - if_
orientations Sequence[GetImaging Policy Image Policy Transformation If Orientation] - im_
queries Sequence[GetImaging Policy Image Policy Transformation Im Query] - Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
- max_
colors Sequence[GetImaging Policy Image Policy Transformation Max Color] - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors
Sequence[Get
Imaging Policy Image Policy Transformation Mirror] - Flips an image horizontally, vertically, or both.
- mono_
hues Sequence[GetImaging Policy Image Policy Transformation Mono Hue] - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities
Sequence[Get
Imaging Policy Image Policy Transformation Opacity] - Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- region_
of_ Sequence[Getinterest_ crops Imaging Policy Image Policy Transformation Region Of Interest Crop] - Crops to a region around a specified area of interest relative to the specified
width
andheight
values. - relative_
crops Sequence[GetImaging Policy Image Policy Transformation Relative Crop] - Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
- remove_
colors Sequence[GetImaging Policy Image Policy Transformation Remove Color] - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- resizes
Sequence[Get
Imaging Policy Image Policy Transformation Resize] - Resizes an image to a particular, absolute dimension. If you don't enter a
width
or aheight
, the image is resized with thefit
aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect. - rotates
Sequence[Get
Imaging Policy Image Policy Transformation Rotate] - Rotate the image around its center by indicating the degrees of rotation.
- scales
Sequence[Get
Imaging Policy Image Policy Transformation Scale] - Changes the image's size to different dimensions relative to its starting size.
- shears
Sequence[Get
Imaging Policy Image Policy Transformation Shears] - Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a
BackgroundColor
transformation for these areas. - trims
Sequence[Get
Imaging Policy Image Policy Transformation Trim] - Automatically crops uniform backgrounds from the edges of an image.
- unsharp_
masks Sequence[GetImaging Policy Image Policy Transformation Unsharp Mask] - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
- appends List<Property Map>
- Places a specified
image
beside the source image. The API places theimage
on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image. - aspect
Crops List<Property Map> - Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
- background
Colors List<Property Map> - Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
- blurs List<Property Map>
- Applies a Gaussian blur to the image.
- chroma
Keys List<Property Map> - Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
- composites List<Property Map>
- Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
- compounds List<Property Map>
- contrasts List<Property Map>
- Adjusts both the contrast and brightness of an image.
- crops List<Property Map>
- Crops an image.
- face
Crops List<Property Map> - Applies a method to detect faces in the source image and applies the rectangular crop on either the
biggest
face orall
of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates. - feature
Crops List<Property Map> - Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified
width
andheight
values. - fit
And List<Property Map>Fills - Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
- goops List<Property Map>
- Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears goopy. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
- grayscales List<Property Map>
- Restricts image color to shades of gray only.
- hsls List<Property Map>
- Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as
Grayscale
andMaxColors
. If youre using more than one, consider the order to apply them for the desired results. - hsvs List<Property Map>
- Identical to HSL except it replaces
lightness
withvalue
. For example, if you reduce thelightness
of a light green, almost white, image, the color turns a vibrant green. Reducing thevalue
turns the image a darker color, close to grey. This happens because the original image color is very close to white. - if
Dimensions List<Property Map> - if
Orientations List<Property Map> - im
Queries List<Property Map> - Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
- max
Colors List<Property Map> - Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
- mirrors List<Property Map>
- Flips an image horizontally, vertically, or both.
- mono
Hues List<Property Map> - Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
- opacities List<Property Map>
- Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
- region
Of List<Property Map>Interest Crops - Crops to a region around a specified area of interest relative to the specified
width
andheight
values. - relative
Crops List<Property Map> - Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
- remove
Colors List<Property Map> - Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
- resizes List<Property Map>
- Resizes an image to a particular, absolute dimension. If you don't enter a
width
or aheight
, the image is resized with thefit
aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect. - rotates List<Property Map>
- Rotate the image around its center by indicating the degrees of rotation.
- scales List<Property Map>
- Changes the image's size to different dimensions relative to its starting size.
- shears List<Property Map>
- Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a
BackgroundColor
transformation for these areas. - trims List<Property Map>
- Automatically crops uniform backgrounds from the edges of an image.
- unsharp
Masks List<Property Map> - Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as sharpening an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
GetImagingPolicyImagePolicyTransformationAppend
- Image
Get
Imaging Policy Image Policy Transformation Append Image - Gravity string
- Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - Gravity
Priority string - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - Gravity
Priority stringVar - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - Gravity
Var string - Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - Preserve
Minor stringDimension - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels. - Preserve
Minor stringDimension Var - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
- Image
Get
Imaging Policy Image Policy Transformation Append Image - Gravity string
- Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - Gravity
Priority string - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - Gravity
Priority stringVar - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - Gravity
Var string - Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - Preserve
Minor stringDimension - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels. - Preserve
Minor stringDimension Var - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
- image
Get
Imaging Policy Image Policy Transformation Append Image - gravity String
- Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - gravity
Priority String - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity
Priority StringVar - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity
Var String - Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - preserve
Minor StringDimension - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels. - preserve
Minor StringDimension Var - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
- image
Get
Imaging Policy Image Policy Transformation Append Image - gravity string
- Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - gravity
Priority string - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity
Priority stringVar - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity
Var string - Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - preserve
Minor stringDimension - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels. - preserve
Minor stringDimension Var - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
- image
Get
Imaging Policy Image Policy Transformation Append Image - gravity str
- Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - gravity_
priority str - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity_
priority_ strvar - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity_
var str - Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - preserve_
minor_ strdimension - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels. - preserve_
minor_ strdimension_ var - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
- image Property Map
- gravity String
- Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - gravity
Priority String - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity
Priority StringVar - Determines the exact placement of the
image
whengravity
isCenter
or a diagonal. The value is eitherhorizontal
orvertical
. Usehorizontal
to append animage
east or west of the source image. This aligns theimage
on the vertical gravity component, placingCenter
gravity east. Usevertical
to append animage
north or south of the source image. This aligns theimage
on the horizontal gravity component, placingCenter
gravity south. - gravity
Var String - Specifies where to place the
image
relative to the source image. The available values represent the eight cardinal directions (North
,South
,East
,West
,NorthEast
,NorthWest
,SouthEast
,SouthWest
) and aCenter
by default. - preserve
Minor StringDimension - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels. - preserve
Minor StringDimension Var - Whether to preserve the source image's minor dimension,
false
by default. The minor dimension is the dimension opposite the dimension that the appendingimage
is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appendingimage
are 50 × 150 pixels. Thegravity
is set toEast
. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, thepreserveMinorDimension
is set totrue
. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
GetImagingPolicyImagePolicyTransformationAppendImage
- Box
Images List<GetImaging Policy Image Policy Transformation Append Image Box Image> - A rectangular box, with a specified color and applied transformation.
- Circle
Images List<GetImaging Policy Image Policy Transformation Append Image Circle Image> - A rectangular box, with a specified color and applied transformation.
- Text
Images List<GetImaging Policy Image Policy Transformation Append Image Text Image> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- Url
Images List<GetImaging Policy Image Policy Transformation Append Image Url Image> - An image loaded from a URL.
- Box
Images []GetImaging Policy Image Policy Transformation Append Image Box Image - A rectangular box, with a specified color and applied transformation.
- Circle
Images []GetImaging Policy Image Policy Transformation Append Image Circle Image - A rectangular box, with a specified color and applied transformation.
- Text
Images []GetImaging Policy Image Policy Transformation Append Image Text Image - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- Url
Images []GetImaging Policy Image Policy Transformation Append Image Url Image - An image loaded from a URL.
- box
Images List<GetImaging Policy Image Policy Transformation Append Image Box Image> - A rectangular box, with a specified color and applied transformation.
- circle
Images List<GetImaging Policy Image Policy Transformation Append Image Circle Image> - A rectangular box, with a specified color and applied transformation.
- text
Images List<GetImaging Policy Image Policy Transformation Append Image Text Image> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images List<GetImaging Policy Image Policy Transformation Append Image Url Image> - An image loaded from a URL.
- box
Images GetImaging Policy Image Policy Transformation Append Image Box Image[] - A rectangular box, with a specified color and applied transformation.
- circle
Images GetImaging Policy Image Policy Transformation Append Image Circle Image[] - A rectangular box, with a specified color and applied transformation.
- text
Images GetImaging Policy Image Policy Transformation Append Image Text Image[] - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images GetImaging Policy Image Policy Transformation Append Image Url Image[] - An image loaded from a URL.
- box_
images Sequence[GetImaging Policy Image Policy Transformation Append Image Box Image] - A rectangular box, with a specified color and applied transformation.
- circle_
images Sequence[GetImaging Policy Image Policy Transformation Append Image Circle Image] - A rectangular box, with a specified color and applied transformation.
- text_
images Sequence[GetImaging Policy Image Policy Transformation Append Image Text Image] - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url_
images Sequence[GetImaging Policy Image Policy Transformation Append Image Url Image] - An image loaded from a URL.
- box
Images List<Property Map> - A rectangular box, with a specified color and applied transformation.
- circle
Images List<Property Map> - A rectangular box, with a specified color and applied transformation.
- text
Images List<Property Map> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images List<Property Map> - An image loaded from a URL.
GetImagingPolicyImagePolicyTransformationAppendImageBoxImage
- Color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Height string
- The height of the box in pixels.
- Height
Var string - The height of the box in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- Color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Height string
- The height of the box in pixels.
- Height
Var string - The height of the box in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- color String
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height String
- The height of the box in pixels.
- height
Var String - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
- color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height string
- The height of the box in pixels.
- height
Var string - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width string
- The width of the box in pixels.
- width
Var string - The width of the box in pixels.
- color str
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color_
var str - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height str
- The height of the box in pixels.
- height_
var str - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width str
- The width of the box in pixels.
- width_
var str - The width of the box in pixels.
- color String
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height String
- The height of the box in pixels.
- height
Var String - The height of the box in pixels.
- transformation Property Map
- width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
GetImagingPolicyImagePolicyTransformationAppendImageCircleImage
- Color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- Color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- color String
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter String
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var String - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
- color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width string
- The width of the box in pixels.
- width
Var string - The width of the box in pixels.
- color str
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color_
var str - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter str
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter_
var str - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width str
- The width of the box in pixels.
- width_
var str - The width of the box in pixels.
- color String
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter String
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var String - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation Property Map
- width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
GetImagingPolicyImagePolicyTransformationAppendImageTextImage
- Fill string
- The main fill color of the text.
- Fill
Var string - The main fill color of the text.
- Size string
- The size in pixels to render the text.
- Size
Var string - The size in pixels to render the text.
- Stroke string
- The color for the outline of the text.
- Stroke
Size string - The thickness in points for the outline of the text.
- Stroke
Size stringVar - The thickness in points for the outline of the text.
- Stroke
Var string - The color for the outline of the text.
- Text string
- The line of text to render.
- Text
Var string - The line of text to render.
- Transformation
Get
Imaging Policy Image Policy Transformation - Typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Fill string
- The main fill color of the text.
- Fill
Var string - The main fill color of the text.
- Size string
- The size in pixels to render the text.
- Size
Var string - The size in pixels to render the text.
- Stroke string
- The color for the outline of the text.
- Stroke
Size string - The thickness in points for the outline of the text.
- Stroke
Size stringVar - The thickness in points for the outline of the text.
- Stroke
Var string - The color for the outline of the text.
- Text string
- The line of text to render.
- Text
Var string - The line of text to render.
- Transformation
Get
Imaging Policy Image Policy Transformation - Typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill String
- The main fill color of the text.
- fill
Var String - The main fill color of the text.
- size String
- The size in pixels to render the text.
- size
Var String - The size in pixels to render the text.
- stroke String
- The color for the outline of the text.
- stroke
Size String - The thickness in points for the outline of the text.
- stroke
Size StringVar - The thickness in points for the outline of the text.
- stroke
Var String - The color for the outline of the text.
- text String
- The line of text to render.
- text
Var String - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Transformation - typeface String
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var String - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill string
- The main fill color of the text.
- fill
Var string - The main fill color of the text.
- size string
- The size in pixels to render the text.
- size
Var string - The size in pixels to render the text.
- stroke string
- The color for the outline of the text.
- stroke
Size string - The thickness in points for the outline of the text.
- stroke
Size stringVar - The thickness in points for the outline of the text.
- stroke
Var string - The color for the outline of the text.
- text string
- The line of text to render.
- text
Var string - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Transformation - typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill str
- The main fill color of the text.
- fill_
var str - The main fill color of the text.
- size str
- The size in pixels to render the text.
- size_
var str - The size in pixels to render the text.
- stroke str
- The color for the outline of the text.
- stroke_
size str - The thickness in points for the outline of the text.
- stroke_
size_ strvar - The thickness in points for the outline of the text.
- stroke_
var str - The color for the outline of the text.
- text str
- The line of text to render.
- text_
var str - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Transformation - typeface str
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface_
var str - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill String
- The main fill color of the text.
- fill
Var String - The main fill color of the text.
- size String
- The size in pixels to render the text.
- size
Var String - The size in pixels to render the text.
- stroke String
- The color for the outline of the text.
- stroke
Size String - The thickness in points for the outline of the text.
- stroke
Size StringVar - The thickness in points for the outline of the text.
- stroke
Var String - The color for the outline of the text.
- text String
- The line of text to render.
- text
Var String - The line of text to render.
- transformation Property Map
- typeface String
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var String - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
GetImagingPolicyImagePolicyTransformationAppendImageUrlImage
- Transformation
Get
Imaging Policy Image Policy Transformation - Url string
- The URL of the image.
- Url
Var string - The URL of the image.
- Transformation
Get
Imaging Policy Image Policy Transformation - Url string
- The URL of the image.
- Url
Var string - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Transformation - url String
- The URL of the image.
- url
Var String - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Transformation - url string
- The URL of the image.
- url
Var string - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Transformation - url str
- The URL of the image.
- url_
var str - The URL of the image.
- transformation Property Map
- url String
- The URL of the image.
- url
Var String - The URL of the image.
GetImagingPolicyImagePolicyTransformationAspectCrop
- Allow
Expansion string - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- Allow
Expansion stringVar - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- Height string
- The height term of the aspect ratio to crop.
- Height
Var string - The height term of the aspect ratio to crop.
- Width string
- The width term of the aspect ratio to crop.
- Width
Var string - The width term of the aspect ratio to crop.
- XPosition string
- Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- XPosition
Var string - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- YPosition string
- Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- YPosition
Var string - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- Allow
Expansion string - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- Allow
Expansion stringVar - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- Height string
- The height term of the aspect ratio to crop.
- Height
Var string - The height term of the aspect ratio to crop.
- Width string
- The width term of the aspect ratio to crop.
- Width
Var string - The width term of the aspect ratio to crop.
- XPosition string
- Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- XPosition
Var string - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- YPosition string
- Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- YPosition
Var string - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- allow
Expansion String - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- allow
Expansion StringVar - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- height String
- The height term of the aspect ratio to crop.
- height
Var String - The height term of the aspect ratio to crop.
- width String
- The width term of the aspect ratio to crop.
- width
Var String - The width term of the aspect ratio to crop.
- x
Position String - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- x
Position StringVar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y
Position String - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y
Position StringVar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- allow
Expansion string - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- allow
Expansion stringVar - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- height string
- The height term of the aspect ratio to crop.
- height
Var string - The height term of the aspect ratio to crop.
- width string
- The width term of the aspect ratio to crop.
- width
Var string - The width term of the aspect ratio to crop.
- x
Position string - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- x
Position stringVar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y
Position string - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y
Position stringVar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- allow_
expansion str - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- allow_
expansion_ strvar - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- height str
- The height term of the aspect ratio to crop.
- height_
var str - The height term of the aspect ratio to crop.
- width str
- The width term of the aspect ratio to crop.
- width_
var str - The width term of the aspect ratio to crop.
- x_
position str - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- x_
position_ strvar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y_
position str - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y_
position_ strvar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- allow
Expansion String - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- allow
Expansion StringVar - Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
- height String
- The height term of the aspect ratio to crop.
- height
Var String - The height term of the aspect ratio to crop.
- width String
- The width term of the aspect ratio to crop.
- width
Var String - The width term of the aspect ratio to crop.
- x
Position String - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- x
Position StringVar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y
Position String - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
- y
Position StringVar - Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
GetImagingPolicyImagePolicyTransformationBackgroundColor
GetImagingPolicyImagePolicyTransformationBlur
- Sigma string
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- Sigma
Var string - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- Sigma string
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- Sigma
Var string - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma String
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma
Var String - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma string
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma
Var string - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma str
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma_
var str - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma String
- The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
- sigma
Var String - The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
GetImagingPolicyImagePolicyTransformationChromaKey
- Hue string
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Hue
Feather string - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Feather stringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Tolerance string - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Tolerance stringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Var string - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Lightness
Feather string - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Feather stringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Tolerance string - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Lightness
Tolerance stringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Saturation
Feather string - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Feather stringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Tolerance string - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- Saturation
Tolerance stringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- Hue string
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Hue
Feather string - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Feather stringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- Hue
Tolerance string - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Tolerance stringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- Hue
Var string - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- Lightness
Feather string - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Feather stringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- Lightness
Tolerance string - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Lightness
Tolerance stringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- Saturation
Feather string - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Feather stringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- Saturation
Tolerance string - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- Saturation
Tolerance stringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue String
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue
Feather String - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Feather StringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Tolerance String - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Tolerance StringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Var String - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness
Feather String - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Feather StringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Tolerance String - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness
Tolerance StringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation
Feather String - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Feather StringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Tolerance String - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation
Tolerance StringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue string
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue
Feather string - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Feather stringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Tolerance string - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Tolerance stringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Var string - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness
Feather string - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Feather stringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Tolerance string - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness
Tolerance stringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation
Feather string - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Feather stringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Tolerance string - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation
Tolerance stringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue str
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue_
feather str - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue_
feather_ strvar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue_
tolerance str - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue_
tolerance_ strvar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue_
var str - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness_
feather str - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness_
feather_ strvar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness_
tolerance str - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness_
tolerance_ strvar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation_
feather str - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation_
feather_ strvar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation_
tolerance str - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation_
tolerance_ strvar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- hue String
- The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- hue
Feather String - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Feather StringVar - How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
- hue
Tolerance String - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Tolerance StringVar - How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
- hue
Var String - The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
- lightness
Feather String - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Feather StringVar - How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
- lightness
Tolerance String - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- lightness
Tolerance StringVar - How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
- saturation
Feather String - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Feather StringVar - How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
- saturation
Tolerance String - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
- saturation
Tolerance StringVar - How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
GetImagingPolicyImagePolicyTransformationComposite
- Image
Get
Imaging Policy Image Policy Transformation Composite Image - Gravity string
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Gravity
Var string - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Placement string
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Placement
Var string - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Scale string
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - Scale
Dimension string - The dimension, either
width
orheight
, of the source image to scale. - Scale
Dimension stringVar - The dimension, either
width
orheight
, of the source image to scale. - Scale
Var string - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - XPosition string
- The x-axis position of the image to apply.
- XPosition
Var string - The x-axis position of the image to apply.
- YPosition string
- The y-axis position of the image to apply.
- YPosition
Var string - The y-axis position of the image to apply.
- Image
Get
Imaging Policy Image Policy Transformation Composite Image - Gravity string
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Gravity
Var string - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- Placement string
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Placement
Var string - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- Scale string
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - Scale
Dimension string - The dimension, either
width
orheight
, of the source image to scale. - Scale
Dimension stringVar - The dimension, either
width
orheight
, of the source image to scale. - Scale
Var string - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - XPosition string
- The x-axis position of the image to apply.
- XPosition
Var string - The x-axis position of the image to apply.
- YPosition string
- The y-axis position of the image to apply.
- YPosition
Var string - The y-axis position of the image to apply.
- image
Get
Imaging Policy Image Policy Transformation Composite Image - gravity String
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity
Var String - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement String
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement
Var String - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale String
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale
Dimension String - The dimension, either
width
orheight
, of the source image to scale. - scale
Dimension StringVar - The dimension, either
width
orheight
, of the source image to scale. - scale
Var String - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x
Position String - The x-axis position of the image to apply.
- x
Position StringVar - The x-axis position of the image to apply.
- y
Position String - The y-axis position of the image to apply.
- y
Position StringVar - The y-axis position of the image to apply.
- image
Get
Imaging Policy Image Policy Transformation Composite Image - gravity string
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity
Var string - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement string
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement
Var string - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale string
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale
Dimension string - The dimension, either
width
orheight
, of the source image to scale. - scale
Dimension stringVar - The dimension, either
width
orheight
, of the source image to scale. - scale
Var string - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x
Position string - The x-axis position of the image to apply.
- x
Position stringVar - The x-axis position of the image to apply.
- y
Position string - The y-axis position of the image to apply.
- y
Position stringVar - The y-axis position of the image to apply.
- image
Get
Imaging Policy Image Policy Transformation Composite Image - gravity str
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity_
var str - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement str
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement_
var str - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale str
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale_
dimension str - The dimension, either
width
orheight
, of the source image to scale. - scale_
dimension_ strvar - The dimension, either
width
orheight
, of the source image to scale. - scale_
var str - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x_
position str - The x-axis position of the image to apply.
- x_
position_ strvar - The x-axis position of the image to apply.
- y_
position str - The y-axis position of the image to apply.
- y_
position_ strvar - The y-axis position of the image to apply.
- image Property Map
- gravity String
- Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- gravity
Var String - Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
- placement String
- Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- placement
Var String - Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
- scale String
- A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - scale
Dimension String - The dimension, either
width
orheight
, of the source image to scale. - scale
Dimension StringVar - The dimension, either
width
orheight
, of the source image to scale. - scale
Var String - A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the
scaleDimension
to calculate thescale
from the source image's width or height. - x
Position String - The x-axis position of the image to apply.
- x
Position StringVar - The x-axis position of the image to apply.
- y
Position String - The y-axis position of the image to apply.
- y
Position StringVar - The y-axis position of the image to apply.
GetImagingPolicyImagePolicyTransformationCompositeImage
- Box
Images List<GetImaging Policy Image Policy Transformation Composite Image Box Image> - A rectangular box, with a specified color and applied transformation.
- Circle
Images List<GetImaging Policy Image Policy Transformation Composite Image Circle Image> - A rectangular box, with a specified color and applied transformation.
- Text
Images List<GetImaging Policy Image Policy Transformation Composite Image Text Image> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- Url
Images List<GetImaging Policy Image Policy Transformation Composite Image Url Image> - An image loaded from a URL.
- Box
Images []GetImaging Policy Image Policy Transformation Composite Image Box Image - A rectangular box, with a specified color and applied transformation.
- Circle
Images []GetImaging Policy Image Policy Transformation Composite Image Circle Image - A rectangular box, with a specified color and applied transformation.
- Text
Images []GetImaging Policy Image Policy Transformation Composite Image Text Image - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- Url
Images []GetImaging Policy Image Policy Transformation Composite Image Url Image - An image loaded from a URL.
- box
Images List<GetImaging Policy Image Policy Transformation Composite Image Box Image> - A rectangular box, with a specified color and applied transformation.
- circle
Images List<GetImaging Policy Image Policy Transformation Composite Image Circle Image> - A rectangular box, with a specified color and applied transformation.
- text
Images List<GetImaging Policy Image Policy Transformation Composite Image Text Image> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images List<GetImaging Policy Image Policy Transformation Composite Image Url Image> - An image loaded from a URL.
- box
Images GetImaging Policy Image Policy Transformation Composite Image Box Image[] - A rectangular box, with a specified color and applied transformation.
- circle
Images GetImaging Policy Image Policy Transformation Composite Image Circle Image[] - A rectangular box, with a specified color and applied transformation.
- text
Images GetImaging Policy Image Policy Transformation Composite Image Text Image[] - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images GetImaging Policy Image Policy Transformation Composite Image Url Image[] - An image loaded from a URL.
- box_
images Sequence[GetImaging Policy Image Policy Transformation Composite Image Box Image] - A rectangular box, with a specified color and applied transformation.
- circle_
images Sequence[GetImaging Policy Image Policy Transformation Composite Image Circle Image] - A rectangular box, with a specified color and applied transformation.
- text_
images Sequence[GetImaging Policy Image Policy Transformation Composite Image Text Image] - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url_
images Sequence[GetImaging Policy Image Policy Transformation Composite Image Url Image] - An image loaded from a URL.
- box
Images List<Property Map> - A rectangular box, with a specified color and applied transformation.
- circle
Images List<Property Map> - A rectangular box, with a specified color and applied transformation.
- text
Images List<Property Map> - A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
- url
Images List<Property Map> - An image loaded from a URL.
GetImagingPolicyImagePolicyTransformationCompositeImageBoxImage
- Color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Height string
- The height of the box in pixels.
- Height
Var string - The height of the box in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- Color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- Height string
- The height of the box in pixels.
- Height
Var string - The height of the box in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- color String
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height String
- The height of the box in pixels.
- height
Var String - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
- color string
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var string - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height string
- The height of the box in pixels.
- height
Var string - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width string
- The width of the box in pixels.
- width
Var string - The width of the box in pixels.
- color str
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color_
var str - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height str
- The height of the box in pixels.
- height_
var str - The height of the box in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width str
- The width of the box in pixels.
- width_
var str - The width of the box in pixels.
- color String
- The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
- height String
- The height of the box in pixels.
- height
Var String - The height of the box in pixels.
- transformation Property Map
- width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
GetImagingPolicyImagePolicyTransformationCompositeImageCircleImage
- Color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- Color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- Diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- Transformation
Get
Imaging Policy Image Policy Transformation - Width string
- The width of the box in pixels.
- Width
Var string - The width of the box in pixels.
- color String
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter String
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var String - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
- color string
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var string - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter string
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var string - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width string
- The width of the box in pixels.
- width
Var string - The width of the box in pixels.
- color str
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color_
var str - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter str
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter_
var str - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation
Get
Imaging Policy Image Policy Transformation - width str
- The width of the box in pixels.
- width_
var str - The width of the box in pixels.
- color String
- The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- color
Var String - The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
- diameter String
- The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- diameter
Var String - The diameter of the circle. The diameter will be the width and the height of the image in pixels.
- transformation Property Map
- width String
- The width of the box in pixels.
- width
Var String - The width of the box in pixels.
GetImagingPolicyImagePolicyTransformationCompositeImageTextImage
- Fill string
- The main fill color of the text.
- Fill
Var string - The main fill color of the text.
- Size string
- The size in pixels to render the text.
- Size
Var string - The size in pixels to render the text.
- Stroke string
- The color for the outline of the text.
- Stroke
Size string - The thickness in points for the outline of the text.
- Stroke
Size stringVar - The thickness in points for the outline of the text.
- Stroke
Var string - The color for the outline of the text.
- Text string
- The line of text to render.
- Text
Var string - The line of text to render.
- Transformation
Get
Imaging Policy Image Policy Transformation - Typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Fill string
- The main fill color of the text.
- Fill
Var string - The main fill color of the text.
- Size string
- The size in pixels to render the text.
- Size
Var string - The size in pixels to render the text.
- Stroke string
- The color for the outline of the text.
- Stroke
Size string - The thickness in points for the outline of the text.
- Stroke
Size stringVar - The thickness in points for the outline of the text.
- Stroke
Var string - The color for the outline of the text.
- Text string
- The line of text to render.
- Text
Var string - The line of text to render.
- Transformation
Get
Imaging Policy Image Policy Transformation - Typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- Typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill String
- The main fill color of the text.
- fill
Var String - The main fill color of the text.
- size String
- The size in pixels to render the text.
- size
Var String - The size in pixels to render the text.
- stroke String
- The color for the outline of the text.
- stroke
Size String - The thickness in points for the outline of the text.
- stroke
Size StringVar - The thickness in points for the outline of the text.
- stroke
Var String - The color for the outline of the text.
- text String
- The line of text to render.
- text
Var String - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Transformation - typeface String
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var String - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill string
- The main fill color of the text.
- fill
Var string - The main fill color of the text.
- size string
- The size in pixels to render the text.
- size
Var string - The size in pixels to render the text.
- stroke string
- The color for the outline of the text.
- stroke
Size string - The thickness in points for the outline of the text.
- stroke
Size stringVar - The thickness in points for the outline of the text.
- stroke
Var string - The color for the outline of the text.
- text string
- The line of text to render.
- text
Var string - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Transformation - typeface string
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var string - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill str
- The main fill color of the text.
- fill_
var str - The main fill color of the text.
- size str
- The size in pixels to render the text.
- size_
var str - The size in pixels to render the text.
- stroke str
- The color for the outline of the text.
- stroke_
size str - The thickness in points for the outline of the text.
- stroke_
size_ strvar - The thickness in points for the outline of the text.
- stroke_
var str - The color for the outline of the text.
- text str
- The line of text to render.
- text_
var str - The line of text to render.
- transformation
Get
Imaging Policy Image Policy Transformation - typeface str
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface_
var str - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- fill String
- The main fill color of the text.
- fill
Var String - The main fill color of the text.
- size String
- The size in pixels to render the text.
- size
Var String - The size in pixels to render the text.
- stroke String
- The color for the outline of the text.
- stroke
Size String - The thickness in points for the outline of the text.
- stroke
Size StringVar - The thickness in points for the outline of the text.
- stroke
Var String - The color for the outline of the text.
- text String
- The line of text to render.
- text
Var String - The line of text to render.
- transformation Property Map
- typeface String
- The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
- typeface
Var String - The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
GetImagingPolicyImagePolicyTransformationCompositeImageUrlImage
- Transformation
Get
Imaging Policy Image Policy Transformation - Url string
- The URL of the image.
- Url
Var string - The URL of the image.
- Transformation
Get
Imaging Policy Image Policy Transformation - Url string
- The URL of the image.
- Url
Var string - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Transformation - url String
- The URL of the image.
- url
Var String - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Transformation - url string
- The URL of the image.
- url
Var string - The URL of the image.
- transformation
Get
Imaging Policy Image Policy Transformation - url str
- The URL of the image.
- url_
var str - The URL of the image.
- transformation Property Map
- url String
- The URL of the image.
- url
Var String - The URL of the image.
GetImagingPolicyImagePolicyTransformationCompound
GetImagingPolicyImagePolicyTransformationContrast
- Brightness string
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Brightness
Var string - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Contrast string
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - Contrast
Var string - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- Brightness string
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Brightness
Var string - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - Contrast string
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - Contrast
Var string - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness String
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness
Var String - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast String
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast
Var String - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness string
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness
Var string - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast string
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast
Var string - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness str
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness_
var str - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast str
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast_
var str - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
- brightness String
- Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - brightness
Var String - Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of
1
produces a white image. A value of-1
produces a black image. The default value is0
, which leaves the image unchanged. The acceptable value range is-1.0
to1.0
. Values outside of the acceptable range clamp to this range. - contrast String
- Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range. - contrast
Var String - Adjusts the contrast of the image. Expressed as a range from
-1
to1
, positive values increase contrast, negative values decrease it, while0
leaves the image unchanged. Values outside of the-1
to1
range clamp to this range.
GetImagingPolicyImagePolicyTransformationCrop
- Allow
Expansion string - If cropping an area outside of the existing canvas, expands the image canvas.
- Allow
Expansion stringVar - If cropping an area outside of the existing canvas, expands the image canvas.
- Gravity string
- Frame of reference for X and Y Positions.
- Gravity
Var string - Frame of reference for X and Y Positions.
- Height string
- The number of pixels to crop along the y-axis.
- Height
Var string - The number of pixels to crop along the y-axis.
- Width string
- The number of pixels to crop along the x-axis.
- Width
Var string - The number of pixels to crop along the x-axis.
- XPosition string
- The x-axis position of the image to crop from.
- XPosition
Var string - The x-axis position of the image to crop from.
- YPosition string
- The y-axis position of the image to crop from.
- YPosition
Var string - The y-axis position of the image to crop from.
- Allow
Expansion string - If cropping an area outside of the existing canvas, expands the image canvas.
- Allow
Expansion stringVar - If cropping an area outside of the existing canvas, expands the image canvas.
- Gravity string
- Frame of reference for X and Y Positions.
- Gravity
Var string - Frame of reference for X and Y Positions.
- Height string
- The number of pixels to crop along the y-axis.
- Height
Var string - The number of pixels to crop along the y-axis.
- Width string
- The number of pixels to crop along the x-axis.
- Width
Var string - The number of pixels to crop along the x-axis.
- XPosition string
- The x-axis position of the image to crop from.
- XPosition
Var string - The x-axis position of the image to crop from.
- YPosition string
- The y-axis position of the image to crop from.
- YPosition
Var string - The y-axis position of the image to crop from.
- allow
Expansion String - If cropping an area outside of the existing canvas, expands the image canvas.
- allow
Expansion StringVar - If cropping an area outside of the existing canvas, expands the image canvas.
- gravity String
- Frame of reference for X and Y Positions.
- gravity
Var String - Frame of reference for X and Y Positions.
- height String
- The number of pixels to crop along the y-axis.
- height
Var String - The number of pixels to crop along the y-axis.
- width String
- The number of pixels to crop along the x-axis.
- width
Var String - The number of pixels to crop along the x-axis.
- x
Position String - The x-axis position of the image to crop from.
- x
Position StringVar - The x-axis position of the image to crop from.
- y
Position String - The y-axis position of the image to crop from.
- y
Position StringVar - The y-axis position of the image to crop from.
- allow
Expansion string - If cropping an area outside of the existing canvas, expands the image canvas.
- allow
Expansion stringVar - If cropping an area outside of the existing canvas, expands the image canvas.
- gravity string
- Frame of reference for X and Y Positions.
- gravity
Var string - Frame of reference for X and Y Positions.
- height string
- The number of pixels to crop along the y-axis.
- height
Var string - The number of pixels to crop along the y-axis.
- width string
- The number of pixels to crop along the x-axis.
- width
Var string - The number of pixels to crop along the x-axis.
- x
Position string - The x-axis position of the image to crop from.
- x
Position stringVar - The x-axis position of the image to crop from.
- y
Position string - The y-axis position of the image to crop from.
- y
Position stringVar - The y-axis position of the image to crop from.
- allow_
expansion str - If cropping an area outside of the existing canvas, expands the image canvas.
- allow_
expansion_ strvar - If cropping an area outside of the existing canvas, expands the image canvas.
- gravity str
- Frame of reference for X and Y Positions.
- gravity_
var str - Frame of reference for X and Y Positions.
- height str
- The number of pixels to crop along the y-axis.
- height_
var str - The number of pixels to crop along the y-axis.
- width str
- The number of pixels to crop along the x-axis.
- width_
var str - The number of pixels to crop along the x-axis.
- x_
position str - The x-axis position of the image to crop from.
- x_
position_ strvar - The x-axis position of the image to crop from.
- y_
position str - The y-axis position of the image to crop from.
- y_
position_ strvar - The y-axis position of the image to crop from.
- allow
Expansion String - If cropping an area outside of the existing canvas, expands the image canvas.
- allow
Expansion StringVar - If cropping an area outside of the existing canvas, expands the image canvas.
- gravity String
- Frame of reference for X and Y Positions.
- gravity
Var String - Frame of reference for X and Y Positions.
- height String
- The number of pixels to crop along the y-axis.
- height
Var String - The number of pixels to crop along the y-axis.
- width String
- The number of pixels to crop along the x-axis.
- width
Var String - The number of pixels to crop along the x-axis.
- x
Position String - The x-axis position of the image to crop from.
- x
Position StringVar - The x-axis position of the image to crop from.
- y
Position String - The y-axis position of the image to crop from.
- y
Position StringVar - The y-axis position of the image to crop from.
GetImagingPolicyImagePolicyTransformationFaceCrop
- Algorithm string
- Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - Algorithm
Var string - Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - Confidence string
- With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - Confidence
Var string - With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - Fail
Gravity string - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- Fail
Gravity stringVar - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- Focus string
- Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - Focus
Var string - Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - Gravity string
- Controls placement of the crop. Directions are relative to the face(s) plus padding.
- Gravity
Var string - Controls placement of the crop. Directions are relative to the face(s) plus padding.
- Height string
- The height of the output image in pixels relative to the specified
style
value. - Height
Var string - The height of the output image in pixels relative to the specified
style
value. - Padding string
- The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - Padding
Var string - The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - Style string
- Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Style
Var string - Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Width string
- The width of the output image in pixels relative to the specified
style
value. - Width
Var string - The width of the output image in pixels relative to the specified
style
value.
- Algorithm string
- Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - Algorithm
Var string - Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - Confidence string
- With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - Confidence
Var string - With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - Fail
Gravity string - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- Fail
Gravity stringVar - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- Focus string
- Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - Focus
Var string - Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - Gravity string
- Controls placement of the crop. Directions are relative to the face(s) plus padding.
- Gravity
Var string - Controls placement of the crop. Directions are relative to the face(s) plus padding.
- Height string
- The height of the output image in pixels relative to the specified
style
value. - Height
Var string - The height of the output image in pixels relative to the specified
style
value. - Padding string
- The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - Padding
Var string - The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - Style string
- Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Style
Var string - Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Width string
- The width of the output image in pixels relative to the specified
style
value. - Width
Var string - The width of the output image in pixels relative to the specified
style
value.
- algorithm String
- Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - algorithm
Var String - Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - confidence String
- With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - confidence
Var String - With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - fail
Gravity String - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- fail
Gravity StringVar - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- focus String
- Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - focus
Var String - Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - gravity String
- Controls placement of the crop. Directions are relative to the face(s) plus padding.
- gravity
Var String - Controls placement of the crop. Directions are relative to the face(s) plus padding.
- height String
- The height of the output image in pixels relative to the specified
style
value. - height
Var String - The height of the output image in pixels relative to the specified
style
value. - padding String
- The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - padding
Var String - The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - style String
- Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style
Var String - Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width String
- The width of the output image in pixels relative to the specified
style
value. - width
Var String - The width of the output image in pixels relative to the specified
style
value.
- algorithm string
- Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - algorithm
Var string - Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - confidence string
- With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - confidence
Var string - With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - fail
Gravity string - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- fail
Gravity stringVar - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- focus string
- Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - focus
Var string - Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - gravity string
- Controls placement of the crop. Directions are relative to the face(s) plus padding.
- gravity
Var string - Controls placement of the crop. Directions are relative to the face(s) plus padding.
- height string
- The height of the output image in pixels relative to the specified
style
value. - height
Var string - The height of the output image in pixels relative to the specified
style
value. - padding string
- The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - padding
Var string - The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - style string
- Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style
Var string - Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width string
- The width of the output image in pixels relative to the specified
style
value. - width
Var string - The width of the output image in pixels relative to the specified
style
value.
- algorithm str
- Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - algorithm_
var str - Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - confidence str
- With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - confidence_
var str - With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - fail_
gravity str - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- fail_
gravity_ strvar - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- focus str
- Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - focus_
var str - Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - gravity str
- Controls placement of the crop. Directions are relative to the face(s) plus padding.
- gravity_
var str - Controls placement of the crop. Directions are relative to the face(s) plus padding.
- height str
- The height of the output image in pixels relative to the specified
style
value. - height_
var str - The height of the output image in pixels relative to the specified
style
value. - padding str
- The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - padding_
var str - The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - style str
- Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style_
var str - Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width str
- The width of the output image in pixels relative to the specified
style
value. - width_
var str - The width of the output image in pixels relative to the specified
style
value.
- algorithm String
- Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - algorithm
Var String - Specifies the type of algorithm used to detect faces in the image, either
cascade
for the cascade classifier algorithm ordnn
for the deep neural network algorithm,cascade
by default. - confidence String
- With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - confidence
Var String - With
algorithm
set todnn
, specifies the minimum confidence needed to detect faces in the image. Values range from0
to1
for increased confidence, and possibly fewer faces detected. - fail
Gravity String - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- fail
Gravity StringVar - Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
- focus String
- Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - focus
Var String - Distinguishes the faces detected, either
biggestFace
orallFaces
to place the crop rectangle around the full set of faces,all
by default. - gravity String
- Controls placement of the crop. Directions are relative to the face(s) plus padding.
- gravity
Var String - Controls placement of the crop. Directions are relative to the face(s) plus padding.
- height String
- The height of the output image in pixels relative to the specified
style
value. - height
Var String - The height of the output image in pixels relative to the specified
style
value. - padding String
- The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - padding
Var String - The padding ratio based on the dimensions of the biggest face detected,
0.5
by default. Larger values increase padding. - style String
- Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style
Var String - Specifies how to crop or scale a crop area for the faces detected in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places a raw crop around the faces, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and faces as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the faces, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width String
- The width of the output image in pixels relative to the specified
style
value. - width
Var String - The width of the output image in pixels relative to the specified
style
value.
GetImagingPolicyImagePolicyTransformationFeatureCrop
- Fail
Gravity string - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- Fail
Gravity stringVar - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- Feature
Radius string - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - Feature
Radius stringVar - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - Gravity string
- Controls placement of the crop. Directions are relative to the region of interest plus padding.
- Gravity
Var string - Controls placement of the crop. Directions are relative to the region of interest plus padding.
- Height string
- The height in pixels of the output image relative to the specified
style
value. - Height
Var string - The height in pixels of the output image relative to the specified
style
value. - Max
Features string - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - Max
Features stringVar - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - Min
Feature stringQuality - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - Min
Feature stringQuality Var - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - Padding string
- Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- Padding
Var string - Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- Style string
- Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Style
Var string - Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Width string
- The width in pixels of the output image relative to the specified
style
value. - Width
Var string - The width in pixels of the output image relative to the specified
style
value.
- Fail
Gravity string - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- Fail
Gravity stringVar - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- Feature
Radius string - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - Feature
Radius stringVar - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - Gravity string
- Controls placement of the crop. Directions are relative to the region of interest plus padding.
- Gravity
Var string - Controls placement of the crop. Directions are relative to the region of interest plus padding.
- Height string
- The height in pixels of the output image relative to the specified
style
value. - Height
Var string - The height in pixels of the output image relative to the specified
style
value. - Max
Features string - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - Max
Features stringVar - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - Min
Feature stringQuality - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - Min
Feature stringQuality Var - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - Padding string
- Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- Padding
Var string - Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- Style string
- Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Style
Var string - Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - Width string
- The width in pixels of the output image relative to the specified
style
value. - Width
Var string - The width in pixels of the output image relative to the specified
style
value.
- fail
Gravity String - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- fail
Gravity StringVar - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- feature
Radius String - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - feature
Radius StringVar - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - gravity String
- Controls placement of the crop. Directions are relative to the region of interest plus padding.
- gravity
Var String - Controls placement of the crop. Directions are relative to the region of interest plus padding.
- height String
- The height in pixels of the output image relative to the specified
style
value. - height
Var String - The height in pixels of the output image relative to the specified
style
value. - max
Features String - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - max
Features StringVar - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - min
Feature StringQuality - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - min
Feature StringQuality Var - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - padding String
- Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- padding
Var String - Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- style String
- Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style
Var String - Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width String
- The width in pixels of the output image relative to the specified
style
value. - width
Var String - The width in pixels of the output image relative to the specified
style
value.
- fail
Gravity string - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- fail
Gravity stringVar - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- feature
Radius string - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - feature
Radius stringVar - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - gravity string
- Controls placement of the crop. Directions are relative to the region of interest plus padding.
- gravity
Var string - Controls placement of the crop. Directions are relative to the region of interest plus padding.
- height string
- The height in pixels of the output image relative to the specified
style
value. - height
Var string - The height in pixels of the output image relative to the specified
style
value. - max
Features string - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - max
Features stringVar - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - min
Feature stringQuality - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - min
Feature stringQuality Var - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - padding string
- Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- padding
Var string - Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- style string
- Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style
Var string - Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width string
- The width in pixels of the output image relative to the specified
style
value. - width
Var string - The width in pixels of the output image relative to the specified
style
value.
- fail_
gravity str - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- fail_
gravity_ strvar - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- feature_
radius str - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - feature_
radius_ strvar - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - gravity str
- Controls placement of the crop. Directions are relative to the region of interest plus padding.
- gravity_
var str - Controls placement of the crop. Directions are relative to the region of interest plus padding.
- height str
- The height in pixels of the output image relative to the specified
style
value. - height_
var str - The height in pixels of the output image relative to the specified
style
value. - max_
features str - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - max_
features_ strvar - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - min_
feature_ strquality - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - min_
feature_ strquality_ var - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - padding str
- Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- padding_
var str - Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- style str
- Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style_
var str - Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width str
- The width in pixels of the output image relative to the specified
style
value. - width_
var str - The width in pixels of the output image relative to the specified
style
value.
- fail
Gravity String - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- fail
Gravity StringVar - Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
- feature
Radius String - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - feature
Radius StringVar - The size in pixels of the important features to search for. If identified, two features never appear closer together than this value,
8.0
by default. - gravity String
- Controls placement of the crop. Directions are relative to the region of interest plus padding.
- gravity
Var String - Controls placement of the crop. Directions are relative to the region of interest plus padding.
- height String
- The height in pixels of the output image relative to the specified
style
value. - height
Var String - The height in pixels of the output image relative to the specified
style
value. - max
Features String - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - max
Features StringVar - The maximum number of features to identify as important features,
32
by default. The strongest features are always chosen. - min
Feature StringQuality - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - min
Feature StringQuality Var - Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from
0
for the lowest quality to1
for the highest quality,.1
by default. - padding String
- Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- padding
Var String - Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
- style String
- Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - style
Var String - Specifies how to crop or scale a crop area for the features identified in the source image,
fill
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
performs a raw crop around the features, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and features as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the features, relative to the specifiedwidth
andheight
values. Allows Variable substitution. - width String
- The width in pixels of the output image relative to the specified
style
value. - width
Var String - The width in pixels of the output image relative to the specified
style
value.
GetImagingPolicyImagePolicyTransformationFitAndFill
- Fill
Transformation GetImaging Policy Image Policy Transformation - Height string
- The height value of the resized image.
- Height
Var string - The height value of the resized image.
- Width string
- The width value of the resized image.
- Width
Var string - The width value of the resized image.
- Fill
Transformation GetImaging Policy Image Policy Transformation - Height string
- The height value of the resized image.
- Height
Var string - The height value of the resized image.
- Width string
- The width value of the resized image.
- Width
Var string - The width value of the resized image.
- fill
Transformation GetImaging Policy Image Policy Transformation - height String
- The height value of the resized image.
- height
Var String - The height value of the resized image.
- width String
- The width value of the resized image.
- width
Var String - The width value of the resized image.
- fill
Transformation GetImaging Policy Image Policy Transformation - height string
- The height value of the resized image.
- height
Var string - The height value of the resized image.
- width string
- The width value of the resized image.
- width
Var string - The width value of the resized image.
- fill_
transformation GetImaging Policy Image Policy Transformation - height str
- The height value of the resized image.
- height_
var str - The height value of the resized image.
- width str
- The width value of the resized image.
- width_
var str - The width value of the resized image.
- fill
Transformation Property Map - height String
- The height value of the resized image.
- height
Var String - The height value of the resized image.
- width String
- The width value of the resized image.
- width
Var String - The width value of the resized image.
GetImagingPolicyImagePolicyTransformationGoop
- Chaos string
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Chaos
Var string - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Density string
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Density
Var string - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Power string
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Power
Var string - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Seed string
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - Seed
Var string - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- Chaos string
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Chaos
Var string - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - Density string
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Density
Var string - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- Power string
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Power
Var string - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - Seed string
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - Seed
Var string - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos String
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos
Var String - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density String
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density
Var String - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power String
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power
Var String - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed String
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed
Var String - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos string
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos
Var string - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density string
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density
Var string - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power string
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power
Var string - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed string
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed
Var string - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos str
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos_
var str - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density str
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density_
var str - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power str
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power_
var str - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed str
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed_
var str - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
- chaos String
- Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - chaos
Var String - Specifies the greatest distance control points may move from their original position. A value of
1.0
shifts control points over as far as the next one in the original grid. A value of0.0
leaves the image unchanged. Values under0.5
work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect. - density String
- Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- density
Var String - Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
- power String
- By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - power
Var String - By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of
2.0
. - seed String
- Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output. - seed
Var String - Specifies your own
seed
value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used,Goop
distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
GetImagingPolicyImagePolicyTransformationGrayscale
GetImagingPolicyImagePolicyTransformationHsl
- Hue string
- The number of degrees to rotate colors around the color wheel,
0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0
by default. - Lightness string
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Lightness
Var string - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- Hue string
- The number of degrees to rotate colors around the color wheel,
0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0
by default. - Lightness string
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Lightness
Var string - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue String
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness String
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness
Var String - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue string
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue
Var string - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness string
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness
Var string - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue str
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue_
var str - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness str
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness_
var str - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation str
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation_
var str - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
- hue String
- The number of degrees to rotate colors around the color wheel,
0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0
by default. - lightness String
- A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - lightness
Var String - A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than
1.0
decrease the lightness of colors in the image. Values greater than1.0
increase the lightness of colors in the image. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image.
GetImagingPolicyImagePolicyTransformationHsv
- Hue string
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0.0
by default. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Value string
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- Value
Var string - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- Hue string
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - Hue
Var string - The number of degrees to rotate colors around the color wheel,
0.0
by default. - Saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - Value string
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- Value
Var string - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue String
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value String
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value
Var String - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue string
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue
Var string - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation string
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var string - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value string
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value
Var string - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue str
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue_
var str - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation str
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation_
var str - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value str
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value_
var str - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- hue String
- The number of degrees to rotate colors around the color wheel,
0.0
by default. - hue
Var String - The number of degrees to rotate colors around the color wheel,
0.0
by default. - saturation String
- A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - saturation
Var String - A multiplier to adjust the saturation of colors in the image. Values less than
1.0
decrease saturation and values greater than1.0
increase the saturation. A value of0.0
removes all color from the image. - value String
- A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
- value
Var String - A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
GetImagingPolicyImagePolicyTransformationIfDimension
- Default
Get
Imaging Policy Image Policy Transformation - Dimension string
- The dimension to use to select the transformation, either
height
,width
, orboth
. - Dimension
Var string - The dimension to use to select the transformation, either
height
,width
, orboth
. - Equal
Get
Imaging Policy Image Policy Transformation - Greater
Than GetImaging Policy Image Policy Transformation - Less
Than GetImaging Policy Image Policy Transformation - Value string
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- Value
Var string - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- Default
Get
Imaging Policy Image Policy Transformation - Dimension string
- The dimension to use to select the transformation, either
height
,width
, orboth
. - Dimension
Var string - The dimension to use to select the transformation, either
height
,width
, orboth
. - Equal
Get
Imaging Policy Image Policy Transformation - Greater
Than GetImaging Policy Image Policy Transformation - Less
Than GetImaging Policy Image Policy Transformation - Value string
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- Value
Var string - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default_
Get
Imaging Policy Image Policy Transformation - dimension String
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension
Var String - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal
Get
Imaging Policy Image Policy Transformation - greater
Than GetImaging Policy Image Policy Transformation - less
Than GetImaging Policy Image Policy Transformation - value String
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value
Var String - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default
Get
Imaging Policy Image Policy Transformation - dimension string
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension
Var string - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal
Get
Imaging Policy Image Policy Transformation - greater
Than GetImaging Policy Image Policy Transformation - less
Than GetImaging Policy Image Policy Transformation - value string
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value
Var string - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default
Get
Imaging Policy Image Policy Transformation - dimension str
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension_
var str - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal
Get
Imaging Policy Image Policy Transformation - greater_
than GetImaging Policy Image Policy Transformation - less_
than GetImaging Policy Image Policy Transformation - value str
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value_
var str - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- default Property Map
- dimension String
- The dimension to use to select the transformation, either
height
,width
, orboth
. - dimension
Var String - The dimension to use to select the transformation, either
height
,width
, orboth
. - equal Property Map
- greater
Than Property Map - less
Than Property Map - value String
- The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
- value
Var String - The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
GetImagingPolicyImagePolicyTransformationIfOrientation
GetImagingPolicyImagePolicyTransformationImQuery
- Allowed
Transformations List<string> - Specifies the transformations that can be applied using the query string parameter.
- Query
Var string
- Allowed
Transformations []string - Specifies the transformations that can be applied using the query string parameter.
- Query
Var string
- allowed
Transformations List<String> - Specifies the transformations that can be applied using the query string parameter.
- query
Var String
- allowed
Transformations string[] - Specifies the transformations that can be applied using the query string parameter.
- query
Var string
- allowed_
transformations Sequence[str] - Specifies the transformations that can be applied using the query string parameter.
- query_
var str
- allowed
Transformations List<String> - Specifies the transformations that can be applied using the query string parameter.
- query
Var String
GetImagingPolicyImagePolicyTransformationMaxColor
- colors str
- The value representing the maximum number of colors to use with the source image.
- colors_
var str - The value representing the maximum number of colors to use with the source image.
GetImagingPolicyImagePolicyTransformationMirror
- Horizontal string
- Flips the image horizontally.
- Horizontal
Var string - Flips the image horizontally.
- Vertical string
- Flips the image vertically.
- Vertical
Var string - Flips the image vertically.
- Horizontal string
- Flips the image horizontally.
- Horizontal
Var string - Flips the image horizontally.
- Vertical string
- Flips the image vertically.
- Vertical
Var string - Flips the image vertically.
- horizontal String
- Flips the image horizontally.
- horizontal
Var String - Flips the image horizontally.
- vertical String
- Flips the image vertically.
- vertical
Var String - Flips the image vertically.
- horizontal string
- Flips the image horizontally.
- horizontal
Var string - Flips the image horizontally.
- vertical string
- Flips the image vertically.
- vertical
Var string - Flips the image vertically.
- horizontal str
- Flips the image horizontally.
- horizontal_
var str - Flips the image horizontally.
- vertical str
- Flips the image vertically.
- vertical_
var str - Flips the image vertically.
- horizontal String
- Flips the image horizontally.
- horizontal
Var String - Flips the image horizontally.
- vertical String
- Flips the image vertically.
- vertical
Var String - Flips the image vertically.
GetImagingPolicyImagePolicyTransformationMonoHue
- Hue string
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- Hue
Var string - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- Hue string
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- Hue
Var string - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue String
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue
Var String - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue string
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue
Var string - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue str
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue_
var str - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue String
- Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
- hue
Var String - Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
GetImagingPolicyImagePolicyTransformationOpacity
- Opacity string
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - Opacity
Var string - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- Opacity string
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - Opacity
Var string - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity String
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity
Var String - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity string
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity
Var string - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity str
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity_
var str - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
- opacity String
- Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions. - opacity
Var String - Represents alpha values on a scale of
0
to1
. Values below1
increase transparency, and0
is invisible. For images that have some transparency, values above1
increase the opacity of the transparent portions.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCrop
- Region
Of GetInterest Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest - Gravity string
- The placement of the crop area relative to the specified area of interest.
- Gravity
Var string - The placement of the crop area relative to the specified area of interest.
- Height string
- The height in pixels of the output image relative to the specified
style
value. - Height
Var string - The height in pixels of the output image relative to the specified
style
value. - Style string
- Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - Style
Var string - Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - Width string
- The width in pixels of the output image relative to the specified
style
value. - Width
Var string - The width in pixels of the output image relative to the specified
style
value.
- Region
Of GetInterest Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest - Gravity string
- The placement of the crop area relative to the specified area of interest.
- Gravity
Var string - The placement of the crop area relative to the specified area of interest.
- Height string
- The height in pixels of the output image relative to the specified
style
value. - Height
Var string - The height in pixels of the output image relative to the specified
style
value. - Style string
- Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - Style
Var string - Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - Width string
- The width in pixels of the output image relative to the specified
style
value. - Width
Var string - The width in pixels of the output image relative to the specified
style
value.
- region
Of GetInterest Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest - gravity String
- The placement of the crop area relative to the specified area of interest.
- gravity
Var String - The placement of the crop area relative to the specified area of interest.
- height String
- The height in pixels of the output image relative to the specified
style
value. - height
Var String - The height in pixels of the output image relative to the specified
style
value. - style String
- Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - style
Var String - Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - width String
- The width in pixels of the output image relative to the specified
style
value. - width
Var String - The width in pixels of the output image relative to the specified
style
value.
- region
Of GetInterest Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest - gravity string
- The placement of the crop area relative to the specified area of interest.
- gravity
Var string - The placement of the crop area relative to the specified area of interest.
- height string
- The height in pixels of the output image relative to the specified
style
value. - height
Var string - The height in pixels of the output image relative to the specified
style
value. - style string
- Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - style
Var string - Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - width string
- The width in pixels of the output image relative to the specified
style
value. - width
Var string - The width in pixels of the output image relative to the specified
style
value.
- region_
of_ Getinterest Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest - gravity str
- The placement of the crop area relative to the specified area of interest.
- gravity_
var str - The placement of the crop area relative to the specified area of interest.
- height str
- The height in pixels of the output image relative to the specified
style
value. - height_
var str - The height in pixels of the output image relative to the specified
style
value. - style str
- Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - style_
var str - Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - width str
- The width in pixels of the output image relative to the specified
style
value. - width_
var str - The width in pixels of the output image relative to the specified
style
value.
- region
Of Property MapInterest - gravity String
- The placement of the crop area relative to the specified area of interest.
- gravity
Var String - The placement of the crop area relative to the specified area of interest.
- height String
- The height in pixels of the output image relative to the specified
style
value. - height
Var String - The height in pixels of the output image relative to the specified
style
value. - style String
- Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - style
Var String - Specifies how to crop or scale a crop area for the specified area of interest in the source image,
zoom
by default. The output image resizes to the specifiedwidth
andheight
values. A value ofcrop
places raw crop around the point of interest, relative to the specifiedgravity
value. A value offill
scales the crop area to include as much of the image and point of interest as possible, relative to the specifiedwidth
andheight
values. A value ofzoom
scales the crop area as small as possible to fit the point of interest, relative to the specifiedwidth
andheight
values. - width String
- The width in pixels of the output image relative to the specified
style
value. - width
Var String - The width in pixels of the output image relative to the specified
style
value.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterest
- Circle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape> - Defines a circle with a specified
radius
from itscenter
point. - Point
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Point Shape> - Polygon
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape> - Defines a polygon from a series of connected points.
- Rectangle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape> - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - Union
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape> - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- Circle
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape - Defines a circle with a specified
radius
from itscenter
point. - Point
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Point Shape - Polygon
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape - Defines a polygon from a series of connected points.
- Rectangle
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - Union
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape> - Defines a circle with a specified
radius
from itscenter
point. - point
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Point Shape> - polygon
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape> - Defines a polygon from a series of connected points.
- rectangle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape> - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape> - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape[] - Defines a circle with a specified
radius
from itscenter
point. - point
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Point Shape[] - polygon
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape[] - Defines a polygon from a series of connected points.
- rectangle
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape[] - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape[] - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape] - Defines a circle with a specified
radius
from itscenter
point. - point_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Point Shape] - polygon_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape] - Defines a polygon from a series of connected points.
- rectangle_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape] - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape] - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle
Shapes List<Property Map> - Defines a circle with a specified
radius
from itscenter
point. - point
Shapes List<Property Map> - polygon
Shapes List<Property Map> - Defines a polygon from a series of connected points.
- rectangle
Shapes List<Property Map> - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union
Shapes List<Property Map> - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestCircleShape
- Center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - Radius string
- The radius of the circle measured in pixels.
- Radius
Var string - The radius of the circle measured in pixels.
- Center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - Radius string
- The radius of the circle measured in pixels.
- Radius
Var string - The radius of the circle measured in pixels.
- center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius String
- The radius of the circle measured in pixels.
- radius
Var String - The radius of the circle measured in pixels.
- center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius string
- The radius of the circle measured in pixels.
- radius
Var string - The radius of the circle measured in pixels.
- center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius str
- The radius of the circle measured in pixels.
- radius_
var str - The radius of the circle measured in pixels.
- center Property Map
- Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius String
- The radius of the circle measured in pixels.
- radius
Var String - The radius of the circle measured in pixels.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestCircleShapeCenter
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestPointShape
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestPolygonShape
- Points
List<Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape Point> - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- Points
[]Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape Point - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points
List<Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape Point> - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape Point[] - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points
Sequence[Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Polygon Shape Point] - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points List<Property Map>
- Series of PointShapeType objects. The last and first points connect to close the shape automatically.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestPolygonShapePoint
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestRectangleShape
- Anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape Anchor - Height string
- Extends the rectangle down from the
anchor
point. - Height
Var string - Extends the rectangle down from the
anchor
point. - Width string
- Extends the rectangle right from the
anchor
point. - Width
Var string - Extends the rectangle right from the
anchor
point.
- Anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape Anchor - Height string
- Extends the rectangle down from the
anchor
point. - Height
Var string - Extends the rectangle down from the
anchor
point. - Width string
- Extends the rectangle right from the
anchor
point. - Width
Var string - Extends the rectangle right from the
anchor
point.
- anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape Anchor - height String
- Extends the rectangle down from the
anchor
point. - height
Var String - Extends the rectangle down from the
anchor
point. - width String
- Extends the rectangle right from the
anchor
point. - width
Var String - Extends the rectangle right from the
anchor
point.
- anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape Anchor - height string
- Extends the rectangle down from the
anchor
point. - height
Var string - Extends the rectangle down from the
anchor
point. - width string
- Extends the rectangle right from the
anchor
point. - width
Var string - Extends the rectangle right from the
anchor
point.
- anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Rectangle Shape Anchor - height str
- Extends the rectangle down from the
anchor
point. - height_
var str - Extends the rectangle down from the
anchor
point. - width str
- Extends the rectangle right from the
anchor
point. - width_
var str - Extends the rectangle right from the
anchor
point.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestRectangleShapeAnchor
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShape
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShape
- Circle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape> - Defines a circle with a specified
radius
from itscenter
point. - Point
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Point Shape> - Polygon
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape> - Defines a polygon from a series of connected points.
- Rectangle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape> - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - Union
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Union Shape> - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- Circle
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape - Defines a circle with a specified
radius
from itscenter
point. - Point
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Point Shape - Polygon
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape - Defines a polygon from a series of connected points.
- Rectangle
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - Union
Shapes []GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Union Shape - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape> - Defines a circle with a specified
radius
from itscenter
point. - point
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Point Shape> - polygon
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape> - Defines a polygon from a series of connected points.
- rectangle
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape> - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union
Shapes List<GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Union Shape> - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape[] - Defines a circle with a specified
radius
from itscenter
point. - point
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Point Shape[] - polygon
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape[] - Defines a polygon from a series of connected points.
- rectangle
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape[] - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union
Shapes GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Union Shape[] - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape] - Defines a circle with a specified
radius
from itscenter
point. - point_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Point Shape] - polygon_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape] - Defines a polygon from a series of connected points.
- rectangle_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape] - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union_
shapes Sequence[GetImaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Union Shape] - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
- circle
Shapes List<Property Map> - Defines a circle with a specified
radius
from itscenter
point. - point
Shapes List<Property Map> - polygon
Shapes List<Property Map> - Defines a polygon from a series of connected points.
- rectangle
Shapes List<Property Map> - Defines a rectangle's
width
andheight
relative to ananchor
point at the top left corner. - union
Shapes List<Property Map> - Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapeCircleShape
- Center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - Radius string
- The radius of the circle measured in pixels.
- Radius
Var string - The radius of the circle measured in pixels.
- Center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - Radius string
- The radius of the circle measured in pixels.
- Radius
Var string - The radius of the circle measured in pixels.
- center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius String
- The radius of the circle measured in pixels.
- radius
Var String - The radius of the circle measured in pixels.
- center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius string
- The radius of the circle measured in pixels.
- radius
Var string - The radius of the circle measured in pixels.
- center
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Circle Shape Center - Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius str
- The radius of the circle measured in pixels.
- radius_
var str - The radius of the circle measured in pixels.
- center Property Map
- Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with
x
andy
members, or a two-element array. - radius String
- The radius of the circle measured in pixels.
- radius
Var String - The radius of the circle measured in pixels.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapeCircleShapeCenter
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapePointShape
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapePolygonShape
- Points
List<Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape Point> - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- Points
[]Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape Point - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points
List<Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape Point> - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape Point[] - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points
Sequence[Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Polygon Shape Point] - Series of PointShapeType objects. The last and first points connect to close the shape automatically.
- points List<Property Map>
- Series of PointShapeType objects. The last and first points connect to close the shape automatically.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapePolygonShapePoint
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapeRectangleShape
- Anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape Anchor - Height string
- Extends the rectangle down from the
anchor
point. - Height
Var string - Extends the rectangle down from the
anchor
point. - Width string
- Extends the rectangle right from the
anchor
point. - Width
Var string - Extends the rectangle right from the
anchor
point.
- Anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape Anchor - Height string
- Extends the rectangle down from the
anchor
point. - Height
Var string - Extends the rectangle down from the
anchor
point. - Width string
- Extends the rectangle right from the
anchor
point. - Width
Var string - Extends the rectangle right from the
anchor
point.
- anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape Anchor - height String
- Extends the rectangle down from the
anchor
point. - height
Var String - Extends the rectangle down from the
anchor
point. - width String
- Extends the rectangle right from the
anchor
point. - width
Var String - Extends the rectangle right from the
anchor
point.
- anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape Anchor - height string
- Extends the rectangle down from the
anchor
point. - height
Var string - Extends the rectangle down from the
anchor
point. - width string
- Extends the rectangle right from the
anchor
point. - width
Var string - Extends the rectangle right from the
anchor
point.
- anchor
Get
Imaging Policy Image Policy Transformation Region Of Interest Crop Region Of Interest Union Shape Shape Rectangle Shape Anchor - height str
- Extends the rectangle down from the
anchor
point. - height_
var str - Extends the rectangle down from the
anchor
point. - width str
- Extends the rectangle right from the
anchor
point. - width_
var str - Extends the rectangle right from the
anchor
point.
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapeRectangleShapeAnchor
GetImagingPolicyImagePolicyTransformationRegionOfInterestCropRegionOfInterestUnionShapeShapeUnionShape
GetImagingPolicyImagePolicyTransformationRelativeCrop
- East string
- The number of pixels to shrink or expand the right side of the image.
- East
Var string - The number of pixels to shrink or expand the right side of the image.
- North string
- The number of pixels to shrink or expand the top side of the image.
- North
Var string - The number of pixels to shrink or expand the top side of the image.
- South string
- The number of pixels to shrink or expand the bottom side of the image.
- South
Var string - The number of pixels to shrink or expand the bottom side of the image.
- West string
- The number of pixels to shrink or expand the left side of the image.
- West
Var string - The number of pixels to shrink or expand the left side of the image.
- East string
- The number of pixels to shrink or expand the right side of the image.
- East
Var string - The number of pixels to shrink or expand the right side of the image.
- North string
- The number of pixels to shrink or expand the top side of the image.
- North
Var string - The number of pixels to shrink or expand the top side of the image.
- South string
- The number of pixels to shrink or expand the bottom side of the image.
- South
Var string - The number of pixels to shrink or expand the bottom side of the image.
- West string
- The number of pixels to shrink or expand the left side of the image.
- West
Var string - The number of pixels to shrink or expand the left side of the image.
- east String
- The number of pixels to shrink or expand the right side of the image.
- east
Var String - The number of pixels to shrink or expand the right side of the image.
- north String
- The number of pixels to shrink or expand the top side of the image.
- north
Var String - The number of pixels to shrink or expand the top side of the image.
- south String
- The number of pixels to shrink or expand the bottom side of the image.
- south
Var String - The number of pixels to shrink or expand the bottom side of the image.
- west String
- The number of pixels to shrink or expand the left side of the image.
- west
Var String - The number of pixels to shrink or expand the left side of the image.
- east string
- The number of pixels to shrink or expand the right side of the image.
- east
Var string - The number of pixels to shrink or expand the right side of the image.
- north string
- The number of pixels to shrink or expand the top side of the image.
- north
Var string - The number of pixels to shrink or expand the top side of the image.
- south string
- The number of pixels to shrink or expand the bottom side of the image.
- south
Var string - The number of pixels to shrink or expand the bottom side of the image.
- west string
- The number of pixels to shrink or expand the left side of the image.
- west
Var string - The number of pixels to shrink or expand the left side of the image.
- east str
- The number of pixels to shrink or expand the right side of the image.
- east_
var str - The number of pixels to shrink or expand the right side of the image.
- north str
- The number of pixels to shrink or expand the top side of the image.
- north_
var str - The number of pixels to shrink or expand the top side of the image.
- south str
- The number of pixels to shrink or expand the bottom side of the image.
- south_
var str - The number of pixels to shrink or expand the bottom side of the image.
- west str
- The number of pixels to shrink or expand the left side of the image.
- west_
var str - The number of pixels to shrink or expand the left side of the image.
- east String
- The number of pixels to shrink or expand the right side of the image.
- east
Var String - The number of pixels to shrink or expand the right side of the image.
- north String
- The number of pixels to shrink or expand the top side of the image.
- north
Var String - The number of pixels to shrink or expand the top side of the image.
- south String
- The number of pixels to shrink or expand the bottom side of the image.
- south
Var String - The number of pixels to shrink or expand the bottom side of the image.
- west String
- The number of pixels to shrink or expand the left side of the image.
- west
Var String - The number of pixels to shrink or expand the left side of the image.
GetImagingPolicyImagePolicyTransformationRemoveColor
- Color string
- The hexadecimal CSS color value to remove.
- Color
Var string - The hexadecimal CSS color value to remove.
- Feather string
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Feather
Var string - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Tolerance string
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- Tolerance
Var string - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- Color string
- The hexadecimal CSS color value to remove.
- Color
Var string - The hexadecimal CSS color value to remove.
- Feather string
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Feather
Var string - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- Tolerance string
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- Tolerance
Var string - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color String
- The hexadecimal CSS color value to remove.
- color
Var String - The hexadecimal CSS color value to remove.
- feather String
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather
Var String - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance String
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance
Var String - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color string
- The hexadecimal CSS color value to remove.
- color
Var string - The hexadecimal CSS color value to remove.
- feather string
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather
Var string - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance string
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance
Var string - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color str
- The hexadecimal CSS color value to remove.
- color_
var str - The hexadecimal CSS color value to remove.
- feather str
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather_
var str - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance str
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance_
var str - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- color String
- The hexadecimal CSS color value to remove.
- color
Var String - The hexadecimal CSS color value to remove.
- feather String
- The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- feather
Var String - The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
- tolerance String
- The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
- tolerance
Var String - The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
GetImagingPolicyImagePolicyTransformationResize
- Aspect string
- Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - Aspect
Var string - Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - Height string
- The height to resize the source image to. Must be set if height is not specified.
- Height
Var string - The height to resize the source image to. Must be set if height is not specified.
- Type string
- Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - Type
Var string - Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - Width string
- The width to resize the source image to. Must be set if width is not specified.
- Width
Var string - The width to resize the source image to. Must be set if width is not specified.
- Aspect string
- Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - Aspect
Var string - Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - Height string
- The height to resize the source image to. Must be set if height is not specified.
- Height
Var string - The height to resize the source image to. Must be set if height is not specified.
- Type string
- Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - Type
Var string - Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - Width string
- The width to resize the source image to. Must be set if width is not specified.
- Width
Var string - The width to resize the source image to. Must be set if width is not specified.
- aspect String
- Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - aspect
Var String - Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - height String
- The height to resize the source image to. Must be set if height is not specified.
- height
Var String - The height to resize the source image to. Must be set if height is not specified.
- type String
- Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - type
Var String - Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - width String
- The width to resize the source image to. Must be set if width is not specified.
- width
Var String - The width to resize the source image to. Must be set if width is not specified.
- aspect string
- Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - aspect
Var string - Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - height string
- The height to resize the source image to. Must be set if height is not specified.
- height
Var string - The height to resize the source image to. Must be set if height is not specified.
- type string
- Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - type
Var string - Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - width string
- The width to resize the source image to. Must be set if width is not specified.
- width
Var string - The width to resize the source image to. Must be set if width is not specified.
- aspect str
- Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - aspect_
var str - Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - height str
- The height to resize the source image to. Must be set if height is not specified.
- height_
var str - The height to resize the source image to. Must be set if height is not specified.
- type str
- Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - type_
var str - Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - width str
- The width to resize the source image to. Must be set if width is not specified.
- width_
var str - The width to resize the source image to. Must be set if width is not specified.
- aspect String
- Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - aspect
Var String - Preserves the aspect ratio. Select
fit
to make the image fit entirely within the selected width and height. When usingfit
, the resulting image has the largest possible size for the specified dimensions. Selectfill
to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwiseignore
changes the original aspect ratio to fit within an arbitrarily shaped rectangle. - height String
- The height to resize the source image to. Must be set if height is not specified.
- height
Var String - The height to resize the source image to. Must be set if height is not specified.
- type String
- Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - type
Var String - Sets constraints for the image resize. Select
normal
to resize in all cases, either increasing or decreasing the dimensions. Selectdownsize
to ignore this transformation if the result would be larger than the original. Selectupsize
to ignore this transformation if the result would be smaller. - width String
- The width to resize the source image to. Must be set if width is not specified.
- width
Var String - The width to resize the source image to. Must be set if width is not specified.
GetImagingPolicyImagePolicyTransformationRotate
- Degrees string
- The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- Degrees
Var string - The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- Degrees string
- The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- Degrees
Var string - The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees String
- The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees
Var String - The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees string
- The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees
Var string - The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees str
- The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees_
var str - The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees String
- The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
- degrees
Var String - The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
GetImagingPolicyImagePolicyTransformationScale
- Height string
- Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - Height
Var string - Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - Width string
- Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers. - Width
Var string - Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers.
- Height string
- Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - Height
Var string - Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - Width string
- Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers. - Width
Var string - Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers.
- height String
- Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - height
Var String - Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - width String
- Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers. - width
Var String - Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers.
- height string
- Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - height
Var string - Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - width string
- Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers. - width
Var string - Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers.
- height str
- Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - height_
var str - Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - width str
- Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers. - width_
var str - Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers.
- height String
- Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - height
Var String - Scaling factor for the input height to determine the output height of the image, where values between
0
and1
decrease size. Image dimensions need to be non-zero positive numbers. - width String
- Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers. - width
Var String - Scaling factor for the input width to determine the output width of the image, where
1
leaves the width unchanged. Values greater than1
increase the image size. Image dimensions need to be non-zero positive numbers.
GetImagingPolicyImagePolicyTransformationShears
- XShear string
- The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- XShear
Var string - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- YShear string
- The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- YShear
Var string - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- XShear string
- The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- XShear
Var string - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- YShear string
- The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- YShear
Var string - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- x
Shear String - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- x
Shear StringVar - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- y
Shear String - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- y
Shear StringVar - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- x
Shear string - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- x
Shear stringVar - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- y
Shear string - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- y
Shear stringVar - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- x_
shear str - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- x_
shear_ strvar - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- y_
shear str - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- y_
shear_ strvar - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- x
Shear String - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- x
Shear StringVar - The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
- y
Shear String - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
- y
Shear StringVar - The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
GetImagingPolicyImagePolicyTransformationTrim
- Fuzz string
- The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - Fuzz
Var string - The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - Padding string
- The amount of padding in pixels to add to the trimmed image.
- Padding
Var string - The amount of padding in pixels to add to the trimmed image.
- Fuzz string
- The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - Fuzz
Var string - The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - Padding string
- The amount of padding in pixels to add to the trimmed image.
- Padding
Var string - The amount of padding in pixels to add to the trimmed image.
- fuzz String
- The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - fuzz
Var String - The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - padding String
- The amount of padding in pixels to add to the trimmed image.
- padding
Var String - The amount of padding in pixels to add to the trimmed image.
- fuzz string
- The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - fuzz
Var string - The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - padding string
- The amount of padding in pixels to add to the trimmed image.
- padding
Var string - The amount of padding in pixels to add to the trimmed image.
- fuzz str
- The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - fuzz_
var str - The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - padding str
- The amount of padding in pixels to add to the trimmed image.
- padding_
var str - The amount of padding in pixels to add to the trimmed image.
- fuzz String
- The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - fuzz
Var String - The fuzz tolerance of the trim, a value between
0
and1
that determines the acceptable amount of background variation before trimming stops. - padding String
- The amount of padding in pixels to add to the trimmed image.
- padding
Var String - The amount of padding in pixels to add to the trimmed image.
GetImagingPolicyImagePolicyTransformationUnsharpMask
- Gain string
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Gain
Var string - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Sigma string
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Sigma
Var string - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Threshold string
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- Threshold
Var string - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- Gain string
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Gain
Var string - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- Sigma string
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Sigma
Var string - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - Threshold string
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- Threshold
Var string - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain String
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain
Var String - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma String
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma
Var String - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold String
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold
Var String - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain string
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain
Var string - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma string
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma
Var string - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold string
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold
Var string - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain str
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain_
var str - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma str
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma_
var str - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold str
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold_
var str - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- gain String
- Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- gain
Var String - Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
- sigma String
- The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - sigma
Var String - The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels,
1.0
by default. High values emphasize large details and low values emphasize small details. - threshold String
- Set the minimum change required to include a detail in the filter. Higher values discard more changes.
- threshold
Var String - Set the minimum change required to include a detail in the filter. Higher values discard more changes.
GetImagingPolicyImagePolicyVariable
- Default
Value string - The default value of the variable if no query parameter is provided. It needs to be one of the
enumOptions
if any are provided. - Name string
- The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
- Type string
- The type of value for the variable.
- Enum
Options List<GetImaging Policy Image Policy Variable Enum Option> - Postfix string
- A postfix added to the value provided for the variable, or to the default value.
- Prefix string
- A prefix added to the value provided for the variable, or to the default value.
- Default
Value string - The default value of the variable if no query parameter is provided. It needs to be one of the
enumOptions
if any are provided. - Name string
- The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
- Type string
- The type of value for the variable.
- Enum
Options []GetImaging Policy Image Policy Variable Enum Option - Postfix string
- A postfix added to the value provided for the variable, or to the default value.
- Prefix string
- A prefix added to the value provided for the variable, or to the default value.
- default
Value String - The default value of the variable if no query parameter is provided. It needs to be one of the
enumOptions
if any are provided. - name String
- The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
- type String
- The type of value for the variable.
- enum
Options List<GetImaging Policy Image Policy Variable Enum Option> - postfix String
- A postfix added to the value provided for the variable, or to the default value.
- prefix String
- A prefix added to the value provided for the variable, or to the default value.
- default
Value string - The default value of the variable if no query parameter is provided. It needs to be one of the
enumOptions
if any are provided. - name string
- The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
- type string
- The type of value for the variable.
- enum
Options GetImaging Policy Image Policy Variable Enum Option[] - postfix string
- A postfix added to the value provided for the variable, or to the default value.
- prefix string
- A prefix added to the value provided for the variable, or to the default value.
- default_
value str - The default value of the variable if no query parameter is provided. It needs to be one of the
enumOptions
if any are provided. - name str
- The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
- type str
- The type of value for the variable.
- enum_
options Sequence[GetImaging Policy Image Policy Variable Enum Option] - postfix str
- A postfix added to the value provided for the variable, or to the default value.
- prefix str
- A prefix added to the value provided for the variable, or to the default value.
- default
Value String - The default value of the variable if no query parameter is provided. It needs to be one of the
enumOptions
if any are provided. - name String
- The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
- type String
- The type of value for the variable.
- enum
Options List<Property Map> - postfix String
- A postfix added to the value provided for the variable, or to the default value.
- prefix String
- A prefix added to the value provided for the variable, or to the default value.
GetImagingPolicyImagePolicyVariableEnumOption
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
akamai
Terraform Provider.