Previous Topic

Next Topic

Book Contents

Book Index

CanvasFormatWithColor

Description:

The CanvasFormatWithColor import option can enforce that the image fits within a certain format such as 4:3 or 16:9. This operation will not alter the aspect ration of the image, and in the case where the image is smaller than the specified format, white space may occur on either side of the original image. You can however control the color of the "white space"

Declaration:

CanvasFormatWithColor:<Width>,<Height>,[<Background color>]


Parameters:

Param

Description

<Width>

The width of the format, such as 4 or 16.

<Height>

The height of the format, such as 3 or 9

<Background color>

Optional parameter to control the background color of the potential white space surrounding the image. Specify the color according to the How to specify colors ?.


Notes:

The main usage for this option is if the result-image is to be used within an application that automatically assumes a certain format. For example may several Flash applications assume that any image displayed within it's image browser, adhere to the 4:3 canvas format. If your image is not adhering to the 4:3 format, the Flash application will stretch the image to fit 4:3, thus destroying the aspect ratio of the image. You can easily avoid that by using the CanvasFormatWithColor import option!

Also note that this import option is repeatable, meaning that its position in the sequence of specified import options, may affect what the result looks like. For example can you ensure that the original image is adhering to a certain format, by specifying CanvasFormatWithColor very early in the sequence of import options. Or, you can rather ensure the format after you have resized and otherwise processed the image, by specifying CanvasFormatWithColor later in the sequence. See more on troubleshooting sequence of import options in Change the sequence of the import options.

Introduced in version:

1.5.0.3

Repeatable

Yes

See Also

All Import Options

AttachImportFile

AppendIPTC

AttachOriginalFile

AttachPreviewFile

AutoOrientation

Blur

ClearExistingMetadata

ExtractEXIFToField

ExtractIPTCToField

ExtractImageVariablesToField

FavorPhotoshop

Flip

ForceImportFilename

ImpersonateAs

InsertIPTC

LeaveDXLBackup

LoadTIFFFrame

OverlayImage

WriteText

OutputSize

ProcessTimeField

ReplaceEXIF

ReplaceIPTC

ReplaceWithVariable

Resize

ResizeMetric

Rotate

SetDPI

SetGhostscriptParameters

SetGhostscriptProcessor

SetLogFilename

SetLogLevel

ResizeMethod

SetResizeNoEnlargement

SetWebGrabBrowserSize

SetWebGrabClipRect

SetWebGrabDelay

SetWebGrabEnableActiveX

SetWebGrabEnableJava

SetWebGrabEnableScript

SetWebGrabTimeout

SetWebGrabZoom

StrictImageVerification

Sharpen

UseImageResourceDatabase

WorkingPath