cfimage

Last updated on Feb 25, 2025 | Also applies to ColdFusion

ColdFusion

Open app

CFML Reference User Guide

ColdFusion functions

ColdFusion functions by category
Functions a-b
1. Abs
2. ACos
3. AddSOAPRequestHeader
4. AddSOAPResponseHeader
5. AjaxLink
6. AjaxOnLoad
7. ApplicationStop
8. ArrayAppend
9. ArrayAvg
10. ArrayClear
11. ArrayContains
12. ArrayContainsNoCase
13. ArrayDelete
14. ArrayDeleteAt
15. ArrayDeleteNoCase
16. ArrayEach
17. ArrayFilter
18. ArrayFind
19. ArrayFindAll
20. ArrayFindAllNoCase
21. ArrayFindNoCase
22. ArrayInsertAt
23. ArrayIsDefined
24. ArrayIsEmpty
25. ArrayLen
26. ArrayMap
27. ArrayMax
28. ArrayMin
29. ArrayNew
30. ArrayPrepend
31. ArrayReduce
32. ArrayResize
33. ArraySet
34. ArraySetMetadata
35. ArraySlice
36. ArraySort
37. ArraySum
38. ArraySwap
39. ArrayToList
40. Asc
41. ASin
42. Atn
43. AuthenticatedContext
44. AuthenticatedUser
45. BinaryDecode
46. BinaryEncode
47. BitAnd
48. BitMaskClear
49. BitMaskRead
50. BitMaskSet
51. BitNot
52. BitOr
53. BitSHLN
54. BitSHRN
55. BitXor
56. BooleanFormat
Functions-c-d
Functions-e-g
Functions-h-im
Functions-in-k
Functions-l
Functions-m-r
Functions-s
Functions-t-z
1. Tan
2. ThreadJoin
3. ThreadTerminate
4. Throw
5. TimeFormat
6. ToBase64
7. ToBinary
8. ToScript
9. ToString
10. Trace
11. Transactionandconcurrency
12. TransactionCommit
13. TransactionRollback
14. TransactionSetSavePoint
15. Trim
16. UCase
17. URLDecode
18. URLEncodedFormat
19. URLSessionFormat
20. Val
21. ValueList
22. VerifyClient
23. Week
24. Wrap
25. WriteDump
26. WriteLog
27. WriteOutput
28. WSGetAllChannels
29. WSGetSubscribers
30. WSPublish
31. WSSendMessage
32. XmlChildPos
33. XmlElemNew
34. XmlFormat
35. XmlGetNodeType
36. XmlNew
37. XmlParse
38. XmlSearch
39. XmlTransform
40. XmlValidate
41. Year
42. YesNoFormat

ColdFusion tags

ColdFusion tag summary
ColdFusion tags by category
1. Application framework tags
  1. cfapplication
  2. cfassociate
  3. cferror
  4. cfimport
  5. cfinterface
  6. cflock
  7. cfscript
  8. cfthread
2. Communications tags
3. Database manipulation tags
4. Data output tags
  1. cfchart
5. Debugging tags
  1. cfdump
  2. cftimer
  3. cftrace
6. Exception handling tags
  1. cfcatch
  2. cferror
  3. cffinally
  4. cfrethrow
  5. cfthrow
  6. cftry
7. Extensibility tags
  1. cfchart
  2. cfchartdata
  3. cfchartseries
  4. cfcollection
  5. cfcomponent
  6. cfexecute
  7. cfftp
  8. function
  9. cfindex
  10. cfinterface
  11. cfinvoke
  12. cfinvokeargument
  13. cfobject
  14. cfproperty
  15. cfreport
  16. cfreportparam
  17. cfreturn
  18. cfsearch
  19. cfsharepoint
  20. cfspreadsheet
  21. cfwddx
  22. cfxml
8. File management tags
  1. cfdirectory
  2. cffile
  3. cffileupload
  4. cfftp
  5. cfzip
  6. cfzipparam
9. Flow-control tags
  1. cfabort
  2. cfbreak
  3. cfcase
  4. cfcontinue
  5. cfdefaultcase
  6. cfelse
  7. cfelseif
  8. cfexecute
  9. cfexit
  10. cfif
  11. cfinclude
  12. cflocation
  13. cfloop
  14. cfrethrow
  15. cfswitch
  16. cfthrow
  17. cftry
10. Forms tags
  1. cfapplet
  2. cfcalendar
  3. cffileupload
  4. cfform
  5. cfformgroup
  6. cfformitem
  7. cfgrid
  8. cfgridcolumn
  9. cfgridrow
  10. cfgridupdate
  11. cfinput
  12. cfpdf
  13. cfpdfform
  14. cfpdfformparam
  15. cfpdfparam
  16. cfpdfsubform
  17. cfselect
  18. cfslider
  19. cftextarea
  20. cftree
  21. cftreeitem
11. Internet Protocol tags
  1. cfajaximport
  2. cfajaxproxy
  3. cfftp
  4. cffeed
  5. cfimap
  6. cfhttp
  7. cfhttpparam
  8. cfldap
  9. cfmail
  10. cfmailparam
  11. cfmailpart
  12. cfpop
  13. cfsprydataset
12. Page processing tags
  1. cfcache
  2. cfcontent
  3. cfflush
  4. cfheader
  5. cfhtmlhead
  6. cfinclude
  7. cfprocessingdirective
  8. cfsetting
  9. cfsilent
13. Security tags
14. Variable manipulation tags
  1. cfcookie
  2. cfdump
  3. cfparam
  4. cfregistry
  5. cfsavecontent
  6. cfschedule
  7. cfset
  8. cfsetting
15. Other tags
  1. cfimage
  2. cflog
  3. cfregistry
Tags a-b
Tags c
Tags f
Tags g-h
1. cfgraph
2. cfgraphdata
3. cfgrid
4. cfgridcolumn
5. cfgridrow
6. cfgridupdate
7. cfheader
8. cfhtmlhead
9. cfhtmltopdf
10. cfhtmltopdfitem
11. cfhttp
12. cfhttpparam
Tags i
1. cfif
2. cfimage
3. cfimap
4. cfimapfilter
5. cfimpersonate
6. cfimport
7. cfinclude
8. cfindex
9. cfinput
10. cfinsert
11. cfinterface
12. cfinvoke
13. cfinvokeargument
Tags j-l
Tags m-o
Tags p-q
1. cfparam
2. cfpdf
3. cfpdfform
4. cfpdfformparam
5. cfpdfparam
6. cfpdfsubform
7. cfpod
8. cfpop
9. cfpresentation
10. cfpresentationslide
11. cfpresenter
12. cfprint
13. cfprocessingdirective
14. cfprocparam
15. cfprocresult
16. cfprogressbar
17. cfproperty
18. cfquery
19. cfqueryparam
Tags r-s
1. cfregistry
2. cfreport
3. cfreportparam
4. cfrethrow
5. cfreturn
6. cfsavecontent
7. cfschedule
8. cfscript
9. cfsearch
10. cfselect
11. cfservlet
12. cfservletparam
13. cfset
14. cfsetting
15. cfsharepoint
16. cfsilent
17. cfslider
18. cfspreadsheet
19. cfsprydataset
20. cfstoredproc
21. cfswitch
Tags t
1. cftable
2. cftextarea
3. cftextinput
4. cfthread
5. cfthrow
6. cftimer
7. cftooltip
8. cftrace
9. cftransaction
10. cftree
11. cftreeitem
12. cftry
Tags u-z
1. cfupdate
2. cfwddx
3. cfwebsocket
4. cfwindow
5. cfxml
6. cfzip
7. cfzipparam

CFML Reference

Cloud services

CFML Reference User Guide
ColdFusion functions
ColdFusion tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

Description

Creates a ColdFusion image. You can use the cfimage tag to perform common image manipulation operations as a shortcut to Image functions. You can use the cfimage tag independently or in conjunction with Image functions.

History

ColdFusion (2025 release): Added support for webp image format. View webp support in cfimage for more information.

ColdFusion 10: Added the attribute interpolation to {{cfimage action = "resize"}}

ColdFusion 8: Added this tag.

Syntax

Add a border to an image

<cfimage

required

action = "border"

source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#"

optional

color = "hexadecimal value|web color"

destination = "absolute pathname|pathname relative to the web root"

isBase64 = "yes|no"

name = "cfimage variable"

overwrite = "yes|no"

thickness = "number of pixels">

Create a CAPTCHA image

<cfimage

required

action = "captcha"

height = "number of pixels"

text = "text string"

width = "number of pixels"

optional

destination = "absolute pathname|pathname relative to the web root"

difficulty = "high|medium|low"

overwrite = "yes|no"

fonts = "comma-separated list of font names"

fontSize = "point size">

Convert an image file format

<cfimage

required

action = "convert"

destination = "absolute pathname|pathname relative to the web root"

source = "absolute pathname|pathname relative to the web root"|URL|#cfimage variable#

optional

isBase64 = "yes|no"

name = "cfimage variable"

overwrite = "yes|no">

Retrieve information about an image

<cfimage

required

action = "info"

source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#"

structname = "structure name"

optional

isBase64 = "yes|no">

Read an image into memory

<cfimage

required

name = "cfimage variable"

source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#"

optional

action = "read"

isBase64 = "yes|no">

Resize an image

<cfimage

required

action = "resize"

height = "number of pixels|percent%"

source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#"

width = "number of pixels|percent%"

optional

destination = "absolute pathname|pathname relative to the web root"

isBase64 = "yes|no"

name = "cfimage variable"

overwrite = "yes|no">

interpolation = "interpolation algorithm"

Rotate an image

<cfimage

required

action = "rotate"

angle = "angle in degrees"

source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#"

optional

destination = "absolute pathname|pathname relative to the web root"

isBase64= "yes|no"

name = "cfimage variable"

overwrite = "yes|no">

Write an image to a file

<cfimage

required

action = "write"

destination = "absolute pathname|pathname relative to the web root"

source = "absolute or relative pathname|URL|#cfimage variable#"

optional

isBase64= "yes|no"

overwrite = "yes|no"

quality = "JPEG image quality">

Write an image to the browser

<cfimage

required

action = "writeToBrowser"

source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#"

optional

format = "png|jpg|jpeg|webp"

isBase64= "yes|no">

Add a border to an image <cfimage required action = "border" source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" optional color = "hexadecimal value|web color" destination = "absolute pathname|pathname relative to the web root" isBase64 = "yes|no" name = "cfimage variable" overwrite = "yes|no" thickness = "number of pixels"> Create a CAPTCHA image <cfimage required action = "captcha" height = "number of pixels" text = "text string" width = "number of pixels" optional destination = "absolute pathname|pathname relative to the web root" difficulty = "high|medium|low" overwrite = "yes|no" fonts = "comma-separated list of font names" fontSize = "point size"> Convert an image file format <cfimage required action = "convert" destination = "absolute pathname|pathname relative to the web root" source = "absolute pathname|pathname relative to the web root"|URL|#cfimage variable# optional isBase64 = "yes|no" name = "cfimage variable" overwrite = "yes|no"> Retrieve information about an image <cfimage required action = "info" source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" structname = "structure name" optional isBase64 = "yes|no"> Read an image into memory <cfimage required name = "cfimage variable" source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" optional action = "read" isBase64 = "yes|no"> Resize an image <cfimage required action = "resize" height = "number of pixels|percent%" source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" width = "number of pixels|percent%" optional destination = "absolute pathname|pathname relative to the web root" isBase64 = "yes|no" name = "cfimage variable" overwrite = "yes|no"> interpolation = "interpolation algorithm" Rotate an image <cfimage required action = "rotate" angle = "angle in degrees" source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" optional destination = "absolute pathname|pathname relative to the web root" isBase64= "yes|no" name = "cfimage variable" overwrite = "yes|no"> Write an image to a file <cfimage required action = "write" destination = "absolute pathname|pathname relative to the web root" source = "absolute or relative pathname|URL|#cfimage variable#" optional isBase64= "yes|no" overwrite = "yes|no" quality = "JPEG image quality"> Write an image to the browser <cfimage required action = "writeToBrowser" source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" optional format = "png|jpg|jpeg|webp" isBase64= "yes|no">

Add a border to an image 
<cfimage 
required 
action = "border" 
source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" 
optional 
color = "hexadecimal value|web color" 
destination = "absolute pathname|pathname relative to the web root" 
isBase64 = "yes|no" 
name = "cfimage variable" 
overwrite = "yes|no" 
thickness = "number of pixels"> 

Create a CAPTCHA image 
<cfimage 
required 
action = "captcha" 
height = "number of pixels" 
text = "text string" 
width = "number of pixels" 
optional 
destination = "absolute pathname|pathname relative to the web root" 
difficulty = "high|medium|low" 
overwrite = "yes|no" 
fonts = "comma-separated list of font names" 
fontSize = "point size"> 

Convert an image file format 
<cfimage 
required 
action = "convert" 
destination = "absolute pathname|pathname relative to the web root" 
source = "absolute pathname|pathname relative to the web root"|URL|#cfimage variable# 
optional 
isBase64 = "yes|no" 
name = "cfimage variable" 
overwrite = "yes|no"> 

Retrieve information about an image 
<cfimage 
required 
action = "info" 
source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" 
structname = "structure name" 
optional 
isBase64 = "yes|no"> 

Read an image into memory 
<cfimage 
required 
name = "cfimage variable" 
source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" 
optional 
action = "read" 
isBase64 = "yes|no"> 

Resize an image 
<cfimage 
required 
action = "resize" 
height = "number of pixels|percent%" 
source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" 
width = "number of pixels|percent%" 
optional 
destination = "absolute pathname|pathname relative to the web root" 
isBase64 = "yes|no" 
name = "cfimage variable" 
overwrite = "yes|no"> 
interpolation = "interpolation algorithm" 

Rotate an image 
<cfimage 
required 
action = "rotate" 
angle = "angle in degrees" 
source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" 
optional 
destination = "absolute pathname|pathname relative to the web root" 
isBase64= "yes|no" 
name = "cfimage variable" 
overwrite = "yes|no"> 

Write an image to a file 
<cfimage 
required 
action = "write" 
destination = "absolute pathname|pathname relative to the web root" 
source = "absolute or relative pathname|URL|#cfimage variable#" 
optional 
isBase64= "yes|no" 
overwrite = "yes|no" 
quality = "JPEG image quality"> 

Write an image to the browser 
<cfimage 
required 
action = "writeToBrowser" 
source = "absolute pathname|pathname relative to the web root|URL|#cfimage variable#" 
optional 
format = "png|jpg|jpeg|webp" 
isBase64= "yes|no">

Note:

You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

Attributes

Attribute	Action	Req/Opt	Default	Description
action	N/A	Optional	read	Action to take. Must be one of the following: border captcha convert info read resize rotate write writeToBrowser The default action is read, which you do not need to specify explicitly.
angle	rotate	Required		Angle in degrees to rotate the image.Specify an integer for the value.
color	border	Optional	black	Border color.Hexadecimal value or supported named color; see the name list in Valid HTML named colors section. For a hexadecimal value, use the form "##xxxxxx" or "xxxxxx", where x = 0-9 or A-F; use two number signs or none.
destination	border captcha convert resizerotate write	Optional (see Description)		Absolute or relative pathname where the image output is written. The image format is determined by the file extension. The convert and write actions require a destination attribute. The border, captcha, resize, and rotateactions require a name attribute or a destination attribute. You can specify both. ColdFusion supports only CAPTCHA images in PNG format. Where the CAPTCHA image is placed depends on the following: If destination is specified, image is written to the file (based on the absolute or relative pathname you specify). If name is specified, image is written to the image variable. If neither destination nor name is specified, image is written to the browser.
difficulty	captcha	Optional	low	Level of complexity of the CAPTCHA text. Specify one of the following levels of text distortion: low medium high
fonts	captcha	Optional		One or more valid fonts to use for the CAPTCHA text. Separate multiple fonts with commas. If the specified font is not available, falls back to system fonts.
fontSize	captcha	Optional	24	Font size of the text in the CAPTCHA image. The value must be an integer.
format	writeToBrowser	Optional	PNG	Format of the image displayed in the browser. If you do not specify a format, the image is displayed in PNG format. You cannot display a GIF image in a browser. GIF images are displayed in PNG format.
height	captcha resize	Required		Height in pixels of the image. For the resize attribute, you also can specify the height as a percentage (an integer followed by the percent (%)symbol). When you resize an image, if you specify a value for the width, you can let ColdFusion calculate the aspect ratio by specifying "" as the height. If specified, the value must be an integer.
inter polation	resize	Optional	highest Quality	Specify a specific interpolation algorithm by name (for example, hamming), by image quality (for example,mediumQuality), or by performance (for example, highestPerformance). The following are the valid values: highestQuality highQuality mediumQuality highestPerformance highPerformance mediumPerformance nearest bilinear bicubic bessel blackman hamming hanning hermite lanczos mitchell quadratic
isBase64	border convert info read resizerotate writewrite ToBrowser	Optional	no	Specifies whether the source is a Base64 string: yes: the source is a Base64 string. no: the source is not a Base64 string.
name	border convertread resizerotate	Optional (see Description)		Name of the ColdFusion image variable to create. The read action requires a name attribute. The border, resize, and rotate actions require a name attribute or a destination attribute. You can specify both.
overwrite	border captcha conver tread resizerotate write	Optional	no	Valid only if the destination attribute is specified. The overwrite values are: yes: overwrites the destination file. no: does not overwrite the destination file. If the destination file exists, ColdFusion generates an error if the overwrite action is not set to yes.
quality	write	Optional	0.75	Quality of the JPEG destination file. Applies only to files with an extension of JPG or JPEG. Valid values are fractions that range from 0 through 1 (the lower the number, the lower the quality).
source	border convert info read resizerotate write write ToBrowser	Required		URL of the source image; for example, "{{ http://www.google.com/images/logo.gif }}" Absolute pathname or a pathname relative to the web root; for example: "c:\images\logo.jpg" ColdFusion image variable containing another image, BLOB, or byte array; for example, "#myImage#" Base64 string; for example, "data:image/jpg;base64,/9j/4AAQSkZJRgABAQA.............."
struct Name	info	Required		Name of the ColdFusion structure to be created.
text	captcha	Required		Text string displayed in the CAPTCHA image. Use capital letters for better readability. Do not include spaces because users cannot detect them in the resulting CAPTCHA image.
thickness	border	Optional	1	Border thickness in pixels. The border is added to the outside edge of the source image, increasing the image area accordingly. The value must be an integer.
width	captcha resize	Required		Width in pixels of the image. For resize, you also can specify the width as a percentage (an integer followed by the % symbol). When you resize an image, if you specify a value for the height, you can let ColdFusion calculate the aspect ratio by specifying "" as the width. If specified, the value must be an integer.

Usage

ColdFusion provides the cfimage tag and the ColdFusion image, a construct native to ColdFusion that contains image data. You can manipulate ColdFusion images in memory and write them to a file, a database, or directly to a browser. You use the cfimage tag to create ColdFusion images from existing image files and perform simple image actions, such as rotating or resizing. Alternatively, you can use theImageNew function to create a ColdFusion image from the beginning or from an existing image. You can use the Image functions to perform complex image manipulation operations on ColdFusion images that you create with the cfimage tag or with the ImageNew function.
You can perform the following tasks with ColdFusion images:

Convert an image from one file format to another. For example, you can convert a BMP file to a JPEG file or a Base64 string to a GIF.
Enforce consistent sizes on files uploaded to the server.
Enforce size limits on JPEG images (by changing the quality of the image).
Save a ColdFusion image to a file or write the image directly to a browser.
Use the ImageGetBlob function within the cfquery tag to insert a ColdFusion image as a Binary Large Object Bitmap (BLOB) in a database. Also, you can extract a BLOB from a database and generate a ColdFusion image from it.
Create watermark images.
Create thumbnail images.
Create a Completely Automated Public Turing test to tell Computers and Humans Apart (CAPTCHA) image, a distorted text image that is human-readable, but not machine-readable, used in a challenge-response test for preventing spam.
For more detailed examples, see Creating and Manipulating ColdFusion Images in the Developing ColdFusion Applications.

File attributes

Use the following syntax to specify an in-memory file, which is not written to disk in the destination and source attributes. In-memory files speed processing of transient data.

ram:///filepath

ram:///filepath

The filepath can include directories, for example ram:///petStore/images/poodle.jpg. Create the directories in the path before you specify the file. For more information on using in-memory files, see Working with in-memory files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.

Supported image file formats

The cfimage tag operates on a number of different file formats. To list the formats that are supported on the server where the ColdFusion application is deployed, use the GetReadableImageFormats function and the GetWriteableImageFormats function.ColdFusion supports the following default image formats on Macintosh, Windows, and Unix operating systems:

JPEG
GIF
WEBP
TIFF
PNG
BMP

ColdFusion does not support the following image formats:

Animated GIF
Multipage TIFF
PSD
AI

CMYK support

The cfimage tag supports reading and writing CMYK images, but does not support actions that require converting the images. For example, you can use CMYK images with the read, write, writeToBrowser, resize, rotate, and info actions. You cannot use CMYK images with the convert, captcha, and border actions. The same rule applies to image functions. For example, the ImageNew, ImageRead, and ImageWrite functions support CMYK images, but the ImageAddBorder function does not.

Valid HTML named colors

The following table lists the W3C HTML 4 named color value or hexadecimal values that the color attribute accepts:

Color name	RGB value
Black	##000000
Blue	##0000FF
Red	##FF0000
Gray	##808080
LightGray	##D3D3D3
DarkGray	##A9A9A9
Green	##008000
Pink	##FFC0CB
Cyan	##00FFFF
Magenta	##FF00FF
Orange	##FFA500
White	##FFFFFF
Yellow	##FFFF00

For all other color values, enter the hexadecimal value. Enter a six-digit value, which specifies the RGB value. Values between 00 and FF are allowed.

Image quality

By default, the cfimage tag generates images with antialiasing turned on (to remove the appearance of jagged edges). The interpolation method is set to highestQuality: this produces a high-quality image, but decreases processing speed. To turn off antialiasing, use the ImageSetAntialiasing function. To change the interpolation method or for more control over image attributes, use the following functions:

border action Use the border action to create a rectangular border around the outer edge of an image. You can control the thickness of the border and its color. For more control, use the ImageAddBorder function. The following example shows how to set the thickness and color of a border:

<!--- This example shows how to create a ColdFusion image from an existing JPEG file, add a

five-pixel-wide red border to the image, and save it to a new JPEG file. --->

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="border" thickness="5"

destination="jeff05.jpg" color="red" overwrite="yes">

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="border" thickness="5" destination="jeff05.jpg" color="red" overwrite="yes">

<!--- This example shows how to create a ColdFusion image from an existing JPEG file, add a
five-pixel-wide red border to the image, and save it to a new JPEG file. --->
<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="border" thickness="5"
destination="jeff05.jpg" color="red" overwrite="yes">

captcha action Use the captchaaction to create a distorted text image that is human-readable but not machine-readable. When you create a CAPTCHA image, you specify the text that is displayed in the CAPTCHA image; ColdFusion randomly distorts the text. You can specify the height and width of the text area, which affects the spacing between letters, the font size, the fonts used for the CAPTCHA text, and the level of difficulty, which affects readability. The following example shows how to write a CAPTCHA image directly to the browser:

<cfimage action="captcha" fontSize="25" width="400" height="150" text="rEadMe"

fonts="Arial,Verdana,Courier New">

<cfimage action="captcha" fontSize="25" width="400" height="150" text="rEadMe"
fonts="Arial,Verdana,Courier New">

Note:

For the CAPTCHA image to display, the width value must be greater than: fontSize times the number of characters specified in text times 1.08. In this example, the minimum width is 162.

ColdFusion supports CAPTCHA images in PNG format only.

Use unique names for the CAPTCHA image files so that when multiple users access the CAPTCHA images, the files are not overwritten.

The following example shows how to create CAPTCHA images with a medium level of difficulty that are written to files:

<cfimage action="captcha" fontSize="15" width="180" height="50" text="rEadMe"

destination="images/rEadMe#tc#.png" difficulty="medium">

<cfset tc = GetTickCount()> <cfimage action="captcha" fontSize="15" width="180" height="50" text="rEadMe" destination="images/rEadMe#tc#.png" difficulty="medium">

<!--- Use the GetTickCount function to generate unique names for the CAPTCHA files. --->
<cfset tc = GetTickCount()> 
<cfimage action="captcha" fontSize="15" width="180" height="50" text="rEadMe"
destination="images/rEadMe#tc#.png" difficulty="medium">

For a detailed example, see the Creating and Manipulating ColdFusion Images in the Developing ColdFusion Applications.

convert action Use the convertaction to convert an image from one file format to another. For more information on file formats, see the section Supported image file formats. The following example shows how to convert a JPEG file to a PNG file:

<cfimage source="../cfdocs/images/artgallery/aiden02.jpg" action="convert"

destination="aiden02.png">

<cfimage source="../cfdocs/images/artgallery/aiden02.jpg" action="convert" destination="aiden02.png">

<!--- This example shows how to convert a JPEG image to a PNG image. --->
<cfimage source="../cfdocs/images/artgallery/aiden02.jpg" action="convert"
destination="aiden02.png">

Note:

Converting images between one file format to another is time-consuming. Also, image quality can degrade; for example, PNG images support 24-bit color, but GIF images support only 256 colors. Converting transparent images (images with alpha) can degrade image quality.

info action Use the info action to create a ColdFusion structure that contains information about the image, including the color model, height, width, and source of the image. The structure is the same as returned by the ImageInfo function. The following example shows how to retrieve all of the information about an image:

<!--- Alternatively, you can use the cfoutput tag to display specific image information, as

shown in the following example. --->

height: #viatoInfo.height# pixels

width: #viatoInfo.width# pixels

source: #viatoInfo.source#

transparency: #viatoInfo.colormodel.transparency#

pixel size: #viatoInfo.colormodel.pixel_size#

color model: #viatoInfo.colormodel.colormodel_type#

alpha channel support: #viatoInfo.colormodel.alpha_channel_support#

color space: #viatoInfo.colormodel.colorspace#

</cfoutput>

<cfimage source="../cfdocs/images/artgallery/viata03.jpg" action="info" structName="viatoInfo"> <cfdump var="#viatoInfo#">  <cfoutput> height: #viatoInfo.height# pixels width: #viatoInfo.width# pixels source: #viatoInfo.source# transparency: #viatoInfo.colormodel.transparency# pixel size: #viatoInfo.colormodel.pixel_size# color model: #viatoInfo.colormodel.colormodel_type# alpha channel support: #viatoInfo.colormodel.alpha_channel_support# color space: #viatoInfo.colormodel.colorspace# </cfoutput>

<!--- This example shows how to retrieve and display image information. --->
<cfimage source="../cfdocs/images/artgallery/viata03.jpg" action="info" structName="viatoInfo"> 
<cfdump var="#viatoInfo#"> 
 
<!--- Alternatively, you can use the cfoutput tag to display specific image information, as 
shown in the following example. --->
<cfoutput> 
<p>height: #viatoInfo.height# pixels</p> 
<p>width: #viatoInfo.width# pixels</p> 
<p>source: #viatoInfo.source#</p> 
<p>transparency: #viatoInfo.colormodel.transparency#</p> 
<p>pixel size: #viatoInfo.colormodel.pixel_size#</p> 
<p>color model: #viatoInfo.colormodel.colormodel_type#</p> 
<p>alpha channel support: #viatoInfo.colormodel.alpha_channel_support#</p> 
<p>color space: #viatoInfo.colormodel.colorspace#</p> 
</cfoutput>

read action Use the read action to read an image from the specified local file pathname or URL, and create a ColdFusion image in memory. You can use the ColdFusion image variable as the source for another cfimage tag or for Image functions. The read action performs the same operation as the ImageRead function. The following example shows how to create a ColdFusion image from a JPEG file and manipulate it using the ImageGrayscalefunction:

<!--- This code shows how to create a ColdFusion image from a JPEG file.

--->

<cfimage source="../cfdocs/images/artgallery/jeff01.jpg" name="myImage">  <cfset ImageGrayscale(myImage)>  <cfimage source="#myImage#" action="write" destination="myGrayscaleImage.jpg" overwrite="yes">

<!--- This code shows how to create a ColdFusion image from a JPEG file. 
--->
<cfimage source="../cfdocs/images/artgallery/jeff01.jpg" name="myImage"> 
<!--- This code shows how to convert the image to grayscale. --->
<cfset ImageGrayscale(myImage)> 
<!--- This code shows how to write the grayscale image to a JPEG file. --->
<cfimage source="#myImage#" action="write" destination="myGrayscaleImage.jpg" overwrite="yes">

resize action Use the resizeaction to resize an image to the specified height and width. You can specify the height and width in pixels or as a percentage:

<cfimage source="../cfdocs/images/artgallery/jeff02.jpg" action="resize"

width="50%" height="50%" destination="jeff02_thumbnail.jpg" overwrite="yes">

<!--- This example shows how to specify the height of an image in pixels and its width as a

percentage. --->

<cfimage source="../cfdocs/images/artgallery/jeff03.jpg" action="resize"

width="50%" height="100" destination="jeff03_thumbnail.jpg" overwrite="yes">

<cfimage source="../cfdocs/images/artgallery/jeff01.jpg" action="resize" width="100" height="100" destination="jeff01_thumbnail.jpg" overwrite="yes">  <cfimage source="../cfdocs/images/artgallery/jeff02.jpg" action="resize" width="50%" height="50%" destination="jeff02_thumbnail.jpg" overwrite="yes">  <cfimage source="../cfdocs/images/artgallery/jeff03.jpg" action="resize" width="50%" height="100" destination="jeff03_thumbnail.jpg" overwrite="yes">

<!--- This example shows how to specify the height and width of an image in pixels. --->
<cfimage source="../cfdocs/images/artgallery/jeff01.jpg" action="resize" width="100" height="100" destination="jeff01_thumbnail.jpg" overwrite="yes"> 
<!--- This example shows how to specify the height and width of an image as percentages. --->
<cfimage source="../cfdocs/images/artgallery/jeff02.jpg" action="resize"
width="50%" height="50%" destination="jeff02_thumbnail.jpg" overwrite="yes"> 
<!--- This example shows how to specify the height of an image in pixels and its width as a 
percentage. --->
<cfimage source="../cfdocs/images/artgallery/jeff03.jpg" action="resize"
width="50%" height="100" destination="jeff03_thumbnail.jpg" overwrite="yes">

For more control of resize attributes, use the ImageResize function.

rotate action Use the rotateaction to rotate an image by degrees:

<cfimage source="../cfdocs/images/artgallery/maxwell01.jpg" action="rotate" angle="30"

name="maxwellAngle">

<cfimage source="../cfdocs/images/artgallery/maxwell01.jpg" action="rotate" angle="30" name="maxwellAngle">  <cfimage source="#maxwellAngle#" action="writeToBrowser">

<!--- This example shows how to rotate an image by 30 degrees. --->
<cfimage source="../cfdocs/images/artgallery/maxwell01.jpg" action="rotate" angle="30"
name="maxwellAngle"> 
<!--- Display the rotated image in a browser. --->
<cfimage source="#maxwellAngle#" action="writeToBrowser">

For more control of the rotate attributes, use the ImageRotate function.

write action Use the write action to write an image to the specified path. The new image is converted to the file type specified in the destination attribute. The write action performs the same operation as the ImageWrite function. When you write an image to a JPEG file, the image quality is set to 75% of the original image by default. To control the image size, use the quality attribute of the write action.
You can use the write action to change the quality of a JPEG image to reduce file size. The following example shows how to change image quality to .5:

<cfimage source="../cfdocs/images/artgallery/aiden01.jpg" action="write"

destination="aiden01.png">

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="write"

destination="jeff05_lq.jpg" quality=".5">

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="write"

destination="jeff05.jpg">

<cfimage source="../cfdocs/images/artgallery/aiden01.jpg" action="write" destination="aiden01.png">  <cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="write" destination="jeff05_lq.jpg" quality=".5">  <cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="write" destination="jeff05.jpg">

<!--- This example shows how to create a PNG file from a JPEG file by using the write action. --->
<cfimage source="../cfdocs/images/artgallery/aiden01.jpg" action="write"
destination="aiden01.png"> 
<!--- This example shows how to create a low-quality JPEG image. --->
<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="write"
destination="jeff05_lq.jpg" quality=".5"> 
<!--- This example shows how to write a JPEG file to a new location. --->
<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="write"
destination="jeff05.jpg">

writeToBrowser action Use the writeToBrowseraction to display one or more ColdFusion images directly to the browser without writing them to files. Images are displayed in PNG format. The following example shows how to reduce the size of an image and display it in the browser:

<!--- This example shows how to create a ColdFusion image from a JPEG file, resize it, and

then display it in the browser as a PNG image. --->

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="resize"

width="50%" height="50%" name="smLogo">

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="resize" width="50%" height="50%" name="smLogo"> <cfimage source="#smLogo#" action="writeToBrowser">

<!--- This example shows how to create a ColdFusion image from a JPEG file, resize it, and 
then display it in the browser as a PNG image. --->
<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" action="resize"
width="50%" height="50%" name="smLogo"> 
<cfimage source="#smLogo#" action="writeToBrowser">

Example

This example shows how to create a ColdFusion image and manipulate it by using Image functions:

<!--- Pass the ColdFusion image to the Image functions to blur the image by a radius of 5,

flip the image 90 degrees, and convert the image to grayscale. --->

<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" name="myImage">  <cfset ImageBlur(myImage,5)> <cfset ImageFlip(myImage,"90")> <cfset ImageGrayscale(myImage)>  <cfimage source="#myImage#" action="writeToBrowser">

<!--- Create the ColdFusion image variable "myImage" from a JPEG file. --->
<cfimage source="../cfdocs/images/artgallery/jeff05.jpg" name="myImage"> 
<!--- Pass the ColdFusion image to the Image functions to blur the image by a radius of 5, 
flip the image 90 degrees, and convert the image to grayscale. --->
<cfset ImageBlur(myImage,5)> 
<cfset ImageFlip(myImage,"90")> 
<cfset ImageGrayscale(myImage)> 
<!--- Write the transformed image to a browser. --->
<cfimage source="#myImage#" action="writeToBrowser">

WebP image support

WebP is an image format that provides higher compression for images on the web. It supports both lossy and lossless compression.

Key Features of WebP

Lossy and lossless compression: WebP can compress images using either lossy or lossless methods, achieving smaller file sizes compared to traditional formats like JPEG and PNG.
Transparency: WebP supports transparent images, similar to PNG, which is useful for images with clear backgrounds or overlay graphics.
Animation: WebP can also handle animated images, providing an alternative to GIFs with better compression and quality.
Wide support: Modern web browsers such as Google Chrome, Firefox, Edge, and Opera support WebP, making it a practical choice for web developers.
Efficient compression: WebP typically results in smaller file sizes compared to JPEG, PNG, and GIF formats while maintaining similar or better image quality. This efficiency can lead to faster website loading times and reduced bandwidth usage.

Using cfimage’s read and write actions, you can read a webp file, apply image processing, and write the modified file back to disk.

Example

<cftry>

Image read successfully.

</cfoutput>

#cfcatch.message#

</cfoutput>

</cfcatch>

</cftry>

<cftry>

Image blurred successfully.

</cfoutput>

#cfcatch.message#

</cfoutput>

</cfcatch>

</cftry>

<cfset imagePath = "fire.webp"> <cftry> <cfimage action="read" source="#imagePath#" name="myImage"> <cfoutput> Image read successfully. </cfoutput> <cfcatch type="image"> <cfoutput> #cfcatch.message# </cfoutput> </cfcatch> </cftry>  <cfset ImageBlur(myImage,10)> <cftry> <cfimage action="write" source="#myImage#" destination="blurred_fire.webp" overwrite="true"> <cfoutput> Image blurred successfully. </cfoutput> <cfcatch type="image"> <cfoutput> #cfcatch.message# </cfoutput> </cfcatch> </cftry>

<cfset imagePath = "fire.webp"> 
<cftry>
    <cfimage action="read" source="#imagePath#" name="myImage">
    <cfoutput>
        Image read successfully.
    </cfoutput>
    <cfcatch type="image">
    <cfoutput>
        #cfcatch.message#
    </cfoutput>
    </cfcatch>
</cftry>
<!--- Apply blurring to the image --->
<cfset ImageBlur(myImage,10)>
<cftry>
    <cfimage action="write" source="#myImage#" destination="blurred_fire.webp" overwrite="true">
    <cfoutput>
        Image blurred successfully.
    </cfoutput>
    <cfcatch type="image">
    <cfoutput>
        #cfcatch.message#
    </cfoutput>
    </cfcatch>
</cftry>

Get help faster and easier

New user?

cfimage

Description

History

Category

Syntax

See also

Attributes

Usage

File attributes

Supported image file formats

CMYK support

Valid HTML named colors

Image quality

Example

WebP image support

Example

Get help faster and easier

Share this page

Ask the Community

Contact Us